From c25787db1ea9b40b06dc3a644fd654dca46056f1 Mon Sep 17 00:00:00 2001
From: Gofannon <gofannon+github@riseup.net>
Date: Wed, 27 Jun 2018 23:12:30 +0200
Subject: [PATCH] [enh] Split configuration in different files

Separate dedicated Yunohost configuration in a new file that cannot be modified by user
Adapt scripts to handle new files

See https://github.com/YunoHost-Apps/dokuwiki_ynh/pull/37
---
 conf/local.php           | 21 ---------------------
 conf/local.protected.php | 33 +++++++++++++++++++++++++++++++++
 scripts/install          | 14 +++++++++++---
 scripts/upgrade          | 24 +++++++++++++++++-------
 4 files changed, 61 insertions(+), 31 deletions(-)
 create mode 100644 conf/local.protected.php

diff --git a/conf/local.php b/conf/local.php
index bd02233..cfa5cd6 100644
--- a/conf/local.php
+++ b/conf/local.php
@@ -11,24 +11,3 @@
 
 /* Basic Settings */
 $conf['lang']        = '__YNH_LANGUAGE__';              //your language
-
-/* Authentication Settings */
-$conf['useacl']      = 1;                //Use Access Control Lists to restrict access?
-$conf['authtype']    = 'authldap';       //which authentication backend should be used
-$conf['passcrypt']   = 'sha1';           //Used crypt method (smd5,md5,sha1,ssha,crypt,mysql,my411)
-$conf['superuser']   = '__YNH_ADMIN_USER__'; //The admin can be user or @group or comma separated list user1,@group1,user2
-$conf['manager']     = '__YNH_ADMIN_USER__'; //The manager can be user or @group or comma separated list user1,@group1,user2
-
-/* LDAP Yunohost config */
-$conf['plugin']['authldap']['server']      = 'localhost';
-$conf['plugin']['authldap']['port']        = 389;
-$conf['plugin']['authldap']['version']     = 3;
-$conf['plugin']['authldap']['usertree']    = 'ou=users,dc=yunohost,dc=org';
-$conf['plugin']['authldap']['userfilter']  = '(&(uid=%{user})(objectClass=posixAccount))';
-# no groups
-#$conf['plugin']['authldap']['grouptree']   = 'ou=Group, dc=server, dc=tld';
-#$conf['plugin']['authldap']['groupfilter'] = '(&(objectClass=posixGroup)(|(gidNumber=%{gid})(memberUID=%{user})))'; 
-
-/* Advanced Settings */
-$conf['updatecheck'] = 0;                //automatically check for new releases?
-$conf['cssdatauri']  = 512;              //Maximum byte size of small images to embed into CSS, won't work on IE<8
diff --git a/conf/local.protected.php b/conf/local.protected.php
new file mode 100644
index 0000000..f1b27c4
--- /dev/null
+++ b/conf/local.protected.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ * This file is used for configuration settings which cannot be modified by Dokuwiki admin panel
+ * See here for explanations : https://www.dokuwiki.org/config
+ * 
+ * Yunohost dedicated settings are stored here in order to be able to upgrade the Yunohost package safely latter for Yunohost packager ( Yeah \o/ )
+ *
+ * You should not modify this file direclty as it will be overwritten by Yunohost package
+ * Use "local.php" instead. You have been warned !
+ */
+
+
+/* Authentication Settings */
+$conf['useacl']      = 1;                //Use Access Control Lists to restrict access?
+$conf['authtype']    = 'authldap';       //which authentication backend should be used
+$conf['passcrypt']   = 'sha1';           //Used crypt method (smd5,md5,sha1,ssha,crypt,mysql,my411)
+$conf['superuser']   = '__YNH_ADMIN_USER__'; //The admin can be user or @group or comma separated list user1,@group1,user2
+$conf['manager']     = '__YNH_ADMIN_USER__'; //The manager can be user or @group or comma separated list user1,@group1,user2
+
+/* LDAP Yunohost config */
+$conf['plugin']['authldap']['server']      = 'localhost';
+$conf['plugin']['authldap']['port']        = 389;
+$conf['plugin']['authldap']['version']     = 3;
+$conf['plugin']['authldap']['usertree']    = 'ou=users,dc=yunohost,dc=org';
+$conf['plugin']['authldap']['userfilter']  = '(&(uid=%{user})(objectClass=posixAccount))';
+# no groups
+#$conf['plugin']['authldap']['grouptree']   = 'ou=Group, dc=server, dc=tld';
+#$conf['plugin']['authldap']['groupfilter'] = '(&(objectClass=posixGroup)(|(gidNumber=%{gid})(memberUID=%{user})))'; 
+
+/* Advanced Settings */
+$conf['updatecheck'] = 0;                //automatically check for new releases?
+// Taken from previous package. Don't know what it does. Maybe Yunohost corner logo ?
+$conf['cssdatauri']  = 512;              //Maximum byte size of small images to embed into CSS, won't work on IE<8
diff --git a/scripts/install b/scripts/install
index 7d94d17..bc7680e 100755
--- a/scripts/install
+++ b/scripts/install
@@ -100,14 +100,22 @@ ynh_add_fpm_config
 # CUSTOMIZE DOKUWIKI
 #=================================================
 
