Reprise globale du package

check_process

@@ -12,13 +12,8 @@
 		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
@@ -32,18 +27,15 @@
 		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
 ;;; Levels
 	Level 1=auto
 	Level 2=auto
 	Level 3=auto
+# Level 4: Pas de gestion des utilisateurs
 	Level 4=na
+# Level 5: https://github.com/YunoHost-Apps/minidlna_ynh/issues/2
 	Level 5=1
 	Level 6=auto
 	Level 7=auto

manifest.json

@@ -10,7 +10,7 @@
 		"fr": "Serveur DLNA léger pour partager les fichiers multimédia sur le réseau local"
 	},
 	"url": "http://minidlna.sourceforge.net/",
-	"license": "free",
+	"license": "GPLv2",
 	"maintainer": {
 		"name": "Maniack Crudelis",
 		"email": "maniackc_dev@crudelis.fr"

scripts/.fonctions

@@ -1,103 +1,86 @@
 #!/bin/bash
 
-CHECK_VAR () {	# Vérifie que la variable n'est pas vide.
+#=================================================
-# $1 = Variable à vérifier
+# CHECKING
-# $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)
+	ynh_user_exists "$1" || ynh_die "Wrong user"
-}
-
-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
+	sudo yunohost app checkurl $domain$path_url -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" ]
+	test ! -e "$final_path" || ynh_die "This path already contains a folder"
-	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
+# DISPLAYING
-	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.
+NO_PRINT () {	# Supprime l'affichage dans stdout pour la commande en argument.
-# 	db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20)
+	set +x
-	db_pwd=$(ynh_string_random)
+	$@
-	CHECK_VAR "$db_pwd" "db_pwd empty"
+	set -x
-	# 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
 }
 
+WARNING () {	# Écrit sur le canal d'erreur pour passer en warning.
+	$@ >&2
+}
+
+SUPPRESS_WARNING () {	# Force l'écriture sur la sortie standard
+	$@ 2>&1
+}
+
+QUIET () {	# Redirige la sortie standard dans /dev/null
+	$@ > /dev/null
+}
+
+ALL_QUIET () {	# Redirige la sortie standard et d'erreur dans /dev/null
+	$@ > /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.
+	src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2)
-	wget -nv -i ../sources/source_url -O $1
+	src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2)
+	# Download sources from the upstream
+	wget -nv -O source.tar.gz $src_url
 	# 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)
