mail/fetchmail: avoid rc.conf overriding daemon interval, many other fixes

Authors: CH = Corey Halpin, MA = Matthias Andree

- fetchmail's rc script now queries the daemon interval from the
  configuration, and falls back to the rc.conf value if given. [CH]
- Similarly, the logging facility will be taken from the configuration [MA]
- Add documentation to the rcfile's header comments. [MA]
- Drop support for fetchmail_home_prefix in rc.conf, and query the
  respective users' home directories with getent instead. [MA]
- In the rc scripts, redirect input from /dev/null so it will not ask
  for passwords. [MA]
- Add support for the typical 12.1 rc.conf ${name}_... keywords. [MA]
- Make script execution easier to follow by simplifying if...else logic. [CH]
- Fix rcscript's exit code to be 1 if one of the per-user calls fails. [CH]
- Add relevant notes to UPDATING. [MA]

PR:		249860
Submitted by:	Corey Halpin (maintainer)
Reported by:	Chris James (on fetchmail-users mailing list)
Approved by:	Corey Halpin (maintainer)

UPDATING

@@ -5,6 +5,22 @@ they are unavoidable.
 You should get into the habit of checking this file for changes each time
 you update your ports collection, before attempting any port upgrades.
 
+20201002:
+  AFFECTS: users of mail/fetchmail beginning with 6.4.12_1
+  AUTHOR:  mandree@FreeBSD.org
+
+  Note that if you are using fetchmail in a multi-user setup, i. e. with the
+  fetchmail_users (mind the -s!) variable set, the $fetchmail_home_prefix +
+  user second-guess work has been replaced by a real lookup of the user's home
+  directory. In the majority of configurations, this should not make a
+  difference, in some setups, it may open up some flexibility.
+
+  The fetchmail_home_prefix variable is ignored from 6.4.12_1 onwards.
+
+  Also, the rc script redirects its input from /dev/null so that passwords
+  will not be interactively queried from an rcfile.  Put passwords into
+  the [.]fetchmailrc or into a .netrc file.
+
 20201002:
   AFFECTS: users of sysutils/modules
   AUTHOR: 0mp@FreeBSD.org

mail/fetchmail/Makefile

@@ -3,6 +3,7 @@
 
 PORTNAME?=	fetchmail
 DISTVERSION=	6.4.12
+PORTREVISION?=	1
 CATEGORIES=	mail
 # The next line is inherited by the fetchmailconf slave port,
 # do NOT replace fetchmail by ${PORTNAME}

mail/fetchmail/files/fetchmail.in

@@ -15,31 +15,47 @@
 #
 # There are two variants:
 #
+#  Note that there are two variables with only very slightly
+#  different names, fetchmail_user and fetchmail_users
+#  (mind the trailing plural-'s').
+#
 #  * Single system-wide fetchmail daemon:
+#    - This mode applies if the 'fetchmail_users' variable
+#      is unset or empty.
 #    - It is run as user `fetchmail_user' (default: fetchmail)
 #      Note: The directory /var/run/fetchmail must be writable for
 #            'fetchmail_user'.
 #    - All configuration is contained in one global file
 #      'fetchmail_config' (default: %%PREFIX%%/etc/fetchmailrc)
-#      that must be owned by 'fetchmail_user' (mode 700)
+#      that must be owned by 'fetchmail_user' and access mode
+#      may not be more than 700.
 #    - The fetchmail daemon awakes to fetch mail every 
 #      'fetchmail_polling_interval' seconds (default: 900).
+#        Note that a "set daemon 123" in the file $fetchmail_config
+#      takes precedence. The rc.conf value is only a fall-back.
+#    - The fetchmail logs will go to the syslog by default, but
+#      you can override it to a file by setting 
+#      'fetchmail_logging_facility=--logfile=/path/to/logfile'
+#      in the rcfile or set logfile /path/to/logfile in the $fetchmail_config
+#      file.  The log-file must pre-exist and be writable by the
+#      'fetchmail_user'.
 #
 #  * Per-user daemon
 #    - Users for which a fetchmail daemon is to be started must be
 #      listed in 'fetchmail_users', e.g. fetchmail_users="user1 user2"
 #      The 'fetchmail_user' (sic!) variable is ignored in this
 #      configuration variant.