+# Set the "admin" user
+ynh_replace_string "__YNH_ADMIN_USER__" "$admin"  "../conf/local.protected.php"
+
 # Set the "language"
 ynh_replace_string "__YNH_LANGUAGE__" "$language" "../conf/local.php"
 
-# Set the "admin" user
-ynh_replace_string "__YNH_ADMIN_USER__" "$admin" "../conf/local.php"
 
 # Copy Yunohost specific configuration
-cp ../conf/local.php $final_path/conf
+
+cp ../conf/local.protected.php $final_path/conf
+# This File cannot be modified directly by Dokuwiki, only by hand or by Yunohost
+# It will only be updated by Yunohost package or directly by adventurous users
+
+cp ../conf/local.php           $final_path/conf
+# This file might be modified by dokuwiki admin panel or by plugins
+# It will not be modified by Yunohost in order to keep user settings
 
 
 # Restrict user rights by enforcing "read-only" mode for all users
diff --git a/scripts/upgrade b/scripts/upgrade
index c2376bd..fae795f 100755
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -113,16 +113,26 @@ if [ -d "${final_path}/data/media" ]; then
 	chown -R $app:root $final_path/{data/attic,data/cache,data/index,data/locks,data/media*,data/meta,data/pages,data/tmp}
 fi
 
-# Set the "language" of Dokuwiki
-# Might overwrite user choice if language has been change directly in Dokuwiki admin panel
-# Should be enhance to avoid this. For now, it is easier to overwrite as there is no need to take care of existing configuration
-ynh_replace_string "__YNH_LANGUAGE__" "$language" "../conf/local.php"
+# Set the "admin" user
+ynh_replace_string "__YNH_ADMIN_USER__" "$admin"  "../conf/local.protected.php"
 
-# Set the "admin" user of Dokuwiki
-ynh_replace_string "__YNH_ADMIN_USER__" "$admin" "../conf/local.php"
 
 # Copy Yunohost specific configuration
-cp ../conf/local.php $final_path/conf
+
+cp ../conf/local.protected.php $final_path/conf
+# This File cannot be modified directly by Dokuwiki, only by hand or by Yunohost
+# It will only be updated by Yunohost package or directly by adventurous users
+
+# Do not overwrite existing dokuwiki configuration as it could have user customization's and settings.
+# Create file if it does not exist
+if [ ! -f "$final_path/conf/local.php" ]; then
+
+	# Set the default "language" only when file does not exist beforehand
+	# Replace string in order to have a functionnal configuration file
+	ynh_replace_string "__YNH_LANGUAGE__" "$language" "../conf/local.php"
+
+	cp ../conf/local.php $final_path/conf
+fi
 
 # Do not overwrite existing ACL configuration file as it could have user customization's and settings.
 # Create file if it does not exist