Usage des helpers

scripts/.fonctions

@@ -16,7 +16,7 @@ EXIT_PROPERLY () {	# Provoque l'arrêt du script en cas d'erreur. Et nettoye les
 	# 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
 
-	exit 1
+	ynh_die
 }
 
 TRAP_ON () {	# Activate signal capture
@@ -32,7 +32,7 @@ TRAP_OFF () {	# Ignoring signal capture until TRAP_ON
 
 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)
+	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.
@@ -59,14 +59,15 @@ CHECK_FINALPATH () {	# Vérifie que le dossier de destination n'est pas déjà u
 
 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)
+	# 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
-	sudo yunohost app setting $app mysqlpwd -v $db_pwd
+	ynh_app_setting_set $app mysqlpwd $db_pwd
 }
 
 SETUP_SOURCE () {	# Télécharge la source, décompresse et copie dans $final_path
@@ -91,7 +92,7 @@ SETUP_SOURCE () {	# Télécharge la source, décompresse et copie dans $final_pa
 }
 
 ADD_SYS_USER () {   # Créer un utilisateur système dédié à l'app
-        if grep -q "^$app:" /etc/passwd	# Test l'existence de l'utilisateur
+        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
@@ -113,13 +114,13 @@ POOL_FPM () {	# Créer le fichier de configuration du pool php-fpm et le configu
 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 $(sudo md5sum "$2" | cut -d' ' -f1)
+	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 [ "$(sudo yunohost app setting $app $1_file_md5)" != $(sudo md5sum "$2" | cut -d' ' -f1) ]; then
+	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
 }
@@ -164,7 +165,7 @@ REMOVE_LOGROTATE_CONF () {	# Suppression de la configuration de logrotate
 }
 
 SECURE_REMOVE () {      # Suppression de dossier avec vérification des variables
-	chaine="$1"
+	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
@@ -180,8 +181,10 @@ SECURE_REMOVE () {      # Suppression de dossier avec vérification des variable
 	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
@@ -201,7 +204,7 @@ REMOVE_BDD () {	# Suppression de la base de donnée et de l'utilisateur associé
 }
 
 REMOVE_SYS_USER () {   # Supprime l'utilisateur système dédié à l'app
-    if grep -q "^$app:" /etc/passwd	# Test l'existence de l'utilisateur
+    if ynh_system_user_exists "$app"	# Test l'existence de l'utilisateur
     then
     	sudo userdel $app
     fi

scripts/backup

@@ -9,8 +9,8 @@ app=$2
 # Source app helpers
 source /usr/share/yunohost/helpers
 
-domain=$(sudo yunohost app setting $app domain)
+domain=$(ynh_app_setting_get $app domain)
-final_path=$(sudo yunohost app setting $app final_path)
+final_path=$(ynh_app_setting_get $app final_path)
 
 # Copy the app files
 sudo mkdir -p ${backup_dir}/var/www

scripts/install

@@ -39,19 +39,19 @@ if [ "$path" == "/" ] && [ "$multisite" = "Yes" ]; then
 fi
 
 # Enregistre les infos dans la config YunoHost
-sudo yunohost app setting $app domain -v $domain
+ynh_app_setting_set $app domain $domain
-sudo yunohost app setting $app path -v $path
+ynh_app_setting_set $app path $path
-sudo yunohost app setting $app admin -v $admin_wordpress
+ynh_app_setting_set $app admin $admin_wordpress
-sudo yunohost app setting $app is_public -v $is_public
+ynh_app_setting_set $app is_public $is_public
-sudo yunohost app setting $app language -v $language
+ynh_app_setting_set $app language $language
-sudo yunohost app setting $app multisite -v $multisite
+ynh_app_setting_set $app multisite $multisite
 
 GENERATE_DB $app	# 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.
 sudo mkdir "$final_path"
-sudo yunohost app setting $app final_path -v $final_path
+ynh_app_setting_set $app final_path $final_path
 
 
 SETUP_SOURCE "wordpress.tar.gz"	# Télécharge la source, décompresse et copie dans $final_path
@@ -93,7 +93,7 @@ done
 sudo chown -R www-data: $final_path
 
 # Donne un accès public pour curl
-sudo yunohost app setting $app unprotected_uris -v "/"
+ynh_app_setting_set $app unprotected_uris "/"
 # Recharge la configuration Nginx
 sudo service nginx reload
 # Régénère la configuration de SSOwat
@@ -175,7 +175,7 @@ sudo chown root: $final_path/wp-config.php
 if [ "$is_public" = "No" ];
 then
 	# Retire l'accès public
-	sudo yunohost app setting $app unprotected_uris -d
+	ynh_app_setting_delete $app unprotected_uris
 	sudo yunohost app ssowatconf
 fi
 

scripts/remove

@@ -7,7 +7,7 @@ source /usr/share/yunohost/helpers
 
 # Récupère les infos de l'application.
 app=$YNH_APP_INSTANCE_NAME
-domain=$(sudo yunohost app setting $app domain)
+domain=$(ynh_app_setting_get $app domain)
 
 REMOVE_BDD $app	# Suppression de la base de donnée et de l'utilisateur associé.
 

scripts/restore

@@ -11,20 +11,18 @@ app=$2
 source /usr/share/yunohost/helpers
 
 # Get old parameter of the app
-domain=$(sudo yunohost app setting $app domain)
+domain=$(ynh_app_setting_get $app domain)
-path=$(sudo yunohost app setting $app path)
+path=$(ynh_app_setting_get $app path)
-is_public=$(sudo yunohost app setting $app is_public)
+is_public=$(ynh_app_setting_get $app is_public)
-final_path=$(sudo yunohost app setting $app final_path)
+final_path=$(ynh_app_setting_get $app final_path)
 
 if [ -d $final_path ]; then
-    echo "There is already a directory: $final_path " | sudo tee /dev/stderr
+    ynh_die "There is already a directory: $final_path"
-    exit 1
 fi
 
 conf=/etc/nginx/conf.d/$domain.d/$app.conf
 if [ -f $conf ]; then
-    echo "There is already a nginx conf file at this path: $conf " | sudo tee /dev/stderr
+    ynh_die "There is already a nginx conf file at this path: $conf"
-    exit 1
 fi
 # Restore conf files
 sudo cp -a "${backup_dir}/conf/nginx.conf" $conf
@@ -34,7 +32,7 @@ sudo service nginx reload
 
 sudo cp -a "${backup_dir}/var/www/$app" $final_path
 
-db_pwd=$(sudo yunohost app setting $app mysqlpwd)
+db_pwd=$(ynh_app_setting_get $app mysqlpwd)
 db_user=$app
 ynh_mysql_create_db $db_user $db_user $db_pwd
 sudo su -c "mysql -u $db_user -p$db_pwd $app < ${backup_dir}/db.sql"
@@ -57,6 +55,6 @@ sudo service php5-fpm reload
 # Set ssowat config
 if [ "$is_public" = "No" ];
 then
-	sudo yunohost app setting $app skipped_uris -d
+	ynh_app_setting_delete $app skipped_uris
 fi
 sudo yunohost app ssowatconf

scripts/upgrade

@@ -7,13 +7,13 @@ source /usr/share/yunohost/helpers
 
 # Récupère les infos de l'application.
 app=$YNH_APP_INSTANCE_NAME
-domain=$(sudo yunohost app setting $app domain)
+domain=$(ynh_app_setting_get $app domain)
-path=$(sudo yunohost app setting $app path)
+path=$(ynh_app_setting_get $app path)
-admin_wordpress=$(sudo yunohost app setting $app admin)
+admin_wordpress=$(ynh_app_setting_get $app admin)
-language=$(sudo yunohost app setting $app language)
+language=$(ynh_app_setting_get $app language)
-is_public=$(sudo yunohost app setting $app is_public)
+is_public=$(ynh_app_setting_get $app is_public)
-multisite=$(sudo yunohost app setting $app multisite)
+multisite=$(ynh_app_setting_get $app multisite)
-final_path=$(sudo yunohost app setting $app final_path)
+final_path=$(ynh_app_setting_get $app final_path)
 
 CHECK_PATH	# Vérifie et corrige la syntaxe du path.
 
@@ -30,19 +30,19 @@ then
     mysql -u root -p$root_pwd $db_name -e "select MAX(user_login) from wp_users where user_status=0 INTO OUTFILE '/tmp/wordpressuser';"
     admin_wordpress=$(cat /tmp/wordpressuser)
     sudo rm -f /tmp/wordpressuser
-	sudo yunohost app setting $app admin -v $admin_wordpress
+	ynh_app_setting_set $app admin $admin_wordpress
 fi
 
 if [[ "$final_path" = "" ]];
 then
     final_path=/var/www/$app
-	sudo yunohost app setting $app final_path -v $final_path
+	ynh_app_setting_set $app final_path $final_path
 fi
 
 if [[ "$language" = "" ]];
 then
     language=$(sudo grep WPLANG $final_path/wp-config.php | cut -d"'" -f4)
-	sudo yunohost app setting $app language -v $language
+	ynh_app_setting_set $app language $language
 fi
 
 # Copie le fichier de config nginx
@@ -67,7 +67,7 @@ else
 		sudo sed -i "s@//--PUBLIC--define@define@g" $final_path/wp-config.php
 	fi
 fi
-sudo yunohost app setting $app multisite -v $multisite
+ynh_app_setting_set $app multisite $multisite
 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
@@ -77,11 +77,11 @@ sudo chown -R www-data: $final_path
 sudo chown root: $final_path/wp-config.php
 
 
-sudo yunohost app setting $app skipped_uris -d	# Retire le skipped_uris si il existe encore.
+ynh_app_setting_delete $app skipped_uris	# Retire le skipped_uris si il existe encore.
 if [ "$is_public" = "No" ]; then	# Retire l'accès public
-	sudo yunohost app setting $app unprotected_uris -d
+	ynh_app_setting_delete $app unprotected_uris
 else	# Ou remplace le skipped_uris par unprotected_uris le cas échéant.
-	sudo yunohost app setting $app unprotected_uris -v "/"
+	ynh_app_setting_set $app unprotected_uris "/"
 fi
 sudo yunohost app ssowatconf