Cleaning

manifest.json

@@ -78,7 +78,7 @@
                 "default": "Yes"
             },
             {
-                "name": "basicauthuser",
+                "name": "basicauthname",
                 "ask": {
                     "en": "Choose the username to access the OPDS/HTML server (unrelated to YunoHost users)",
                     "fr": "Indiquez le nom d'utilisateur pour accéder au serveur OPDS/HTML (NON lié lié aux utilisateurs YunoHost)"
@@ -88,7 +88,6 @@
             },
             {
                 "name": "basicauthpass",
-                "type": "password",
                 "ask": {
                     "en": "Choose the password to access the OPDS/HTML server",
                     "fr": "Renseignez le mot de passe pour accéder au serveur OPDS/HTML"

scripts/fonctions

@@ -1,213 +0,0 @@
-#!/bin/bash
-
-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.
-	exit_code=$?
-	if [ "$exit_code" -eq 0 ]; then
-			exit 0	# Quitte sans erreur si le script se termine correctement.
-	fi
-	trap '' EXIT
-	set +eu
-	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
-
-	if type -t CLEAN_SETUP > /dev/null; then	# Vérifie l'existance de la fonction avant de l'exécuter.
-		CLEAN_SETUP	# Appel la fonction de nettoyage spécifique du script install.
-	fi
-
-	# 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
-
-	ynh_die
-}
-
-TRAP_ON () {	# Activate signal capture
-	set -eu	# Exit if a command fail, and if a variable is used unset.
-	trap EXIT_PROPERLY EXIT	# Capturing exit signals on shell script
-}
-
-CHECK_USER () {	# Vérifie la validité de l'user admin
-# $1 = Variable de l'user admin.
-	ynh_user_exists "$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
-	db_user=$1
-	db_user=${db_user//-/_}	# mariadb ne supporte pas les - dans les noms de base de données. Ils sont donc remplacé par des _
-	# Génère un mot de passe aléatoire.
-# 	db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20)
-	db_pwd=$(ynh_string_random)
-	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
-	ynh_app_setting_set $app mysqlpwd $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 -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.
-	if test -e "../sources/ajouts"; then
-		sudo cp -a ../sources/ajouts/. "$final_path"
-	fi
-}
-
-ADD_SYS_USER () {   # Créer un utilisateur système dédié à l'app
-        if ! ynh_system_user_exists "$app"	# Test l'existence de l'utilisateur
-        then
-            sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || (echo "Unable to create $app system account" >&2 && false)
-        fi
-}
-
-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
-	sed -i "s@__USER__@$app@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.
-	ynh_app_setting_set $app $1_file_md5 $(sudo 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 [ "$(ynh_app_setting_get $app $1_file_md5)" != $(sudo 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
-}
-
-SECURE_REMOVE () {      # Suppression de dossier avec vérification des variables
-	chaine="$1"	# L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables.
-	no_var=0
-	while (echo "$chaine" | grep -q '\$')	# Boucle tant qu'il y a des $ dans la chaine
-	do
-		no_var=1
-		global_var=$(echo "$chaine" | cut -d '$' -f 2)	# Isole la première variable trouvée.
-		only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)')	# Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière.
-		real_var=$(eval "echo ${only_var}")		# `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable.
-		if test -z "$real_var" || [ "$real_var" = "/" ]; then
-			echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2
-			return 1
-		fi
-		chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@")	# remplace la variable par sa valeur dans la chaine.
-	done
-	if [ "$no_var" -eq 1 ]
-	then
-		if [ -e "$chaine" ]; then
-			echo "Delete directory $chaine"
-			sudo rm -r "$chaine"
-		fi
-		return 0
-	else
-		echo "No detected variable." >&2
-		return 1
-	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
-}
-
-REMOVE_SYS_USER () {   # Supprime l'utilisateur système dédié à l'app
-    if ynh_system_user_exists "$app"	# Test l'existence de l'utilisateur
-    then
-    	sudo userdel $app
-    fi
-}

scripts/install

@@ -2,10 +2,10 @@
 #set -eu
 
 # Charge les fonctions génériques habituellement utilisées dans le script
-source fonctions
+#source fonctions
 
 # Active trap pour arrêter le script si une erreur est détectée.
-TRAP_ON
+#TRAP_ON
 
 # Source app helpers
 source /usr/share/yunohost/helpers
@@ -18,17 +18,47 @@ is_public=$YNH_APP_ARG_IS_PUBLIC
 runninguser=$YNH_APP_ARG_RUNNINGUSER
 calibre=$YNH_APP_ARG_CALIBRE
 basicauthcreate=$YNH_APP_ARG_BASICAUTHCREATE
-basicauthuser=$YNH_APP_ARG_BASICAUTHUSER
+basicauthname=$YNH_APP_ARG_BASICAUTHNAME
 basicauthpass=$YNH_APP_ARG_BASICAUTHPASS
 
 # We check variables are not empty
+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)
+}
+
 CHECK_VAR "$app" "app name not set"
 
 # Check the path value and correct it (adds / at begining and removes it at the end)
+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 l$
+                path="${path:0:${#path}-1}"     # Supprime le dernier caractère
+        fi
+}
+
 CHECK_PATH;
+
 # Check domain and path availibility
+CHECK_DOMAINPATH () {   # Vérifie la disponibilité du path et du domaine.
+        sudo yunohost app checkurl $domain$path -a $app
+}
+
 CHECK_DOMAINPATH
+
 # Check destination folder is not used already
+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
+}
+
 CHECK_FINALPATH
 
 # We check that calibre path is correct
