From 6b63a2ce2feca4550e55f2404e8b18f13ef58fc7 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Wed, 30 Jan 2019 16:19:40 +0100
Subject: [PATCH 1/6] Add progression bar

---
 scripts/_common.sh                   | 78 ++++++++++++++++++++++++++++
 scripts/actions/check_quota          |  8 +++
 scripts/actions/clean_images         |  8 +++
 scripts/actions/clean_ip             |  8 +++
 scripts/actions/public_private       | 14 +++++
 scripts/actions/reset_default_config | 11 ++++
 scripts/backup                       | 12 +++++
 scripts/change_url                   | 15 ++++++
 scripts/install                      | 20 +++++++
 scripts/remove                       | 12 +++++
 scripts/restore                      | 15 ++++++
 scripts/upgrade                      | 22 +++++++-
 12 files changed, 222 insertions(+), 1 deletion(-)

diff --git a/scripts/_common.sh b/scripts/_common.sh
index caf8bc7..278d8c7 100755
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -629,6 +629,84 @@ ynh_clean_check_starting () {
 
 #=================================================
 
+# Print a message as INFO and show progression during an app script
+#
+# usage: ynh_script_progression --message=message [--weight=weight] [--time]
+# | arg: -m, --message= - The text to print
+# | arg: -w, --weight=  - The weight for this progression. This value is 1 by default. Use a bigger value for a longer part of the script.
+# | arg: -t, --time=    - Print the execution time since the last call to this helper. Especially usefull to define weights.
+# | arg: -l, --last=    - Use for the last call of the helper, to fill te progression bar.
+increment_progression=0
+previous_weight=0
+# Define base_time when the file is sourced
+base_time=$(date +%s)
+ynh_script_progression () {
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [m]=message= [w]=weight= [t]=time [l]=last )
+	local message
+	local weight
+	local time
+	local last
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	weight=${weight:-1}
+	time=${time:-0}
+	last=${last:-0}
+
+	# Get execution time since the last $base_time
+	local exec_time=$(( $(date +%s) - $base_time ))
+	base_time=$(date +%s)
+
+	# Get the number of occurrences of 'ynh_script_progression' in the script. Except those are commented.
+	local helper_calls="$(grep --count "^[^#]*ynh_script_progression" $0)"
+	# Get the number of call with a weight value
+	local weight_calls=$(grep --perl-regexp --count "^[^#]*ynh_script_progression.*(--weight|-w )" $0)
+
+	# Get the weight of each occurrences of 'ynh_script_progression' in the script using --weight
+	local weight_valuesA="$(grep --perl-regexp "^[^#]*ynh_script_progression.*--weight" $0 | sed 's/.*--weight[= ]\([[:digit:]].*\)/\1/g')"
+	# Get the weight of each occurrences of 'ynh_script_progression' in the script using -w
+	local weight_valuesB="$(grep --perl-regexp "^[^#]*ynh_script_progression.*-w " $0 | sed 's/.*-w[= ]\([[:digit:]].*\)/\1/g')"
+	# Each value will be on a different line.
+	# Remove each 'end of line' and replace it by a '+' to sum the values.
+	local weight_values=$(( $(echo "$weight_valuesA" | tr '\n' '+') + $(echo "$weight_valuesB" | tr '\n' '+') 0 ))
+
+	# max_progression is a total number of calls to this helper.
+	#    Less the number of calls with a weight value.
+	#    Plus the total of weight values
+	local max_progression=$(( $helper_calls - $weight_calls + $weight_values ))
+
+	# Increment each execution of ynh_script_progression in this script by the weight of the previous call.
+	increment_progression=$(( $increment_progression + $previous_weight ))
+	# Store the weight of the current call in $previous_weight for next call
+	previous_weight=$weight
+
+	# Set the scale of the progression bar
+	local scale=20
+	# progress_string(1,2) should have the size of the scale.
+	local progress_string1="####################"
+	local progress_string0="...................."
+
+	# Reduce $increment_progression to the size of the scale
+	if [ $last -eq 0 ]
+	then
+		local effective_progression=$(( $increment_progression * $scale / $max_progression ))
+	# If last is specified, fill immediately the progression_bar
+	else
+		local effective_progression=$scale
+	fi
+
+	# Build $progression_bar from progress_string(1,2) according to $effective_progression
+	local progression_bar="${progress_string1:0:$effective_progression}${progress_string0:0:$(( $scale - $effective_progression ))}"
+
+	local print_exec_time=""
+	if [ $time -eq 1 ]
+	then
+		print_exec_time=" [$(date +%Hh%Mm,%Ss --date="0 + $exec_time sec")]"
+	fi
+
+	ynh_print_info "[$progression_bar] > ${message}${print_exec_time}"
+}
+
 # Send an email to inform the administrator
 #
 # usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
diff --git a/scripts/actions/check_quota b/scripts/actions/check_quota
index db5c144..627dab3 100755
--- a/scripts/actions/check_quota
+++ b/scripts/actions/check_quota
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
 
@@ -30,5 +31,12 @@ final_path=$(ynh_app_setting_get $app final_path)
 #=================================================
 # CHECK THE DISK QUOTA FOR IMAGES STORED BY LUTIM
 #=================================================
+ynh_script_progression --message="Check the disk quota for images stored by lutim" --weight=9
 
 (cd "$final_path" && $(which carton) exec script/lutim cron watch)
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Execution completed" --last
diff --git a/scripts/actions/clean_images b/scripts/actions/clean_images
index a27a5b9..098fc70 100755
--- a/scripts/actions/clean_images
+++ b/scripts/actions/clean_images
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
 
@@ -30,5 +31,12 @@ final_path=$(ynh_app_setting_get $app final_path)
 #=================================================
 # REMOVE EXPIRED IMAGES
 #=================================================
+ynh_script_progression --message="Remove expired images" --weight=9
 
 (cd "$final_path" && $(which carton) exec script/lutim cron cleanfiles)
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Execution completed" --last
diff --git a/scripts/actions/clean_ip b/scripts/actions/clean_ip
index 45515d0..d40adbf 100755
--- a/scripts/actions/clean_ip
+++ b/scripts/actions/clean_ip
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
 
@@ -30,5 +31,12 @@ final_path=$(ynh_app_setting_get $app final_path)
 #=================================================
 # REMOVE OBSOLETE IP FROM THE DATABASE
 #=================================================
+ynh_script_progression --message="Remove obsolete ip from the database" --weight=9
 
 (cd "$final_path" && $(which carton) exec script/lutim cron cleanbdd)
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Execution completed" --last
diff --git a/scripts/actions/public_private b/scripts/actions/public_private
index 30fb19e..bfb74ae 100755
--- a/scripts/actions/public_private
+++ b/scripts/actions/public_private
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 # Get is_public
 is_public=${YNH_ACTION_IS_PUBLIC}
@@ -40,6 +41,12 @@ fi
 #=================================================
 # MOVE TO PUBLIC OR PRIVATE
 #=================================================
+if [ $is_public -eq 0 ]; then
+	public_private="private"
+else
+	public_private="public"
+fi
+ynh_script_progression --message="Move the application to $public_private" --weight=3
 
 if [ $is_public -eq 0 ]
 then
@@ -64,5 +71,12 @@ ynh_app_setting_set $app is_public $is_public
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reload nginx"
 
 ynh_systemd_action --action=reload --service_name=nginx
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Execution completed" --last
diff --git a/scripts/actions/reset_default_config b/scripts/actions/reset_default_config
index 4fef116..87ad555 100755
--- a/scripts/actions/reset_default_config
+++ b/scripts/actions/reset_default_config
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest" --weight=3
 
 app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
 final_path=$(ynh_app_setting_get $app final_path)
@@ -36,6 +37,7 @@ fi
 #=================================================
 # RESET THE CONFIG FILE
 #=================================================
+ynh_script_progression --message="Reset the config file $config_file" --weight=9
 
 # Verify the checksum and backup the file if it's different
 ynh_backup_if_checksum_is_different "$config_file"
@@ -56,5 +58,14 @@ fi
 # Calculate and store the config file checksum into the app settings
 ynh_store_file_checksum "$config_file"
 
+ynh_script_progression --message="Restart Lutim" --weight=5
+
 # Wait for lutim to be fully started
 ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="/var/log/$app/production.log" --timeout="120"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Execution completed" --last
+
diff --git a/scripts/backup b/scripts/backup
index beee673..920c5f0 100644
--- a/scripts/backup
+++ b/scripts/backup
@@ -19,6 +19,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Load settings" --weight=2
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -30,6 +31,7 @@ domain=$(ynh_app_setting_get $app domain)
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Backup the app main dir" --weight=4
 
 CHECK_SIZE "$final_path"
 ynh_backup "$final_path"
@@ -37,6 +39,7 @@ ynh_backup "$final_path"
 #=================================================
 # BACKUP NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Backup nginx configuration"
 
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 
@@ -45,17 +48,26 @@ ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # BACKUP LOGROTATE
 #=================================================
+ynh_script_progression --message="Backup logrotate configuration"
 
 ynh_backup "/etc/logrotate.d/$app"
 
 #=================================================
 # BACKUP SYSTEMD
 #=================================================
+ynh_script_progression --message="Backup systemd configuration"
 
 ynh_backup "/etc/systemd/system/$app.service"
 
 #=================================================
 # BACKUP A CRON FILE
 #=================================================
+ynh_script_progression --message="Backup cron file"
 
 ynh_backup "/etc/cron.d/$app"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Backup completed" --last
diff --git a/scripts/change_url b/scripts/change_url
index f284e84..c913314 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 old_domain=$YNH_APP_OLD_DOMAIN
 old_path=$YNH_APP_OLD_PATH
@@ -24,6 +25,7 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Load settings" --weight=2
 
 final_path=$(ynh_app_setting_get $app final_path)
 is_public=$(ynh_app_setting_get $app is_public)
@@ -32,6 +34,7 @@ port=$(ynh_app_setting_get $app port)
 #=================================================
 # CHECK THE SYNTAX OF THE PATHS
 #=================================================
+ynh_script_progression --message="Check the syntax of the paths"
 
 test -n "$old_path" || old_path="/"
 test -n "$new_path" || new_path="/"
@@ -41,6 +44,7 @@ old_path=$(ynh_normalize_url_path $old_path)
 #=================================================
 # ACTIVATE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Activate maintenance mode"
 
 path_url=$old_path
 domain=$old_domain
@@ -78,6 +82,7 @@ ynh_abort_if_errors
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
+ynh_script_progression --message="Modify url in nginx configuration" --weight=2
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
@@ -112,6 +117,7 @@ fi
 #=================================================
 # UPDATE SSOWAT
 #=================================================
+ynh_script_progression --message="Reconfigure SSOwat"
 
 if [ $is_public -eq 0 ]
 then
@@ -138,12 +144,14 @@ ynh_replace_string "\(^ *prefix.*=> '\).*" "\1$new_path'," "$final_path/lutim.co
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reload nginx" --weight=2
 
 ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # START AND CHECK LUTIM BOOTING
 #=================================================
+ynh_script_progression --message="Restart Lutim" --weight=3
 
 # Wait for lutim to be fully started
 ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="/var/log/$app/production.log" --timeout="120"
@@ -151,7 +159,14 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Deactive maintenance mode" --weight=5
 
 path_url=$old_path
 domain=$old_domain
 ynh_maintenance_mode_OFF
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Change of url completed" --last
diff --git a/scripts/install b/scripts/install
index e51f0a3..3576004 100644
--- a/scripts/install
+++ b/scripts/install
@@ -24,6 +24,7 @@ ynh_abort_if_errors
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
+ynh_script_progression --message="Retrieve arguments from the manifest"
 
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
@@ -35,6 +36,7 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS
 #=================================================
+ynh_script_progression --message="Check if the app can be installed" --weight=2
 
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
@@ -48,6 +50,7 @@ ynh_webpath_register $app $domain $path_url
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_script_progression --message="Store settings from manifest" --weight=2
 
 ynh_app_setting_set $app domain $domain
 ynh_app_setting_set $app is_public $is_public
@@ -61,6 +64,7 @@ ynh_app_setting_set $app overwrite_systemd "1"
 #=================================================
 # FIND AND OPEN A PORT
 #=================================================
+ynh_script_progression --message="Find a free port" --weight=3
 
 # Find a free port
 port=$(ynh_find_port 8095)
@@ -79,12 +83,14 @@ ynh_setup_source "$final_path"
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
+ynh_script_progression --message="Install dependencies" --weight=60
 
 ynh_install_app_dependencies $app_depencencies
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Configure nginx" --weight=2
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -92,6 +98,7 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Create a dedicated user" --weight=2
 
 # Create a dedicated system user
 ynh_system_user_create $app
@@ -101,6 +108,7 @@ ynh_system_user_create $app
 #=================================================
 # SETUP LUTIM
 #=================================================
+ynh_script_progression --message="Configure Lutim" --weight=2
 
 # Configure Lutim
 cp ../conf/lutim.conf.template "$final_path/lutim.conf"
@@ -117,6 +125,7 @@ ynh_store_file_checksum "$final_path/lutim.conf"
 #=================================================
 # SETUP SYSTEMD
 #=================================================
+ynh_script_progression --message="Configure systemd" --weight=2
 
 # Create a dedicated systemd config
 ynh_add_systemd_config
@@ -132,6 +141,7 @@ chmod +x $final_path/script/lutim
 #=================================================
 # INSTALL LUTIM WITH CARTON
 #=================================================
+ynh_script_progression --message="Install Lutim with Carton" --weight=60
 
 mkdir -p /var/log/$app/
 (cd $final_path
@@ -166,6 +176,7 @@ chown -R $app: $final_path
 #=================================================
 # SETUP LOGROTATE
 #=================================================
+ynh_script_progression --message="Configure logrotate" --weight=2
 
 # Use logrotate to manage application logfile(s)
 ynh_use_logrotate
@@ -179,6 +190,7 @@ yunohost service add lutim -l $final_path/log/production.log
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_script_progression --message="Setup SSOwat"
 
 ynh_app_setting_set $app skipped_uris "/"
 if [ $is_public -eq 0 ]
@@ -196,12 +208,14 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reload nginx" --weight=2
 
 ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # CHECK LUTIM BOOTING
 #=================================================
+ynh_script_progression --message="Restart Lutim" --weight=6
 
 # Wait for lutim to be fully started
 ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="/var/log/$app/production.log" --timeout="120"
@@ -224,3 +238,9 @@ You can also find some specific actions for this app by using the experimental a
 If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
 
 ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="install"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Installation completed" --last
diff --git a/scripts/remove b/scripts/remove
index 36e6234..346dc92 100644
--- a/scripts/remove
+++ b/scripts/remove
@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Load settings" --weight=2
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -22,6 +23,7 @@ domain=$(ynh_app_setting_get $app domain)
 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================
+ynh_script_progression --message="Stop and remove the service" --weight=6
 
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
@@ -40,6 +42,7 @@ fi
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
+ynh_script_progression --message="Remove dependencies" --weight=20
 
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
@@ -47,6 +50,7 @@ ynh_remove_app_dependencies
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Remove app main directory" --weight=2
 
 # Remove the app directory securely
 ynh_secure_remove "/var/www/$app"
@@ -54,6 +58,7 @@ ynh_secure_remove "/var/www/$app"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Remove nginx configuration"
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -61,6 +66,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE LOGROTATE CONFIGURATION
 #=================================================
+ynh_script_progression --message="Remove logrotate configuration"
 
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
@@ -72,3 +78,9 @@ ynh_remove_logrotate
 #=================================================
 
 ynh_secure_remove "/etc/cron.d/$app"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Deletion completed" --last
diff --git a/scripts/restore b/scripts/restore
index 67b9af7..f00c438 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -25,6 +25,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Load settings" --weight=2
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -44,6 +45,7 @@ test ! -d $final_path \
 #=================================================
 # ACTIVATE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Activate maintenance mode" --weight=2
 
 ynh_maintenance_mode_ON
 
@@ -58,12 +60,14 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Restore the app main directory"
 
 ynh_restore_file "$final_path"
 
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Recreate the dedicated user" --weight=2
 
 # Create the dedicated user (if not existing)
 ynh_system_user_create $app
@@ -80,6 +84,7 @@ chown -R $app: $final_path
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
+ynh_script_progression --message="Reinstall dependencies" --weight=60
 
 ynh_install_app_dependencies $app_depencencies
 
@@ -92,6 +97,7 @@ yunohost service add $app --log "/var/log/$app/APP.log"
 #=================================================
 # RESTORE SYSTEMD
 #=================================================
+ynh_script_progression --message="Restore the systemd configuration"
 
 ynh_restore_file "/etc/systemd/system/$app.service"
 systemctl enable $app.service
@@ -122,12 +128,14 @@ ynh_restore_file "/etc/logrotate.d/$app"
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reload nginx" --weight=2
 
 ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # START AND CHECK LUTIM BOOTING
 #=================================================
+ynh_script_progression --message="Restart Lutim" --weight=3
 
 # Wait for lutim to be fully started
 ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="/var/log/$app/production.log" --timeout="120"
@@ -135,6 +143,7 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Deactive maintenance mode" --weight=7
 
 ynh_maintenance_mode_OFF
 
@@ -153,3 +162,9 @@ You can also find some specific actions for this app by using the experimental a
 If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
 
 ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="restore"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Restoration completed" --last
diff --git a/scripts/upgrade b/scripts/upgrade
index 2cc37e7..b2db90b 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -14,6 +14,7 @@ source _variables
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Load settings" --weight=4
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -41,6 +42,7 @@ upgrade_type=$(ynh_check_app_version_changed)
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
+ynh_script_progression --message="Ensure downward compatibility" --weight=2
 
 # Fix is_public as a boolean
 if [ "$is_public" = "Yes" ]; then
@@ -94,6 +96,7 @@ fi
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
+ynh_script_progression --message="Backup the app before upgrading" --weight=15
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -116,6 +119,7 @@ path_url=$(ynh_normalize_url_path $path_url)
 #=================================================
 # ACTIVATE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Activate maintenance mode" --weight=2
 
 ynh_maintenance_mode_ON
 
@@ -127,6 +131,7 @@ ynh_maintenance_mode_ON
 
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
+	ynh_script_progression --message="Download, check and unpack source"
 	# Download, check integrity, uncompress and patch the source from app.src
 	ynh_setup_source "$final_path"
 fi
@@ -134,6 +139,7 @@ fi
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
+ynh_script_progression --message="Upgrade dependencies" --weight=9
 
 ynh_install_app_dependencies $app_depencencies
 
@@ -144,12 +150,14 @@ ynh_install_app_dependencies $app_depencencies
 # Overwrite the nginx configuration only if it's allowed
 if [ $overwrite_nginx -eq 1 ]
 then
+	ynh_script_progression --message="Reconfigure nginx" --weight=2
 	ynh_add_nginx_config
 fi
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Create a dedicated user"
 
 # Create a dedicated user (if not existing)
 ynh_system_user_create $app
@@ -159,6 +167,7 @@ ynh_system_user_create $app
 #=================================================
 # SETUP LUTIM
 #=================================================
+ynh_script_progression --message="Reconfigure Lutim"
 
 # Overwrite the settings config file only if it's allowed
 if [ $overwrite_settings -eq 1 ]
@@ -195,6 +204,7 @@ fi
 # Overwrite the systemd configuration only if it's allowed
 if [ $overwrite_systemd -eq 1 ]
 then
+	ynh_script_progression --message="Reconfigure systemd" --weight=2
 	ynh_add_systemd_config
 fi
 
@@ -211,6 +221,7 @@ ynh_replace_string "__FINALPATH__" "$final_path/" /etc/cron.d/$app
 
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
+	ynh_script_progression --message="Upgrade Lutim with carton" --weight=4
 	(cd $final_path
 	carton install 2>&1 | tee -a "/var/log/$app/setup_carton.log")
 fi
@@ -227,6 +238,7 @@ chown -R $app: $final_path
 #=================================================
 # SETUP LOGROTATE
 #=================================================
+ynh_script_progression --message="Reconfigure logrotate"
 
 ynh_use_logrotate --non-append
 chown $app -R /var/log/$app
@@ -234,6 +246,7 @@ chown $app -R /var/log/$app
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_script_progression --message="Reconfigure SSOwat"
 
 ynh_app_setting_set $app skipped_uris "/"
 if [ $is_public -eq 0 ]
@@ -247,12 +260,14 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reload nginx"
 
 ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # START AND CHECK LUTIM BOOTING
 #=================================================
+ynh_script_progression --message="Restart Lutim" --weight=4
 
 # Wait for lutim to be fully started
 ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="/var/log/$app/production.log" --timeout="120"
@@ -260,6 +275,7 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
+ynh_script_progression --message="Deactive maintenance mode" --weight=7
 
 ynh_maintenance_mode_OFF
 
@@ -277,4 +293,8 @@ You can also find some specific actions for this app by using the experimental a
 
 If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="upgrade"
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Upgrade completed" --last

From 746d00174c3fde429f64b514d4f113b01780e701 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Wed, 30 Jan 2019 19:27:17 +0100
Subject: [PATCH 2/6] Changelog & html email

---
 config_panel.json  |  11 ++++
 scripts/_common.sh | 125 +++++++++++++++++++++++++++++++++++++++++++--
 scripts/config     |  11 ++++
 scripts/install    |  12 +++--
 scripts/restore    |  10 ++--
 scripts/upgrade    |  18 +++++--
 6 files changed, 168 insertions(+), 19 deletions(-)

diff --git a/config_panel.json b/config_panel.json
index dbd2a9e..48b376d 100644
--- a/config_panel.json
+++ b/config_panel.json
@@ -63,6 +63,17 @@
 				"type": "bool",
 				"default": true
 			}]
+		},
+		{
+			"name": "Global configuration",
+			"id": "global_config",
+			"options": [{
+				"name": "Send HTML email to admin ?",
+				"help": "Allow app scripts to send HTML mails instead of plain text.",
+				"id": "email_type",
+				"type": "bool",
+				"default": true
+			}]
 		}]
 	}
 ]
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 278d8c7..e1d5b28 100755
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -710,7 +710,7 @@ ynh_script_progression () {
 # Send an email to inform the administrator
 #
 # usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
-# | arg: -m --app_message= - The message to send to the administrator.
+# | arg: -m --app_message= - The file with the content to send to the administrator.
 # | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
 #	example: "root admin@domain"
 #	If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
@@ -723,11 +723,16 @@ ynh_send_readme_to_admin() {
 	local recipients
 	local type
 	# Manage arguments with getopts
+
 	ynh_handle_getopts_args "$@"
-	app_message="${app_message:-...No specific information...}"
+	app_message="${app_message:-}"
 	recipients="${recipients:-root}"
 	type="${type:-install}"
 
+	# Get the value of admin_mail_html
+	admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
+	admin_mail_html="${admin_mail_html:-0}"
+
 	# Retrieve the email of users
 	find_mails () {
 		local list_mails="$1"
@@ -774,12 +779,53 @@ ynh_send_readme_to_admin() {
 
 Specific information for the application $app.
 
-$app_message
+$(if [ -n "$app_message" ]
+then
+	cat "$app_message"
+else
+	echo "...No specific information..."
+fi)
 
 ---
 Automatic diagnosis data from YunoHost
 
-$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
+__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__"
+
+	# Store the message into a file for further modifications.
+	echo "$mail_message" > mail_to_send
+
+	# If a html email is required. Apply html tags to the message.
+ 	if [ "$admin_mail_html" -eq 1 ]
+ 	then
+		# Insert 'br' tags at each ending of lines.
+		ynh_replace_string "$" "<br>" mail_to_send
+
+		# Insert starting HTML tags
+		sed --in-place '1s@^@<!DOCTYPE html>\n<html>\n<head></head>\n<body>\n@' mail_to_send
+
+		# Keep tabulations
+		ynh_replace_string "  " "\&#160;\&#160;" mail_to_send
+		ynh_replace_string "\t" "\&#160;\&#160;" mail_to_send
+
+		# Insert url links tags
+		ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
+
+		# Insert pre tags
+		ynh_replace_string "__PRE_TAG1__" "<pre>" mail_to_send
+		ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
+
+		# Insert finishing HTML tags
+		echo -e "\n</body>\n</html>" >> mail_to_send
+
+	# Otherwise, remove tags to keep a plain text.
+	else
+		# Remove URL tags
+		ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
+		ynh_replace_string "__URL_TAG2__" ": " mail_to_send
+
+		# Remove PRE tags
+		ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
+	fi
 
 	# Define binary to use for mail command
 	if [ -e /usr/bin/bsd-mailx ]
@@ -789,8 +835,15 @@ $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
 		local mail_bin=/usr/bin/mail.mailutils
 	fi
 
+	if [ "$admin_mail_html" -eq 1 ]
+	then
+		content_type="text/html"
+	else
+		content_type="text/plain"
+	fi
+
 	# Send the email to the recipients
-	echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
+	cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
 }
 
 #=================================================
@@ -961,3 +1014,65 @@ ynh_download_file () {
 	# Move the file to its destination
 	mv $filename $dest_dir
 }
+
+#=================================================
+
+# Create a changelog for an app after an upgrade.
+#
+# The changelog is printed into the file ./changelog for the time of the upgrade.
+#
+# In order to create a changelog, ynh_app_changelog will get info from /etc/yunohost/apps/$app/status.json
+# In order to find the current commit use by the app.
+# The remote repository, and the branch.
+# The changelog will be only the commits since the current revision.
+#
+# Because of the need of those info, ynh_app_changelog works only
+# with apps that have been installed from a list.
+#
+# usage: ynh_app_changelog
+ynh_app_changelog () {
+	get_value_from_settings ()
+	{
+		local value="$1"
+		# Extract a value from the status.json file of an installed app.
+
+		grep "$value\": \"" /etc/yunohost/apps/$app/status.json | sed "s/.*$value\": \"\([^\"]*\).*/\1/"
+	}
+
+	local current_revision="$(get_value_from_settings revision)"
+	local repo="$(get_value_from_settings url)"
+	local branch="$(get_value_from_settings branch)"
+	# ynh_app_changelog works only with an app installed from a list.
+	if [ -z "$current_revision" ] || [ -z "$repo" ] || [ -z "$branch" ]
+	then
+		ynh_print_warn "Unable to build the changelog..."
+		touch changelog
+		return 0
+	fi
+
+	# Fetch the history of the repository, without cloning it
+	mkdir git_history
+	(cd git_history
+	ynh_exec_warn_less git init
+	ynh_exec_warn_less git remote add -f origin $repo
+	# Get the line of the current commit of the installed app in the history.
+	local line_to_head=$(git log origin/$branch --pretty=oneline | grep --line-number "$current_revision" | cut -d':' -f1)
+	# Cut the history before the current commit, to keep only newer commits.
+	# Then use sed to reorganise each lines and have a nice list of commits since the last upgrade.
+	# This list is redirected into the file changelog
+	git log origin/$branch --pretty=oneline | head --lines=$(($line_to_head-1)) | sed 's/^\([[:alnum:]]*\)\(.*\)/*(\1) -> \2/g' > ../changelog)
+	# Remove 'Merge pull request' commits
+	sed -i '/Merge pull request #[[:digit:]]* from/d' changelog
+	# As well as conflict resolving commits
+	sed -i '/Merge branch .* into/d' changelog
+
+	# Get the value of admin_mail_html
+	admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
+	admin_mail_html="${admin_mail_html:-0}"
+
+	# If a html email is required. Apply html to the changelog.
+ 	if [ "$admin_mail_html" -eq 1 ]
+ 	then
+		sed -in-place "s@\*(\([[:alnum:]]*\)) -> \(.*\)@* __URL_TAG1__\2__URL_TAG2__${repo}/commit/\1__URL_TAG3__@g" changelog
+ 	fi
+}
diff --git a/scripts/config b/scripts/config
index eb80f2b..c7a776c 100644
--- a/scripts/config
+++ b/scripts/config
@@ -82,6 +82,11 @@ old_overwrite_systemd="$(ynh_app_setting_get $app overwrite_systemd)"
 old_overwrite_systemd=$(bool_to_true_false $old_overwrite_systemd)
 overwrite_systemd="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_SYSTEMD:-$old_overwrite_systemd}"
 
+# Type of admin mail configuration
+old_admin_mail_html="$(ynh_app_setting_get $app admin_mail_html)"
+old_admin_mail_html=$(bool_to_true_false $old_admin_mail_html)
+admin_mail_html="${YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE:-$old_admin_mail_html}"
+
 #=================================================
 # SHOW_CONFIG FUNCTION FOR 'SHOW' COMMAND
 #=================================================
@@ -99,6 +104,8 @@ show_config() {
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_SETTINGS=$overwrite_settings"
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_NGINX=$overwrite_nginx"
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_SYSTEMD=$overwrite_systemd"
+
+	echo "YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE=$admin_mail_html"
 }
 
 #=================================================
@@ -171,6 +178,10 @@ apply_config() {
 	# Set overwrite_systemd
 	overwrite_systemd=$(bool_to_01 $overwrite_systemd)
 	ynh_app_setting_set $app overwrite_systemd "$overwrite_systemd"
+
+	# Set admin_mail_html
+	admin_mail_html=$(bool_to_01 $admin_mail_html)
+	ynh_app_setting_set $app admin_mail_html "$admin_mail_html"
 }
 
 #=================================================
diff --git a/scripts/install b/scripts/install
index 3576004..6f8df9e 100644
--- a/scripts/install
+++ b/scripts/install
@@ -55,9 +55,11 @@ ynh_script_progression --message="Store settings from manifest" --weight=2
 ynh_app_setting_set $app domain $domain
 ynh_app_setting_set $app is_public $is_public
 ynh_app_setting_set $app always_encrypt $always_encrypt
+
 ynh_app_setting_set $app overwrite_settings "1"
 ynh_app_setting_set $app overwrite_nginx "1"
 ynh_app_setting_set $app overwrite_systemd "1"
+ynh_app_setting_set $app admin_mail_html "1"
 
 #=================================================
 # STANDARD MODIFICATIONS
@@ -230,14 +232,14 @@ chown -R $app: $final_path
 # Get main domain and buid the url of the admin panel of the app.
 admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
 
-message="You can find a config file at $final_path/lutim.conf
+echo "You can find a config file at $final_path/lutim.conf
 
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
 
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/lutim_ynh__URL_TAG3__." > mail_to_send
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="install"
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="install"
 
 #=================================================
 # END OF SCRIPT
diff --git a/scripts/restore b/scripts/restore
index f00c438..1ecbf84 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -154,14 +154,14 @@ ynh_maintenance_mode_OFF
 # Get main domain and buid the url of the admin panel of the app.
 admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
 
-message="You can find a config file at $final_path/lutim.conf
+echo "You can find a config file at $final_path/lutim.conf
 
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
 
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/lutim_ynh__URL_TAG3__." > mail_to_send
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="restore"
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="restore"
 
 #=================================================
 # END OF SCRIPT
diff --git a/scripts/upgrade b/scripts/upgrade
index b2db90b..158f18e 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -286,12 +286,22 @@ ynh_maintenance_mode_OFF
 # Get main domain and buid the url of the admin panel of the app.
 admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
 
-message="You can find a config file at $final_path/lutim.conf
+# Build the changelog
+ynh_app_changelog || true
 
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+echo "You can find a config file at $final_path/lutim.conf
 
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/lutim_ynh"
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
+
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/lutim_ynh__URL_TAG3__.
+
+---
+
+Changelog since your last upgrade:
+$(cat changelog)" > mail_to_send
+
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="upgrade"
 
 #=================================================
 # END OF SCRIPT

From 827de3dfe6677794f896e56abaad6ca178068598 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Wed, 30 Jan 2019 19:58:36 +0100
Subject: [PATCH 3/6] Require ynh 3.4

---
 manifest.json      |   4 +-
 scripts/_common.sh | 229 +--------------------------------------------
 2 files changed, 6 insertions(+), 227 deletions(-)

diff --git a/manifest.json b/manifest.json
index 0db6258..90a4a5d 100644
--- a/manifest.json
+++ b/manifest.json
@@ -6,7 +6,7 @@
 		"en": "Self hosting images and sharing anonymous application",
 		"fr": "Application d'hébergement et de partage d'images anonyme"
 	},
-	"version": "0.11.4~ynh1",
+	"version": "0.11.4~ynh2",
 	"url": "https://lut.im",
 	"license": "AGPL-3.0",
 	"maintainer": {
@@ -14,7 +14,7 @@
 		"email": "maniackc_dev@crudelis.fr"
 	},
 	"requirements": {
-		"yunohost": ">= 3.3.3"
+		"yunohost": ">= 3.4"
 	},
 	"multi_instance": false,
 	"services": [
diff --git a/scripts/_common.sh b/scripts/_common.sh
index e1d5b28..e74bc0f 100755
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -52,210 +52,6 @@ bool_to_true_false () {
 # FUTUR OFFICIAL HELPERS
 #=================================================
 
-# Internal helper design to allow helpers to use getopts to manage their arguments
-#
-# [internal]
-#
-# example: function my_helper()
-# {
-#     declare -Ar args_array=( [a]=arg1= [b]=arg2= [c]=arg3 )
-#     local arg1
-#     local arg2
-#     local arg3
-#     ynh_handle_getopts_args "$@"
-#
-#     [...]
-# }
-# my_helper --arg1 "val1" -b val2 -c
-#
-# usage: ynh_handle_getopts_args "$@"
-# | arg: $@    - Simply "$@" to tranfert all the positionnal arguments to the function
-#
-# This helper need an array, named "args_array" with all the arguments used by the helper
-# 	that want to use ynh_handle_getopts_args
-# Be carreful, this array has to be an associative array, as the following example:
-# declare -Ar args_array=( [a]=arg1 [b]=arg2= [c]=arg3 )
-# Let's explain this array:
-# a, b and c are short options, -a, -b and -c
-# arg1, arg2 and arg3 are the long options associated to the previous short ones. --arg1, --arg2 and --arg3
-# For each option, a short and long version has to be defined.
-# Let's see something more significant
-# declare -Ar args_array=( [u]=user [f]=finalpath= [d]=database )
-#
-# NB: Because we're using 'declare' without -g, the array will be declared as a local variable.
-#
-# Please keep in mind that the long option will be used as a variable to store the values for this option.
-# For the previous example, that means that $finalpath will be fill with the value given as argument for this option.
-#
-# Also, in the previous example, finalpath has a '=' at the end. That means this option need a value.
-# So, the helper has to be call with --finalpath /final/path, --finalpath=/final/path or -f /final/path, the variable $finalpath will get the value /final/path
-# If there's many values for an option, -f /final /path, the value will be separated by a ';' $finalpath=/final;/path
-# For an option without value, like --user in the example, the helper can be called only with --user or -u. $user will then get the value 1.
-#
-# To keep a retrocompatibility, a package can still call a helper, using getopts, with positional arguments.
-# The "legacy mode" will manage the positional arguments and fill the variable in the same order than they are given in $args_array.
-# e.g. for `my_helper "val1" val2`, arg1 will be filled with val1, and arg2 with val2.
-ynh_handle_getopts_args () {
-	# Manage arguments only if there's some provided
-	set +x
-	if [ $# -ne 0 ]
-	then
-		# Store arguments in an array to keep each argument separated
-		local arguments=("$@")
-
-		# For each option in the array, reduce to short options for getopts (e.g. for [u]=user, --user will be -u)
-		# And built parameters string for getopts
-		# ${!args_array[@]} is the list of all option_flags in the array (An option_flag is 'u' in [u]=user, user is a value)
-		local getopts_parameters=""
-		local option_flag=""
-		for option_flag in "${!args_array[@]}"
-		do
-			# Concatenate each option_flags of the array to build the string of arguments for getopts
-			# Will looks like 'abcd' for -a -b -c -d
-			# If the value of an option_flag finish by =, it's an option with additionnal values. (e.g. --user bob or -u bob)
-			# Check the last character of the value associate to the option_flag
-			if [ "${args_array[$option_flag]: -1}" = "=" ]
-			then
-				# For an option with additionnal values, add a ':' after the letter for getopts.
-				getopts_parameters="${getopts_parameters}${option_flag}:"
-			else
-				getopts_parameters="${getopts_parameters}${option_flag}"
-			fi
-			# Check each argument given to the function
-			local arg=""
-			# ${#arguments[@]} is the size of the array
-			for arg in `seq 0 $(( ${#arguments[@]} - 1 ))`
-			do
-				# And replace long option (value of the option_flag) by the short option, the option_flag itself
-				# (e.g. for [u]=user, --user will be -u)
-				# Replace long option with =
-				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]}/-${option_flag} }"
-				# And long option without =
-				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]%=}/-${option_flag}}"
-			done
-		done
-
-		# Read and parse all the arguments
-		# Use a function here, to use standart arguments $@ and be able to use shift.
-		parse_arg () {
-			# Read all arguments, until no arguments are left
-			while [ $# -ne 0 ]
-			do
-				# Initialize the index of getopts
-				OPTIND=1
-				# Parse with getopts only if the argument begin by -, that means the argument is an option
-				# getopts will fill $parameter with the letter of the option it has read.
-				local parameter=""
-				getopts ":$getopts_parameters" parameter || true
-
-				if [ "$parameter" = "?" ]
-				then
-					ynh_die --message="Invalid argument: -${OPTARG:-}"
-				elif [ "$parameter" = ":" ]
-				then
-					ynh_die --message="-$OPTARG parameter requires an argument."
-				else
-					local shift_value=1
-					# Use the long option, corresponding to the short option read by getopts, as a variable
-					# (e.g. for [u]=user, 'user' will be used as a variable)
-					# Also, remove '=' at the end of the long option
-					# The variable name will be stored in 'option_var'
-					local option_var="${args_array[$parameter]%=}"
-					# If this option doesn't take values
-					# if there's a '=' at the end of the long option name, this option takes values
-					if [ "${args_array[$parameter]: -1}" != "=" ]
-					then
-						# 'eval ${option_var}' will use the content of 'option_var'
-						eval ${option_var}=1
-					else
-						# Read all other arguments to find multiple value for this option.
-						# Load args in a array
-						local all_args=("$@")
-
-						# If the first argument is longer than 2 characters,
-						# There's a value attached to the option, in the same array cell
-						if [ ${#all_args[0]} -gt 2 ]; then
-							# Remove the option and the space, so keep only the value itself.
-							all_args[0]="${all_args[0]#-${parameter} }"
-							# Reduce the value of shift, because the option has been removed manually
-							shift_value=$(( shift_value - 1 ))
-						fi
-
-						# Declare the content of option_var as a variable.
-						eval ${option_var}=""
-						# Then read the array value per value
-						local i
-						for i in `seq 0 $(( ${#all_args[@]} - 1 ))`
-						do
-							# If this argument is an option, end here.
-							if [ "${all_args[$i]:0:1}" == "-" ]
-							then
-								# Ignore the first value of the array, which is the option itself
-								if [ "$i" -ne 0 ]; then
-									break
-								fi
-							else
-								# Else, add this value to this option
-								# Each value will be separated by ';'
-								if [ -n "${!option_var}" ]
-								then
-									# If there's already another value for this option, add a ; before adding the new value
-									eval ${option_var}+="\;"
-								fi
-								eval ${option_var}+=\"${all_args[$i]}\"
-								shift_value=$(( shift_value + 1 ))
-							fi
-						done
-					fi
-				fi
-
-				# Shift the parameter and its argument(s)
-				shift $shift_value
-			done
-		}
-
-		# LEGACY MODE
-		# Check if there's getopts arguments
-		if [ "${arguments[0]:0:1}" != "-" ]
-		then
-			# If not, enter in legacy mode and manage the arguments as positionnal ones..
-			# Dot not echo, to prevent to go through a helper output. But print only in the log.
-			set -x; echo "! Helper used in legacy mode !" > /dev/null; set +x
-			local i
-			for i in `seq 0 $(( ${#arguments[@]} -1 ))`
-			do
-				# Try to use legacy_args as a list of option_flag of the array args_array
-				# Otherwise, fallback to getopts_parameters to get the option_flag. But an associative arrays isn't always sorted in the correct order...
-				# Remove all ':' in getopts_parameters
-				getopts_parameters=${legacy_args:-${getopts_parameters//:}}
-				# Get the option_flag from getopts_parameters, by using the option_flag according to the position of the argument.
-				option_flag=${getopts_parameters:$i:1}
-				if [ -z "$option_flag" ]; then
-						ynh_print_warn --message="Too many arguments ! \"${arguments[$i]}\" will be ignored."
-						continue
-				fi
-				# Use the long option, corresponding to the option_flag, as a variable
-				# (e.g. for [u]=user, 'user' will be used as a variable)
-				# Also, remove '=' at the end of the long option
-				# The variable name will be stored in 'option_var'
-				local option_var="${args_array[$option_flag]%=}"
-
-				# Store each value given as argument in the corresponding variable
-				# The values will be stored in the same order than $args_array
-				eval ${option_var}+=\"${arguments[$i]}\"
-			done
-			unset legacy_args
-		else
-			# END LEGACY MODE
-			# Call parse_arg and pass the modified list of args as an array of arguments.
-			parse_arg "${arguments[@]}"
-		fi
-	fi
-	set -x
-}
-
-#=================================================
-
 # Install or update the main directory yunohost.multimedia
 #
 # usage: ynh_multimedia_build_main_dir
@@ -517,27 +313,6 @@ ynh_check_app_version_changed () {
 
 #=================================================
 
-# Delete a file checksum from the app settings
-#
-# $app should be defined when calling this helper
-#
-# usage: ynh_remove_file_checksum file
-# | arg: -f, --file= - The file for which the checksum will be deleted
-ynh_delete_file_checksum () {
-	# Declare an array to define the options of this helper.
-	declare -Ar args_array=( [f]=file= )
-	local file
-	# Manage arguments with getopts
-	ynh_handle_getopts_args "$@"
-
-	local checksum_setting_name=checksum_${file//[\/ ]/_}	# Replace all '/' and ' ' by '_'
-	ynh_app_setting_delete $app $checksum_setting_name
-}
-
-#=================================================
-# EXPERIMENTAL HELPERS
-#=================================================
-
 # Start (or other actions) a service,  print a log in case of failure and optionnaly wait until the service is completely started
 #
 # usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
@@ -707,6 +482,10 @@ ynh_script_progression () {
 	ynh_print_info "[$progression_bar] > ${message}${print_exec_time}"
 }
 
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
 # Send an email to inform the administrator
 #
 # usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]

From 5ebc66ef883230fd25c3e39e3015a19a51a63988 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Thu, 31 Jan 2019 11:35:05 +0100
Subject: [PATCH 4/6] Typo fix

---
 scripts/change_url | 2 +-
 scripts/restore    | 2 +-
 scripts/upgrade    | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/scripts/change_url b/scripts/change_url
index c913314..af83bee 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -159,7 +159,7 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
-ynh_script_progression --message="Deactive maintenance mode" --weight=5
+ynh_script_progression --message="Disable maintenance mode" --weight=5
 
 path_url=$old_path
 domain=$old_domain
diff --git a/scripts/restore b/scripts/restore
index 1ecbf84..c9070d7 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -143,7 +143,7 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
-ynh_script_progression --message="Deactive maintenance mode" --weight=7
+ynh_script_progression --message="Disable maintenance mode" --weight=7
 
 ynh_maintenance_mode_OFF
 
diff --git a/scripts/upgrade b/scripts/upgrade
index 158f18e..b69aab3 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -275,7 +275,7 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path="
 #=================================================
 # DEACTIVE MAINTENANCE MODE
 #=================================================
-ynh_script_progression --message="Deactive maintenance mode" --weight=7
+ynh_script_progression --message="Disable maintenance mode" --weight=7
 
 ynh_maintenance_mode_OFF
 

From 0c2af89b610a420129588e62537bb248d7810777 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Thu, 31 Jan 2019 11:53:22 +0100
Subject: [PATCH 5/6] Do not open port

---
 scripts/install | 2 --
 scripts/upgrade | 6 ++++++
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/scripts/install b/scripts/install
index 6f8df9e..13bf9b4 100644
--- a/scripts/install
+++ b/scripts/install
@@ -70,8 +70,6 @@ ynh_script_progression --message="Find a free port" --weight=3
 
 # Find a free port
 port=$(ynh_find_port 8095)
-# Open this port
-ynh_exec_fully_quiet yunohost firewall allow --no-upnp TCP $port
 ynh_app_setting_set $app port $port
 
 #=================================================
diff --git a/scripts/upgrade b/scripts/upgrade
index b69aab3..7cf4ce0 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -93,6 +93,12 @@ if [ -z "$secret" ]; then
 	ynh_app_setting_set $app secret $secret
 fi
 
+# Close opened port
+if yunohost firewall list | grep -q "\- $port$"
+then
+	ynh_exec_quiet yunohost firewall disallow TCP $port
+fi
+
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================

From f9d7f124f0966870004aa620ac4626dd8ebb19ff Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackc_dev@crudelis.fr>
Date: Thu, 31 Jan 2019 11:53:55 +0100
Subject: [PATCH 6/6] Delete dedicated user

---
 scripts/remove | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/scripts/remove b/scripts/remove
index 346dc92..611f6d3 100644
--- a/scripts/remove
+++ b/scripts/remove
@@ -79,6 +79,16 @@ ynh_remove_logrotate
 
 ynh_secure_remove "/etc/cron.d/$app"
 
+#=================================================
+# GENERIC FINALISATION
+#=================================================
+# REMOVE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Remove the dedicated user" --weight=5
+
+# Delete dedicated system user
+ynh_system_user_delete $app
+
 #=================================================
 # END OF SCRIPT
 #=================================================