Merge pull request #1 from maniackcrudelis/master

Factorisation du code

check_process

@@ -0,0 +1,41 @@
+;; Test paquet stable
+	auto_remove=1
+	; Manifest
+		version="A. Version of the Debian repositories (recommended)"
+	; Checks
+		pkg_linter=1
+		setup_sub_dir=0
+		setup_root=0
+		setup_nourl=1
+		setup_private=0
+		setup_public=0
+		upgrade=1
+		backup_restore=1
+		multi_instance=0
+		wrong_user=0
+		wrong_path=0
+		incorrect_path=0
+		corrupt_source=0
+		fail_download_source=0
+		port_already_use=1	(48200)
+		final_path_already_use=0
+;; Test paquet backports
+	auto_remove=1
+	; Manifest
+		version="B. Latest version available for Debian"
+	; Checks
+		setup_sub_dir=0
+		setup_root=0
+		setup_nourl=1
+		setup_private=0
+		setup_public=0
+		upgrade=1
+		backup_restore=0
+		multi_instance=0
+		wrong_user=0
+		wrong_path=0
+		incorrect_path=0
+		corrupt_source=0
+		fail_download_source=0
+		port_already_use=0
+		final_path_already_use=0

manifest.json

@@ -10,12 +10,12 @@
 		"fr": "Serveur DLNA léger pour partager les fichiers multimédia sur le réseau local"
 	},
 	"url": "http://minidlna.sourceforge.net/",
-    "licence": "free",
+	"license": "free",
 	"maintainer": {
 		"name": "Maniack Crudelis",
 		"email": "maniackc_dev@crudelis.fr"
 	},
-    "multi_instance": "false",
+	"multi_instance": false,
 	"services": [],
 	"arguments": {
 		"install" : [

scripts/.fonctions

@@ -0,0 +1,183 @@
+#!/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" >&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!!" >&2
+
+	CLEAN_SETUP	# Appel la fonction de nettoyage spécifique du script install.
+
+	# Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation.
+	sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json
+
+	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" >&2 && 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" >&2
+		false
+	fi
+}
+
+GENERATE_DB () {	# Créer une base de données et un utilisateur dédié au nom de l'app.
+# $1 = Nom de la base de donnée
+	# Génère un mot de passe aléatoire.
+	db_user=$1
+	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
+	# 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" >&2 && 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é.
+# $1 = Nom de la base de donnée
+	# Utilise '$app' comme nom d'utilisateur et de base de donnée
+	db_user=$1
+	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
+}

scripts/backup

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Récupère les infos de l'application.
-ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)	# Récupère le numéro de version de Yunohost.
 if [ $ynh_version = "2.4" ]; then
 	app=$YNH_APP_INSTANCE_NAME
 else

scripts/install

@@ -1,6 +1,16 @@
 #!/bin/bash
 
-ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+
+YNH_VERSION	# Récupère le numéro de version de Yunohost.
+
+CLEAN_SETUP () {
+# Nettoyage des résidus d'installation non pris en charge par le script remove.
+# Pas de nettoyage supplémentaire nécessaire ici...
+	echo ""
+}
+TRAP_ON	# Active trap pour arrêter le script si une erreur est détectée.
+
 # Retrieve arguments
 if [ $ynh_version = "2.4" ]
 then
@@ -9,43 +19,17 @@ then
 	app=$YNH_APP_INSTANCE_NAME
 
 	# Source app helpers
-	. /usr/share/yunohost/helpers
+	source /usr/share/yunohost/helpers
 else
 	version=$1
 	app=minidlna
 fi
 
-
+# Vérifie que les variables ne sont pas vides.
-# Delete files and db if exit with an error
+CHECK_VAR "$app" "app name not set"
-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!!"
-
-	if [ $ynh_version = "2.2" ]; then
-		/bin/bash ./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
-}
-TRAP_ON
 
 
-# Cherche un port libre.
+FIND_PORT 48200	# Cherche un port libre.
-port=48200
-sudo yunohost app checkport $port
-while [[ ! $? -eq 0 ]]; do
-    port=$((port+1))
-    sudo yunohost app checkport $port
-done
 
 # Ouvre les ports dans le firewall
 sudo yunohost firewall allow --no-upnp TCP $port > /dev/null 2>&1
