From 671471c81f2cb8515c06a6976b7e738481cadb85 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniack_crudelis@yahoo.fr>
Date: Wed, 15 Jun 2016 23:57:45 +0200
Subject: [PATCH] Factorisation du code

---
 scripts/.fonctions | 178 +++++++++++++++++++++++++++++++++++++++++++++
 scripts/install    |  99 ++++++-------------------
 scripts/remove     |  33 +--------
 scripts/upgrade    |  11 ++-
 4 files changed, 209 insertions(+), 112 deletions(-)
 create mode 100755 scripts/.fonctions

diff --git a/scripts/.fonctions b/scripts/.fonctions
new file mode 100755
index 0000000..7569aae
--- /dev/null
+++ b/scripts/.fonctions
@@ -0,0 +1,178 @@
+#!/bin/bash
+
+YNH_VERSION () {	# Renvoi le numéro de version de la moulinette Yunohost
+	ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+}
+
+CHECK_VAR () {	# Vérifie que la variable n'est pas vide.
+# $1 = Variable à vérifier
+# $2 = Texte à afficher en cas d'erreur
+	test -n "$1" || (echo "$2" && false)
+}
+
+EXIT_PROPERLY () {	# Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus.
+	trap '' ERR
+	echo -e "\e[91m \e[1m"	# Shell in light red bold
+	echo -e "!!\n  $app install's script has encountered an error. Installation was cancelled.\n!!"
+
+	CLEAN_SETUP	# Appel la fonction de nettoyage spécifique du script install.
+
+	if [ $ynh_version = "2.2" ]; then
+		/bin/bash $script_dir/remove	# Appel le script remove. En 2.2, ce comportement n'est pas automatique.
+	fi
+
+	exit 1
+}
+
+TRAP_ON () {	# Activate signal capture
+	trap EXIT_PROPERLY ERR	# Capturing exit signals on error
+}
+
+TRAP_OFF () {	# Ignoring signal capture until TRAP_ON
+	# Pour une raison que j'ignore, la fonction TRAP_ON fonctionne très bien.
+	# Mais pas la fonction TRAP_OFF...
+	# Utiliser directement `trap '' ERR` dans le code pour l'utiliser, à la place de la fonction.
+	trap '' ERR	# Ignoring exit signals
+}
+
+CHECK_USER () {	# Vérifie la validité de l'user admin
+# $1 = Variable de l'user admin.
+	sudo yunohost user list --json | grep -q "\"username\": \"$1\"" || (echo "Wrong admin" && false)
+}
+
+CHECK_PATH () {	# Vérifie la présence du / en début de path. Et son absence à la fin.
+	if [ "${path:0:1}" != "/" ]; then    # Si le premier caractère n'est pas un /
+		path="/$path"    # Ajoute un / en début de path
+	fi
+	if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then    # Si le dernier caractère est un / et que ce n'est pas le seul caractère.
+		path="${path:0:${#path}-1}"	# Supprime le dernier caractère
+	fi
+}
+
+CHECK_DOMAINPATH () {	# Vérifie la disponibilité du path et du domaine.
+	sudo yunohost app checkurl $domain$path -a $app
+}
+
+CHECK_FINALPATH () {	# Vérifie que le dossier de destination n'est pas déjà utilisé.
+	final_path=/var/www/$app
+	if [ -e "$final_path" ]
+	then
+		echo "This path already contains a folder"
+		false
+	fi
+}
+
+GENERATE_DB () {	# Créer une base de données et un utilisateur dédié au nom de l'app.
+	# Génère un mot de passe aléatoire.
+	db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20)
+	CHECK_VAR "$db_pwd" "db_pwd empty"
+	# Utilise '$app' comme nom d'utilisateur et de base de donnée
+	db_user=$app
+	# Initialise la base de donnée et stocke le mot de passe mysql.
+	ynh_mysql_create_db $db_user $db_user $db_pwd
+	sudo yunohost app setting $app mysqlpwd -v $db_pwd
+}
+
+SETUP_SOURCE () {	# Télécharge la source, décompresse et copie dans $final_path
+# $1 = Nom de l'archive téléchargée.
+	wget -nv --show-progress -i ../sources/source_url -O $1
+	# Vérifie la somme de contrôle de la source téléchargée.
+	md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" && false)
+	# Décompresse la source
+	if [ "$(echo ${1##*.})" == "gz" ]; then
+		tar -x -f $1
+	elif [ "$(echo ${1##*.})" == "zip" ]; then
+		unzip -q $1
+	else
+		false	# Format d'archive non pris en charge.
+	fi
+	# Copie les fichiers sources
+	sudo cp -a $(cat ../sources/source_dir)/. "$final_path"
+	# Copie les fichiers additionnels ou modifiés.
+	sudo cp -a ../sources/ajouts/. "$final_path"
+}
+
+POOL_FPM () {	# Créer le fichier de configuration du pool php-fpm et le configure.
+	sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf
+	sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf
+	finalphpconf=/etc/php5/fpm/pool.d/$app.conf
+	sudo cp ../conf/php-fpm.conf $finalphpconf
+	sudo chown root: $finalphpconf
+	finalphpini=/etc/php5/fpm/conf.d/20-$app.ini
+	sudo cp ../conf/php-fpm.ini $finalphpini
+	sudo chown root: $finalphpini
+	sudo service php5-fpm reload
+}
+
+STORE_MD5_CONFIG () {	# Enregistre la somme de contrôle du fichier de config
+# $1 = Nom du fichier de conf pour le stockage dans settings.yml
+# $2 = Nom complet et chemin du fichier de conf.
+	sudo yunohost app setting $app $1_file_md5 -v $(md5sum "$2" | cut -d' ' -f1)
+}
+
+CHECK_MD5_CONFIG () {	# Créé un backup du fichier de config si il a été modifié.
+# $1 = Nom du fichier de conf pour le stockage dans settings.yml
+# $2 = Nom complet et chemin du fichier de conf.
+	if [ "$(sudo yunohost app setting $app $1_file_md5)" != $(md5sum "$2" | cut -d' ' -f1) ]; then
+		sudo cp -a "$2" "$2.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')"	# Si le fichier de config a été modifié, créer un backup.
+	fi
+}
+
+FIND_PORT () {	# Cherche un port libre.
+# $1 = Numéro de port pour débuter la recherche.
+	port=$1
+	while ! sudo yunohost app checkport $port ; do
+		port=$((port+1))
+	done
+	CHECK_VAR "$port" "port empty"
+}
+
+
+### REMOVE SCRIPT
+
+REMOVE_NGINX_CONF () {	# Suppression de la configuration nginx
+	if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then	# Delete nginx config
+		echo "Delete nginx config"
+		sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
+		sudo service nginx reload
+	fi
+}
+
+REMOVE_FPM_CONF () {	# Suppression de la configuration du pool php-fpm
+	if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then	# Delete fpm config
+		echo "Delete fpm config"
+		sudo rm "/etc/php5/fpm/pool.d/$app.conf"
+	fi
+	if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then	# Delete php config
+		echo "Delete php config"
+		sudo rm "/etc/php5/fpm/conf.d/20-$app.ini"
+	fi
+	sudo service php5-fpm reload
+}
+
+REMOVE_LOGROTATE_CONF () {	# Suppression de la configuration de logrotate
+	if [ -e "/etc/logrotate.d/$app" ]; then
+		echo "Delete logrotate config"
+		sudo rm "/etc/logrotate.d/$app"
+	fi
+}
+
+REMOVE_APP_DIR () {	# Suppression du dossier de l'application
+	if [ test -n "$app" ]
+	then	# Supprime le dossier seulement si $app n'est pas vide.
+		if [ -e "/var/www/$app" ]; then	# Delete final_path
+			echo "Delete app dir"
+			sudo rm -r "/var/www/$app"
+		fi
+	fi
+}
+
+REMOVE_BDD () {	# Suppression de la base de donnée et de l'utilisateur associé.
+	# Utilise '$app' comme nom d'utilisateur et de base de donnée
+	db_user=$app
+	if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then
+		echo "Delete db"
+		ynh_mysql_drop_db $db_user
+		ynh_mysql_drop_user $db_user
+	fi
+}
diff --git a/scripts/install b/scripts/install
index 6c47c3c..9f5e4e2 100644
--- a/scripts/install
+++ b/scripts/install
@@ -1,5 +1,15 @@
 #!/bin/bash
 
