net-im/ejabberd: Version bump.
authorHanno Böck <hanno@gentoo.org>
Thu, 30 Apr 2020 08:16:32 +0000 (10:16 +0200)
committerHanno Böck <hanno@gentoo.org>
Thu, 30 Apr 2020 08:16:32 +0000 (10:16 +0200)
Based on ebuild from Vampik's overlay with small changes.
Remove old postinst warnings, add warning for needed config changes
for updates from 17.x.

Closes: https://bugs.gentoo.org/626260
Signed-off-by: Hanno Böck <hanno@gentoo.org>
Package-Manager: Portage-2.3.99, Repoman-2.3.22

net-im/ejabberd/Manifest
net-im/ejabberd/ejabberd-20.03.ebuild [new file with mode: 0644]
net-im/ejabberd/files/ejabberd-19.08-0002-Dont-overwrite-service-file.patch [new file with mode: 0644]
net-im/ejabberd/files/ejabberd-19.08-ejabberdctl.patch [new file with mode: 0644]
net-im/ejabberd/metadata.xml

index 57e9e73b4c00a69c010f2d57aee9467cf109723b..20a2eb6b380b7e90709a8d0b65c143fe6041a761 100644 (file)
@@ -1 +1,2 @@
 DIST ejabberd-17.04.tar.gz 1690441 BLAKE2B 2d31f1f0a393c6531653a55021b9deb729357bb53e86e85b85796a65f505257bcf7a14b0d168af2d13a6820e1524e1164ea7f17797df23ae41d7a8379f9e2066 SHA512 03467434dba92bd1ff2f70d78aa8fcf86fc73cb52aaaa73e4947229e1d14225e7b0d0133c3da7c8efe4c9db13aab932f40f757be46b120d0f280f96d62c203d7
