Revert "Revert "New .fonctions""

scripts/.fonctions

@@ -1,107 +1,80 @@
 #!/bin/bash
 
+#=================================================
+# CHECKING
+#=================================================
+
 ynh_version="2.4"
 
 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)
+CHECK_USER () {	# Vérifie la validité de l'user admin
+# $1 = Variable de l'user admin.
+	ynh_user_exists "$1" || ynh_die "Wrong user"
 }
 
-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
-
-	ynh_die
+CHECK_DOMAINPATH () {	# Vérifie la disponibilité du path et du domaine.
+	sudo yunohost app checkurl $domain$path_url -a $app
 }
 
-TRAP_ON () {	# Activate signal capture
-	trap EXIT_PROPERLY ERR	# Capturing exit signals on error
+CHECK_FINALPATH () {	# Vérifie que le dossier de destination n'est pas déjà utilisé.
+	final_path=/var/www/$app
+	test ! -e "$final_path" || ynh_die "This path already contains a folder"
 }
 
-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
-}
+#=================================================
+# DISPLAYING
+#=================================================
 
-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)
+NO_PRINT () {	# Supprime l'affichage dans stdout pour la commande en argument.
+	set +x
+	eval "$@"
+	set -x
 }
 
-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
+WARNING () {	# Écrit sur le canal d'erreur pour passer en warning.
+	eval "$@" >&2
 }
 
-CHECK_DOMAINPATH () {	# Vérifie la disponibilité du path et du domaine.
-	sudo yunohost app checkurl $domain$path -a $app
+SUPPRESS_WARNING () {	# Force l'écriture sur la sortie standard
+	eval "$@" 2>&1
 }
 
-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
+QUIET () {	# Redirige la sortie standard dans /dev/null
+	eval "$@" > /dev/null
 }
 
-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
-	ynh_app_setting_set $app mysqlpwd $db_pwd
+ALL_QUIET () {	# Redirige la sortie standard et d'erreur dans /dev/null
+	eval "$@" > /dev/null 2>&1
 }
 
+#=================================================
+# SETUP
+#=================================================
+
 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
+	src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d= -f2)
+	src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2)
+	# Download sources from the upstream
+	wget -nv -O source.zip $src_url
 	# Vérifie la somme de contrôle de la source téléchargée.
-	md5sum -c ../sources/source_md5 --status
-	sudo unzip -q $1 -d $final_path
-}
-
-EXTRACT_SOURCE() {
-  local DESTDIR=$1
-    
-  # retrieve and extract Prestashop Zip File
-  rc_tarball="${DESTDIR}/prestashop.zip"
-  sudo wget -q -O "$rc_tarball" "$PRESTASHOP_SOURCE_URL" \
-    || ynh_die "Unable to download source tarball"
-  sudo unzip "$rc_tarball" "$DESTDIR" \
-    || ynh_die "Unable to extract source tarball"
-  sudo rm "$rc_tarball"
+	echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source"
+	# Extract source into the app dir
+	sudo mkdir -p $final_path
+	sudo mv source.zip $final_path/source.zip
+	pushd $final_path
+	sudo unzip source.zip
+	sudo rm Install_PrestaShop.html index.php
+	sudo unzip prestashop.zip
+	sudo rm prestashop.zip
 }
 
 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
@@ -111,6 +84,107 @@ POOL_FPM () {	# Créer le fichier de configuration du pool php-fpm et le configu
 	sudo service php5-fpm reload
 }
 