+source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+
+CLEAN_SETUP () {
+# Nettoyage des résidus d'installation non pris en charge par le script remove.
+	# Clean hosts
+	sudo sed -i '/#wordpress_yunohost/d' /etc/hosts
+}
+TRAP_ON	# Active trap pour arrêter le script si une erreur est détectée.
+
+# Retrieve arguments
 domain=$YNH_APP_ARG_DOMAIN
 path=$YNH_APP_ARG_PATH
 admin_wordpress=$YNH_APP_ARG_ADMIN
@@ -9,56 +19,19 @@ is_public=$YNH_APP_ARG_IS_PUBLIC
 
 app=$YNH_APP_INSTANCE_NAME
 
-test -z "$app" && (echo "app name not set" && false)
-
 # Source app helpers
 source /usr/share/yunohost/helpers
 
-
-# Delete files and db if exit with an error
-EXIT_PROPERLY () {
-	trap '' ERR
-	echo -e "\e[91m \e[1m"	# Shell in light red bold
-	echo -e "!!\n  $app install's script has encountered an error. Installation was cancelled.\n!!"
-
-	# Clean hosts
-	sudo sed -i '/#wordpress_yunohost/d' /etc/hosts
-
-	exit 1
-}
-TRAP_ON () {	# Activate signal capture
-	trap EXIT_PROPERLY ERR	# Capturing exit signals on error
-}
-TRAP_OFF () {	# Ignoring signal capture until TRAP_ON
-# Pour une raison que j'ignore, la fonction TRAP_ON fonctionne très bien.
-# Mais pas la fonction TRAP_OFF...
-# Utiliser directement `trap '' ERR` dans le code pour l'utiliser, à la place de la fonction.
-	trap '' ERR	# Ignoring exit signals
-}
-TRAP_ON
+# Vérifie que les variables ne sont pas vides.
+CHECK_VAR "$app" "app name not set"
 
 
-# Vérifie la validité de l'user admin
-sudo yunohost user list --json | grep -q "\"username\": \"$admin_wordpress\"" || (echo "Wrong admin" && false)
+CHECK_USER "$admin"	# Vérifie la validité de l'user admin
 
