Add setting to configure pop3 for dovecot

data/hooks/conf_regen/25-dovecot

@@ -2,6 +2,8 @@
 
 set -e
 
+. /usr/share/yunohost/helpers
+
 do_pre_regen() {
   pending_dir=$1
 
@@ -14,11 +16,10 @@ do_pre_regen() {
   cp dovecot-ldap.conf "${dovecot_dir}/dovecot-ldap.conf"
   cp dovecot.sieve "${dovecot_dir}/global_script/dovecot.sieve"
 
-  # prepare dovecot.conf conf file
-  main_domain=$(cat /etc/yunohost/current_host)
-  cat dovecot.conf \
-    | sed "s/{{ main_domain }}/${main_domain}/g" \
-    > "${dovecot_dir}/dovecot.conf"
+  export pop3_enabled="$(yunohost settings get 'pop3.enabled')"
+  export main_domain=$(cat /etc/yunohost/current_host)
+
+  ynh_render_template "dovecot.conf" "${dovecot_dir}/dovecot.conf"
 
   # adapt it for IPv4-only hosts
   if [ ! -f /proc/net/if_inet6 ]; then

data/templates/dovecot/dovecot.conf

@@ -8,11 +8,10 @@ mail_home = /var/mail/%n
 mail_location = maildir:/var/mail/%n
 mail_uid = 500
 
-protocols = imap sieve
+protocols = imap sieve {% if pop3_enabled == "True" %}pop3{% endif %}
 
 mail_plugins = $mail_plugins quota
 
-
 ssl = yes
 ssl_cert = </etc/yunohost/certs/{{ main_domain }}/crt.pem
 ssl_key = </etc/yunohost/certs/{{ main_domain }}/key.pem

locales/en.json

@@ -263,6 +263,7 @@
     "global_settings_cant_write_settings": "Could not save settings file, reason: {reason:s}",
     "global_settings_key_doesnt_exists": "The key '{settings_key:s}' does not exist in the global settings, you can see all the available keys by running 'yunohost settings list'",
     "global_settings_reset_success": "Previous settings now backed up to {path:s}",
+    "global_settings_setting_pop3_enabled": "Enable the POP3 protocol for the mail server",
     "global_settings_setting_example_bool": "Example boolean option",
     "global_settings_setting_example_enum": "Example enum option",
     "global_settings_setting_example_int": "Example int option",

src/yunohost/settings.py

@@ -1,5 +1,6 @@
 import os
 import json
+import subprocess
 
 from datetime import datetime
 from collections import OrderedDict
@@ -46,6 +47,7 @@ DEFAULTS = OrderedDict([
         "choices": ["intermediate", "modern"]}),
     ("security.postfix.compatibility", {"type": "enum", "default": "intermediate",
         "choices": ["intermediate", "modern"]}),
+    ("pop3.enabled", {"type": "bool", "default": False}),
 ])
 
 
@@ -299,3 +301,29 @@ def reconfigure_ssh(setting_name, old_value, new_value):
 def reconfigure_ssh(setting_name, old_value, new_value):
     if old_value != new_value:
         service_regen_conf(names=['postfix'])
+
+@post_change_hook("pop3.enabled")
+def reconfigure_dovecot(setting_name, old_value, new_value):
+    dovecot_package = 'dovecot-pop3d'
+
+    environment = os.environ.copy()
+    environment.update({'DEBIAN_FRONTEND': 'noninteractive'})
+
+    if new_value == "True":
+        command = [
+            'apt-get',
+            '-y',
+            '--no-remove',
+            '-o Dpkg::Options::=--force-confdef',
+            '-o Dpkg::Options::=--force-confold',
+            'install',
+            dovecot_package,
+        ]
+        subprocess.call(command, env=environment)
+        if old_value != new_value:
+            service_regen_conf(names=['dovecot'])
+    else:
+        if old_value != new_value:
+            service_regen_conf(names=['dovecot'])
+        command = ['apt-get', '-y', 'remove', dovecot_package]
+        subprocess.call(command, env=environment)