+	echo "$src_checksum source.tar.gz" | md5sum -c --status || ynh_die "Corrupt source"
-	# Décompresse la source
+	# Extract source into the app dir
-	if [ "$(echo ${1##*.})" == "gz" ]; then
+	sudo mkdir -p $final_path
-		tar -x -f $1
+	sudo tar -x -f source.tar.gz -C $final_path --strip-components 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
+SETUP_SOURCE_ZIP () {	# Télécharge la source, décompresse et copie dans $final_path
-        if ! ynh_system_user_exists "$app"	# Test l'existence de l'utilisateur
+	src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2)
-        then
+	src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2)
-            sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || (echo "Unable to create $app system account" >&2 && false)
+	# Download sources from the upstream
-        fi
+	wget -nv -O source.zip $src_url
+	# Vérifie la somme de contrôle de la source téléchargée.
+	echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source"
+	# Extract source into the app dir
+	sudo mkdir -p $final_path
+	temp_dir=$(mktemp -d)
+	unzip -quo source.zip -d $temp_dir	# On passe par un dossier temporaire car unzip ne permet pas d'ignorer le dossier parent.
+	sudo cp -a $temp_dir/*/. $final_path
+	rm -r $temp_dir
+	# Copie les fichiers additionnels ou modifiés.
+	if test -e "../sources/ajouts"; then
+		sudo cp -a ../sources/ajouts/. "$final_path"
+	fi
 }
 
 POOL_FPM () {	# Créer le fichier de configuration du pool php-fpm et le configure.
@@ -110,9 +93,123 @@ POOL_FPM () {	# Créer le fichier de configuration du pool php-fpm et le configu
 	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
+	sudo systemctl reload php5-fpm
 }
 
+YNH_CURL () {
+	data_post=$1
+	url_access=$2
+	sleep 1
+	curl -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 --data "$data_post" "https://localhost$path_url$url_access" 2>&1
+}
+
+#=================================================
+# 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 systemctl reload nginx
+	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 systemctl reload php5-fpm
+}
+
+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
+}
+
+#=================================================
+# BACKUP
+#=================================================
+
+BACKUP_FAIL_UPGRADE () {
+	WARNING echo "Upgrade failed."
+	app_bck=${app//_/-}	# Replace all '_' by '-'
+	if sudo yunohost backup list | grep -q $app_bck-pre-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_bck-pre-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
+	app_bck=${app//_/-}	# Replace all '_' by '-'
+	if sudo yunohost backup list | grep -q $app_bck-pre-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_bck-pre-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 sudo yunohost backup list | grep -q $app_bck-pre-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_bck-pre-upgrade$old_backup_number
+		fi
+	else	# Si le backup a échoué
+		ynh_die "Backup failed, the upgrade process was aborted."
+	fi
+}
+
+HUMAN_SIZE () {	# Transforme une taille en Ko en une taille lisible pour un humain
+	human=$(numfmt --to=iec --from-unit=1K $1)
+	echo $human
+}
+
+CHECK_SIZE () {	# Vérifie avant chaque backup que l'espace est suffisant
+	file_to_analyse=$1
+	backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1)
+	free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d)
+
+	if [ $free_space -le $backup_size ]
+	then
+		WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse."
+		WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)"
+		ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)"
+	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.
@@ -127,87 +224,278 @@ 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
+# FUTUR YNH HELPERS
-		port=$((port+1))
+#=================================================
-	done
+# Importer ce fichier de fonction avant celui des helpers officiel
-	CHECK_VAR "$port" "port empty"
+# 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
+}
 
-### REMOVE SCRIPT
+# 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_NGINX_CONF () {	# Suppression de la configuration nginx
+# Remove a database if it exist and the associated user
-	if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then	# Delete nginx config
+#
-		echo "Delete nginx config"
+# usage: ynh_mysql_remove_db user name
-		sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
+# | arg: user - Proprietary of the database
-		sudo service nginx reload
+# | 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
 }
 
-REMOVE_FPM_CONF () {	# Suppression de la configuration du pool php-fpm
+# Correct the name given in argument for mariadb
-	if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then	# Delete fpm config
+#
-		echo "Delete fpm config"
+# Avoid invalid name for your database
-		sudo rm "/etc/php5/fpm/pool.d/$app.conf"
+#
-	fi
+# Exemple: dbname=$(ynh_make_valid_dbid $app)
-	if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then	# Delete php config
+#
-		echo "Delete php config"
+# usage: ynh_make_valid_dbid name
-		sudo rm "/etc/php5/fpm/conf.d/20-$app.ini"
+# | arg: name - name to correct
-	fi
+# | ret: the corrected name
-	sudo service php5-fpm reload
+ynh_make_valid_dbid () {
+	dbid=${1//[-.]/_}	# Mariadb doesn't support - and . in the name of databases. It will be replace by _
+	echo $dbid
 }
 
-REMOVE_LOGROTATE_CONF () {	# Suppression de la configuration de logrotate
+# Manage a fail of the script
+#
+# Print a warning to inform that the script was failed
+# Execute the ynh_clean_setup function if used in the app script
+#
+# usage of ynh_clean_setup function
+# This function provide a way to clean some residual of installation that not managed by remove script.
+# To use it, simply add in your script:
+# ynh_clean_setup () {
+#        instructions...
+# }
+# This function is optionnal.
+#
+# Usage: ynh_exit_properly is used only by the helper ynh_check_error.
+# You must not use it directly.
+ynh_exit_properly () {
+	exit_code=$?
+	if [ "$exit_code" -eq 0 ]; then
+			exit 0	# Exit without error if the script ended correctly
+	fi
+
+	trap '' EXIT	# Ignore new exit signals
+	set +eu	# Do not exit anymore if a command fail or if a variable is empty
+
+	echo -e "!!\n  $app's script has encountered an error. Its execution was cancelled.\n!!" >&2
+
+	if type -t ynh_clean_setup > /dev/null; then	# Check if the function exist in the app script.
+		ynh_clean_setup	# Call the function to do specific cleaning for the app.
+	fi
+
+	ynh_die	# Exit with error status
+}
+
+# Exit if an error occurs during the execution of the script.
+#
+# Stop immediatly the execution if an error occured or if a empty variable is used.
+# The execution of the script is derivate to ynh_exit_properly function before exit.
+#
+# Usage: ynh_abort_if_errors
+ynh_abort_if_errors () {
+	set -eu	# Exit if a command fail, and if a variable is used unset.
+	trap ynh_exit_properly EXIT	# Capturing exit signals on shell script
+}
+
+# Install dependencies with a equivs control file
+#
+# usage: ynh_install_app_dependencies dep [dep [...]]
+# | arg: dep - the package name to install in dependence
+ynh_install_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 '-'
+
+    if ynh_package_is_installed "${dep_app}-ynh-deps"; then
+		echo "A package named ${dep_app}-ynh-deps is already installed" >&2
+    else
+		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
+		ynh_app_setting_set $app apt_dependencies $dependencies
+	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.
+}
+
+# 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 [ "$#" -gt 0 ]; 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
+	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 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
+# Find a free port and return it
-	chaine="$1"	# L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables.
+#
-	no_var=0
+# example: port=$(ynh_find_port 8080)
-	while (echo "$chaine" | grep -q '\$')	# Boucle tant qu'il y a des $ dans la chaine
+#
+# 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
+		port=$((port+1))	# Else, pass to next port
-		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 ]
+	echo $port
-	then
+}
-		if [ -e "$chaine" ]; then
+
-			echo "Delete directory $chaine"
+# Create a system user
-			sudo rm -r "$chaine"
+#
+# usage: ynh_system_user_create user_name [home_dir]
+# | arg: user_name - Name of the system user that will be create
+# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home
+ynh_system_user_create () {
+	if ! ynh_system_user_exists "$1"	# Check if the user exists on the system
+	then	# If the user doesn't exist
+		if [ $# -ge 2 ]; then	# If a home dir is mentioned
+			user_home_dir="-d $2"
+		else
+			user_home_dir="--no-create-home"
 		fi
-		return 0
+		sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account"
-	else
-		echo "No detected variable." >&2
-		return 1
 	fi
 }
 
-REMOVE_BDD () {	# Suppression de la base de donnée et de l'utilisateur associé.
+# Delete a system user
-# $1 = Nom de la base de donnée
+#
-	# Utilise '$app' comme nom d'utilisateur et de base de donnée
+# usage: ynh_system_user_delete user_name
-	db_user=$1
+# | arg: user_name - Name of the system user that will be create
-	if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then
+ynh_system_user_delete () {
-		echo "Delete db"
+    if ynh_system_user_exists "$1"	# Check if the user exists on the system
-		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
+		echo "Remove the user $1" >&2
+		sudo userdel $1
+	else
+		echo "The user $1 was not found" >&2
     fi
 }

scripts/backup

@@ -1,24 +1,54 @@
 #!/bin/bash
 
-# Récupère les infos de l'application.
+#=================================================
-app=$YNH_APP_INSTANCE_NAME
+# GENERIC STARTING
+#=================================================
+# MANAGE FAILURE OF THE SCRIPT
+#=================================================
 
-# Source app helpers
+# Exit on command errors and treat unset variables as an error
+set -eu
+
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+if [ ! -e .fonctions ]; then
+	# Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant
+	sudo cp ../settings/scripts/.fonctions ./.fonctions
+	sudo chmod a+rx .fonctions
+fi
+source .fonctions
 source /usr/share/yunohost/helpers
 
+#=================================================
+# LOAD SETTINGS
+#=================================================
+
+app=$YNH_APP_INSTANCE_NAME
+
 version=$(ynh_app_setting_get $app version)
-port=$(ynh_app_setting_get $app port)
 
-
+#=================================================
-# The parameter $1 is the backup directory location
+# SPECIFIC BACKUP
-# which will be compressed afterward
+#=================================================
-backup_dir=$1/apps/$app
+# BACKUP OF THE APT SOURCE
-sudo mkdir -p "$backup_dir"
+#=================================================
 
 # Copie des fichiers spécifiques à l'application
 if [ $version = "B" ]
 then
-	sudo cp -a /etc/apt/sources.list.d/minidlna.list $backup_dir/
+	ynh_backup /etc/apt/sources.list.d/minidlna.list minidlna.list
 fi
-sudo cp -a /etc/sysctl.d/90-inotify_minidlna.conf $backup_dir/
+
-sudo cp -a /etc/minidlna.conf $backup_dir/
+#=================================================
+# BACKUP OF THE INOTIFY'S CONFIG
+#=================================================
+
+ynh_backup /etc/sysctl.d/90-inotify_minidlna.conf inotify
+
+#=================================================
+# BACKUP OF THE CONFIG OF MINIDLNA
+#=================================================
+
+ynh_backup /etc/minidlna.conf minidlna.conf

scripts/install

@@ -1,46 +1,67 @@
 #!/bin/bash
 
-source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-CLEAN_SETUP () {
+source .fonctions
-# 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
-version=$YNH_APP_ARG_VERSION
-
-app=$YNH_APP_INSTANCE_NAME
-
-# Source app helpers
 source /usr/share/yunohost/helpers
 
-# Vérifie que les variables ne sont pas vides.
+#=================================================
-CHECK_VAR "$app" "app name not set"
+# MANAGE FAILURE OF THE SCRIPT
+#=================================================
 
+ynh_abort_if_errors	# Active trap pour arrêter le script si une erreur est détectée.
 
-FIND_PORT 48200	# Cherche un port libre.
+#=================================================
+# RETRIEVE ARGUMENTS FROM THE MANIFEST
+#=================================================
+
+version=$YNH_APP_ARG_VERSION
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# CHECK THE DEBIAN'S CODENAME
+#=================================================
+
+codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2)
+test -z "$codename" && (ynh_die "codename empty")
+
+#=================================================
+# STANDARD MODIFICATIONS
+#=================================================
+# FIND AND OPEN A PORT
+#=================================================
+
+port=$(ynh_find_port 48200)	# Cherche un port libre.
 
 # Ouvre les ports dans le firewall
-sudo yunohost firewall allow --no-upnp TCP $port > /dev/null 2>&1
+ALL_QUIET sudo yunohost firewall allow --no-upnp TCP $port
-sudo yunohost firewall allow --no-upnp UDP 1900 > /dev/null 2>&1	# Découverte SSDP pour UPNP.
+ALL_QUIET sudo yunohost firewall allow --no-upnp UDP 1900	# Découverte SSDP pour UPNP.
+ynh_app_setting_set $app port $port
 
 # Enregistre les infos dans la config YunoHost
 ynh_app_setting_set $app version ${version:0:1}
-ynh_app_setting_set $app port $port
 
-# Création du dossier yunohost.multimedia
+#=================================================
-wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
+# CREATE YUNOHOST.MULTIMEDIA DIRECTORY
+#=================================================
+
+wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 
+#=================================================
+# SPECIFIC SETUP
+#=================================================
+# INSTALL MINIDLNA
+#=================================================
+
 # Installation du paquet minidlna et ses dépendances
 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
@@ -49,15 +70,28 @@ else	# Installation de la version minidlna des dépots courants.
 	sudo apt-get update
 	sudo apt-get -y install minidlna
 fi
+ynh_app_setting_set $app version ${version:0:1}
+
+#=================================================
+# INCREASE INOTIFY'S LIMITS
+#=================================================
 
 # Augmentation du nombre maximum de fichiers surveillés par inotify.
 sudo cp -a ../conf/90-inotify_minidlna.conf /etc/sysctl.d/
 # Et rechargement de la config du noyau.
 sudo sysctl --system
 
+#=================================================
+# ENABLE SERVICE IN ADMIN PANEL
+#=================================================
+
 # Ajoute le service au monitoring de Yunohost.
 sudo yunohost service add minidlna --log "/var/log/minidlna.log"
 
+#=================================================
+# CONFIGURE MINIDLNA
+#=================================================
+
 # Modifie la configuration de minidlna
 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
@@ -65,8 +99,9 @@ sudo sed -i "s/^#*friendly_name=.*/friendly_name=Yunohost DLNA/" /etc/minidlna.c
 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
