From 92b105e43db05dc912e5a9877096abeb785577a7 Mon Sep 17 00:00:00 2001
From: Florent <florent.git@zeteo.me>
Date: Thu, 30 Dec 2021 14:12:37 +0100
Subject: [PATCH] Split config into several files

---
 conf/config.local.php          |  9 ++++++
 conf/config.local.release.php  | 51 ------------------------------
 conf/config.local.user.php     | 13 ++++++++
 conf/config.local.yunohost.php | 58 ++++++++++++++++++++++++++++++++++
 scripts/_common.sh             |  2 +-
 scripts/install                | 23 ++++++--------
 scripts/upgrade                | 19 +++++------
 7 files changed, 101 insertions(+), 74 deletions(-)
 create mode 100644 conf/config.local.php
 delete mode 100644 conf/config.local.release.php
 create mode 100644 conf/config.local.user.php
 create mode 100644 conf/config.local.yunohost.php

diff --git a/conf/config.local.php b/conf/config.local.php
new file mode 100644
index 0000000..82b5400
--- /dev/null
+++ b/conf/config.local.php
@@ -0,0 +1,9 @@
+<?php
+
+/**
+ * NE PAS MODIFIER CE FICHIER. Il est généré automatiquement à chaque mise à jour de Yunohost
+ *
+ * Modifiez plutôt le fichier config.local.user.php
+ */
+require '__FINALPATH__/config.local.yunohost.php';
+require '__FINALPATH__/config.local.user.php';
diff --git a/conf/config.local.release.php b/conf/config.local.release.php
deleted file mode 100644
index cd0cf1d..0000000
--- a/conf/config.local.release.php
+++ /dev/null
@@ -1,51 +0,0 @@
-<?php
-
-/**
- * Activer la possibilité de faire une mise à jour semi-automatisée
- * depuis fossil.kd2.org.
- *
- * Si mis à TRUE, alors un bouton sera accessible depuis le menu "Configuration"
- * pour faire une mise à jour en deux clics.
- *
- * Il est conseillé de désactiver cette fonctionnalité si vous ne voulez pas
- * permettre à un utilisateur de casser l'installation !
- *
- * Défaut : true, ajout pour l'environement Yunohost défaut : false
- *
- * @var bool
- */
-
-const ENABLE_UPGRADES = false;
-
-/**
- * Commande de création de PDF
- *
- * Commande qui sera exécutée pour créer un fichier PDF à partir d'un HTML.
- * Si laissé non spécifié (ou NULL), Garradin essaiera de détecter une solution entre
- * PrinceXML, Chromium, wkhtmltopdf ou weasyprint.
- *
- * %1$s sera remplacé par le chemin du fichier HTML, et %2$s par le chemin du fichier PDF.
- *
- * Exemple : chromium --headless --print-to-pdf=%2$s %1$s
- *
- * Défaut : null
- */
-//const PDF_COMMAND = 'wkhtmltopdf %2$s %1$s';
-
-/**
- * Clé de licence
- *
- * Cette clé permet de débloquer certaines fonctionnalités dans des extensions officielles.
- *
- * Pour l'obtenir il faut se créer un compte sur Garradin.eu
- * et faire une contribution financière.
- * La clé apparaîtra ensuite en dessous des informations
- * de l'association dans la page "Mon abonnement Garradin.eu".
- *
- * Il faut recopier cette clé dans le fichier config.local.php
- * dans la constante CONTRIBUTOR_LICENSE.
- *
- * Merci de ne pas essayer de contourner cette licence et de contribuer au
- * financement de notre travail :-)
- */
-//const CONTRIBUTOR_LICENSE = 'XXXXX';
\ No newline at end of file
diff --git a/conf/config.local.user.php b/conf/config.local.user.php
new file mode 100644
index 0000000..04b8d27
--- /dev/null
+++ b/conf/config.local.user.php
@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Ce fichier représente un exemple des constantes de configuration
+ * disponibles pour Garradin.
+ *
+ * Modifiez ce fichier à votre guise, il ne sera pas modifié lors des mises à jour.
+ * Consultez le fichier config.dist.php pour disposer d'un exemple.
+ *
+ */
+
+// Nécessaire pour situer les constantes dans le bon namespace
+namespace Garradin;
diff --git a/conf/config.local.yunohost.php b/conf/config.local.yunohost.php
new file mode 100644
index 0000000..f097426
--- /dev/null
+++ b/conf/config.local.yunohost.php
@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Ce fichier représente un exemple des constantes de configuration
+ * disponibles pour Garradin.
+ *
+ * NE PAS MODIFIER CE FICHIER!
+ *
+ * Ce fichier sera mis à jour à chaque nouvelle version de Yunohost
+ *
+ * Pour ajouter vos configurations personnalisées, rendez-vous dans le fichier config.local.user.php
+ *
+ */
+
+// Nécessaire pour situer les constantes dans le bon namespace
+namespace Garradin;
+
+/**
+ * Clé secrète, doit être unique à chaque instance de Garradin
+ *
+ * Ceci est utilisé afin de sécuriser l'envoi de formulaires
+ * (protection anti-CSRF).
+ *
+ * Cette valeur peut être modifiée sans autre impact que la déconnexion des utilisateurs
+ * actuellement connectés.
+ *
+ * Si cette constante n'est définie, Garradin ajoutera automatiquement
+ * une valeur aléatoire dans le fichier config.local.php.
+ */
+
+const SECRET_KEY = '__SECRET_KEY__';
+
+/**
+ * Adresse URI de la racine du site Garradin
+ * (doit se terminer par un slash)
+ *
+ * Défaut : découverte automatique à partir de SCRIPT_NAME
+ */
+
+const WWW_URI = '__PATH__/';
+
+/**
+ * Activer la possibilité de faire une mise à jour semi-automatisée
+ * depuis fossil.kd2.org.
+ *
+ * Si mis à TRUE, alors un bouton sera accessible depuis le menu "Configuration"
+ * pour faire une mise à jour en deux clics.
+ *
+ * Il est conseillé de désactiver cette fonctionnalité si vous ne voulez pas
+ * permettre à un utilisateur de casser l'installation !
+ *
+ * Défaut : true, ajout pour l'environement Yunohost défaut : false
+ *
+ * @var bool
+ */
+
+const ENABLE_UPGRADES = false;
+
diff --git a/scripts/_common.sh b/scripts/_common.sh
index c350c4f..b126a6d 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -8,7 +8,7 @@
 
 YNH_PHP_VERSION="7.4"
 