-#    - The config files for the individual users must be located at
+#    - The config files for the individual users must be located in
-#      ${fetchmail_home_prefix}/${user}/${fetchmail_config_name}. The
+#      the fetchmail_user's home directory as ${fetchmail_config_name}. The
-#      default for 'fetchmail_home_prefix' is "/home", and that for
+#      default for 'fetchmail_config_name' is ".fetchmailrc".
-#      'fetchmail_config_name' is ".fetchmailrc".
+#    - There are user-specific versions of 'fetchmail_config',
-#    - Note that "${fetchmail_home_prefix}/${user}" must be writable
+#      'fetchmail_logging_facility' and 'fetchmail_polling_interval' as well as
-#      for ${user} since it is used to store the per-user PID files!
+#      the usual rc.subr variables that can be used to override the defaults,
-#    - There are user-specific versions of 'fetchmail_config' and
+#      i.e. for the user 'user1' there are variables 'fetchmail_user1_config'
-#      'fetchmail_polling_interval' that can be used to override the
+#      and 'fetchmail_user1_polling_interval', or fetchmail_user1_env to
-#      defaults, i.e. for the user 'user1' there are variables
+#      set user-daemon specific environment variables.
-#      'fetchmail_user1_config' and 'fetchmail_user1_polling_interval'
+#        Note that a "set daemon 123" in the config file (.fetchmailrc
+#      by default) takes precedence. The rc.conf value is only a fall-back.
 #    - All commands (e.g. start, stop, awaken (see below)) can be either
 #      passed to all instances of the daemon (if %%PREFIX%%/etc/rc.d/fetchmail)
 #      is run as root), or just to the instance belonging to the respective
@@ -54,11 +70,17 @@
 #
 # In any case, you will need a working fetchmailrc file. Please consult
 # the man page fetchmail(1), the documentation in %%PREFIX%%/share/doc/fetchmail/
-# and/or the material found at <http://www.fetchmail.info/>.
+# and/or the material found at <https://www.fetchmail.info/> or
+# <https://fetchmail.sourceforge.io/>.
 
 . /etc/rc.subr
 
+# prevent reading passwords from the boot console
+exec < /dev/null
+
 name=fetchmail
+# note we do not override name for instances, because we want to have a fallback
+# to global defaults.  Check for PULLVARS below.
 rcvar=fetchmail_enable
 
 command=%%PREFIX%%/bin/${name}
@@ -71,11 +93,11 @@ fetchmail_script=%%PREFIX%%/etc/rc.d/$name
 # read settings, set default values
 load_rc_config "$name"
 : ${fetchmail_enable="NO"}
+: ${fetchmail_flags=""}
 : ${fetchmail_user="fetchmail"}
 : ${fetchmail_config="%%PREFIX%%/etc/fetchmailrc"}
 : ${fetchmail_polling_interval="900"}
 : ${fetchmail_logging_facility="--syslog"}
-: ${fetchmail_home_prefix="/home"}
 : ${fetchmail_config_name=".fetchmailrc"}
 
 # send signal to fetchmail process(es) to check for new mail immediately
@@ -91,58 +113,91 @@ fetchmail_awaken()
 	return
 }
 
-if [ -n "$2" ]; then
+# query a value from the fetchmail config file, value specified in first argument
-	# perform action for an instance of fetchmail daemon
+fetchmail_dump_config()
-        user="$2"
+{
-        if [ "x${fetchmail_users}" != "x" -o "x$3" = "xGLOBALCONFIG"  ]; then
+	su -m ${fetchmail_user} -c sh -c "fetchmail -f ${fetchmail_config} --configdump" | fgrep $1 | cut -d: -f2
-		if [ "x${fetchmail_users}" != "x" ]; then
+}
-			# multiuser setup:  determine user specific config and pid file
+
-			eval fetchmail_config="\${fetchmail_${user}_config:-${fetchmail_home_prefix}/${user}}/${fetchmail_config_name}"
+# arguments:
-			eval pidfile="${fetchmail_home_prefix}/${user}/.fetchmail.pid"
+# ACTION - perform ACTION for the one global daemon
-			eval fetchmail_user=$user
+# ACTION USER GLOBALCONFIG - ditto, inside the recursive call
-		else
+# ACTION USER - perform ACTION for the USER-specific daemon, inside recursive call
-			eval pidfile=/var/run/fetchmail/fetchmail.pid
+
-		fi
+# if this is the global or 'umbrella' run
-		required_files=${fetchmail_config}
+if [ -z "$2" ] ; then
-		eval fetchmail_polling_interval="\${fetchmail_${user}_polling_interval:-${fetchmail_polling_interval}}"
+	uid=$(id -u)
-		fetchmail_flags="-f ${fetchmail_config} \
+	if [ "x${fetchmail_users}" != "x" -a "x$1" != "x" -a "$uid" = "0" ]; then
-				--pidfile ${pidfile} \
-				-d ${fetchmail_polling_interval} \
-				${fetchmail_logging_facility}"
-        else
-                echo "$0: extra argument ignored"
-        fi
-else
-	uid=`id -u`
-        if [ "x${fetchmail_users}" != "x" -a "x$1" != "x" -a "$uid" = "0" ]; then
 		# root mode: multiple user profiles are handled by recursive
 		# calls of this script
 		for user in ${fetchmail_users}; do
 			echo "===> fetchmail user: ${user}"