+# RESTART MINIDLNA'S SERVICE
+#=================================================
 
-# Régénère la configuration de SSOwat
+# Redémarre minidlna pour prendre en compte la nouvelle configuration
-sudo yunohost app ssowatconf
+sudo systemctl restart minidlna

scripts/remove

@@ -1,27 +1,57 @@
 #!/bin/bash
 
-source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Récupère les infos de l'application.
+source .fonctions
-app=$YNH_APP_INSTANCE_NAME
-
-# Source app helpers
 source /usr/share/yunohost/helpers
 
+#=================================================
+# LOAD SETTINGS
+#=================================================
+
+app=$YNH_APP_INSTANCE_NAME
+
 port=$(ynh_app_setting_get $app port)
 
+#=================================================
+# STANDARD REMOVE
+#=================================================
+# DISABLE SERVICE IN ADMIN PANEL
+#=================================================
+
+# Retire le service du monitoring de Yunohost.
+if sudo yunohost service status | grep -q minidlna	# Test l'existence du service dans Yunohost
+then
+	echo "Remove minidlna service"
+	sudo yunohost service remove minidlna
+fi
+
+#=================================================
+# CLOSE THE PORTS
+#=================================================
+
 # Ferme les ports dans le firewall
 if sudo yunohost firewall list | grep -q "\- $port$"
 then
 	echo "Close port $port"
