Merge pull request #791 from decentral1se/add-pop3-setting

Add pop3.enabled setting

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
+  export pop3_enabled="$(yunohost settings get 'pop3.enabled')"
-  main_domain=$(cat /etc/yunohost/current_host)
+  export main_domain=$(cat /etc/yunohost/current_host)
-  cat dovecot.conf \
+
-    | sed "s/{{ main_domain }}/${main_domain}/g" \
+  ynh_render_template "dovecot.conf" "${dovecot_dir}/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

@@ -270,6 +270,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/app.py

@@ -2762,11 +2762,7 @@ def is_true(arg):
     if isinstance(arg, bool):
         return arg
     elif isinstance(arg, basestring):
-        true_list = ['yes', 'Yes', 'true', 'True']
+        return arg.lower() in ['yes', 'true', 'on']
-        for string in true_list:
-            if arg == string:
-                return True
-        return False
     else:
         logger.debug('arg should be a boolean or a string, got %r', arg)
         return True if arg else False

src/yunohost/settings.py

@@ -1,5 +1,6 @@
 import os
 import json
+import subprocess
 
 from datetime import datetime
 from collections import OrderedDict
@@ -14,6 +15,25 @@ logger = getActionLogger('yunohost.settings')
 SETTINGS_PATH = "/etc/yunohost/settings.json"
 SETTINGS_PATH_OTHER_LOCATION = "/etc/yunohost/settings-%s.json"
 
+def is_boolean(value):
+    """
+    Ensure a string value is intended as a boolean
+
+    Keyword arguments:
+        arg -- The string to check
+
+    Returns:
+        Boolean
+
+    """
+    if isinstance(value, bool):
+        return True
+    elif isinstance(value, basestring):
+        return str(value).lower() in ['true', 'on', 'yes', 'false', 'off', 'no']
+    else:
+        return False
+
+
 # a settings entry is in the form of:
 # namespace.subnamespace.name: {type, value, default, description, [choices]}
 # choices is only for enum
@@ -27,7 +47,7 @@ SETTINGS_PATH_OTHER_LOCATION = "/etc/yunohost/settings-%s.json"
 # * bool
 # * int
 # * string
-# * enum (in form a python list)
+# * enum (in the form of a python list)
 
 DEFAULTS = OrderedDict([
     ("example.bool", {"type": "bool", "default": True}),
@@ -46,6 +66,7 @@ DEFAULTS = OrderedDict([
         "choices": ["intermediate", "modern"]}),
     ("security.postfix.compatibility", {"type": "enum", "default": "intermediate",
         "choices": ["intermediate", "modern"]}),
+    ("pop3.enabled", {"type": "bool", "default": False}),
 ])
 
 
@@ -93,7 +114,7 @@ def settings_set(key, value):
     key_type = settings[key]["type"]
 
     if key_type == "bool":
-        if not isinstance(value, bool):
+        if not is_boolean(value):
             raise YunohostError('global_settings_bad_type_for_setting', setting=key,
                                 received_type=type(value).__name__, expected_type=key_type)
     elif key_type == "int":
@@ -126,8 +147,6 @@ def settings_set(key, value):
     settings[key]["value"] = value
     _save_settings(settings)
 
-    # TODO : whatdo if the old value is the same as
-    # the new value...
     try:
         trigger_post_change_hook(key, old_value, value)
     except Exception as e:
@@ -296,6 +315,32 @@ def reconfigure_ssh(setting_name, old_value, new_value):
         service_regen_conf(names=['ssh'])
 
 @post_change_hook("security.postfix.compatibility")
-def reconfigure_ssh(setting_name, old_value, new_value):
+def reconfigure_postfix(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)

src/yunohost/tests/test_settings.py

@@ -62,6 +62,8 @@ def test_settings_set():
     settings_set("example.bool", False)
     assert settings_get("example.bool") == False
 
+    settings_set("example.bool", "on")
+    assert settings_get("example.bool") == True
 
 def test_settings_set_int():
     settings_set("example.int", 21)