-# Vérifie la présence du / en début de path. Et son absence à la fin.
-if [ "${path:0:1}" != "/" ]; then    # Si le premier caractère n'est pas un /
-	path="/$path"    # Ajoute un / en début de path
-fi
-if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then    # Si le dernier caractère est un / et que ce n'est pas le seul caractère.
-	path="${path:0:${#path}-1}"	# Supprime le dernier caractère
-fi
+CHECK_PATH	# Vérifie et corrige la syntaxe du path.
+CHECK_DOMAINPATH	# Vérifie la disponibilité du path et du domaine.
 
-# Vérifie la disponibilité du path et du domaine.
-sudo yunohost app checkurl $domain$path -a $app
-
-# Vérifie que le dossier de destination n'est pas déjà utilisé.
-final_path=/var/www/$app
-if [ -e "$final_path" ]
-then
-    echo "This path already contains a folder"
-    false
-fi
+CHECK_FINALPATH	# Vérifie que le dossier de destination n'est pas déjà utilisé.
 
 if [ "$path" == "/" ] && [ "$multisite" = "Yes" ]; then
     echo "Multisite option of wordpress doesn't work at root of domain."
@@ -73,15 +46,7 @@ sudo yunohost app setting $app is_public -v $is_public
 sudo yunohost app setting $app language -v $language
 sudo yunohost app setting $app multisite -v $multisite
 
-
-# Génère un mot de passe aléatoire.
-db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20)
-test -z "$db_pwd" && (echo "db_pwd empty" && false)
-# Utilise '$app' comme nom d'utilisateur et de base de donnée
-db_user=$app
-# Initialise la base de donnée et stocke le mot de passe mysql.
-ynh_mysql_create_db $db_user $db_user $db_pwd
-sudo yunohost app setting $app mysqlpwd -v $db_pwd
+GENERATE_DB	# Créer une base de données et un utilisateur dédié au nom de l'app.
 
 
 # Crée le repertoire de destination et stocke son emplacement.
@@ -89,16 +54,8 @@ sudo mkdir "$final_path"
 sudo yunohost app setting $app final_path -v $final_path
 
 
-# Télécharge la source
-wget -nv --show-progress -i ../sources/source_url -O wordpress.tar.gz
-# Vérifie la somme de contrôle de la source téléchargée.
-md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" && false)
-# Décompresse la source
-tar -x -f wordpress.tar.gz
-# Copie les fichiers sources
-sudo cp -a $(cat ../sources/source_dir)/. "$final_path"
-# Copie les fichiers additionnels ou modifiés.
-sudo cp -a ../sources/ajouts/. "$final_path"
+SETUP_SOURCE "wordpress.tar.gz"	# Télécharge la source, décompresse et copie dans $final_path
+
 # Et copie le fichier de config nginx
 sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
 
@@ -108,17 +65,7 @@ sudo sed -i "s@__PATHTOCHANGE__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf
 sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/nginx/conf.d/$domain.d/$app.conf
 sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf
 
-# Créer le fichier de configuration du pool php-fpm et le configure.
-sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf
-sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf
-finalphpconf=/etc/php5/fpm/pool.d/$app.conf
-sudo cp ../conf/php-fpm.conf $finalphpconf
-sudo chown root: $finalphpconf
-finalphpini=/etc/php5/fpm/conf.d/20-$app.ini
-sudo cp ../conf/php-fpm.ini $finalphpini
-sudo chown root: $finalphpini
-sudo service php5-fpm reload
-
+POOL_FPM	# Créer le fichier de configuration du pool php-fpm et le configure.
 
 
 sudo cp ../conf/wp-config.php $final_path/wp-config.php