-	sudo yunohost firewall disallow TCP $port > /dev/null
+	QUIET sudo yunohost firewall disallow TCP $port
 fi
 if sudo yunohost firewall list | grep -q "\- 1900$"
 then
 	echo "Close port 1900"
-	sudo yunohost firewall disallow UDP 1900 > /dev/null
+	QUIET sudo yunohost firewall disallow UDP 1900
 fi
 
+#=================================================
+# SPECIFIC REMOVE
+#=================================================
+# REMOVE MINIDNLA
+#=================================================
+
 # Suppression du paquet minidlna
 if [ -e "/usr/sbin/minidlnad" ] || [ -e "/usr/bin/minidlnad" ]; then
 	echo "Remove minidlna package"
@@ -32,6 +62,10 @@ if [ -e "/etc/apt/sources.list.d/minidlna.list" ]; then
 	sudo rm "/etc/apt/sources.list.d/minidlna.list"
 fi
 
+#=================================================
+# REMOVE INOTIFY'S CONFIG
+#=================================================
+
 # Suppression du paramètre inotify pour minidlna.
 if [ -e "/etc/sysctl.d/90-inotify_minidlna.conf" ]; then
 	echo "Delete kernel config"
@@ -39,21 +73,3 @@ if [ -e "/etc/sysctl.d/90-inotify_minidlna.conf" ]; then
 	# Et rechargement de la config du noyau.
 	sudo sysctl --system
 fi