@@ -56,7 +40,7 @@ sudo yunohost app setting $app version -v ${version:0:1}
 sudo yunohost app setting $app port -v $port
 
 # Création du dossier yunohost.multimedia
-wget https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
+wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 
@@ -64,6 +48,7 @@ sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 if [ ${version:0:1} = "B" ]
 then	# Installation de la version minidlna disponible dans backport. (En cas de problème avec la version actuelle des dépots)
 	codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2)
+	test -z "$codename" && (echo "codename empty" && false)
 	sudo sed -i "s@__CODENAME__@$codename@g" ../conf/minidlna.list
 	sudo cp -a ../conf/minidlna.list /etc/apt/sources.list.d/
 	sudo apt-get update
@@ -86,6 +71,7 @@ sudo sed -i 's@^#*media_dir=.*@media_dir=/home/yunohost.multimedia/share@' /etc/
 sudo sed -i "s/^#*port=.*/port=$port/" /etc/minidlna.conf
 sudo sed -i "s/^#*friendly_name=.*/friendly_name=Yunohost DLNA/" /etc/minidlna.conf
 sudo sed -i "s/^#*root_container=.*/root_container=B/" /etc/minidlna.conf
+STORE_MD5_CONFIG "minidlna.conf" "/etc/minidlna.conf"	# Enregistre la somme de contrôle du fichier de config
 
 # Redémarre minidlna pour prendre en compte la nouvelle configuration
 sudo service minidlna restart

scripts/remove

@@ -1,12 +1,14 @@
 #!/bin/bash
 
+source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+
 # Récupère les infos de l'application.
-ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+YNH_VERSION	# Récupère le numéro de version de Yunohost.
 if [ $ynh_version = "2.4" ]; then
 	app=$YNH_APP_INSTANCE_NAME
 
 	# Source app helpers
-	. /usr/share/yunohost/helpers
+	source /usr/share/yunohost/helpers
 else
 	app=minidlna
 fi
@@ -30,7 +32,7 @@ if [ -e "/usr/sbin/minidlnad" ] || [ -e "/usr/bin/minidlnad" ]; then
 	sudo apt-get -y purge minidlna
 fi
 if [ -e "/etc/apt/sources.list.d/minidlna.list" ]; then
-	echo "Delete apt config"
+	echo "Delete sources.list config"
 	sudo rm "/etc/apt/sources.list.d/minidlna.list"
 fi
 

scripts/restore

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Récupère les infos de l'application.
-ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)	# Récupère le numéro de version de Yunohost.
 if [ $ynh_version = "2.4" ]; then
 	app=$YNH_APP_INSTANCE_NAME
 else
@@ -18,7 +18,7 @@ sudo yunohost firewall allow --no-upnp TCP $port > /dev/null 2>&1
 sudo yunohost firewall allow --no-upnp UDP 1900 > /dev/null 2>&1	# Découverte SSDP pour UPNP.
 
 # Création du dossier yunohost.multimedia
-wget https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
+wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 

scripts/upgrade

@@ -1,7 +1,9 @@
 #!/bin/bash
 
+source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+
 # Récupère les infos de l'application.
-ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
+YNH_VERSION	# Récupère le numéro de version de Yunohost.
 if [ $ynh_version = "2.4" ]; then
 	app=$YNH_APP_INSTANCE_NAME
 else
@@ -11,7 +13,7 @@ version=$(sudo yunohost app setting $app version)
 port=$(sudo yunohost app setting $app port)
 
 # Mise à jour du dossier yunohost.multimedia
-wget https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
+wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 
@@ -37,6 +39,7 @@ sudo sysctl --system
 sudo yunohost service add minidlna --log "/var/log/minidlna.log"
 
 # Modifie la configuration de minidlna
+CHECK_MD5_CONFIG "minidlna.conf" "/etc/minidlna.conf"	# Créé un backup du fichier de config si il a été modifié.
 sudo sed -i 's@^#*media_dir=.*@media_dir=/home/yunohost.multimedia/share@' /etc/minidlna.conf
 sudo sed -i "s/^#*port=.*/port=$port/" /etc/minidlna.conf
 sudo sed -i "s/^#*friendly_name=.*/friendly_name=Yunohost DLNA/" /etc/minidlna.conf