Merge pull request #500 from YunoHost-Apps/config-panel-v1

Implement Config Panels v1.0 (PHP and maintenance mode)

config_panel.toml

@@ -3,23 +3,36 @@ version = "1.0"
 [main]
 name = "Nextcloud configuration"
 
+    [main.maintenance_mode]
+    name = "Maintenance mode"
+
+        [main.maintenance_mode.maintenance_mode]
+        ask = "Enable maintenance mode"
+        type = "boolean"
+        default = "0"
+
     [main.php_fpm_config]
     name = "PHP-FPM configuration"
 
         [main.php_fpm_config.fpm_footprint]
-        ask = "Memory footprint of the service?"
-        choices = ["low", "medium", "high", "specific"]
+        ask = "Memory footprint"
+        type = "select"
+        choices.low = "Low, <= 20Mb per pool"
+        choices.medium = "Medium, between 20Mb and 40Mb per pool"
+        choices.high = "High, > 40Mb per pool"
+        choices.specific = "Use specific value"
         default = "low"
-        help = "low <= 20Mb per pool. medium between 20Mb and 40Mb per pool. high > 40Mb per pool.<br>Use specific to set a value with the following option."
 
-        [main.php_fpm_config.free_footprint]
+        [main.php_fpm_config.fpm_free_footprint]
+        visible = "fpm_footprint == 'specific'"
         ask = "Memory footprint of the service?"
         type = "number"
         default = "0"
         help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values."
 
         [main.php_fpm_config.fpm_usage]
-        ask = "Expected usage of the service?"
+        ask = "Expected usage"
+        type = "select"
         choices = ["low", "medium", "high"]
         default = "low"
         help = "low: Personal usage, behind the SSO. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.<br>medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.<br>high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding."

scripts/config

@@ -22,6 +22,22 @@ current_fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
 # SPECIFIC GETTERS FOR TOML SHORT KEY
 #=================================================
 
+get__maintenance_mode() {
+    # Maintenance mode status
+    maintenance_mode_status="$(cd "$final_path" && ynh_exec_as "$app" \
+        php${phpversion} --define apc.enable_cli=1 occ --no-interaction --no-ansi maintenance:mode)" 2> /dev/null
+    if echo $maintenance_mode_status | grep -q "disabled"
+    then
+        echo "0"
+    elif echo $maintenance_mode_status | grep -q "enabled"
+    then
+        echo "1"
+    else
+        ynh_print_err --message="Unexpected output from maintenance status check command."
+        exit 0
+    fi
+}
+
 get__fpm_footprint() {
     # Free footprint value for php-fpm
     # Check if current_fpm_footprint is an integer
@@ -49,6 +65,21 @@ get__free_footprint() {
 # SPECIFIC SETTERS FOR TOML SHORT KEYS
 #=================================================
 
+set__maintenance_mode() {
+    if [ "$maintenance_mode" -eq "0" ]; then
+        # If maintenance_mode was set to 0, disable maintenance mode
+        (cd "$final_path" && ynh_exec_as "$app" \
+            php${phpversion} --define apc.enable_cli=1 occ --no-interaction --no-ansi maintenance:mode --off)
+        ynh_print_info "Maintenance mode disabled"
+    elif [ "$maintenance_mode" -eq "1" ]; then
+        # If maintenance_mode was set to 1, enable maintenance mode
+        (cd "$final_path" && ynh_exec_as "$app" \
+            php${phpversion} --define apc.enable_cli=1 occ --no-interaction --no-ansi maintenance:mode --on)
+        ynh_print_info "Maintenance mode enabled"
+    fi
+    ynh_app_setting_set --app=$app --key=maintenance_mode --value="$maintenance_mode"
+}
+
 set__fpm_footprint() {
     if [ "$fpm_footprint" != "specific" ]
     then
@@ -56,10 +87,10 @@ set__fpm_footprint() {
     fi
 }
 
-set__free_footprint() {
-    if [ "$fpm_footprint" == "specific" ]
+set__fpm_free_footprint() {
+    if [ "$fpm_footprint" = "specific" ]
     then
-        ynh_app_setting_set --app=$app --key=fpm_footprint --value="$free_footprint"
+        ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_free_footprint"
     fi
 }
 
@@ -70,11 +101,11 @@ set__free_footprint() {
 ynh_app_config_validate() {
     _ynh_app_config_validate
 
-    if [ "${changed[fpm_usage]}" == "true" ] || [ "${changed[fpm_footprint]}" == "true" ] || [ "${changed[free_footprint]}" == "true" ]; then
-        # If fpm_footprint is set to 'specific', use $free_footprint value.
-        if [ "$fpm_footprint" == "specific" ]
+    if [ "${changed[fpm_usage]}" == "true" ] || [ "${changed[fpm_footprint]}" == "true" ] || [ "${changed[fpm_free_footprint]}" == "true" ]; then
+        # If fpm_footprint is set to 'specific', use $fpm_free_footprint value.
+        if [ "$fpm_footprint" = "specific" ]
         then
-            fpm_footprint=$free_footprint
+            fpm_footprint=$fpm_free_footprint
         fi
 
         if [ "$fpm_footprint" == "0" ]

scripts/install

@@ -50,6 +50,9 @@ ynh_app_setting_set --app=$app --key=path --value=$path_url
 ynh_app_setting_set --app=$app --key=admin --value=$admin
 ynh_app_setting_set --app=$app --key=user_home --value=$user_home
 
+maintenance_mode=0
+ynh_app_setting_set --app=$app --key=maintenance_mode --value=$maintenance_mode
+
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
@@ -105,8 +108,18 @@ ynh_system_user_create --username=$app
 #=================================================
 ynh_script_progression --message="Configuring PHP-FPM..." --weight=50
 
+fpm_footprint="high"
+fpm_free_footprint=0
+fpm_usage="medium"
+
+ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
+ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint
+ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
+
 # Create a dedicated php-fpm config
-ynh_add_fpm_config --usage=medium --footprint=high
+ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --phpversion=$YNH_PHP_VERSION
+# Used by ynh_add_nginx_config
+phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # NGINX CONFIGURATION

scripts/upgrade

@@ -24,6 +24,7 @@ db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$db_name
 user_home=$(ynh_app_setting_get --app=$app --key=user_home)
 
+maintenance_mode=$(ynh_app_setting_get --app=$app --key=maintenance_mode)
 fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
 fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
 
@@ -59,12 +60,24 @@ fi
 # Remove the option backup_core_only if it's in the settings.yml file
 ynh_app_setting_delete --app=$app --key=backup_core_only
 
+# If maintenance_mode doesn't exist, create it
+if [ -z "$maintenance_mode" ]; then
+	maintenance_mode=0
+	ynh_app_setting_set --app=$app --key=maintenance_mode --value=$maintenance_mode
+fi
+
 # If fpm_footprint doesn't exist, create it
 if [ -z "$fpm_footprint" ]; then
 	fpm_footprint=high
 	ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
 fi
 
+# If fpm_free_footprint doesn't exist, create it
+if [ -z "$fpm_free_footprint" ]; then
+	fpm_free_footprint=0
+	ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint
+fi
+
 # If fpm_usage doesn't exist, create it
 if [ -z "$fpm_usage" ]; then
 	fpm_usage=medium