-
-# Retire le service du monitoring de Yunohost.
-if sudo yunohost service status | grep -q minidlna	# Test l'existence du service dans Yunohost
-then
-	echo "Remove minidlna service"
-	sudo yunohost service remove minidlna
-fi
-
-# Suppression des log
-if [ -e "/var/log/minidlna.log" ]; then
-	echo "Delete log"
-	sudo rm "/var/log/minidlna.log"
-fi
-
-# Régénère la configuration de SSOwat
-sudo yunohost app ssowatconf
-
-echo -e "\e[0m"	# Restore normal color

scripts/restore

@@ -1,31 +1,60 @@
 #!/bin/bash
 
-# Récupère les infos de l'application.
+#=================================================
-app=$YNH_APP_INSTANCE_NAME
+# GENERIC STARTING
+#=================================================
+# MANAGE FAILURE OF THE SCRIPT
+#=================================================
 
-# Source app helpers
+# Exit on command errors and treat unset variables as an error
+set -eu
+
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+if [ ! -e .fonctions ]; then
+	# Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant
+	sudo cp ../settings/scripts/.fonctions ./.fonctions
+	sudo chmod a+rx .fonctions
+fi
+source .fonctions
 source /usr/share/yunohost/helpers
 
+#=================================================
+# LOAD SETTINGS
+#=================================================
+
+app=$YNH_APP_INSTANCE_NAME
+
 version=$(ynh_app_setting_get $app version)
 port=$(ynh_app_setting_get $app port)
 
-# The parameter $1 is the uncompressed restore directory location
+#=================================================
-backup_dir=$1/apps/$app
+# SPECIFIC RESTORE
+#=================================================
+# OPEN PORTS
+#=================================================
 
-# Ouvre les ports dans le firewall
 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.
+sudo yunohost firewall allow --no-upnp UDP 1900	 > /dev/null 2>&1 # Découverte SSDP pour UPNP.
+
+#=================================================
+# CREATE YUNOHOST.MULTIMEDIA DIRECTORY
+#=================================================
 