+DIST ejabberd-20.03.tar.gz 2006603 BLAKE2B 67fa7d86e6802f24e783e91a8cb498375ca615bf22422ebe8bf630eb721e50574f468cfe25271172ebdfdca0c1df24dc6dd7f96a289153a017c32eb82af06d82 SHA512 f3ab666d9ffa596386ef121161dc7eeedca85cb7f5d290ad0882cd9557ea4166467bce9c082bdb423f932b44999c8e887d6a386d53564febf360f306feda3952
diff --git a/net-im/ejabberd/ejabberd-20.03.ebuild b/net-im/ejabberd/ejabberd-20.03.ebuild
new file mode 100644 (file)
index 0000000..aadecdb
--- /dev/null
@@ -0,0 +1,292 @@
+# Copyright 1999-2020 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=6
+
+SSL_CERT_MANDATORY=1
+
+inherit eutils pam rebar ssl-cert systemd
+
+DESCRIPTION="Robust, scalable and extensible XMPP server"
+HOMEPAGE="https://www.ejabberd.im/ https://github.com/processone/ejabberd/"
+SRC_URI="https://static.process-one.net/${PN}/downloads/${PV}/${P}.tgz
+       -> ${P}.tar.gz"
+
+LICENSE="GPL-2"
+SLOT="0"
+KEYWORDS="~amd64"
+REQUIRED_USE="mssql? ( odbc )"
+# TODO: Add 'tools' flag.
+IUSE="captcha debug full-xml hipe ldap mssql mysql odbc pam postgres redis
+       roster-gw sip sqlite stun zlib"
+
+RESTRICT="test"
+
+# TODO: Add dependencies for 'tools' flag enabled.
+# TODO: tools? (
+# TODO:                >=dev-erlang/luerl-0.3
+# TODO: )
+DEPEND=">=dev-lang/erlang-19.3[hipe?,odbc?,ssl]
+       >=dev-erlang/cache_tab-1.0.22
+       >=dev-erlang/eimp-1.0.14
+       >=dev-erlang/fast_tls-1.1.4
+       >=dev-erlang/fast_xml-1.1.39
+       >=dev-erlang/fast_yaml-1.0.24
+       >=dev-erlang/yconf-1.0.4
+       >=dev-erlang/jiffy-1.0.1
+       >=dev-erlang/jose-1.9.0
+       >=dev-erlang/lager-3.6.10
+       >=dev-erlang/p1_oauth2-0.6.6
+       >=dev-erlang/p1_utils-1.0.18
+       >=dev-erlang/stringprep-1.0.19
+       >=dev-erlang/xmpp-1.4.5
+       >=dev-erlang/pkix-1.0.5
+       >=dev-erlang/mqtree-1.0.7
+       >=dev-erlang/idna-6.0.0
+       >=dev-erlang/p1_acme-1.0.5
+       >=dev-erlang/base64url-1.0
+       >=net-im/jabber-base-0.01
+       ldap? ( =net-nds/openldap-2* )
+       mysql? ( >=dev-erlang/p1_mysql-1.0.14 )
+       odbc? ( dev-db/unixODBC )
+       pam? ( >=dev-erlang/epam-1.0.7 )
+       postgres? ( >=dev-erlang/p1_pgsql-1.1.9 )
+       redis? ( >=dev-erlang/eredis-1.0.8 )
+       sip? ( >=dev-erlang/esip-1.0.32 )
+       sqlite? ( >=dev-erlang/sqlite3-1.1.6 )
+       stun? ( >=dev-erlang/stun-1.0.31 )
+       zlib? ( >=dev-erlang/ezlib-1.0.7 )"
+RDEPEND="${DEPEND}
+       captcha? ( media-gfx/imagemagick[truetype,png] )"
+
+DOCS=( CHANGELOG.md README.md )
+PATCHES=( "${FILESDIR}/${PN}-19.08-ejabberdctl.patch"
+       "${FILESDIR}/${PN}-19.08-0002-Dont-overwrite-service-file.patch")
+
+EJABBERD_CERT="${EPREFIX}/etc/ssl/ejabberd/server.pem"
+# Paths in net-im/jabber-base
+JABBER_ETC="${EPREFIX}/etc/jabber"
+JABBER_LOG="${EPREFIX}/var/log/jabber"
+JABBER_SPOOL="${EPREFIX}/var/spool/jabber"
+
+# Adjust example configuration file to Gentoo.
+# - Use our sample certificate.
+adjust_config() {
+       sed -rne "/^#?\s+certfiles:/{p;a\  - ${EJABBERD_CERT}" -e ":a;n;/^#?\s+-/ba};p" \
+               -i "${S}/ejabberd.yml.example" \
+               || die 'failed to adjust example config'
+       sed -re 's/^#\s+(certfiles)/\1/' \
+               -i "${S}/ejabberd.yml.example" \
+               || die 'failed to adjust example config'
+}
+
+# Set paths to ejabberd lib directory consistently to point always to directory
+# suffixed with version.
+correct_ejabberd_paths() {
+       sed -e "/^EJABBERDDIR[[:space:]]*=/{s:ejabberd:${P}:}" \
+               -i "${S}/Makefile.in" \
+               || die 'failed to set ejabberd path in Makefile.in'
+       sed -e "/EJABBERD_BIN_PATH=/{s:ejabberd:${P}:}" \
+               -i "${S}/ejabberdctl.template" \
+               || die 'failed to set ejabberd path in ejabberdctl.template'
+}
+
+# Get epam-wrapper from 'files' directory and correct path to lib directory in
+# it. epam-wrapper is placed into work directory. It is assumed no epam-wrapper
+# file exists there already.
+customize_epam_wrapper() {
+       local epam_wrapper_src="$1"
+       local epam_wrapper_dst="${S}/epam-wrapper"
+
+       [[ -e ${epam_wrapper_dst} ]] && die 'epam-wrapper already exists'
+       sed -r -e "s@^(ERL_LIBS=).*\$@\1${EPREFIX}$(get_erl_libs)@" \
+               "${epam_wrapper_src}" >"${epam_wrapper_dst}" \
+               || die 'failed to install epam-wrapper'
+}
+
+# Check if we are missing a default certificate.
+ejabberd_cert_missing() {
+       if grep -qs "^\s\+- ${EJABBERD_CERT}" "${EROOT%/}${JABBER_ETC}/ejabberd.yml"; then
+               if [[ -f "${EROOT%/}${EJABBERD_CERT}" ]]; then
+                       # default certificate is present in config and exists - not installing
+                       return 1
+               else
+                       # default certificate is present in config
+                       # but doesn't exist - need to install one
+                       return 0
+               fi
+       fi
+       # no default certificate in config - not installing
+       return 1
+}
+
+# Generate and install sample ejabberd certificate. It's installed into
+# EJABBERD_CERT path.
+ejabberd_cert_install() {
+       SSL_ORGANIZATION="${SSL_ORGANIZATION:-ejabberd XMPP Server}"
+       install_cert "${EJABBERD_CERT%.*}"
+       chown root:jabber "${EROOT%/}${EJABBERD_CERT}" || die
+       chmod 0440 "${EROOT%/}${EJABBERD_CERT}" || die
+}
+
+# Get path to ejabberd lib directory.
+#
+# This is the path ./configure script Base for this path is path set in
+# ./configure script which is /usr/lib by default. If libdir is explicitely set
+# to something else than this should be adjusted here as well.
+get_ejabberd_path() {
+       echo "/usr/$(get_libdir)/${P}"
+}
+
+# Make ejabberd.service for systemd from upstream provided template.
+make_ejabberd_service() {
+       sed -r \
+               -e 's!@ctlscriptpath@!/usr/sbin!g' \
+               -e 's!^(User|Group)=(.*)!\1=jabber!' \
+               -e 's!^(After)=(.*)!\1=epmd.service network.target!' \
+               -e '/^After=/ a Requires=epmd.service' \
+               "${PN}.service.template" >"${PN}.service" \
+               || die 'failed to make ejabberd.service'
+}
+
+# Set paths to defined by net-im/jabber-base.
+set_jabberbase_paths() {
+       sed -e "/^ETCDIR[[:space:]]*=/{s:@sysconfdir@/ejabberd:${JABBER_ETC}:}" \
+               -e "/^LOGDIR[[:space:]]*=/{s:@localstatedir@/log/ejabberd:${JABBER_LOG}:}" \
+               -e "/^SPOOLDIR[[:space:]]*=/{s:@localstatedir@/lib/ejabberd:${JABBER_SPOOL}:}" \
+               -i "${S}/Makefile.in" \
+               || die 'failed to set paths in Makefile.in'
+       sed -e "s|\(ETC_DIR:=\"\){{sysconfdir}}[^\"]*|\1${JABBER_ETC}|" \
+               -e "s|\(LOGS_DIR:=\"\){{localstatedir}}[^\"]*|\1${JABBER_LOG}|" \
+               -e "s|\(SPOOL_DIR:=\"\){{localstatedir}}[^\"]*|\1${JABBER_SPOOL}|" \
+               -i "${S}/ejabberdctl.template" \
+               || die 'failed to set paths ejabberdctl.template'
+}
+
+# Skip installing docs because it's only COPYING that's installed by Makefile.
+skip_docs() {
+       gawk -i inplace '
+/# Documentation/, /^[[:space:]]*#?[[:space:]]*$/ {
+       if ($0 ~ /^[[:space:]]*#?[[:space:]]*$/) {
+               print $0;
+       } else {
+               next;
+       }
+}
+1
+' "${S}/Makefile.in" || die 'failed to remove docs section from Makefile.in'
+}
+
+src_prepare() {
+       default
+
+       rebar_remove_deps
+       correct_ejabberd_paths
+       set_jabberbase_paths
+       make_ejabberd_service
+       skip_docs
+       adjust_config
+       customize_epam_wrapper "${FILESDIR}/epam-wrapper"
+
+       rebar_fix_include_path fast_xml
+       rebar_fix_include_path p1_utils
+       rebar_fix_include_path xmpp
+
+       # Fix bug #591862. ERL_LIBS should point directly to ejabberd directory
+       # rather than its parent which is default. That way ejabberd directory
+       # takes precedence is module lookup.
+       local ejabberd_erl_libs="$(get_ejabberd_path):$(get_erl_libs)"
+       sed -e "s|\(ERL_LIBS=\){{libdir}}.*|\1${ejabberd_erl_libs}|" \
+               -i "${S}/ejabberdctl.template" \
+               || die 'failed to set ERL_LIBS in ejabberdctl.template'
+
+       sed -e "s|\(AC_INIT(ejabberd, \)m4_esyscmd([^)]*)|\1[$PV]|" \
+               -i configure.ac || die "Failed to write correct version to configure"
+       # eautoreconf # required in case of download from github
+}
+
+src_configure() {
+       econf \
+               --docdir="${EPREFIX}/usr/share/doc/${PF}/html" \
+               --enable-user=jabber \
+               --disable-system-deps \
+               $(use_enable debug) \
+               $(use_enable full-xml) \
+               $(use_enable hipe) \
+               $(use_enable mssql) \
+               $(use_enable mysql) \
+               $(use_enable odbc) \
+               $(use_enable pam) \
+               $(use_enable postgres pgsql) \
+               $(use_enable redis) \
+               $(use_enable roster-gw roster-gateway-workaround) \
+               $(use_enable sqlite) \
+               $(use_enable sip) \
+               $(use_enable stun) \
+               $(use_enable zlib)
+
+       # more options to support
+       # --enable-elixir requires https://github.com/elixir-lang/elixir
+}
+
+src_compile() {
+       emake REBAR='rebar -v' src
+}
+
+src_install() {
+       default
+
+       keepdir /var/lib/lock/ejabberdctl
+       rm -rf "${ED%/}/var/log" || die
+       rm -rf "${ED%/}/var/spool" || die
+
+       if use pam; then
+               local epam_path="$(get_ejabberd_path)/priv/bin/epam"
+
+               pamd_mimic_system xmpp auth account || die "cannot create pam.d file"
+               into "$(get_ejabberd_path)/priv"
+               newbin epam-wrapper epam
+       fi
+
+       newconfd "${FILESDIR}/${PN}.confd" "${PN}"
+       newinitd "${FILESDIR}/${PN}.initd" "${PN}"
+       systemd_dounit "${PN}.service"
+       systemd_dotmpfilesd "${FILESDIR}/${PN}.tmpfiles.conf"
+
+       insinto /etc/logrotate.d
+       newins "${FILESDIR}/${PN}.logrotate" "${PN}"
+}
+
+pkg_preinst() {
+       if use pam; then
+               einfo "Adding jabber user to epam group to allow ejabberd to use PAM" \
+                       "authentication"
+               # See
+               # <https://docs.ejabberd.im/admin/configuration/#pam-authentication>.
+               # epam binary is installed by dev-erlang/epam package, therefore SUID
+               # is set by that package. Instead of jabber group it uses epam group,
+               # therefore we need to add jabber user to epam group.
+               usermod -a -G epam jabber || die
+       fi
+}
+
+pkg_postinst() {
+       if [[ ! ${REPLACING_VERSIONS} ]]; then
+               echo
+               elog "For configuration instructions, please see"
+               elog "  https://docs.ejabberd.im/"
+               echo
+       fi
+       if [[ " ${REPLACING_VERSIONS} " =~ \ 17\. ]]; then
+               ewarn If you are updating from an older version like 17.x
+               ewarn you may need to add an access_rules section to your
+               ewarn ejabberd.yml config file.
+               ewarn Otherwise authentication will be broken and users
+               ewarn will not be able to log in.
+               echo
+       fi
+
+       if ejabberd_cert_missing; then
+               ejabberd_cert_install
+       fi
+}
diff --git a/net-im/ejabberd/files/ejabberd-19.08-0002-Dont-overwrite-service-file.patch b/net-im/ejabberd/files/ejabberd-19.08-0002-Dont-overwrite-service-file.patch
new file mode 100644 (file)
index 0000000..2bea750
--- /dev/null
@@ -0,0 +1,15 @@
+diff --git a/Makefile.in b/Makefile.in
+index a0b4553d..4675b88a 100644
+--- a/Makefile.in
++++ b/Makefile.in
+@@ -204,8 +204,8 @@ install: all copy-files
+       chmod 755 ejabberd.init
+       #
+       # Service script
+-      $(SED) -e "s*@ctlscriptpath@*$(SBINDIR)*g" ejabberd.service.template \
+-              > ejabberd.service
++      [ -f ejabberd.service ] || $(SED) -e "s*@ctlscriptpath@*$(SBINDIR)*g" \
++              ejabberd.service.template > ejabberd.service
+       chmod 644 ejabberd.service
+       #
+       # Spool directory
diff --git a/net-im/ejabberd/files/ejabberd-19.08-ejabberdctl.patch b/net-im/ejabberd/files/ejabberd-19.08-ejabberdctl.patch
new file mode 100644 (file)
index 0000000..0fb1f5c
--- /dev/null
@@ -0,0 +1,38 @@
+Subject: [PATCH] Adjust ejabberdctl for Gentoo jabberbase setup
+
+Set SHELL since the generic jabber user used on Gentoo for jabber
+servers doesn't have a valid shell set by default and fix EXEC_CMD
+otherwise it fails with This account is currently not available again
+due to jabber not having a valid shell.
+
+Also, workaround the assumption that jabber's /root is a directory when
+instead it defaults to /dev/null on Gentoo.
+---
+
+diff --git a/ejabberdctl.template b/ejabberdctl.template
+index 571b90b..71336c0 100755
+--- a/ejabberdctl.template
++++ b/ejabberdctl.template
+@@ -82,6 +82,7 @@ fi
+ ERL_LIBS={{libdir}}
+ ERL_CRASH_DUMP="$LOGS_DIR"/erl_crash_$(date "+%Y%m%d-%H%M%S").dump
+ ERL_INETRC="$ETC_DIR"/inetrc
++HOME=$SPOOL_DIR
+ # define ejabberd parameters
+ EJABBERD_OPTS="$EJABBERD_OPTS\
+@@ -105,12 +106,13 @@ export ERL_MAX_ETS_TABLES
+ export CONTRIB_MODULES_PATH
+ export CONTRIB_MODULES_CONF_DIR
+ export ERL_LIBS
++export HOME
+ # run command either directly or via su $INSTALLUSER
+ exec_cmd()
+ {
+     case $EXEC_CMD in
+-        as_install_user) su -s /bin/sh -c '"$0" "$@"' "$INSTALLUSER" -- "$@" ;;
++        as_install_user) su -p -s /bin/sh -c '"$0" "$@"' "$INSTALLUSER" -- "$@" ;;
+         as_current_user) "$@" ;;
+     esac
+ }
index d9f1e24554e168b8905785f0772b971367149849..ecd307a3a00f7c245130e91b54d0c565100e09c3 100644 (file)
@@ -1,9 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
 <pkgmetadata>
-       <maintainer type="person">
-               <email>hanno@gentoo.org</email>
-               <name>Hanno Böck</name>
+       <maintainer type="project">
+               <email>ejabberd@gentoo.org</email>
        </maintainer>
        <longdescription>
                Free and Open Source distributed fault-tolerant Jabber server. It's
@@ -25,6 +24,8 @@
                        data store</flag>
                <flag name="roster-gw">Turn on workaround for processing gateway subscriptions</flag>
                <flag name="sqlite">Enable SQLite database support</flag>
+               <flag name="sip">Enable SIP support</flag>
+               <flag name="stun">Enable STUN/TURN support</flag>
                <flag name="zlib">Enable Stream Compression (XEP-0138) using zlib</flag>
                <!-- TODO Add later: flag name="tools">Build development tools</flag -->
        </use>