From 701962415d5858198f4dbefb6da522c645c14fe3 Mon Sep 17 00:00:00 2001
From: casperklein <casperklein@users.noreply.github.com>
Date: Fri, 9 Aug 2024 21:56:53 +0200
Subject: [PATCH] Getmail revision
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Verify GETMAIL_POLL
* Switch state-dir from /tmp/docker-mailserver/getmail to /var/lib/getmail
* Add support for custom getmailrc_general.cf file
* remove getmail 'message_log'  option in favor of 'message_log_syslog'
* Change config directory structure:

├── docker-data/dms/config
│   ├── getmail-example.cf

to

├── docker-data/dms/config
│   ├── getmail
│   │   ├── getmailrc_general.cf
│   │   ├── imap-example.cf
│   │   ├── pop3-example.cf
---
 target/scripts/startup/setup.d/getmail.sh    | 81 ++++++++++++--------
 target/scripts/startup/setup.d/mail_state.sh |  1 +
 2 files changed, 52 insertions(+), 30 deletions(-)

diff --git a/target/scripts/startup/setup.d/getmail.sh b/target/scripts/startup/setup.d/getmail.sh
index c1345063..8bd8f1e1 100644
--- a/target/scripts/startup/setup.d/getmail.sh
+++ b/target/scripts/startup/setup.d/getmail.sh
@@ -4,38 +4,59 @@ function _setup_getmail() {
   if [[ ${ENABLE_GETMAIL} -eq 1 ]]; then
     _log 'trace' 'Preparing Getmail configuration'
 
-    local GETMAILRC ID CONFIGS
-
-    GETMAILRC='/etc/getmailrc.d'
-    CONFIGS=0
-
-    mkdir -p "${GETMAILRC}"
-
-    # Generate getmailrc configs, starting with the `/etc/getmailrc_general` base config,
-    # Add a unique `message_log` config, then append users own config to the end.
-    for FILE in /tmp/docker-mailserver/getmail-*.cf; do
-      if [[ -f ${FILE} ]]; then
-        CONFIGS=1
-        ID=$(cut -d '-' -f 3 <<< "${FILE}" | cut -d '.' -f 1)
-        local GETMAIL_CONFIG="${GETMAILRC}/getmailrc-${ID}"
-
-        cat /etc/getmailrc_general                                 >"${GETMAIL_CONFIG}"
-        echo -e "message_log = /var/log/mail/getmail-${ID}.log\n" >>"${GETMAIL_CONFIG}"
-        cat "${FILE}"                                             >>"${GETMAIL_CONFIG}"
-      fi
-    done
-
-    if [[ ${CONFIGS} -eq 1 ]]; then
-      cat >/etc/cron.d/getmail << EOF
-*/${GETMAIL_POLL} * * * * root /usr/local/bin/getmail-cron
-EOF
-      chmod -R 600 "${GETMAILRC}"
+    # Verify correct value for GETMAIL_POLL. Valid are any numbers greater than 0.
+    if ! [[ ${GETMAIL_POLL} =~ ^[0-9]+$ && ${GETMAIL_POLL} -gt 0 ]]; then
+      _log 'warn' "Invalid value for GETMAIL_POLL: ${GETMAIL_POLL}"
+      _log 'warn' "Getmail will be disabled"
+      # return 1
     fi
 
-    # Both the debug command and cron job (that runs getmail) for getmail
-    # expect this location to exist.
-    GETMAILDIR=/tmp/docker-mailserver/getmail
-    mkdir -p "${GETMAILDIR}"
+    local GETMAIL_RC ID GETMAIL_DIR
+
+    local GETMAIL_CONFIG_DIR='/tmp/docker-mailserver/getmail'
+    local GETMAIL_RC_DIR='/etc/getmailrc.d'
+    local GETMAIL_RC_GENERAL_CF="${GETMAIL_CONFIG_DIR}/getmailrc_general.cf"
+    local GETMAIL_RC_GENERAL='/etc/getmailrc_general'
+
+    # Create the directory /etc/getmailrc.d to place the user config in later.
+    mkdir -p "${GETMAIL_RC_DIR}"
+
+    # Check if getmail config directory exists and at least one <ID>.cf file is present.
+    # getmailrc_general.cf is not mandatory and excluded.
+    if ! find "${GETMAIL_CONFIG_DIR}" -type f -name '*.cf' -not -name getmailrc_general.cf 2>/dev/null | grep -q .; then
+      _log 'warn' 'No getmail configration found'
+      _log 'warn' "Getmail will be disabled"
+    fi
+
+    # Check if custom getmailrc_general.cf file is present.
+    if [[ -f "${GETMAIL_RC_GENERAL_CF}" ]]; then
+      _log 'debug' "Custom 'getmailrc_general.cf' found"
+      cp "${GETMAIL_RC_GENERAL_CF}" "${GETMAIL_RC_GENERAL}"
+    fi
+
+    # If no matching filenames are found, and the shell option nullglob is disabled, the word is left unchanged.
+    # If the nullglob option is set, and no matches are found, the word is removed.
+    shopt -s nullglob
+
+    # Generate getmailrc configs, starting with the `/etc/getmailrc_general` base config, then appending users own config to the end.
+    for FILE in "${GETMAIL_CONFIG_DIR}"/*.cf; do
+      if [[ ${FILE} =~ /getmail/(.+)\.cf && ${FILE} != "${GETMAIL_RC_GENERAL_CF}" ]]; then
+        ID=${BASH_REMATCH[1]}
+
+        _log 'debug' "Processing getmail config '${ID}'"
+
+        GETMAIL_RC=${GETMAIL_RC_DIR}/${ID}
+        cat "${GETMAIL_RC_GENERAL}" "${FILE}" >"${GETMAIL_RC}"
+      fi
+    done
+    chmod -R 600 "${GETMAIL_RC_DIR}"
+
+    # Directory, where "oldmail" files are stored
+    # getmail stores its state - its "memory" of what it has seen in your POP/IMAP account - in the oldmail files.
+    # The debug command for getmail expect this location to exist.
+    GETMAIL_DIR=/var/lib/getmail
+    _log 'debug' "Creating getmail state-dir '${GETMAIL_DIR}'"
+    mkdir -p "${GETMAIL_DIR}"
   else
     _log 'debug' 'Getmail is disabled'
   fi
diff --git a/target/scripts/startup/setup.d/mail_state.sh b/target/scripts/startup/setup.d/mail_state.sh
index de15ee3b..e819c138 100644
--- a/target/scripts/startup/setup.d/mail_state.sh
+++ b/target/scripts/startup/setup.d/mail_state.sh
@@ -23,6 +23,7 @@ function _setup_save_states() {
     [[ ${ENABLE_CLAMAV}       -eq 1 ]] && SERVICEDIRS+=('lib/clamav')
     [[ ${ENABLE_FAIL2BAN}     -eq 1 ]] && SERVICEDIRS+=('lib/fail2ban')
     [[ ${ENABLE_FETCHMAIL}    -eq 1 ]] && SERVICEDIRS+=('lib/fetchmail')
+    [[ ${ENABLE_GETMAIL}      -eq 1 ]] && SERVICEDIRS+=('lib/getmail')
     [[ ${ENABLE_MTA_STS}      -eq 1 ]] && SERVICEDIRS+=('lib/mta-sts')
     [[ ${ENABLE_POSTGREY}     -eq 1 ]] && SERVICEDIRS+=('lib/postgrey')
     [[ ${ENABLE_RSPAMD}       -eq 1 ]] && SERVICEDIRS+=('lib/rspamd')