-# Création du dossier yunohost.multimedia
 wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 
-# Installation du paquet minidlna et ses dépendances
+#=================================================
+# INSTALL MINIDLNA
+#=================================================
+
 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)
-	sudo cp -a $backup_dir/minidlna.list /etc/apt/sources.list.d/
+	sudo cp -a ./minidlna.list /etc/apt/sources.list.d/
 	sudo sed -i "s@ [a-z]*-backports@ $codename-backports@g" /etc/apt/sources.list.d/minidlna.list
 	sudo apt-get update
 	sudo apt-get -t $codename-backports -y install minidlna
@@ -34,14 +63,19 @@ else	# Installation de la version minidlna des dépots courants.
 	sudo apt-get -y install minidlna
 fi
 
-# Copie des fichiers spécifiques à l'application
+#=================================================
-sudo cp -a $backup_dir/90-inotify_minidlna.conf /etc/sysctl.d/
+# RESTORE INOTIFY'S CONFIG
+#=================================================
+
+sudo cp -a ./inotify /etc/sysctl.d/90-inotify_minidlna.conf
 sudo sysctl --system
 
-sudo cp -a $backup_dir/minidlna.conf /etc/
+sudo cp -a ./minidlna.conf /etc/
-sudo service minidlna restart
+sudo systemctl restart minidlna
+
+#=================================================
+# ENABLE SERVICE IN ADMIN PANEL
+#=================================================
 
 # Ajoute le service au monitoring de Yunohost.
 sudo yunohost service add minidlna --log "/var/log/minidlna.log"
-
-sudo yunohost app ssowatconf

scripts/upgrade

@@ -1,22 +1,45 @@
 #!/bin/bash
 
-source .fonctions	# Charge les fonctions génériques habituellement utilisées dans le script
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Récupère les infos de l'application.
+source .fonctions
-app=$YNH_APP_INSTANCE_NAME
-
-# Source app helpers
 source /usr/share/yunohost/helpers
 
+#=================================================
+# LOAD SETTINGS
+#=================================================
+
+app=$YNH_APP_INSTANCE_NAME
+
 version=$(ynh_app_setting_get $app version)
 port=$(ynh_app_setting_get $app port)
 
-# Mise à jour du dossier yunohost.multimedia
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+
+BACKUP_BEFORE_UPGRADE	# Backup the current version of the app
+ynh_clean_setup () {
+	BACKUP_FAIL_UPGRADE	# restore it if the upgrade fails
+}
+ynh_abort_if_errors	# Active trap pour arrêter le script si une erreur est détectée.
+
+#=================================================
+# UPGRADE THE YUNOHOST.MULTIMEDIA DIRECTORY
+#=================================================
+
 wget -nv https://github.com/maniackcrudelis/yunohost.multimedia/archive/master.zip
 unzip master.zip
 sudo ./yunohost.multimedia-master/script/ynh_media_build.sh
 
-# Mise à jour éventuelle du paquet minidlna
+#=================================================
+# UPGRADE MINIDLNA
+#=================================================
+
 if [ $version = "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)
@@ -29,14 +52,26 @@ else	# Installation de la version minidlna des dépots courants.
 	sudo apt-get -y install minidlna
 fi
 
+#=================================================
+# INCREASE INOTIFY'S LIMITS
+#=================================================
+
 # Augmentation du nombre maximum de fichiers surveillés par inotify.
 sudo cp -a ../conf/90-inotify_minidlna.conf /etc/sysctl.d/
 # Et rechargement de la config du noyau.
 sudo sysctl --system
 
+#=================================================
+# ENABLE SERVICE IN ADMIN PANEL
+#=================================================
+
 # Ajoute le service au monitoring de Yunohost.
 sudo yunohost service add minidlna --log "/var/log/minidlna.log"
 
+#=================================================
+# CONFIGURE MINIDLNA
+#=================================================
+
 # 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
@@ -44,8 +79,9 @@ 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
 
-# Redémarre minidlna pour prendre en compte la nouvelle configuration
+#=================================================
-sudo service minidlna restart
+# RESTART MINIDLNA'S SERVICE
+#=================================================
 
-# Régénère la configuration de SSOwat
+# Redémarre minidlna pour prendre en compte la nouvelle configuration
-sudo yunohost app ssowatconf
+sudo systemctl restart minidlna