Просмотр исходного кода

Merge branch 'testing' into 5.7

ericgaspar 4 лет назад
Родитель
Сommit
d8e03bdd7c
19 измененных файлов с 178 добавлено и 550 удалено
  1. 0 3
      .gitignore
  2. 2 1
      README_fr.md
  3. 0 117
      YEP.md
  4. 0 45
      actions.toml
  5. 5 5
      conf/nginx.conf
  6. 0 69
      config_panel.toml
  7. BIN
      doc/.DS_Store
  8. 0 0
      doc/.gitkeep
  9. 1 0
      doc/DESCRIPTION.md
  10. 0 0
      doc/screenshots/.gitkeep
  11. 1 1
      manifest.json
  12. 5 1
      scripts/_common.sh
  13. 6 9
      scripts/backup
  14. 22 24
      scripts/change_url
  15. 0 170
      scripts/config
  16. 21 18
      scripts/install
  17. 14 16
      scripts/remove
  18. 17 21
      scripts/restore
  19. 84 50
      scripts/upgrade

+ 0 - 3
.gitignore

@@ -1,3 +0,0 @@
-*.swp
-*~
-Notes

+ 2 - 1
README_fr.md

@@ -11,7 +11,8 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
 
 
 ## Vue d'ensemble
 ## Vue d'ensemble
 
 
-Filtrage publicitaire via votre propre serveur DNS
+Network-wide ad blocking via your own DNS server
+
 
 
 **Version incluse :** 5.9~ynh1
 **Version incluse :** 5.9~ynh1
 
 

+ 0 - 117
YEP.md