-extra_php_dependencies="php${YNH_PHP_VERSION}-sqlite3 php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-imagick php${YNH_PHP_VERSION}-intl  php${YNH_PHP_VERSION}-cli"
+extra_php_dependencies="php${YNH_PHP_VERSION} php${YNH_PHP_VERSION}-sqlite3 php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-imagick php${YNH_PHP_VERSION}-intl  php${YNH_PHP_VERSION}-cli"
 
 #=================================================
 # PERSONAL HELPERS
diff --git a/scripts/install b/scripts/install
index 8fa2f6d..ca0d5a1 100644
--- a/scripts/install
+++ b/scripts/install
@@ -84,18 +84,13 @@ ynh_add_fpm_config
 #=================================================
 ynh_script_progression --message="Adding a configuration file..." --weight=5
 
-# copy config.dist.php creating config.local.php
-cp -a $final_path/config.dist.php $final_path/config.local.php
-# create a key for the secret key CSFR;
-key=$(ynh_string_random --length=50)
-# edit config.local.php
-ynh_replace_string --match_string="const SECRET_KEY = '3xUhIgGwuovRKOjVsVPQ5yUMfXUSIOX2GKzcebsz5OINrYC50r';" --replace_string="const SECRET_KEY = '$key';" --target_file="$final_path/config.local.php"
-if [ "$path_url" == "/" ]; then
-  ynh_replace_string --match_string="//const WWW_URI = '/asso/';" --replace_string="const WWW_URI = '$path_url';" --target_file="$final_path/config.local.php"
-else
-  ynh_replace_string --match_string="//const WWW_URI = '/asso/';" --replace_string="const WWW_URI = '$path_url/';" --target_file="$final_path/config.local.php"
-fi
-ynh_replace_string --match_string="//const ENABLE_UPGRADES = true;" --replace_string="const ENABLE_UPGRADES = false;" --target_file="$final_path/config.local.php"
+# create a key for the secret key CSFR:
+secret_key=$(ynh_string_random --length=50)
+
+# Install configuration files
+ynh_add_config --template="config.local.php" --destination="$final_path/config.local.php"
+ynh_add_config --template="config.local.yunohost.php" --destination="$final_path/config.local.yunohost.php"
+ynh_add_config --template="config.local.user.php" --destination="$final_path/config.local.user.php"
 
 # Permissions on files and directories
 chmod -R o-rwx "$final_path"