-			$fetchmail_script $1 ${user}
+			$fetchmail_script "$1" "${user}"
 			retcode="$?"
 			if [ "0${retcode}" -ne 0 ]; then
 				failed="${user} (${retcode}) ${failed:-}"
-			else
-				success="${user} ${success:-}"
 			fi
 		done
-		exit 0
 	else
 		if [ "x${fetchmail_users}" = "x" ]; then
 			# There is only one global configuration file
 			globalconfig=GLOBALCONFIG
 		fi
-		$fetchmail_script $1 `id -u -n` $globalconfig
+		$fetchmail_script "$1" "$(id -u -n)" $globalconfig
 		retcode="$?"
 		if [ "0${retcode}" -ne 0 ]; then
-			failed="${user} (${retcode}) ${failed:-}"
+			failed="${name} (${retcode}) ${failed:-}"
-			exit 1
-		else
-			success="${user} ${success:-}"
 		fi
-		exit 0
         fi
+
+	# if we had any failures, exit witn an error
+	if [ -n "${failed}" ] ; then
+		exit 1
+	fi
+
+	# otherwise, exit success
+	exit 0
+fi
+
+# perform action for an instance of fetchmail daemon
+fetchmail_user="$2"
+if [ "x${fetchmail_users}" != "x" -o "x$3" = "xGLOBALCONFIG" ]; then
+	if [ "x${fetchmail_users}" != "x" ]; then
+		# multiuser setup:  determine user specific config and pid file
+		fetchmail_home="$(getent passwd ${fetchmail_user} | cut -f6 -d:)"
+		fetchmail_home="${fetchmail_home%/}"
+		fetchmail_config="${fetchmail_home}/${fetchmail_config_name}"
+		pidfile="${fetchmail_home}/.fetchmail.pid"
+		# PULLVARS - pull user specific variables into scope if existing
+		# else use global defaults
+		for i in chdir chroot env env_file fib flags nice \
+			limits login_class oomprotect program user group groups prepend \
+			logging_facility polling_interval
+		do
+			uvarname=fetchmail_${fetchmail_user}_${i}
+	 		eval fetchmail_${i}="\${${uvarname}-\${fetchmail_${i}}}"
+		done
+	else
+		pidfile=/var/run/fetchmail/fetchmail.pid
+	fi
+	required_files=${fetchmail_config}
+
+	# add early command line arguments
+	# if logfile set in config file, do not override with rc.conf default (note logfile overrides syslog)
+	_logfile="$(fetchmail_dump_config logfile)"
+	if [ _"${_logfile}" != _"None," ] ; then
+		fetchmail_logging_facility=""
+	fi
+
+	fetchmail_flags="${fetchmail_flags} -f ${fetchmail_config} --pidfile ${pidfile} ${fetchmail_logging_facility}"
+
+	# add late command line arguments
+	# if no polling interval in config file, use value from rc.conf
+	if [ "$(fetchmail_dump_config poll_interval)" = "0," ] ; then
+		fetchmail_flags="${fetchmail_flags} -d ${fetchmail_polling_interval}"
+	fi
+else
+	echo "$0: extra argument ignored"
 fi
 
 # actually execute the fetchmail program

mail/fetchmailconf/Makefile

@@ -1,6 +1,7 @@
 # $FreeBSD$
 
 PORTNAME=	fetchmailconf
+PORTREVISION=	0
 DISTNAME=	fetchmail-${DISTVERSIONPREFIX}${DISTVERSION}${DISTVERSIONSUFFIX}
 # NOTE: MASTER_SITES in ../fetchmail must NOT use the $PORTNAME variable,
 # else _this_ port (fetchmailconf) becomes unfetchable