@@ -1,117 +0,0 @@
-#### [Level 0](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-0)  
-[YEP 1.1 - Nommer son app et son dépot](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-11)  
-`Validated`  
-[YEP 1.2 - Inscrire l'app sur un "répertoire" connu](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-12)  
-`Validated`  
-
-#### [Level 1](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-1)  
-[YEP 2.2 - Utiliser bash pour les scripts principaux](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-22)  
-`Validated`  
-[YEP 2.5 - Copier correctement des fichiers](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-25)  
-`Don't know`  
-[YEP 2.7 - Donner des permissions suffisantes aux instructions bash](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-27)  
-`Validated`  
-[YEP 2.15 - Suivre les instructions d'installation de l'application](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-215)  
-`Validated`  
-
-#### [Level 2](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-2)  
-[YEP 1.5 - Mettre à jour régulièrement le statut de l'app](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-11)  
-`Validated`  
-[YEP 2.18.2 - Gérer l'installation à la racine d’un nom de domaine](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-2182)  
-`Validated` - *Automatically verified.*  
-[YEP 2.18.3 - Gérer l'installation sur un sous-domaine](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-2183)  
-`Validated` - *Automatically verified.*  
-[YEP 2.18.4 - Gérer l'installation sur un chemin /path](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-2184)  
-`Validated` - *Automatically verified.*  
-[YEP 4.6 - Gère le multi-instance](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-11)  
-`Not applicable` - *Automatically verified.*  
-
-#### [Level 3](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-3)  
-[YEP 2.3 - Sauvegarder les réponses lors de l'installation](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-23)  
-`Validated`  
-
-#### [Level 4](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-4)  
-[YEP 4.1 - Lier au ldap](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-41)  
-`Not applicable`  
-[YEP 4.2 - Lier l'authentification au sso](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-42)  
-`Not applicable`  
-
-#### [Level 5](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-5)  
-[YEP 1.3 - Indiquer la licence associée au paquet](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-13)  
-`Validated`  
-[YEP 2.1 - Respecter le format du manifeste](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-21)  
-`Validated` - *Automatically verified.*  
-[YEP 2.12 - Utiliser les commandes pratiques (helpers)](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-212)  
-`Validated`  
-[YEP 2.18.1 - Lancer le script d'installation d'une webapp correctement](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-2181)  
-`Not applicable`  
-
-#### [Level 6](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-6)  
-[YEP 1.4 - Informer sur l'intention de maintenir un paquet](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-14)  
-`Validated`  
-[YEP 1.6 - Se tenir informé sur l'évolution du packaging d'apps](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-16)  
-`Validated`  
-[YEP 1.7 - Ajouter l'app à l'organisation YunoHost-Apps](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-17)  
-`Validated` - *Automatically verified.*  
-[YEP 1.8 - Publier des demandes de test](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-18)  
-`Validated`  
-[YEP 1.9 - Documenter l'app](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-19)  
-`Validated`  
-[YEP 1.10 - Garder un historique de version propre](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-110)  
-`Don't know`  
-[YEP 2.9 - Enlever toutes traces de l'app lors de la suppression](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-29)  
-`Validated`  
-[YEP 3.3 - Faciliter le contrôle de l'intégrité des sources](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-33)  
-`Validated`  
-[YEP 3.5 - Suivre les recommendations de la documentation de l'app](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-35)  
-`Validated`  
-[YEP 3.6 - Mettre à jour les versions contenant des CVE](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-36)  
-`Validated`  
-[YEP 4.3 - Fournir un script de sauvegarde YunoHost fonctionnel](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-43)  
-`Validated` - *Automatically verified.*  
-[YEP 4.4 - Fournir un script de restauration YunoHost fonctionnel](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-44)  
-`Validated` - *Automatically verified.*  
-
-#### [Level 7](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-7)  
-[YEP 2.6 - Annuler l'action si les valeurs d'entrées sont incorrectes](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-26)  
-`Validated`  
-[YEP 3.2 - Ouvrir un port correctement](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-32)  
-`Validated`  
-
-#### [Level 8](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-8)  
-[YEP 2.4 - Détecter et gérer les erreurs](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-24)  
-`Validated`  
-[YEP 2.8 - Modifier correctement une configuration système](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-28)  
-`Validated`  
-[YEP 2.16 - Vérifier la disponibilité des dépendances sur ARM, x86 et x64](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-216)  
-`Not yet validated` - *Automatically verified.*  
-[YEP 2.18.5 - Gérer la tuile YunoHost pour faciliter la navigation entre les applications](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-2185)  
-`Validated`  
-[YEP 3.4 - Isoler l'app](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-34)  
-`Partially validated`  
-[YEP 4.5 - Utiliser les hooks](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-45)  
-`Validated`  
-
-#### [Level 9](https://github.com/YunoHost/doc/blob/master/packaging_apps_levels_fr.md#niveau-9)  
-[YEP 2.10 - Configurer les logs de l'application](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-210)  
-`Validated`  
-[YEP 2.11 - Utiliser une variable plutôt que l'app id directement](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-211)  
-`Validated`  
-[YEP 2.13 - Traduire le paquet en anglais](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-213)  
-`Partially validated`  
-[YEP 2.14 - Remplir correctement un fichier de conf](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-214)  
-`Not yet validated`  
-[YEP 2.17 - Prendre en compte la version d'origine lors des mises à jour](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-217)  
-`Validated`  
-[YEP 4.2.1 - Déconnexion](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-421)  
-`Not applicable`  
-
-#### Other YEP  
-[YEP 3.1 - Ne pas demander ou stocker de mot de passe LDAP](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-31)  
-`Validated`  
-[YEP 4.7 - Ajouter un module à la CLI](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-47)  
-`Not applicable`  
-[YEP 4.8 - Ajouter un module à l'admin web](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines_fr.md#yep-48)  
-`Not applicable`  
-
-State of each YEP can be one of these: `Validated`, `Partially validated`, `Not yet validated`, `Not applicable`, `Don't know`.

+ 0 - 45
actions.toml

@@ -1,45 +0,0 @@
-[reset_default_setupvars]
-name = "Reset the config file and restore a default one."
-command = "/bin/bash scripts/actions/reset_default_config \"setupVars.conf\""
-# user = "root"  # optional
-# cwd = "/" # optional
-# accepted_return_codes = [0, 1, 2, 3]  # optional
-accepted_return_codes = [0]
-description = "Reset the config file setupVars.conf."
-
-[reset_default_ftl]
-name = "Reset the config file and restore a default one."
-command = "/bin/bash scripts/actions/reset_default_config \"pihole-FTL.conf\""
-# user = "root"  # optional
-# cwd = "/" # optional
-# accepted_return_codes = [0, 1, 2, 3]  # optional
-accepted_return_codes = [0]
-description = "Reset the config file pihole-FTL.conf."
-
-[reset_default_nginx]
-name = "Reset the nginx config for this app."
-command = "/bin/bash scripts/actions/reset_default_system nginx"
-# user = "root"  # optional
-# cwd = "/" # optional
-# accepted_return_codes = [0, 1, 2, 3]  # optional
-accepted_return_codes = [0]
-description = "Reset the nginx config for this app."
-
-[reset_default_phpfpm]
-name = "Reset the php-fpm config for this app."
-command = "/bin/bash scripts/actions/reset_default_system phpfpm"
-# user = "root"  # optional
-# cwd = "/" # optional
-# accepted_return_codes = [0, 1, 2, 3]  # optional
-accepted_return_codes = [0]
-description = "Reset the php-fpm config for this app."
-
-
-[reset_default_app]
-name = "Reset the app with a default configuration."
-command = "/bin/bash scripts/actions/reset_default_app"
-# user = "root"  # optional
-# cwd = "/" # optional
-# accepted_return_codes = [0, 1, 2, 3]  # optional
-accepted_return_codes = [0]
-description = "Reset the app to its default configuration to try to fix potential issues.<br>This action won't remove any data added to the app.<br>However, if you have modified any configuration, it will be overwritten."

+ 5 - 5
conf/nginx.conf

@@ -1,10 +1,10 @@
 #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 location __PATH__/ {
 location __PATH__/ {
 
 
-    # Path to source
-    alias __FINALPATH__/;
+  # Path to source
+  alias __FINALPATH__/;
 
 
-    index index.html index.php ;
+  index index.html index.php;
 
 
     try_files $uri $uri/ index.php;
     try_files $uri $uri/ index.php;
     location ~ [^/]\.php(/|$) {
     location ~ [^/]\.php(/|$) {
@@ -17,6 +17,6 @@ location __PATH__/ {
         fastcgi_param SCRIPT_FILENAME $request_filename;
         fastcgi_param SCRIPT_FILENAME $request_filename;
     }
     }
 
 
-    # Include SSOWAT user panel.
-    include conf.d/yunohost_panel.conf.inc;
+  # Include SSOWAT user panel.
+  include conf.d/yunohost_panel.conf.inc;
 }
 }

+ 0 - 69
config_panel.toml

@@ -1,69 +0,0 @@
-version = "1.0"
-
-[main]
-name = "PiHole configuration"
-
-    [main.overwrite_files]
-    name = "Overwriting config files"
-
-        [main.overwrite_files.overwrite_setupvars]
-        ask = "Overwrite the config file setupVars.conf?"
-        type = "boolean"
-        default = true
-        help = "If the file is overwritten, a backup will be created."
-
-        [main.overwrite_files.overwrite_ftl]
-        ask = "Overwrite the config file pihole-FTL.conf?"
-        type = "boolean"
-        default = true
-        help = "If the file is overwritten, a backup will be created."
-
-        [main.overwrite_files.overwrite_nginx]
-        ask = "Overwrite the nginx config file?"
-        type = "boolean"
-        default = true
-        help = "If the file is overwritten, a backup will be created."
-
-        [main.overwrite_files.overwrite_phpfpm]
-        ask = "Overwrite the PHP-FPM config file?"
-        type = "boolean"
-        default = true
-        help = "If the file is overwritten, a backup will be created."
-
-
-    [main.global_config]
-    name = "Global configuration"
-
-        [main.global_config.email_type]
-        ask = "Send HTML email to admin?"
-        type = "boolean"
-        default = true
-        help = "Allow app scripts to send HTML mails instead of plain text."
-
-
-    [main.php_fpm_config]
-    name = "PHP-FPM configuration"
-
-        [main.php_fpm_config.footprint]
-        ask = "Memory footprint of the service?"
-        choices = ["low", "medium", "high", "specific"]
-        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]
-        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.usage]
-        ask = "Expected usage of the service?"
-        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."
-
-        [main.php_fpm_config.force_max_children]
-        ask = "Force the value of pm.max_children?"
-        type = "number"
-        default = "0"
-        help = "Do not change this value unless you're sure about what you're doing!<br>pm.max_children is automatically defined by this formula: $max_ram / 2 / $footprint<br>You can force that value, and ignore the formula by changing the value here.<br>To reset to the default value, set to 0."


+ 0 - 0
doc/.gitkeep


+ 1 - 0
doc/DESCRIPTION.md

@@ -0,0 +1 @@
+Network-wide ad blocking via your own DNS server

+ 0 - 0
doc/screenshots/.gitkeep


+ 1 - 1
manifest.json

@@ -32,7 +32,7 @@
         "php7.3-fpm"
         "php7.3-fpm"
     ],
     ],
     "arguments": {
     "arguments": {
-        "install" : [
+        "install": [
             {
             {
                 "name": "domain",
                 "name": "domain",
                 "type": "domain"
                 "type": "domain"

+ 5 - 1
scripts/_common.sh

@@ -377,4 +377,8 @@ ynh_app_changelog () {
     then
     then
         echo "No significative changes from the changelog..." > "${final_changelog}_lite"
         echo "No significative changes from the changelog..." > "${final_changelog}_lite"
     fi
     fi
-}
+}
+
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================

+ 6 - 9
scripts/backup

@@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 # IMPORT GENERIC HELPERS
 #=================================================
 #=================================================
 
 
+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 source /usr/share/yunohost/helpers
 
 
@@ -36,7 +37,7 @@ fpm_config_dir=$(ynh_app_setting_get --app=$app --key=fpm_config_dir)
 ynh_print_info --message="Declaring files to be backed up..."
 ynh_print_info --message="Declaring files to be backed up..."
 
 
 #=================================================
 #=================================================
-# BACKUP THE MAIN APP DIRECTORIES
+# BACKUP THE APP MAIN DIRECTORIES
 #=================================================
 #=================================================
 
 
 ynh_backup --src_path="$final_path"
 ynh_backup --src_path="$final_path"
@@ -45,13 +46,13 @@ ynh_backup --src_path="/etc/pihole"
 ynh_backup --src_path="/opt/pihole"
 ynh_backup --src_path="/opt/pihole"
 
 
 #=================================================
 #=================================================
-# BACKUP NGINX CONFIGURATION
+# BACKUP THE NGINX CONFIGURATION
 #=================================================
 #=================================================
 
 
 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 
 #=================================================
 #=================================================
-# BACKUP PHP-FPM CONFIGURATION
+# BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
 #=================================================
 
 
 ynh_backup --src_path="$fpm_config_dir/php-fpm-$app.conf"
 ynh_backup --src_path="$fpm_config_dir/php-fpm-$app.conf"
@@ -60,15 +61,11 @@ ynh_backup --src_path="$fpm_config_dir/pool.d/$app.conf"
 #=================================================
 #=================================================
 # SPECIFIC BACKUP
 # SPECIFIC BACKUP
 #=================================================
 #=================================================
-# BACKUP CRON FILE
+# BACKUP VARIOUS FILES
 #=================================================
 #=================================================
 
 
 ynh_backup --src_path="/etc/cron.d/pihole"
 ynh_backup --src_path="/etc/cron.d/pihole"
 
 
-#=================================================
-# BACKUP SPECIFIC FILES
-#=================================================
-
 ynh_backup --src_path="/usr/local/bin/pihole"
 ynh_backup --src_path="/usr/local/bin/pihole"
 ynh_backup --src_path="/etc/bash_completion.d/pihole"
 ynh_backup --src_path="/etc/bash_completion.d/pihole"
 
 
@@ -78,7 +75,7 @@ ynh_backup --src_path="/etc/init.d/pihole-FTL"
 ynh_backup --src_path="/usr/bin/pihole-FTL"
 ynh_backup --src_path="/usr/bin/pihole-FTL"
 
 
 if test -e "/etc/dnsmasq.d/03-pihole-wildcard.conf"; then
 if test -e "/etc/dnsmasq.d/03-pihole-wildcard.conf"; then
-    ynh_backup --src_path="/etc/dnsmasq.d/03-pihole-wildcard.conf"
+	ynh_backup --src_path="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 fi
 fi
 
 
 ynh_backup --src_path="/usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app"
 ynh_backup --src_path="/usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app"

+ 22 - 24
scripts/change_url

@@ -26,21 +26,22 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 #=================================================
 ynh_script_progression --message="Loading installation settings..." --weight=2
 ynh_script_progression --message="Loading installation settings..." --weight=2
 
 
+# Needed for helper "ynh_add_nginx_config"
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
 
 #=================================================
 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
 #=================================================
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=11
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=11
 
 
 # Backup the current version of the app
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_backup_before_upgrade
 ynh_clean_setup () {
 ynh_clean_setup () {
-    # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
-    ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+	# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
+	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 
 
-    # restore it if the upgrade fails
-    ynh_restore_upgradebackup
+	# Restore it if the upgrade fails
+	ynh_restore_upgradebackup
 }
 }
 # Exit if an error occurs during the execution of the script
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 ynh_abort_if_errors
@@ -61,13 +62,13 @@ ynh_maintenance_mode_ON
 change_domain=0
 change_domain=0
 if [ "$old_domain" != "$new_domain" ]
 if [ "$old_domain" != "$new_domain" ]
 then
 then
-    change_domain=1
+	change_domain=1
 fi
 fi
 
 
 change_path=0
 change_path=0
 if [ "$old_path" != "$new_path" ]
 if [ "$old_path" != "$new_path" ]
 then
 then
-    change_path=1
+	change_path=1
 fi
 fi
 
 
 #=================================================
 #=================================================
@@ -79,29 +80,26 @@ ynh_script_progression --message="Updating NGINX web server configuration..." --
 
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
 
-# Change the path in the nginx config file
+# Change the path in the NGINX config file
 if [ $change_path -eq 1 ]
 if [ $change_path -eq 1 ]
 then
 then
-    # Make a backup of the original nginx config file if modified
-    ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
-
-    # Set global variables for nginx helper
-    domain="$old_domain"
-    path_url="$new_path"
-
-    # Create a dedicated nginx config
-    ynh_add_nginx_config
+	# Make a backup of the original NGINX config file if modified
+	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
+	# Set global variables for NGINX helper
+	domain="$old_domain"
+	path_url="$new_path"
+	# Create a dedicated NGINX config
+	ynh_add_nginx_config
 fi
 fi
 
 
-# Change the domain for nginx
+# Change the domain for NGINX
 if [ $change_domain -eq 1 ]
 if [ $change_domain -eq 1 ]
 then
 then
-    # Delete file checksum for the old conf file location
-    ynh_delete_file_checksum --file="$nginx_conf_path"
-    mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
-
-    # Store file checksum for the new config file location
-    ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+	# Delete file checksum for the old conf file location
+	ynh_delete_file_checksum --file="$nginx_conf_path"
+	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+	# Store file checksum for the new config file location
+	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 fi
 
 
 #=================================================
 #=================================================

+ 0 - 170
scripts/config

@@ -1,170 +0,0 @@
-#!/bin/bash
-
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
-source _common.sh
-source /usr/share/yunohost/helpers
-
-ynh_abort_if_errors
-
-#=================================================
-# RETRIEVE ARGUMENTS
-#=================================================
-
-app=$YNH_APP_INSTANCE_NAME
-
-fpm_config_dir=$(ynh_app_setting_get --app=$app --key=fpm_config_dir)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
-#=================================================
-# SPECIFIC CODE
-#=================================================
-# LOAD VALUES
-#=================================================
-
-# Load the real value from the app config or elsewhere.
-# Then get the value from the form.
-# If the form has a value for a variable, take the value from the form,
-# Otherwise, keep the value from the app config.
-
-# Overwrite setupVars.conf file
-old_overwrite_setupvars="$(ynh_app_setting_get --app=$app --key=overwrite_setupvars)"
-overwrite_setupvars="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_SETUPVARS:-$old_overwrite_setupvars}"
-
-# Overwrite pihole-FTL.conf file
-old_overwrite_ftl="$(ynh_app_setting_get --app=$app --key=overwrite_ftl)"
-overwrite_ftl="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_FTL:-$old_overwrite_ftl}"
-
-# Overwrite nginx configuration
-old_overwrite_nginx="$(ynh_app_setting_get --app=$app --key=overwrite_nginx)"
-overwrite_nginx="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_NGINX:-$old_overwrite_nginx}"
-
-# Overwrite php-fpm configuration
-old_overwrite_phpfpm="$(ynh_app_setting_get --app=$app --key=overwrite_phpfpm)"
-overwrite_phpfpm="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_PHPFPM:-$old_overwrite_phpfpm}"
-
-
-# Type of admin mail configuration
-old_admin_mail_html="$(ynh_app_setting_get --app=$app --key=admin_mail_html)"
-admin_mail_html="${YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE:-$old_admin_mail_html}"
-
-
-# Footprint for php-fpm
-old_fpm_footprint="$(ynh_app_setting_get --app=$app --key=fpm_footprint)"
-fpm_footprint="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FOOTPRINT:-$old_fpm_footprint}"
-
-# Free footprint value for php-fpm
-# Check if fpm_footprint is an integer
-if [ "$fpm_footprint" -eq "$fpm_footprint" ] 2> /dev/null
-then
-    # If fpm_footprint is an integer, that's a numeric value for the footprint
-    old_free_footprint=$fpm_footprint
-    fpm_footprint=specific
-else
-    old_free_footprint=0
-fi
-free_footprint="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FREE_FOOTPRINT:-$old_free_footprint}"
-
-# Usage for php-fpm
-old_fpm_usage="$(ynh_app_setting_get --app=$app --key=fpm_usage)"
-fpm_usage="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_USAGE:-$old_fpm_usage}"
-
-# php_forced_max_children for php-fpm
-old_php_forced_max_children="$(ynh_app_setting_get --app=$app --key=php_forced_max_children)"
-# If php_forced_max_children isn't into settings.yml, get the current value from the fpm config
-if [ -z "$old_php_forced_max_children" ]; then
-    old_php_forced_max_children="$(grep "^pm.max_children" "$fpm_config_dir/pool.d/$app.conf" | awk '{print $3}')"
-fi
-php_forced_max_children="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FORCE_MAX_CHILDREN:-$old_php_forced_max_children}"
-
-#=================================================
-# SHOW_CONFIG FUNCTION FOR 'SHOW' COMMAND
-#=================================================
-
-show_config() {
-    # here you are supposed to read some config file/database/other then print the values
-    # ynh_return "YNH_CONFIG_${PANEL_ID}_${SECTION_ID}_${OPTION_ID}=value"
-
-    ynh_return "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_SETUPVARS=$overwrite_setupvars"
-    ynh_return "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_FTL=$overwrite_ftl"
-    ynh_return "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_NGINX=$overwrite_nginx"
-    ynh_return "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_PHPFPM=$overwrite_phpfpm"
-
-    ynh_return "YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE=$admin_mail_html"
-
-    ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FOOTPRINT=$fpm_footprint"
-    ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FREE_FOOTPRINT=$free_footprint"
-    ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_USAGE=$fpm_usage"
-    ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FORCE_MAX_CHILDREN=$php_forced_max_children"
-}
-
-#=================================================
-# MODIFY THE CONFIGURATION
-#=================================================
-
-apply_config() {
-
-    #=================================================
-    # MODIFY OVERWRITTING SETTINGS
-    #=================================================
-
-    # Set overwrite_setupvars
-    ynh_app_setting_set --app=$app --key=overwrite_setupvars --value="$overwrite_setupvars"
-    # Set overwrite_ftl
-    ynh_app_setting_set --app=$app --key=overwrite_ftl --value="$overwrite_ftl"
-    # Set overwrite_nginx
-    ynh_app_setting_set --app=$app --key=overwrite_nginx --value="$overwrite_nginx"
-    # Set overwrite_phpfpm
-    ynh_app_setting_set --app=$app --key=overwrite_phpfpm --value="$overwrite_phpfpm"
-
-    #=================================================
-    # MODIFY EMAIL SETTING
-    #=================================================
-
-    # Set admin_mail_html
-    ynh_app_setting_set --app=$app --key=admin_mail_html --value="$admin_mail_html"
-
-    #=================================================
-    # RECONFIGURE PHP-FPM
-    #=================================================
-
-    if [ "$fpm_usage" != "$old_fpm_usage" ] || \
-        [ "$fpm_footprint" != "$old_fpm_footprint" ] || \
-        [ "$free_footprint" != "$old_free_footprint" ] || \
-        [ "$php_forced_max_children" != "$old_php_forced_max_children" ]
-    then
-        # If fpm_footprint is set to 'specific', use $free_footprint value.
-        if [ "$fpm_footprint" = "specific" ]
-        then
-            fpm_footprint=$free_footprint
-        fi
-
-        if [ "$php_forced_max_children" != "$old_php_forced_max_children" ]
-        then
-            # Set php_forced_max_children
-            if [ $php_forced_max_children -ne 0 ]
-            then
-                ynh_app_setting_set --app=$app --key=php_forced_max_children --value="$php_forced_max_children"
-            else
-                # If the value is set to 0, remove the setting
-                ynh_app_setting_delete --app=$app --key=php_forced_max_children
-            fi
-        fi
-
-        if [ "$fpm_footprint" != "0" ]
-        then
-            ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --dedicated_service
-        else
-            ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below."
-        fi
-    fi
-}
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-ynh_app_config_run $1

+ 21 - 18
scripts/install

@@ -1,7 +1,7 @@
 #!/bin/bash
 #!/bin/bash
 
 
 #=================================================
 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 #=================================================
 # IMPORT GENERIC HELPERS
 # IMPORT GENERIC HELPERS
 #=================================================
 #=================================================
@@ -11,7 +11,7 @@ source _common.sh
 source /usr/share/yunohost/helpers
 source /usr/share/yunohost/helpers
 
 
 #=================================================
 #=================================================
-# MANAGE FAILURE OF THE SCRIPT
+# MANAGE SCRIPT FAILURE
 #=================================================
 #=================================================
 
 
 # Exit if an error occurs during the execution of the script
 # Exit if an error occurs during the execution of the script
@@ -30,7 +30,7 @@ enable_dhcp=$YNH_APP_ARG_ENABLE_DHCP
 app=$YNH_APP_INSTANCE_NAME
 app=$YNH_APP_INSTANCE_NAME
 
 
 #=================================================
 #=================================================
-# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS
+# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
 #=================================================
 ynh_script_progression --message="Validating installation parameters..." --weight=2
 ynh_script_progression --message="Validating installation parameters..." --weight=2
 
 
@@ -64,11 +64,11 @@ ynh_app_setting_set --app=$app --key=admin_mail_html --value=1
 #=================================================
 #=================================================
 ynh_script_progression --message="Finding an available port..." --weight=12
 ynh_script_progression --message="Finding an available port..." --weight=12
 
 
-# Find a free port
+# Find an available port
 port=$(ynh_find_port --port=4711)
 port=$(ynh_find_port --port=4711)
 if [ $port -gt 4720 ]
 if [ $port -gt 4720 ]
 then
 then
-    ynh_die --message="The ports 4711 to 4720 are already in use. Pi-hole can't work on another port. Please try to free one of these ports."
+	ynh_die --message="The ports 4711 to 4720 are already in use. Pi-hole can't work on another port. Please try to free one of these ports."
 fi
 fi
 ynh_app_setting_set --app=$app --key=port --value=$port
 ynh_app_setting_set --app=$app --key=port --value=$port
 
 
@@ -88,8 +88,8 @@ ynh_install_app_dependencies $pkg_dependencies
 #=================================================
 #=================================================
 ynh_script_progression --message="Configuring system user..." --weight=2
 ynh_script_progression --message="Configuring system user..." --weight=2
 
 
-# Create a dedicated system user
-ynh_system_user_create --username=$app
+# Create a system user
+ynh_system_user_create --username=$app --home_dir=$final_path
 
 
 #=================================================
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -112,7 +112,7 @@ chown $app:www-data "$final_path"
 #=================================================
 #=================================================
 ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 ynh_add_nginx_config
 
 
 #=================================================
 #=================================================
@@ -120,7 +120,7 @@ ynh_add_nginx_config
 #=================================================
 #=================================================
 ynh_script_progression --message="Configuring PHP-FPM..." --weight=2
 ynh_script_progression --message="Configuring PHP-FPM..." --weight=2
 
 
-# Create a dedicated php-fpm config
+# Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low --dedicated_service
 ynh_add_fpm_config --usage=low --footprint=low --dedicated_service
 
 
 #=================================================
 #=================================================
@@ -167,6 +167,7 @@ chown $dnsmasq_user:root /var/log/{pihole,pihole-FTL}.log
 
 
 # This sudoers config allow pihole to execute /usr/local/bin/pihole as root without password. Nothing more.
 # This sudoers config allow pihole to execute /usr/local/bin/pihole as root without password. Nothing more.
 cp "$pihole_local_repo/advanced/Templates/pihole.sudo" /etc/sudoers.d/pihole
 cp "$pihole_local_repo/advanced/Templates/pihole.sudo" /etc/sudoers.d/pihole
+
 echo "$app ALL=NOPASSWD: /usr/local/bin/pihole" >> /etc/sudoers.d/pihole
 echo "$app ALL=NOPASSWD: /usr/local/bin/pihole" >> /etc/sudoers.d/pihole
 # echo "Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin" >> /etc/sudoers.d/pihole
 # echo "Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin" >> /etc/sudoers.d/pihole
 chmod 0440 /etc/sudoers.d/pihole
 chmod 0440 /etc/sudoers.d/pihole
@@ -176,6 +177,7 @@ chmod 0440 /etc/sudoers.d/pihole
 #=================================================
 #=================================================
 
 
 cp "$pihole_local_repo/advanced/Templates/logrotate" "$pihole_storage/logrotate"
 cp "$pihole_local_repo/advanced/Templates/logrotate" "$pihole_storage/logrotate"
+
 sed -i "/# su #/d;" "$pihole_storage/logrotate"
 sed -i "/# su #/d;" "$pihole_storage/logrotate"
 
 
 #=================================================
 #=================================================
@@ -195,6 +197,7 @@ ynh_setup_source --dest_dir="$FTL_temp_path" --source_id=FTL
     ynh_exec_warn_less make
     ynh_exec_warn_less make
     ynh_exec_warn_less make install 
     ynh_exec_warn_less make install 
 )
 )
+
 ynh_secure_remove --file="$FTL_temp_path"
 ynh_secure_remove --file="$FTL_temp_path"
 
 
 cp "../conf/dns-servers.conf" "$pihole_storage"
 cp "../conf/dns-servers.conf" "$pihole_storage"
@@ -245,9 +248,9 @@ echo "IPV6_ADDRESS=::1" >> $setupVars
 echo "PIHOLE_DNS_1=" >> $setupVars
 echo "PIHOLE_DNS_1=" >> $setupVars
 echo "PIHOLE_DNS_2=" >> $setupVars
 echo "PIHOLE_DNS_2=" >> $setupVars
 if [ $query_logging -eq 1 ]; then
 if [ $query_logging -eq 1 ]; then
-    query_logging=true
+	query_logging=true
 else
 else
-    query_logging=false
+	query_logging=false
 fi
 fi
 echo "QUERY_LOGGING=$query_logging" >> $setupVars
 echo "QUERY_LOGGING=$query_logging" >> $setupVars
 echo "INSTALL_WEB=true" >> $setupVars
 echo "INSTALL_WEB=true" >> $setupVars
@@ -266,12 +269,12 @@ localipv4=$(ip address | grep "${main_iface}\$" | awk '{print $2;}' | cut -d/ -f
 # List all YunoHost domains
 # List all YunoHost domains
 while read perdomain
 while read perdomain
 do
 do
-    # Comment domain resolution in /etc/hosts on 127.0.0.1, because they can interfere with the local network resolution.
-    ynh_replace_string --match_string="^127.0.0.1.*$perdomain" --replace_string="#Commented by pihole# &" --target_file=/etc/hosts
+	# Comment domain resolution in /etc/hosts on 127.0.0.1, because they can interfere with the local network resolution.
+	ynh_replace_string --match_string="^127.0.0.1.*$perdomain" --replace_string="#Commented by pihole# &" --target_file=/etc/hosts
 
 
-    # And add a resolution on the local IP instead
-    grep -q "^$localipv4.*$perdomain" /etc/hosts || \
-        echo "$localipv4	$perdomain #Added by pihole#" >> /etc/hosts
+	# And add a resolution on the local IP instead
+	grep -q "^$localipv4.*$perdomain" /etc/hosts || \
+		echo "$localipv4	$perdomain #Added by pihole#" >> /etc/hosts
 done <<< "$(yunohost domain list | grep "\." | sed 's/.*: \|.*- //')"
 done <<< "$(yunohost domain list | grep "\." | sed 's/.*: \|.*- //')"
 
 
 #=================================================
 #=================================================
@@ -354,12 +357,12 @@ admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)
 
 
 if [ $enable_dhcp -eq 1 ]
 if [ $enable_dhcp -eq 1 ]
 then
 then
-    dhcp_alert="You asked to use the internal DHCP server of dnsmasq with PiHole.
+	dhcp_alert="You asked to use the internal DHCP server of dnsmasq with PiHole.
 You should really read the __URL_TAG1__documentation about that__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md__URL_TAG3__
 You should really read the __URL_TAG1__documentation about that__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md__URL_TAG3__
 
 
 "
 "
 else
 else
-    dhcp_alert=""
+	dhcp_alert=""
 fi
 fi
 
 
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.

+ 14 - 16
scripts/remove

@@ -1,7 +1,7 @@
 #!/bin/bash
 #!/bin/bash
 
 
 #=================================================
 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 #=================================================
 # IMPORT GENERIC HELPERS
 # IMPORT GENERIC HELPERS
 #=================================================
 #=================================================
@@ -22,14 +22,14 @@ port=$(ynh_app_setting_get --app=$app --key=port)
 #=================================================
 #=================================================
 # STANDARD REMOVE
 # STANDARD REMOVE
 #=================================================
 #=================================================
-# REMOVE SERVICE FROM ADMIN PANEL
+# REMOVE SERVICE INTEGRATION IN YUNOHOST
 #=================================================
 #=================================================
 
 
 # Check if the service is declared in YunoHost
 # Check if the service is declared in YunoHost
 if ynh_exec_fully_quiet yunohost service status pihole-FTL
 if ynh_exec_fully_quiet yunohost service status pihole-FTL
 then
 then
-    ynh_script_progression --message="Removing pihole-FTL service..." --weight=2
-    yunohost service remove pihole-FTL
+	ynh_script_progression --message="Removing pihole-FTL service..." --weight=2
+	yunohost service remove pihole-FTL
 fi
 fi
 
 
 #=================================================
 #=================================================
@@ -89,7 +89,7 @@ ynh_secure_remove --file="/etc/.pihole"
 #=================================================
 #=================================================
 ynh_script_progression --message="Removing NGINX web server configuration..."
 ynh_script_progression --message="Removing NGINX web server configuration..."
 
 
-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config
 ynh_remove_nginx_config
 
 
 #=================================================
 #=================================================
@@ -97,7 +97,7 @@ ynh_remove_nginx_config
 #=================================================
 #=================================================
 ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2
 ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2
 
 
-# Remove the dedicated php-fpm config
+# Remove the dedicated PHP-FPM config
 ynh_remove_fpm_config
 ynh_remove_fpm_config
 
 
 #=================================================
 #=================================================
@@ -107,28 +107,25 @@ ynh_script_progression --message="Closing ports $port and 67..." --weight=13
 
 
 if yunohost firewall list | grep -q "\- $port$"
 if yunohost firewall list | grep -q "\- $port$"
 then
 then
-    ynh_print_info "Close port $port"
-    ynh_exec_quiet yunohost firewall disallow TCP $port
+	ynh_print_info "Close port $port"
+	ynh_exec_quiet yunohost firewall disallow TCP $port
 fi
 fi
 
 
 if yunohost firewall list | grep -q "\- 67$"
 if yunohost firewall list | grep -q "\- 67$"
 then
 then
-    ynh_print_info "Close port 67"
-    ynh_exec_quiet yunohost firewall disallow UDP 67
+	ynh_print_info "Close port 67"
+	ynh_exec_quiet yunohost firewall disallow UDP 67
 fi
 fi
 
 
 #=================================================
 #=================================================
 # SPECIFIC REMOVE
 # SPECIFIC REMOVE
 #=================================================
 #=================================================
-# REMOVE CRON FILE
+# REMOVE VARIOUS FILES
 #=================================================
 #=================================================
+ynh_script_progression --message="Removing various files..."
 
 
 ynh_secure_remove --file="/etc/cron.d/pihole"
 ynh_secure_remove --file="/etc/cron.d/pihole"
 
 
-#=================================================
-# REMOVE OTHER FILES
-#=================================================
-
 # Remove logs
 # Remove logs
 ynh_secure_remove --file="/var/log/pihole.log"
 ynh_secure_remove --file="/var/log/pihole.log"
 ynh_secure_remove --file="/var/log/pihole-FTL.log"
 ynh_secure_remove --file="/var/log/pihole-FTL.log"
@@ -176,7 +173,7 @@ ynh_script_progression --message="Restarting Dnsmasq..."
 ynh_systemd_action --action=restart --service_name=dnsmasq
 ynh_systemd_action --action=restart --service_name=dnsmasq
 
 
 #=================================================
 #=================================================
-# GENERIC FINALISATION
+# GENERIC FINALIZATION
 #=================================================
 #=================================================
 # REMOVE DEDICATED USER
 # REMOVE DEDICATED USER
 #=================================================
 #=================================================
@@ -184,6 +181,7 @@ ynh_script_progression --message="Removing the dedicated system user..." --weigh
 
 
 # Dirty hack to remove correctly the user
 # Dirty hack to remove correctly the user
 killall -u $app
 killall -u $app
+
 ynh_system_user_delete --username=$app
 ynh_system_user_delete --username=$app
 
 
 #=================================================
 #=================================================

+ 17 - 21
scripts/restore

@@ -58,6 +58,14 @@ ynh_maintenance_mode_ON
 
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 
+#=================================================
+# RECREATE THE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Recreating the dedicated system user..." --weight=2
+
+# Create the dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir=$final_path
+
 #=================================================
 #=================================================
 # RESTORE THE MAIN DIRECTORIES OF THE APP
 # RESTORE THE MAIN DIRECTORIES OF THE APP
 #=================================================
 #=================================================
@@ -71,18 +79,6 @@ ynh_restore_file --origin_path="/etc/pihole"
 
 
 ynh_restore_file --origin_path="/opt/pihole"
 ynh_restore_file --origin_path="/opt/pihole"
 
 
-#=================================================
-# RECREATE THE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=2
-
-# Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
-#=================================================
-# RESTORE USER RIGHTS
-#=================================================
-
 # Restore permissions on app files
 # Restore permissions on app files
 chown $app: -R "/etc/pihole"
 chown $app: -R "/etc/pihole"
 # /etc/pihole/logrotate have to belong to root, otherwise logrotate will failed silently...
 # /etc/pihole/logrotate have to belong to root, otherwise logrotate will failed silently...
@@ -186,7 +182,7 @@ systemctl daemon-reload
 ynh_script_progression --message="Restoring Dnsmasq config..."
 ynh_script_progression --message="Restoring Dnsmasq config..."
 
 
 test -e "${YNH_APP_BACKUP_DIR}/etc/dnsmasq.d/03-pihole-wildcard.conf" && \
 test -e "${YNH_APP_BACKUP_DIR}/etc/dnsmasq.d/03-pihole-wildcard.conf" && \
-    ynh_restore_file --origin_path="/etc/dnsmasq.d/03-pihole-wildcard.conf"
+	ynh_restore_file --origin_path="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 
 
 systemctl daemon-reload
 systemctl daemon-reload
 ynh_exec_warn_less yunohost tools regen-conf dnsmasq
 ynh_exec_warn_less yunohost tools regen-conf dnsmasq
@@ -204,12 +200,12 @@ localipv4=$(ip address | grep "${main_iface}\$" | awk '{print $2;}' | cut -d/ -f
 # List all YunoHost domains
 # List all YunoHost domains
 while read perdomain
 while read perdomain
 do
 do
-    # Comment domain resolution in /etc/hosts on 127.0.0.1, because they can interfere with the local network resolution.
-    ynh_replace_string --match_string="^127.0.0.1.*$perdomain" --replace_string="#Commented by pihole# &" --target_file=/etc/hosts
+	# Comment domain resolution in /etc/hosts on 127.0.0.1, because they can interfere with the local network resolution.
+	ynh_replace_string --match_string="^127.0.0.1.*$perdomain" --replace_string="#Commented by pihole# &" --target_file=/etc/hosts
 
 
-    # And add a resolution on the local IP instead
-    grep -q "^$localipv4.*$perdomain" /etc/hosts || \
-        echo "$localipv4	$perdomain #Added by pihole#" >> /etc/hosts
+	# And add a resolution on the local IP instead
+	grep -q "^$localipv4.*$perdomain" /etc/hosts || \
+		echo "$localipv4	$perdomain #Added by pihole#" >> /etc/hosts
 done <<< "$(yunohost domain list | grep "\." | sed 's/.*: \|.*- //')"
 done <<< "$(yunohost domain list | grep "\." | sed 's/.*: \|.*- //')"
 
 
 #=================================================
 #=================================================
@@ -234,7 +230,7 @@ ynh_exec_warn_less systemctl enable pihole-FTL --quiet
 ynh_systemd_action --action=restart --service_name=pihole-FTL
 ynh_systemd_action --action=restart --service_name=pihole-FTL
 
 
 #=================================================
 #=================================================
-# GENERIC FINALISATION
+# GENERIC FINALIZATION
 #=================================================
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 # RELOAD NGINX AND PHP-FPM
 #=================================================
 #=================================================
@@ -259,12 +255,12 @@ admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)
 
 
 if [ $enable_dhcp -eq 1 ]
 if [ $enable_dhcp -eq 1 ]
 then
 then
-    dhcp_alert="You asked to use the internal DHCP server of Dnsmasq with PiHole.
+	dhcp_alert="You asked to use the internal DHCP server of Dnsmasq with PiHole.
 You should really read the __URL_TAG1__documentation about that__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md__URL_TAG3__
 You should really read the __URL_TAG1__documentation about that__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md__URL_TAG3__
 
 
 "
 "
 else
 else
-    dhcp_alert=""
+	dhcp_alert=""
 fi
 fi
 
 
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.

+ 84 - 50
scripts/upgrade

@@ -1,7 +1,7 @@
 #!/bin/bash
 #!/bin/bash
 
 
 #=================================================
 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 #=================================================
 # IMPORT GENERIC HELPERS
 # IMPORT GENERIC HELPERS
 #=================================================
 #=================================================
@@ -30,16 +30,40 @@ overwrite_setupvars=$(ynh_app_setting_get --app=$app --key=overwrite_setupvars)
 overwrite_ftl=$(ynh_app_setting_get --app=$app --key=overwrite_ftl)
 overwrite_ftl=$(ynh_app_setting_get --app=$app --key=overwrite_ftl)
 overwrite_nginx=$(ynh_app_setting_get --app=$app --key=overwrite_nginx)
 overwrite_nginx=$(ynh_app_setting_get --app=$app --key=overwrite_nginx)
 overwrite_phpfpm=$(ynh_app_setting_get --app=$app --key=overwrite_phpfpm)
 overwrite_phpfpm=$(ynh_app_setting_get --app=$app --key=overwrite_phpfpm)
-
+admin_mail_html=$(ynh_app_setting_get --app=$app --key=admin_mail_html)
 fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
 fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
 fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
 fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
 
 
 #=================================================
 #=================================================
 # CHECK VERSION
 # CHECK VERSION
 #=================================================
 #=================================================
+ynh_script_progression --message="Checking version..."
 
 
 upgrade_type=$(ynh_check_app_version_changed)
 upgrade_type=$(ynh_check_app_version_changed)
 
 
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=7
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	# Restore it if the upgrade fails
+	ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# ACTIVATE MAINTENANCE MODE
+#=================================================
+ynh_script_progression --message="Activating maintenance mode..."
+
+ynh_maintenance_mode_ON
+
+#=================================================
+# STANDARD UPGRADE STEPS
 #=================================================
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
 #=================================================
@@ -47,50 +71,50 @@ ynh_script_progression --message="Ensuring downward compatibility..."
 
 
 # If overwrite_setupvars doesn't exist, create it
 # If overwrite_setupvars doesn't exist, create it
 if [ -z "$overwrite_setupvars" ]; then
 if [ -z "$overwrite_setupvars" ]; then
-    overwrite_setupvars=1
-    ynh_app_setting_set --app=$app --key=overwrite_setupvars --value=$overwrite_setupvars
+	overwrite_setupvars=1
+	ynh_app_setting_set --app=$app --key=overwrite_setupvars --value=$overwrite_setupvars
 fi
 fi
 
 
 # If overwrite_ftl doesn't exist, create it
 # If overwrite_ftl doesn't exist, create it
 if [ -z "$overwrite_ftl" ]; then
 if [ -z "$overwrite_ftl" ]; then
-    overwrite_ftl=1
-    ynh_app_setting_set --app=$app --key=overwrite_ftl --value=$overwrite_ftl
+	overwrite_ftl=1
+	ynh_app_setting_set --app=$app --key=overwrite_ftl --value=$overwrite_ftl
 fi
 fi
 
 
 # If overwrite_nginx doesn't exist, create it
 # If overwrite_nginx doesn't exist, create it
 if [ -z "$overwrite_nginx" ]; then
 if [ -z "$overwrite_nginx" ]; then
-    overwrite_nginx=1
-    ynh_app_setting_set --app=$app --key=overwrite_nginx --value=$overwrite_nginx
+	overwrite_nginx=1
+	ynh_app_setting_set --app=$app --key=overwrite_nginx --value=$overwrite_nginx
 fi
 fi
 
 
 # If overwrite_phpfpm doesn't exist, create it
 # If overwrite_phpfpm doesn't exist, create it
 if [ -z "$overwrite_phpfpm" ]; then
 if [ -z "$overwrite_phpfpm" ]; then
-    overwrite_phpfpm=1
-    ynh_app_setting_set --app=$app --key=overwrite_phpfpm --value=$overwrite_phpfpm
+	overwrite_phpfpm=1
+	ynh_app_setting_set --app=$app --key=overwrite_phpfpm --value=$overwrite_phpfpm
 fi
 fi
 
 
 # If admin_mail_html doesn't exist, create it
 # If admin_mail_html doesn't exist, create it
 if [ -z "$admin_mail_html" ]; then
 if [ -z "$admin_mail_html" ]; then
-    admin_mail_html=1
-    ynh_app_setting_set --app=$app --key=admin_mail_html --value=$admin_mail_html
+	admin_mail_html=1
+	ynh_app_setting_set --app=$app --key=admin_mail_html --value=$admin_mail_html
 fi
 fi
 
 
 # If fpm_footprint doesn't exist, create it
 # If fpm_footprint doesn't exist, create it
 if [ -z "$fpm_footprint" ]; then
 if [ -z "$fpm_footprint" ]; then
-    fpm_footprint=low
-    ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
+	fpm_footprint=low
+	ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
 fi
 fi
 
 
 # If fpm_usage doesn't exist, create it
 # If fpm_usage doesn't exist, create it
 if [ -z "$fpm_usage" ]; then
 if [ -z "$fpm_usage" ]; then
-    fpm_usage=low
-    ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
+	fpm_usage=low
+	ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
 fi
 fi
 
 
 # If pihole_version doesn't exist, create it
 # If pihole_version doesn't exist, create it
 if [ -z "$pihole_version" ]; then
 if [ -z "$pihole_version" ]; then
-    pihole_version="Last 3.X"
-    ynh_app_setting_set --app=$app --key=pihole_version --value="$pihole_version"
+	pihole_version="Last 3.X"
+	ynh_app_setting_set --app=$app --key=pihole_version --value="$pihole_version"
 fi
 fi
 
 
 #=================================================
 #=================================================
@@ -154,11 +178,18 @@ chown $app:www-data "$final_path"
 # Overwrite the nginx configuration only if it's allowed
 # Overwrite the nginx configuration only if it's allowed
 if [ $overwrite_nginx -eq 1 ]
 if [ $overwrite_nginx -eq 1 ]
 then
 then
-    ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
-    # Create a dedicated nginx config
-    ynh_add_nginx_config
+	ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
+	# Create a dedicated NGINX config
+	ynh_add_nginx_config
 fi
 fi
 
 
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Upgrading dependencies..." --weight=6
+
+ynh_install_app_dependencies $pkg_dependencies
+
 #=================================================
 #=================================================
 # PHP-FPM CONFIGURATION
 # PHP-FPM CONFIGURATION
 #=================================================
 #=================================================
@@ -166,9 +197,9 @@ fi
 # Overwrite the php-fpm configuration only if it's allowed
 # Overwrite the php-fpm configuration only if it's allowed
 if [ $overwrite_phpfpm -eq 1 ]
 if [ $overwrite_phpfpm -eq 1 ]
 then
 then
-    ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=3
-    # Create a dedicated php-fpm config
-    ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --dedicated_service
+	ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=3
+	# Create a dedicated php-fpm config
+	ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --dedicated_service
 fi
 fi
 
 
 #=================================================
 #=================================================
@@ -236,7 +267,7 @@ fi
 # Overwrite pihole-FTL config file only if it's allowed
 # Overwrite pihole-FTL config file only if it's allowed
 if [ $overwrite_ftl -eq 1 ]
 if [ $overwrite_ftl -eq 1 ]
 then
 then
-    ynh_add_config --template="../conf/pihole-FTL.conf" --destination="$pihole_storage/pihole-FTL.conf"
+	ynh_add_config --template="../conf/pihole-FTL.conf" --destination="$pihole_storage/pihole-FTL.conf"
 fi
 fi
 
 
 # Last version available
 # Last version available
@@ -284,26 +315,26 @@ setupVars="$pihole_storage/setupVars.conf"
 # Overwrite the setupVars config file only if it's allowed
 # Overwrite the setupVars config file only if it's allowed
 if [ $overwrite_setupvars -eq 1 ]
 if [ $overwrite_setupvars -eq 1 ]
 then
 then
-    # Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
-    ynh_backup_if_checksum_is_different --file="$setupVars"
-
-    # Get the default network interface
-    main_iface=$(ip route | grep --max-count=1 default | awk '{print $5;}')
-    echo "PIHOLE_INTERFACE=$main_iface" > $setupVars
-    echo "IPV4_ADDRESS=127.0.0.1" >> $setupVars
-    echo "IPV6_ADDRESS=::1" >> $setupVars
-    echo "PIHOLE_DNS_1=" >> $setupVars
-    echo "PIHOLE_DNS_2=" >> $setupVars
-    if [ $query_logging -eq 1 ]; then
-        query_logging=true
-    else
-        query_logging=false
-    fi
-    echo "QUERY_LOGGING=$query_logging" >> $setupVars
-    echo "INSTALL_WEB=true" >> $setupVars
-
-    # Recalculate and store the checksum of the file for the next upgrade.
-    ynh_store_file_checksum --file="$setupVars"
+	# Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
+	ynh_backup_if_checksum_is_different --file="$setupVars"
+
+	# Get the default network interface
+	main_iface=$(ip route | grep --max-count=1 default | awk '{print $5;}')
+	echo "PIHOLE_INTERFACE=$main_iface" > $setupVars
+	echo "IPV4_ADDRESS=127.0.0.1" >> $setupVars
+	echo "IPV6_ADDRESS=::1" >> $setupVars
+	echo "PIHOLE_DNS_1=" >> $setupVars
+	echo "PIHOLE_DNS_2=" >> $setupVars
+	if [ $query_logging -eq 1 ]; then
+		query_logging=true
+	else
+		query_logging=false
+	fi
+	echo "QUERY_LOGGING=$query_logging" >> $setupVars
+	echo "INSTALL_WEB=true" >> $setupVars
+
+	# Recalculate and store the checksum of the file for the next upgrade.
+	ynh_store_file_checksum --file="$setupVars"
 fi
 fi
 
 
 #=================================================
 #=================================================
@@ -318,18 +349,21 @@ echo "$pihole_core_version $dashboard_version $FTL_version" | tee $pihole_storag
 #=================================================
 #=================================================
 
 
 cp $pihole_local_repo/advanced/Templates/pihole.cron /etc/cron.d/pihole
 cp $pihole_local_repo/advanced/Templates/pihole.cron /etc/cron.d/pihole
+
 # Remove git usage for version. Which fails because we use here a release instead of master.
 # Remove git usage for version. Which fails because we use here a release instead of master.
 ynh_replace_string --match_string=".*updatechecker.*" --replace_string="#&" --target_file=/etc/cron.d/pihole
 ynh_replace_string --match_string=".*updatechecker.*" --replace_string="#&" --target_file=/etc/cron.d/pihole
 
 
 #=================================================
 #=================================================
-# ADVERTISE SERVICE IN ADMIN PANEL
+# INTEGRATE SERVICE IN YUNOHOST
 #=================================================
 #=================================================
+ynh_script_progression --message="Integrating service in YunoHost..."
 
 
 yunohost service add pihole-FTL --description="PiHole backend service" --log="/var/log/pihole-FTL.log"
 yunohost service add pihole-FTL --description="PiHole backend service" --log="/var/log/pihole-FTL.log"
 
 
 #=================================================
 #=================================================
 # UPDATE CONF_REGEN HOOK
 # UPDATE CONF_REGEN HOOK
 #=================================================
 #=================================================
+ynh_script_progression --message="Updating conf_regen hook..."
 
 
 cp ../conf/dnsmasq_regenconf_hook /usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app
 cp ../conf/dnsmasq_regenconf_hook /usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app
 ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="/usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app"
 ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="/usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app"
@@ -367,20 +401,20 @@ admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)
 
 
 # If a html email is required. Apply html to the changelog.
 # If a html email is required. Apply html to the changelog.
 if [ "$admin_mail_html" -eq 1 ]; then
 if [ "$admin_mail_html" -eq 1 ]; then
-    format=html
+	format=html
 else
 else
-    format=plain
+	format=plain
 fi
 fi
 ynh_app_changelog --format=$format
 ynh_app_changelog --format=$format
 
 
 if [ $enable_dhcp -eq 1 ]
 if [ $enable_dhcp -eq 1 ]
 then
 then
-    dhcp_alert="You asked to use the internal DHCP server of dnsmasq with PiHole.
+	dhcp_alert="You asked to use the internal DHCP server of dnsmasq with PiHole.
 You should really read the documentation about that, https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md
 You should really read the documentation about that, https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md
 
 
 "
 "
 else
 else
-    dhcp_alert=""
+	dhcp_alert=""
 fi
 fi
 
 
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
 echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.