@@ -104,7 +99,9 @@ find "$final_path" -type d -exec chmod 550 {} +
 find "$final_path" -type f -exec chmod 440 {} +
 find "$final_path/data" -type d -exec chmod 770 {} +
 find "$final_path/data" -type f -exec chmod 660 {} +
-chmod 660 "$final_path/config.local.php"
+chmod 440 "$final_path/config.local.php"
+chmod 440 "$final_path/config.local.yunohost.php"
+chmod 660 "$final_path/config.local.user.php"
 
 #=================================================
 # SETUP SSOWAT
diff --git a/scripts/upgrade b/scripts/upgrade
index d2ec51c..5e9f4b2 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -20,6 +20,7 @@ domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path) || ynh_die "This path already contains a folder"
 phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+secret_key=$(ynh_string_random --length=50)
 
 #=================================================
 # CHECK VERSION
@@ -91,7 +92,7 @@ fi
 
 if ynh_compare_current_package_version --comparison lt --version 0.9.8.1~ynh1
 then
-  ynh_script_progression --message="Upgrading upgrade to 0.9.8" --weight=5
+  ynh_script_progression --message="Upgrading to 0.9.8" --weight=5
     # Download, check integrity, uncompress and patch the source from 0.9.8.src
   ynh_setup_source --keep="config.local.php" --dest_dir="$final_path" --source_id="0.9.8"
   # Set permissions on app files
@@ -139,7 +140,7 @@ fi
 
 if ynh_compare_current_package_version --comparison lt --version 1.1.0~ynh1
 then
-  ynh_script_progression --message="Upgrading upgrade to 1.1.0" --weight=5
+  ynh_script_progression --message="Upgrading to 1.1.0" --weight=5
   # Download, check integrity, uncompress and patch the source from 0.9.8.src
   ynh_setup_source --keep="config.local.php" --dest_dir="$final_path" --source_id="1.1.0"
   # Set permissions on app files
@@ -198,7 +199,7 @@ ynh_script_progression --message="Upgrading source files..." --weight=5
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
   # Download, check integrity, uncompress and patch the source from app.src
-  ynh_setup_source --keep="config.local.php" --dest_dir="$final_path"
+  ynh_setup_source --keep="config.local.user.php" --dest_dir="$final_path"
 fi
 
 #=================================================
@@ -258,9 +259,9 @@ fi
 #=================================================
 ynh_script_progression --message="Adding a configuration file..." --weight=5
 
-ynh_add_config --template="config.local.release.php" --destination="$final_path/config.local.release.php"
-
-echo -e "\n require 'config.local.release.php;'" >> $final_path/config.local.php
+ynh_add_config --template="config.local.php" --destination="$final_path/config.local.php"
+ynh_add_config --template="config.local.yunohost.php" --destination="$final_path/config.local.yunohost.php"
+# NOTE: Don't overwrite config.local.user.php
 
 # Permissions on files and directories
 chmod -R o-rwx "$final_path"
@@ -269,8 +270,9 @@ find "$final_path" -type d -exec chmod 550 {} +
 find "$final_path" -type f -exec chmod 440 {} +
 find "$final_path/data" -type d -exec chmod 770 {} +
 find "$final_path/data" -type f -exec chmod 660 {} +
-chmod 660 "$final_path/config.local.php"
-chmod 660 "$final_path/config.local.release.php"
+chmod 440 "$final_path/config.local.php"
+chmod 440 "$final_path/config.local.yunohost.php"
+chmod 660 "$final_path/config.local.user.php"
 
 #=================================================
 # RELOAD NGINX
@@ -285,7 +287,6 @@ ynh_systemd_action --service_name=nginx --action=reload
 ynh_script_progression --message="Finalise upgrade" --weight=1
 
 ynh_local_curl "/admin/index.php"
-chmod 440 "$final_path/config.local.php"
 
 #=================================================
 # END OF SCRIPT