+YNH_CURL () {
+	data_post=$1
+	url_access=$2
+	sleep 1
+	SUPPRESS_WARNING curl -kL -H \"Host: $domain\" --resolve $domain:443:127.0.0.1 --data \"$data_post\" \"https://localhost$path_url$url_access\"
+}
+
+#=================================================
+# REMOVE
+#=================================================
+
+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
+}
+
+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
+			WARNING echo "Variable $only_var is empty, suppression of $chaine cancelled."
+			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
+		WARNING echo "No detected variable."
+		return 1
+	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
+}
+
+#=================================================
+# BACKUP
+#=================================================
+
+BACKUP_FAIL_UPGRADE () {
+	WARNING echo "Upgrade failed."
+	if ALL_QUIET sudo yunohost backup list | grep -q $app-before-upgrade$backup_number; then	# Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer
+		sudo yunohost app remove $app	# Supprime l'application avant de la restaurer.
+		sudo yunohost backup restore --ignore-hooks $app-before-upgrade$backup_number --apps $app --force	# Restore the backup if upgrade failed
+		ynh_die "The app was restored to the way it was before the failed upgrade."
+	fi
+}
+
+BACKUP_BEFORE_UPGRADE () {	# Backup the current version of the app, restore it if the upgrade fails
+	backup_number=1
+	old_backup_number=2
+	if ALL_QUIET sudo yunohost backup list | grep -q $app-before-upgrade1; then	# Vérifie l'existence d'une archive déjà numéroté à 1.
+		backup_number=2	# Et passe le numéro de l'archive à 2
+		old_backup_number=1
+	fi
+
+	sudo yunohost backup create --ignore-hooks --apps $app --name $app-before-upgrade$backup_number	# Créer un backup différent de celui existant.
+	if [ "$?" -eq 0 ]; then	# Si le backup est un succès, supprime l'archive précédente.
+		if ALL_QUIET sudo yunohost backup list | grep -q $app-before-upgrade$old_backup_number; then	# Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur.
+			QUIET sudo yunohost backup delete $app-before-upgrade$old_backup_number
+		fi
+	else	# Si le backup a échoué
+		ynh_die "Backup failed, the upgrade process was aborted."
+	fi
+}
+
+#=================================================
+# CONFIGURATION
+#=================================================
+
 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.