@@ -88,7 +118,7 @@ sudo chown -hR $runninguser:$runninguser $final_path
 # Add basic auth if requested
 if [ "$basicauthcreate" = "Yes" ];
 then
-	ynh_app_setting_set "$app" basicauthuser "$basicauthuser"
+	ynh_app_setting_set "$app" basicauthname "$basicauthname"
 	ynh_app_setting_set "$app" basicauthpass "$basicauthpass"
 
 	# Generation of the htpasswd file according https://www.nginx.com/resources/wiki/community/faq/
@@ -97,7 +127,7 @@ then
 	openssl dgst -binary -sha1 | xxd -ps |
 	sed 's#$#'"`echo -n $SALT | xxd -ps`"'#' |
 	xxd -r -ps |
-	base64);printf "$basicauthuser:{SSHA}$SHA1\n" >> ../sources/htpasswd)
+	base64);printf "$basicauthname:{SSHA}$SHA1\n" >> ../sources/htpasswd)
 	sudo cp ../sources/htpasswd $final_path
 	sudo chmod 440 $final_path/htpasswd
 	sudo chown www-data:www-data $final_path/htpasswd

scripts/remove

@@ -14,6 +14,12 @@ source /usr/share/yunohost/helpers
 app=$YNH_APP_INSTANCE_NAME
 
 # We check variables are not empty
+
+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)
+}
 CHECK_VAR "$app" "app name not set"
 
 path=$(ynh_app_setting_get $app path)

scripts/upgrade

@@ -2,7 +2,7 @@
 #set -eu
 
 # Charge les fonctions génériques habituellement utilisées dans le script
-source fonctions
+#source fonctions
 
 # Active trap pour arrêter le script si une erreur est détectée.
 #TRAP_ON
@@ -14,6 +14,11 @@ source /usr/share/yunohost/helpers
 app=$YNH_APP_INSTANCE_NAME
 
 # We check variables are not empty
+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)
+}
 CHECK_VAR "$app" "app name not set"
 
 path=$(ynh_app_setting_get $app path)
@@ -66,7 +71,7 @@ sudo chown -hR $runninguser:$runninguser $final_path
 # Add basic auth if requested
 if [ "$basicauthcreate" = "Yes" ];
 then
-	basicauthuser=$(ynh_app_setting_get $app basicauthuser)
+	basicauthname=$(ynh_app_setting_get $app basicauthname)
 	basicauthpass=$(ynh_app_setting_get $app basicauthpass)
 
         # Generation of the htpasswd file according https://www.nginx.com/resources/wiki/community/faq/
@@ -75,7 +80,7 @@ then
         openssl dgst -binary -sha1 | xxd -ps |
         sed 's#$#'"`echo -n $SALT | xxd -ps`"'#' |
         xxd -r -ps |
-        base64);printf "$basicauthuser:{SSHA}$SHA1\n" >> ../sources/htpasswd)
+        base64);printf "$basicauthname:{SSHA}$SHA1\n" >> ../sources/htpasswd)
         sudo cp ../sources/htpasswd $final_path
         sudo chmod 440 $final_path/htpasswd
         sudo chown www-data:www-data $final_path/htpasswd