@@ -147,9 +94,8 @@ sudo chown -R www-data: $final_path
 
 # Donne un accès public pour curl
 sudo yunohost app setting $app unprotected_uris -v "/"
-# Recharge la configuration Nginx et php5-fpm
+# Recharge la configuration Nginx
 sudo service nginx reload
-sudo service php5-fpm reload
 # Régénère la configuration de SSOwat
 sudo yunohost app ssowatconf
 
@@ -220,8 +166,7 @@ fi
 # Décommente les add_filter, qui auraient provoqué une erreur avec wp-cli
 sudo sed -i "s@//add_filter@add_filter@g" $final_path/wp-config.php
 
-# Enregistre la somme de contrôle du fichier de config
-sudo yunohost app setting $app wp-config.php_file_md5 -v $(md5sum "$final_path/wp-config.php" | cut -d' ' -f1)
+STORE_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php"	# Enregistre la somme de contrôle du fichier de config
 
 
 # Configure les droits d'accès au fichiers
diff --git a/scripts/remove b/scripts/remove
index 5ed6599..4fdc230 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -7,38 +7,13 @@ app=$YNH_APP_INSTANCE_NAME
 source /usr/share/yunohost/helpers
 domain=$(sudo yunohost app setting $app domain)
 
-# Suppression de la base de donnée et de l'utilisateur associé.
-# Utilise '$app' comme nom d'utilisateur et de base de donnée
-db_user=$app
-if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then
-	echo "Delete db"
-	ynh_mysql_drop_db $db_user
-	ynh_mysql_drop_user $db_user
-fi
+REMOVE_BDD	# Suppression de la base de donnée et de l'utilisateur associé.
 
-# Suppression du dossier de l'application
-if [ -e "/var/www/$app" ]; then	# Delete final_path
-	echo "Delete app dir"
-	sudo rm -r "/var/www/$app"
-fi
+REMOVE_APP_DIR	# Suppression du dossier de l'application
 
-# Suppression de la configuration nginx
-if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then	# Delete nginx config
-	echo "Delete nginx config"
-	sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
-	sudo service nginx reload
-fi
+REMOVE_NGINX_CONF	# Suppression de la configuration nginx
 
-# Suppression de la configuration du pool php-fpm
-if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then	# Delete fpm config
-	echo "Delete fpm config"
-	sudo rm "/etc/php5/fpm/pool.d/$app.conf"
-fi
-if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then	# Delete php config
-	echo "Delete php config"
-	sudo rm "/etc/php5/fpm/conf.d/20-$app.ini"
-fi
-sudo service php5-fpm reload
+REMOVE_FPM_CONF	# Suppression de la configuration du pool php-fpm
 
 # Régénère la configuration de SSOwat
 sudo yunohost app ssowatconf
diff --git a/scripts/upgrade b/scripts/upgrade
index 9f2e638..14fc4e0 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+
 # Récupère les infos de l'application.
 app=$YNH_APP_INSTANCE_NAME
 domain=$(sudo yunohost app setting $app domain)
@@ -10,6 +12,7 @@ is_public=$(sudo yunohost app setting $app is_public)
 multisite=$(sudo yunohost app setting $app multisite)
 final_path=$(sudo yunohost app setting $app final_path)
 
+CHECK_PATH	# Vérifie et corrige la syntaxe du path.
 root_pwd=$(sudo cat /etc/yunohost/mysql)
 db_name=$app
 if [[ "$admin_wordpress" = "" ]];
@@ -57,10 +60,7 @@ sudo chown root: $finalphpini
 sudo service php5-fpm reload
 
 
-config_file="$final_path/wp-config.php"
-if [ "$(sudo yunohost app setting $app wp-config.php_file_md5)" != $(md5sum "$config_file" | cut -d' ' -f1) ]; then
-	sudo cp -a "$config_file" "$config_file.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')"	# Si le fichier de config a été modifié, créer un backup.
-fi
+CHECK_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php"	# Créé un backup du fichier de config si il a été modifié.
 if [ "$multisite" = "Yes" ];
 then
     sudo sed -i "s@#--MULTISITE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf
@@ -74,8 +74,7 @@ else
 	fi
 fi
 sudo yunohost app setting $app multisite -v $multisite
-# Réenregistre la somme de contrôle du fichier de config.
-sudo yunohost app setting $app wp-config.php_file_md5 -v $(md5sum "$final_path/wp-config.php" | cut -d' ' -f1)
+STORE_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php"	# Réenregistre la somme de contrôle du fichier de config
 
 # Configure les droits d'accès au fichiers
 # Les fichiers appartiennent à www-data, pour permettre les mises à jour.