@@ -125,13 +199,93 @@ CHECK_MD5_CONFIG () {	# Créé un backup du fichier de config si il a été modi
 	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"
+
+#=================================================
+#=================================================
+# FUTUR YNH HELPERS
+#=================================================
+# Importer ce fichier de fonction avant celui des helpers officiel
+# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant
+#=================================================
+
+# Ignore the yunohost-cli log to prevent errors with conditionals commands
+# usage: ynh_no_log COMMAND
+# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command
+# It's a very badly hack...
+ynh_no_log() {
+  ynh_cli_log=/var/log/yunohost/yunohost-cli.log
+  sudo cp -a ${ynh_cli_log} ${ynh_cli_log}-move
+  eval $@
+  exit_code=$?
+  sudo mv ${ynh_cli_log}-move ${ynh_cli_log}
+  return $?
+}
+
+# Normalize the url path syntax
+# Handle the slash at the beginning of path and its absence at ending
+# Return a normalized url path
+#
+# example: url_path=$(ynh_normalize_url_path $url_path)
+#          ynh_normalize_url_path example -> /example
+#          ynh_normalize_url_path /example -> /example
+#          ynh_normalize_url_path /example/ -> /example
+#
+# usage: ynh_normalize_url_path path_to_normalize
+# | arg: url_path_to_normalize - URL path to normalize before using it
+ynh_normalize_url_path () {
+	path_url=$1
+	test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing."
+	if [ "${path_url:0:1}" != "/" ]; then    # If the first character is not a /
+		path_url="/$path_url"    # Add / at begin of path variable
+	fi
+	if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then    # If the last character is a / and that not the only character.
+		path_url="${path_url:0:${#path_url}-1}"	# Delete the last character
+	fi
+	echo $path_url
+}
+
+# Create a database, an user and its password. Then store the password in the app's config
+#
+# User of database will be store in db_user's variable.
+# Name of database will be store in db_name's variable.
+# And password in db_pwd's variable.
+#
+# usage: ynh_mysql_generate_db user name
+# | arg: user - Owner of the database
+# | arg: name - Name of the database
+ynh_mysql_generate_db () {
+	db_pwd=$(ynh_string_random)	# Generate a random password
+	ynh_mysql_create_db "$2" "$1" "$db_pwd"	# Create the database
+	ynh_app_setting_set $app mysqlpwd $db_pwd	# Store the password in the app's config
+}
+
+# Remove a database if it exist and the associated user
+#
+# usage: ynh_mysql_remove_db user name
+# | arg: user - Proprietary of the database
+# | arg: name - Name of the database
+ynh_mysql_remove_db () {
+	if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $2"; then	# Check if the database exist
+		echo "Remove database $2" >&2
+		ynh_mysql_drop_db $2	# Remove the database
+		ynh_mysql_drop_user $1	# Remove the associated user to database
+	else
+		echo "Database $2 not found" >&2
+	fi
+}
+
+# Correct the name given in argument for mariadb
+#
+# Avoid invalid name for your database
+#
+# Exemple: dbname=$(ynh_make_valid_dbid $app)
+#
+# usage: ynh_make_valid_dbid name
+# | arg: name - name to correct
+# | ret: the corrected name
+ynh_make_valid_dbid () {
+	dbid=${1//[-.]/_}	# Mariadb doesn't support - and . in the name of databases. It will be replace by _
+	echo $dbid
 }
 
 # Manage a fail of the script
@@ -178,71 +332,108 @@ ynh_check_error () {
 	trap ynh_exit_properly EXIT	# Capturing exit signals on shell script
 }
 
+# Install dependencies with a equivs control file
+#
+# usage: ynh_app_dependencies dep [dep [...]]
+# | arg: dep - the package name to install in dependence
+ynh_app_dependencies () {
+    dependencies=$@
+    manifest_path="../manifest.json"
+    if [ ! -e "$manifest_path" ]; then
+    	manifest_path="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
+    fi
+    version=$(sudo python3 -c "import sys, json;print(json.load(open(\"$manifest_path\"))['version'])")	# Retrieve the version number in the manifest file.
+    dep_app=${app//_/-}	# Replace all '_' by '-'
+    cat > ./${dep_app}-ynh-deps.control << EOF	# Make a control file for equivs-build
+Section: misc
+Priority: optional
+Package: ${dep_app}-ynh-deps
+Version: ${version}
+Depends: ${dependencies}
+Architecture: all
+Description: Fake package for ${app} (YunoHost app) dependencies
+ This meta-package is only responsible of installing its dependencies.
+EOF
+    ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \
+        || ynh_die "Unable to install dependencies"	# Install the fake package and its dependencies
+}
 
-### 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 fake package and its dependencies
+#
+# Dependencies will removed only if no other package need them.
+#
+# usage: ynh_remove_app_dependencies
+ynh_remove_app_dependencies () {
+    dep_app=${app/_/-}	# Replace all '_' by '-'
+    ynh_package_autoremove ${dep_app}-ynh-deps	# Remove the fake package and its dependencies if they not still used.
 }
 
-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"
+# Use logrotate to manage the logfile
+#
+# usage: ynh_use_logrotate [logfile]
+# | arg: logfile - absolute path of logfile
+#
+# If no argument provided, a standard directory will be use. /var/log/${app}
+# You can provide a path with the directory only or with the logfile.
+# /parentdir/logdir/
+# /parentdir/logdir/logfile.log
+#
+# It's possible to use this helper several times, each config will added to same logrotate config file.
+ynh_use_logrotate () {
+	if [ -n "$1" ]; then
+		if [ "$(echo ${1##*.})" == "log" ]; then	# Keep only the extension to check if it's a logfile
+			logfile=$1	# In this case, focus logrotate on the logfile
+		else
+			logfile=$1/.log	# Else, uses the directory and all logfile into it.
+		fi
+	else
+		logfile="/var/log/${app}/.log" # Without argument, use a defaut directory in /var/log
 	fi
-	sudo service php5-fpm reload
+	cat > ./${app}-logrotate << EOF	# Build a config file for logrotate
+$logfile {
+		# Rotate if the logfile exceeds 100Mo
+	size 100M
+		# Keep 12 old log maximum
+	rotate 12
+		# Compress the logs with gzip
+	compress
+		# Compress the log at the next cycle. So keep always 2 non compressed logs
+	delaycompress
+		# Copy and truncate the log to allow to continue write on it. Instead of move the log.
+	copytruncate
+		# Do not do an error if the log is missing
+	missingok
+		# Not rotate if the log is empty
+	notifempty
+		# Keep old logs in the same dir
+	noolddir
+}
+EOF
+	sudo mkdir -p $(dirname "$logfile")	# Create the log directory, if not exist
+	cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null	# Append this config to the others for this app. If a config file already exist
 }
 
-REMOVE_LOGROTATE_CONF () {	# Suppression de la configuration de logrotate
+# Remove the app's logrotate config.
+#
+# usage: ynh_remove_logrotate
+ynh_remove_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
+# Find a free port and return it
+#
+# example: port=$(ynh_find_port 8080)
+#
+# usage: ynh_find_port begin_port
+# | arg: begin_port - port to start to search
+ynh_find_port () {
+	port=$1
+	test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port."
+	while netcat -z 127.0.0.1 $port       # Check if the port is free
 	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.
+		port=$((port+1))	# Else, pass to next port
 	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
+	echo $port
 }
-
-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/install

@@ -81,11 +81,12 @@ sudo mkdir "$final_path"
 sudo chown -R www-data: $final_path
 
 #=================================================
-# Download, check and unpack source
+# DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 
+final_path=/var/www/$app
 ynh_app_setting_set $app final_path $final_path
-SETUP_SOURCE  "prestashop_1.7.0.5.zip" # Télécharge la source, décompresse et copie dans $final_path
+SETUP_SOURCE	# Télécharge la source, décompresse et copie dans $final_path
 
 #=================================================
 # Installation de Prestashop