Merge branch 'stretch-unstable' into add_ynh_systemd_action

bin/yunohost-api

@@ -149,6 +149,11 @@ def _init_moulinette(use_websocket=True, debug=False, verbose=False):
                 'handlers': [],
                 'propagate': True,
             },
+            'gnupg': {
+                'level': 'INFO',
+                'handlers': [],
+                'propagate': False,
+            },
         },
         'root': {
             'level': level,

data/helpers.d/backend

@@ -1,9 +1,11 @@
+#!/bin/bash
+
 # Use logrotate to manage the logfile
 #
-# usage: ynh_use_logrotate [logfile] [--non-append|--append] [specific_user/specific_group]
-# | arg: logfile - absolute path of logfile
-# | arg: --non-append - (Option) Replace the config file instead of appending this new config.
-# | arg: specific_user : run logrotate as the specified user and group. If not specified logrotate is runned as root.
+# usage: ynh_use_logrotate [--logfile=/log/file] [--nonappend] [--specific_user=user/group]
+# | arg: -l, --logfile= - absolute path of logfile
+# | arg: -n, --nonappend - (Option) Replace the config file instead of appending this new config.
+# | arg: -u, --specific_user : run logrotate as the specified user and group. If not specified logrotate is runned as root.
 #
 # 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.
@@ -13,28 +15,53 @@
 # It's possible to use this helper several times, each config will be added to the same logrotate config file.
 # Unless you use the option --non-append
 ynh_use_logrotate () {
-	local customtee="tee -a"
-	local user_group="${3:-}"
+	# Declare an array to define the options of this helper.
+	local legacy_args=lnuya
+	declare -Ar args_array=( [l]=logfile= [n]=nonappend [u]=specific_user= [y]=non [a]=append )
+	# [y]=non [a]=append are only for legacy purpose, to not fail on the old option '--non-append'
+	local logfile
+	local nonappend
+	local specific_user
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	local logfile="${logfile:-}"
+	local nonappend="${nonappend:-0}"
+	local specific_user="${specific_user:-}"
+
+	# LEGACY CODE - PRE GETOPTS
 	if [ $# -gt 0 ] && [ "$1" == "--non-append" ]; then
-		customtee="tee"
+		nonappend=1
 		# Destroy this argument for the next command.
 		shift
 	elif [ $# -gt 1 ] && [ "$2" == "--non-append" ]; then
-		customtee="tee"
+		nonappend=1
 	fi
-	if [ $# -gt 0 ]; then
+
+	if [ $# -gt 0 ] && [ "$(echo ${1:0:1})" != "-" ]; then
 		if [ "$(echo ${1##*.})" == "log" ]; then	# Keep only the extension to check if it's a logfile
 			local logfile=$1	# In this case, focus logrotate on the logfile
 		else
 			local logfile=$1/*.log	# Else, uses the directory and all logfile into it.
 		fi
+	fi
+	# LEGACY CODE
+
+	local customtee="tee -a"
+	if [ "$nonappend" -eq 1 ]; then
+		customtee="tee"
+	fi
+	if [ -n "$logfile" ]
+	then
+		if [ "$(echo ${logfile##*.})" != "log" ]; then	# Keep only the extension to check if it's a logfile
+			local logfile="$1/*.log"	# Else, uses the directory and all logfile into it.
+		fi
 	else
-		local logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log
+		logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log
 	fi
 	local su_directive=""
-	if [[ -n $user_group ]]; then
+	if [[ -n $specific_user ]]; then
 		su_directive="	# Run logorotate as specific user - group
-	su ${user_group%/*} ${user_group#*/}"
+	su ${specific_user%/*} ${specific_user#*/}"
 	fi
 
 	cat > ./${app}-logrotate << EOF	# Build a config file for logrotate
@@ -73,9 +100,9 @@ ynh_remove_logrotate () {
 
 # Create a dedicated systemd config
 #
-# usage: ynh_add_systemd_config [service] [template]
-# | arg: service - Service name (optionnal, $app by default)
-# | arg: template - Name of template file (optionnal, this is 'systemd' by default, meaning ./conf/systemd.service will be used as template)
+# usage: ynh_add_systemd_config [--service=service] [--template=template]
+# | arg: -s, --service - Service name (optionnal, $app by default)
+# | arg: -t, --template - Name of template file (optionnal, this is 'systemd' by default, meaning ./conf/systemd.service will be used as template)
 #
 # This will use the template ../conf/<templatename>.service
 # to generate a systemd config, by replacing the following keywords
@@ -86,40 +113,54 @@ ynh_remove_logrotate () {
 #   __FINALPATH__ by  $final_path
 #
 ynh_add_systemd_config () {
-	local service_name="${1:-$app}"
+	# Declare an array to define the options of this helper.
+	local legacy_args=st
+	declare -Ar args_array=( [s]=service= [t]=template= )
+	local service
+	local template
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	local service="${service:-$app}"
+	local template="${nonappend:-systemd.service}"
 
-	finalsystemdconf="/etc/systemd/system/$service_name.service"
-	ynh_backup_if_checksum_is_different "$finalsystemdconf"
-	sudo cp ../conf/${2:-systemd.service} "$finalsystemdconf"
+	finalsystemdconf="/etc/systemd/system/$service.service"
+	ynh_backup_if_checksum_is_different --file="$finalsystemdconf"
+	sudo cp ../conf/$template "$finalsystemdconf"
 
 	# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
 	# Substitute in a nginx config file only if the variable is not empty
 	if test -n "${final_path:-}"; then
-		ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf"
+		ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$finalsystemdconf"
 	fi
 	if test -n "${app:-}"; then
-		ynh_replace_string "__APP__" "$app" "$finalsystemdconf"
+		ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$finalsystemdconf"
 	fi
-	ynh_store_file_checksum "$finalsystemdconf"
+	ynh_store_file_checksum --file="$finalsystemdconf"
 
 	sudo chown root: "$finalsystemdconf"
-	sudo systemctl enable $service_name
+	sudo systemctl enable $service
 	sudo systemctl daemon-reload
 }
 
 # Remove the dedicated systemd config
 #
-# usage: ynh_remove_systemd_config [service]
-# | arg: service - Service name (optionnal, $app by default)
+# usage: ynh_remove_systemd_config [--service=service]
+# | arg: -s, --service - Service name (optionnal, $app by default)
 #
 ynh_remove_systemd_config () {
-	local service_name="${1:-$app}"
+	# Declare an array to define the options of this helper.
+	local legacy_args=s
+	declare -Ar args_array=( [s]=service= )
+	local service
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	local service="${service:-$app}"
 
-	local finalsystemdconf="/etc/systemd/system/$service_name.service"
+	local finalsystemdconf="/etc/systemd/system/$service.service"
 	if [ -e "$finalsystemdconf" ]; then
 		ynh_systemd_action --service_name=$service_name --action=stop
 		systemctl disable $service_name
-		ynh_secure_remove "$finalsystemdconf"
+		ynh_secure_remove --file="$finalsystemdconf"
 		systemctl daemon-reload
 	fi
 }
@@ -145,7 +186,7 @@ ynh_remove_systemd_config () {
 ynh_add_nginx_config () {
 	finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
 	local others_var=${1:-}
-	ynh_backup_if_checksum_is_different "$finalnginxconf"
+	ynh_backup_if_checksum_is_different --file="$finalnginxconf"
 	sudo cp ../conf/nginx.conf "$finalnginxconf"
 
 	# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
@@ -153,20 +194,20 @@ ynh_add_nginx_config () {
 	if test -n "${path_url:-}"; then
 		# path_url_slash_less is path_url, or a blank value if path_url is only '/'
 		local path_url_slash_less=${path_url%/}
-		ynh_replace_string "__PATH__/" "$path_url_slash_less/" "$finalnginxconf"
-		ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf"
+		ynh_replace_string --match_string="__PATH__/" --replace_string="$path_url_slash_less/" --target_file="$finalnginxconf"
+		ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$finalnginxconf"
 	fi
 	if test -n "${domain:-}"; then
-		ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf"
+		ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$finalnginxconf"
 	fi
 	if test -n "${port:-}"; then
-		ynh_replace_string "__PORT__" "$port" "$finalnginxconf"
+		ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$finalnginxconf"
 	fi
 	if test -n "${app:-}"; then
-		ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
+		ynh_replace_string --match_string="__NAME__" --replace_string="$app" --target_file="$finalnginxconf"
 	fi
 	if test -n "${final_path:-}"; then
-		ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
+		ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$finalnginxconf"
 	fi
 
 	# Replace all other variable given as arguments
@@ -174,17 +215,17 @@ ynh_add_nginx_config () {
 	do
 		# ${var_to_replace^^} make the content of the variable on upper-cases
 		# ${!var_to_replace} get the content of the variable named $var_to_replace 
-		ynh_replace_string "__${var_to_replace^^}__" "${!var_to_replace}" "$finalnginxconf"
+		ynh_replace_string --match_string="__${var_to_replace^^}__" --replace_string="${!var_to_replace}" --target_file="$finalnginxconf"
 	done
 	
 	if [ "${path_url:-}" != "/" ]
 	then
-		ynh_replace_string "^#sub_path_only" "" "$finalnginxconf"
+		ynh_replace_string --match_string="^#sub_path_only" --replace_string="" --target_file="$finalnginxconf"
 	else
-		ynh_replace_string "^#root_path_only" "" "$finalnginxconf"
+		ynh_replace_string --match_string="^#root_path_only" --replace_string="" --target_file="$finalnginxconf"
 	fi
 
-	ynh_store_file_checksum "$finalnginxconf"
+	ynh_store_file_checksum --file="$finalnginxconf"
 
 	ynh_systemd_action --service_name=nginx --action=reload
 }
@@ -193,7 +234,7 @@ ynh_add_nginx_config () {
 #
 # usage: ynh_remove_nginx_config
 ynh_remove_nginx_config () {
-	ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
+	ynh_secure_remove --file="/etc/nginx/conf.d/$domain.d/$app.conf"
 	ynh_systemd_action --service_name=nginx --action=reload
 }
 
@@ -209,16 +250,16 @@ ynh_add_fpm_config () {
 		fpm_config_dir="/etc/php5/fpm"
 		fpm_service="php5-fpm"
 	fi
-	ynh_app_setting_set $app fpm_config_dir "$fpm_config_dir"
-	ynh_app_setting_set $app fpm_service "$fpm_service"
+	ynh_app_setting_set --app=$app --key=fpm_config_dir --value="$fpm_config_dir"
+	ynh_app_setting_set --app=$app --key=fpm_service --value="$fpm_service"
 	finalphpconf="$fpm_config_dir/pool.d/$app.conf"
-	ynh_backup_if_checksum_is_different "$finalphpconf"
+	ynh_backup_if_checksum_is_different --file="$finalphpconf"
 	sudo cp ../conf/php-fpm.conf "$finalphpconf"
-	ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
-	ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
-	ynh_replace_string "__USER__" "$app" "$finalphpconf"
+	ynh_replace_string --match_string="__NAMETOCHANGE__" --replace_string="$app" --target_file="$finalphpconf"
+	ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$finalphpconf"
+	ynh_replace_string --match_string="__USER__" --replace_string="$app" --target_file="$finalphpconf"
 	sudo chown root: "$finalphpconf"
-	ynh_store_file_checksum "$finalphpconf"
+	ynh_store_file_checksum --file="$finalphpconf"
 
 	if [ -e "../conf/php-fpm.ini" ]
 	then
@@ -236,14 +277,14 @@ ynh_add_fpm_config () {
 #
 # usage: ynh_remove_fpm_config
 ynh_remove_fpm_config () {
-	local fpm_config_dir=$(ynh_app_setting_get $app fpm_config_dir)
-	local fpm_service=$(ynh_app_setting_get $app fpm_service)
+	local fpm_config_dir=$(ynh_app_setting_get --app=$app --key=fpm_config_dir)
+	local fpm_service=$(ynh_app_setting_get --app=$app --key=fpm_service)
 	# Assume php version 7 if not set
 	if [ -z "$fpm_config_dir" ]; then
 		fpm_config_dir="/etc/php/7.0/fpm"
 		fpm_service="php7.0-fpm"
 	fi
-	ynh_secure_remove "$fpm_config_dir/pool.d/$app.conf"
-	ynh_secure_remove "$fpm_config_dir/conf.d/20-$app.ini" 2>&1
+	ynh_secure_remove --file="$fpm_config_dir/pool.d/$app.conf"
+	ynh_secure_remove --file="$fpm_config_dir/conf.d/20-$app.ini" 2>&1
 	ynh_systemd_action --service_name=$fpm_service --action=reload
 }

data/helpers.d/filesystem

@@ -1,3 +1,7 @@
+#!/bin/bash
+
+source /usr/share/yunohost/helpers.d/getopts
+
 CAN_BIND=${CAN_BIND:-1}
 
 # Add a file or a directory to the list of paths to backup
@@ -10,13 +14,13 @@ CAN_BIND=${CAN_BIND:-1}
 # 
 # If DEST is ended by a slash it complete this path with the basename of SRC.
 #
-# usage: ynh_backup src [dest [is_big [not_mandatory [arg]]]]
-# | arg: src - file or directory to bind or symlink or copy. it shouldn't be in
+# usage: ynh_backup --src_path=src_path [--dest_path=dest_path] [--is_big] [--not_mandatory]
+# | arg: -s, --src_path - file or directory to bind or symlink or copy. it shouldn't be in
 # the backup dir. 
-# | arg: dest - destination file or directory inside the
+# | arg: -d, --dest_path - destination file or directory inside the
 # backup dir
-# | arg: is_big - 1 to indicate data are big (mail, video, image ...)
-# | arg: not_mandatory - 1 to indicate that if the file is missing, the backup can ignore it.
+# | arg: -b, --is_big - Indicate data are big (mail, video, image ...)
+# | arg: -m, --not_mandatory - Indicate that if the file is missing, the backup can ignore it.
 # | arg: arg - Deprecated arg
 #
 # example:
@@ -44,16 +48,26 @@ CAN_BIND=${CAN_BIND:-1}
 #
 ynh_backup() {
     # TODO find a way to avoid injection by file strange naming !
-    local SRC_PATH="$1"
-    local DEST_PATH="${2:-}"
-    local IS_BIG="${3:-0}"
-    local NOT_MANDATORY="${4:-0}"
+
+    # Declare an array to define the options of this helper.
+    local legacy_args=sdbm
+    declare -Ar args_array=( [s]=src_path= [d]=dest_path= [b]=is_big [m]=not_mandatory )
+    local src_path
+    local dest_path
+    local is_big
+    local not_mandatory
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    local dest_path="${dest_path:-}"
+    local is_big="${is_big:-0}"
+    local not_mandatory="${not_mandatory:-0}"
+
     BACKUP_CORE_ONLY=${BACKUP_CORE_ONLY:-0}
 
     # If backing up core only (used by ynh_backup_before_upgrade),
     # don't backup big data items
-    if [ "$IS_BIG" == "1" ] && [ "$BACKUP_CORE_ONLY" == "1" ] ; then
-      echo "$SRC_PATH will not be saved, because backup_core_only is set." >&2
+    if [ "$is_big" == "1" ] && [ "$BACKUP_CORE_ONLY" == "1" ] ; then
+      echo "$src_path will not be saved, because backup_core_only is set." >&2
       return 0
     fi
     
@@ -61,15 +75,16 @@ ynh_backup() {
     # Format correctly source and destination paths
     # ==============================================================================
     # Be sure the source path is not empty
-    [[ -e "${SRC_PATH}" ]] || {
-        if [ "$NOT_MANDATORY" == "0" ]
+    [[ -e "${src_path}" ]] || {
+        echo "Source path '${src_path}' does not exist" >&2
+        if [ "$not_mandatory" == "0" ]
         then
 		echo "Source path '${SRC_PATH}' does not exist" >&2
 
                 # This is a temporary fix for fail2ban config files missing after the migration to stretch.
-                if echo "${SRC_PATH}" | grep --quiet "/etc/fail2ban"
+                if echo "${src_path}" | grep --quiet "/etc/fail2ban"
                 then
-                        touch "${SRC_PATH}"
+                        touch "${src_path}"
                         echo "The missing file will be replaced by a dummy one for the backup !!!" >&2
                 else
                         return 1
@@ -81,17 +96,17 @@ ynh_backup() {
 
     # Transform the source path as an absolute path
     # If it's a dir remove the ending /
-    SRC_PATH=$(realpath "$SRC_PATH")
+    src_path=$(realpath "$src_path")
 
     # If there is no destination path, initialize it with the source path
     # relative to "/".
-    # eg: SRC_PATH=/etc/yunohost -> DEST_PATH=etc/yunohost
-    if [[ -z "$DEST_PATH" ]]; then
+    # eg: src_path=/etc/yunohost -> dest_path=etc/yunohost
+    if [[ -z "$dest_path" ]]; then
 
-        DEST_PATH="${SRC_PATH#/}"
+        dest_path="${src_path#/}"
 
     else
-        if [[ "${DEST_PATH:0:1}" == "/" ]]; then
+        if [[ "${dest_path:0:1}" == "/" ]]; then
 
             # If the destination path is an absolute path, transform it as a path
             # relative to the current working directory ($YNH_CWD)
@@ -100,43 +115,43 @@ ynh_backup() {
             # $YNH_BACKUP_DIR/apps/APP_INSTANCE_NAME/backup/
             #
             # If it's a system part backup script, YNH_CWD is equal to $YNH_BACKUP_DIR
-            DEST_PATH="${DEST_PATH#$YNH_CWD/}"
+            dest_path="${dest_path#$YNH_CWD/}"
 
             # Case where $2 is an absolute dir but doesn't begin with $YNH_CWD
-            [[ "${DEST_PATH:0:1}" == "/" ]] \
-                && DEST_PATH="${DEST_PATH#/}"
+            [[ "${dest_path:0:1}" == "/" ]] \
+                && dest_path="${dest_path#/}"
         fi
 
-        # Complete DEST_PATH if ended by a /
-        [[ "${DEST_PATH: -1}" == "/" ]] \
-            &&  DEST_PATH="${DEST_PATH}/$(basename $SRC_PATH)"
+        # Complete dest_path if ended by a /
+        [[ "${dest_path: -1}" == "/" ]] \
+            &&  dest_path="${dest_path}/$(basename $src_path)"
     fi
 
-    # Check if DEST_PATH already exists in tmp archive
-    [[ ! -e "${DEST_PATH}" ]] || {
-        echo "Destination path '${DEST_PATH}' already exist" >&2
+    # Check if dest_path already exists in tmp archive
+    [[ ! -e "${dest_path}" ]] || {
+        echo "Destination path '${dest_path}' already exist" >&2
         return 1
     }
 
     # Add the relative current working directory to the destination path
-    local REL_DIR="${YNH_CWD#$YNH_BACKUP_DIR}"
-    REL_DIR="${REL_DIR%/}/"
-    DEST_PATH="${REL_DIR}${DEST_PATH}"
-    DEST_PATH="${DEST_PATH#/}"
+    local rel_dir="${YNH_CWD#$YNH_BACKUP_DIR}"
+    rel_dir="${rel_dir%/}/"
+    dest_path="${rel_dir}${dest_path}"
+    dest_path="${dest_path#/}"
     # ==============================================================================
 
     # ==============================================================================
     # Write file to backup into backup_list
     # ==============================================================================
-    local SRC=$(echo "${SRC_PATH}" | sed -r 's/"/\"\"/g')
-    local DEST=$(echo "${DEST_PATH}" | sed -r 's/"/\"\"/g')
-    echo "\"${SRC}\",\"${DEST}\"" >> "${YNH_BACKUP_CSV}"
+    local src=$(echo "${src_path}" | sed -r 's/"/\"\"/g')
+    local dest=$(echo "${dest_path}" | sed -r 's/"/\"\"/g')
+    echo "\"${src}\",\"${dest}\"" >> "${YNH_BACKUP_CSV}"
 
     # ==============================================================================
 
     # Create the parent dir of the destination path
     # It's for retro compatibility, some script consider ynh_backup creates this dir
-    mkdir -p $(dirname "$YNH_BACKUP_DIR/${DEST_PATH}")
+    mkdir -p $(dirname "$YNH_BACKUP_DIR/${dest_path}")
 }
 
 # Restore all files linked to the restore hook or to the restore app script
@@ -153,7 +168,7 @@ ynh_restore () {
     while read line; do
         local ORIGIN_PATH=$(echo "$line" | grep -ohP "^\"\K.*(?=\",\".*\"$)")
         local ARCHIVE_PATH=$(echo "$line" | grep -ohP "^\".*\",\"$REL_DIR\K.*(?=\"$)")
-        ynh_restore_file "$ARCHIVE_PATH" "$ORIGIN_PATH"
+        ynh_restore_file --origin_path="$ARCHIVE_PATH" --dest_path="$ORIGIN_PATH"
     done
 }
 
@@ -183,13 +198,13 @@ with open(sys.argv[1], 'r') as backup_file:
 # Use the registered path in backup_list by ynh_backup to restore the file at
 # the good place.
 #
-# usage: ynh_restore_file ORIGIN_PATH [ DEST_PATH [NOT_MANDATORY]]
-# | arg: ORIGIN_PATH - Path where was located the file or the directory before
+# usage: ynh_restore_file --origin_path=origin_path [--dest_path=dest_path] [--not_mandatory]
+# | arg: -o, --origin_path - Path where was located the file or the directory before
 # to be backuped or relative path to $YNH_CWD where it is located in the backup archive
-# | arg: DEST_PATH   - Path where restore the file or the dir, if unspecified,
+# | arg: -d, --dest_path - Path where restore the file or the dir, if unspecified,
 # the destination will be ORIGIN_PATH or if the ORIGIN_PATH doesn't exist in
 # the archive, the destination will be searched into backup.csv
-# | arg: NOT_MANDATORY - 1 to indicate that if the file is missing, the restore process can ignore it.
+# | arg: -m, --not_mandatory - Indicate that if the file is missing, the restore process can ignore it.
 #
 # If DEST_PATH already exists and is lighter than 500 Mo, a backup will be made in 
 # /home/yunohost.conf/backup/. Otherwise, the existing file is removed.
@@ -205,49 +220,58 @@ with open(sys.argv[1], 'r') as backup_file:
 # ynh_restore_file "conf/nginx.conf"
 #
 ynh_restore_file () {
-    local ORIGIN_PATH="/${1#/}"
-    local ARCHIVE_PATH="$YNH_CWD${ORIGIN_PATH}"
-    # Default value for DEST_PATH = /$ORIGIN_PATH
-    local DEST_PATH="${2:-$ORIGIN_PATH}"
-    local NOT_MANDATORY="${3:-0}"
+    # Declare an array to define the options of this helper.
+    local legacy_args=odm
+    declare -Ar args_array=( [o]=origin_path= [d]=dest_path= [m]=not_mandatory )
+    local origin_path
+    local archive_path
+    local dest_path
+    local not_mandatory
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    local origin_path="/${origin_path#/}"
+    local archive_path="$YNH_CWD${origin_path}"
+    # Default value for dest_path = /$origin_path
+    local dest_path="${dest_path:-$origin_path}"
+    local not_mandatory="${not_mandatory:-0}"
 
-    # If ARCHIVE_PATH doesn't exist, search for a corresponding path in CSV
-    if [ ! -d "$ARCHIVE_PATH" ] && [ ! -f "$ARCHIVE_PATH" ] && [ ! -L "$ARCHIVE_PATH" ]; then
-        if [ "$NOT_MANDATORY" == "0" ]
+    # If archive_path doesn't exist, search for a corresponding path in CSV
+    if [ ! -d "$archive_path" ] && [ ! -f "$archive_path" ] && [ ! -L "$archive_path" ]; then
+        if [ "$not_mandatory" == "0" ]
         then
-            ARCHIVE_PATH="$YNH_BACKUP_DIR/$(_get_archive_path \"$ORIGIN_PATH\")"
+            archive_path="$YNH_BACKUP_DIR/$(_get_archive_path \"$origin_path\")"
         else
             return 0
         fi
     fi
 
     # Move the old directory if it already exists
-    if [[ -e "${DEST_PATH}" ]]
+    if [[ -e "${dest_path}" ]]
     then
         # Check if the file/dir size is less than 500 Mo
-        if [[ $(du -sb ${DEST_PATH} | cut -d"/" -f1) -le "500000000" ]]
+        if [[ $(du -sb ${dest_path} | cut -d"/" -f1) -le "500000000" ]]
         then
-            local backup_file="/home/yunohost.conf/backup/${DEST_PATH}.backup.$(date '+%Y%m%d.%H%M%S')"
+            local backup_file="/home/yunohost.conf/backup/${dest_path}.backup.$(date '+%Y%m%d.%H%M%S')"
             mkdir -p "$(dirname "$backup_file")"
-            mv "${DEST_PATH}" "$backup_file"	# Move the current file or directory
+            mv "${dest_path}" "$backup_file"	# Move the current file or directory
         else
-            ynh_secure_remove ${DEST_PATH}
+            ynh_secure_remove --file=${dest_path}
         fi
     fi
 
-    # Restore ORIGIN_PATH into DEST_PATH
-    mkdir -p $(dirname "$DEST_PATH")
+    # Restore origin_path into dest_path
+    mkdir -p $(dirname "$dest_path")
 
     # Do a copy if it's just a mounting point
     if mountpoint -q $YNH_BACKUP_DIR; then
-        if [[ -d "${ARCHIVE_PATH}" ]]; then
-            ARCHIVE_PATH="${ARCHIVE_PATH}/."
-            mkdir -p "$DEST_PATH"
+        if [[ -d "${archive_path}" ]]; then
+            archive_path="${archive_path}/."
+            mkdir -p "$dest_path"
         fi
-        cp -a "$ARCHIVE_PATH" "${DEST_PATH}"
+        cp -a "$archive_path" "${dest_path}"
     # Do a move if YNH_BACKUP_DIR is already a copy
     else
-        mv "$ARCHIVE_PATH" "${DEST_PATH}"
+        mv "$archive_path" "${dest_path}"
     fi
 }
 
@@ -287,11 +311,18 @@ properly with chmod/chown." >&2
 #
 # $app should be defined when calling this helper
 #
-# usage: ynh_store_file_checksum file
-# | arg: file - The file on which the checksum will performed, then stored.
+# usage: ynh_store_file_checksum --file=file
+# | arg: -f, --file - The file on which the checksum will performed, then stored.
 ynh_store_file_checksum () {
-	local checksum_setting_name=checksum_${1//[\/ ]/_}	# Replace all '/' and ' ' by '_'
-	ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1)
+	# Declare an array to define the options of this helper.
+	local legacy_args=f
+	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_set --app=$app --key=$checksum_setting_name --value=$(sudo md5sum "$file" | cut -d' ' -f1)
 }
 
 # Verify the checksum and backup the file if it's different
@@ -300,14 +331,20 @@ ynh_store_file_checksum () {
 #
 # $app should be defined when calling this helper
 #
-# usage: ynh_backup_if_checksum_is_different file
-# | arg: file - The file on which the checksum test will be perfomed.
+# usage: ynh_backup_if_checksum_is_different --file=file
+# | arg: -f, --file - The file on which the checksum test will be perfomed.
 #
 # | ret: Return the name a the backup file, or nothing
 ynh_backup_if_checksum_is_different () {
-	local file=$1
+	# Declare an array to define the options of this helper.
+	local legacy_args=f
+	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 '_'
-	local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name)
+	local checksum_value=$(ynh_app_setting_get --app=$app --key=$checksum_setting_name)
 	if [ -n "$checksum_value" ]
 	then	# Proceed only if a value was stored into the app settings
 		if ! echo "$checksum_value $file" | sudo md5sum -c --status
@@ -329,39 +366,51 @@ ynh_backup_if_checksum_is_different () {
 # | 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.
+	local legacy_args=f
 	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
+	ynh_app_setting_delete --app=$app --key=$checksum_setting_name
 }
 
 # Remove a file or a directory securely
 #
-# usage: ynh_secure_remove path_to_remove
-# | arg: path_to_remove - File or directory to remove
+# usage: ynh_secure_remove --file=path_to_remove
+# | arg: -f, --file - File or directory to remove
 ynh_secure_remove () {
-	local path_to_remove=$1
+	# Declare an array to define the options of this helper.
+	local legacy_args=f
+	declare -Ar args_array=( [f]=file= )
+	local file
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local forbidden_path=" \
 	/var/www \
 	/home/yunohost.app"
 
-	if [[ "$forbidden_path" =~ "$path_to_remove" \
+	if [ $# -ge 2 ]
+	then
+		echo "/!\ Packager ! You provided more than one argument to ynh_secure_remove but it will be ignored... Use this helper with one argument at time." >&2
+	fi
+
+	if [[ "$forbidden_path" =~ "$file" \
 		# Match all paths or subpaths in $forbidden_path
-		|| "$path_to_remove" =~ ^/[[:alnum:]]+$ \
+		|| "$file" =~ ^/[[:alnum:]]+$ \
 		# Match all first level paths from / (Like /var, /root, etc...)
-		|| "${path_to_remove:${#path_to_remove}-1}" = "/" ]]
+		|| "${file:${#file}-1}" = "/" ]]
 		# Match if the path finishes by /. Because it seems there is an empty variable
 	then
-		echo "Avoid deleting $path_to_remove." >&2
+		echo "Avoid deleting $file." >&2
 	else
-		if [ -e "$path_to_remove" ]
+		if [ -e "$file" ]
 		then
-			sudo rm -R "$path_to_remove"
+			sudo rm -R "$file"
 		else
-			echo "$path_to_remove wasn't deleted because it doesn't exist." >&2
+			echo "$file wasn't deleted because it doesn't exist." >&2
 		fi
 	fi
 }

data/helpers.d/getopts

@@ -98,10 +98,10 @@ ynh_handle_getopts_args () {
 
 				if [ "$parameter" = "?" ]
 				then
-					ynh_die "Invalid argument: -${OPTARG:-}"
+					ynh_die --message="Invalid argument: -${OPTARG:-}"
 				elif [ "$parameter" = ":" ]
 				then
-					ynh_die "-$OPTARG parameter requires an argument."
+					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
@@ -179,7 +179,7 @@ ynh_handle_getopts_args () {
 				# 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 "Too many arguments ! \"${arguments[$i]}\" will be ignored."
+						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

data/helpers.d/ip

@@ -1,6 +1,8 @@
+#!/bin/bash
+
 # Validate an IP address
 #
-# usage: ynh_validate_ip [family] [ip_address]
+# usage: ynh_validate_ip --family=family --ip_address=ip_address
 # | ret: 0 for valid ip addresses, 1 otherwise
 #
 # example: ynh_validate_ip 4 111.222.333.444
@@ -9,17 +11,22 @@ ynh_validate_ip()
 {
   # http://stackoverflow.com/questions/319279/how-to-validate-ip-address-in-python#319298
 
-  local IP_ADDRESS_FAMILY=$1
-  local IP_ADDRESS=$2
+  # Declare an array to define the options of this helper.
+  local legacy_args=fi
+  declare -Ar args_array=( [f]=family= [i]=ip_address= )
+  local family
+  local ip_address
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
 
-  [ "$IP_ADDRESS_FAMILY" == "4" ] || [ "$IP_ADDRESS_FAMILY" == "6" ] || return 1
+  [ "$family" == "4" ] || [ "$family" == "6" ] || return 1
 
   python /dev/stdin << EOF
 import socket
 import sys
 family = { "4" : socket.AF_INET, "6" : socket.AF_INET6 }
 try:
-    socket.inet_pton(family["$IP_ADDRESS_FAMILY"], "$IP_ADDRESS")
+    socket.inet_pton(family["$family"], "$ip_address")
 except socket.error:
     sys.exit(1)
 sys.exit(0)
@@ -30,12 +37,19 @@ EOF
 #
 # example: ynh_validate_ip4 111.222.333.444
 #
-# usage: ynh_validate_ip4 <ip_address>
+# usage: ynh_validate_ip4 --ip_address=ip_address
 # | ret: 0 for valid ipv4 addresses, 1 otherwise
 #
 ynh_validate_ip4()
 {
-  ynh_validate_ip 4 $1
+  # Declare an array to define the options of this helper.
+  local legacy_args=i
+  declare -Ar args_array=( [i]=ip_address= )
+  local ip_address
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
+
+  ynh_validate_ip 4 $ip_address
 }
 
 
@@ -43,10 +57,17 @@ ynh_validate_ip4()
 #
 # example: ynh_validate_ip6 2000:dead:beef::1
 #
-# usage: ynh_validate_ip6 <ip_address>
+# usage: ynh_validate_ip6 --ip_address=ip_address
 # | ret: 0 for valid ipv6 addresses, 1 otherwise
 #
 ynh_validate_ip6()
 {
-  ynh_validate_ip 6 $1
+  # Declare an array to define the options of this helper.
+  local legacy_args=i
+  declare -Ar args_array=( [i]=ip_address= )
+  local ip_address
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
+
+  ynh_validate_ip 6 $ip_address
 }

data/helpers.d/mysql

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 MYSQL_ROOT_PWD_FILE=/etc/yunohost/mysql
 
 # Open a connection as a user
@@ -5,32 +7,60 @@ MYSQL_ROOT_PWD_FILE=/etc/yunohost/mysql
 # example: ynh_mysql_connect_as 'user' 'pass' <<< "UPDATE ...;"
 # example: ynh_mysql_connect_as 'user' 'pass' < /path/to/file.sql
 #
-# usage: ynh_mysql_connect_as user pwd [db]
-# | arg: user - the user name to connect as
-# | arg: pwd - the user password
-# | arg: db - the database to connect to
+# usage: ynh_mysql_connect_as --user=user --password=password [--database=database]
+# | arg: -u, --user - the user name to connect as
+# | arg: -p, --password - the user password
+# | arg: -d, --database - the database to connect to
 ynh_mysql_connect_as() {
-    mysql -u "$1" --password="$2" -B "${3:-}"
+    # Declare an array to define the options of this helper.
+    local legacy_args=upd
+    declare -Ar args_array=( [u]=user= [p]=password= [d]=database= )
+    local user
+    local password
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
+    mysql -u "$user" --password="$password" -B "$database"
 }
 
 # Execute a command as root user
 #
-# usage: ynh_mysql_execute_as_root sql [db]
-# | arg: sql - the SQL command to execute
-# | arg: db - the database to connect to
+# usage: ynh_mysql_execute_as_root --sql=sql [--database=database]
+# | arg: -s, --sql - the SQL command to execute
+# | arg: -d, --database - the database to connect to
 ynh_mysql_execute_as_root() {
-    ynh_mysql_connect_as "root" "$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
-        "${2:-}" <<< "$1"
+    # Declare an array to define the options of this helper.
+    local legacy_args=sd
+    declare -Ar args_array=( [s]=sql= [d]=database= )
+    local sql
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
+    ynh_mysql_connect_as --user="root" --password="$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
+        --database="$database" <<< "$sql"
 }
 
 # Execute a command from a file as root user
 #
-# usage: ynh_mysql_execute_file_as_root file [db]
-# | arg: file - the file containing SQL commands
-# | arg: db - the database to connect to
+# usage: ynh_mysql_execute_file_as_root --file=file [--database=database]
+# | arg: -f, --file - the file containing SQL commands
+# | arg: -d, --database - the database to connect to
 ynh_mysql_execute_file_as_root() {
-    ynh_mysql_connect_as "root" "$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
-        "${2:-}" < "$1"
+    # Declare an array to define the options of this helper.
+    local legacy_args=fd
+    declare -Ar args_array=( [f]=file= [d]=database= )
+    local file
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
+    ynh_mysql_connect_as --user="root" --password="$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
+        --database="$database" < "$file"
 }
 
 # Create a database and grant optionnaly privilegies to a user
@@ -53,7 +83,7 @@ ynh_mysql_create_db() {
         sql+=" WITH GRANT OPTION;"
     fi
 
-    ynh_mysql_execute_as_root "$sql"
+    ynh_mysql_execute_as_root --sql="$sql"
 }
 
 # Drop a database
@@ -66,18 +96,25 @@ ynh_mysql_create_db() {
 # usage: ynh_mysql_drop_db db
 # | arg: db - the database name to drop
 ynh_mysql_drop_db() {
-    ynh_mysql_execute_as_root "DROP DATABASE ${1};"
+    ynh_mysql_execute_as_root --sql="DROP DATABASE ${1};"
 }
 
 # Dump a database
 #
 # example: ynh_mysql_dump_db 'roundcube' > ./dump.sql
 #
-# usage: ynh_mysql_dump_db db
-# | arg: db - the database name to dump
+# usage: ynh_mysql_dump_db --database=database
+# | arg: -d, --database - the database name to dump
 # | ret: the mysqldump output
 ynh_mysql_dump_db() {
-    mysqldump -u "root" -p"$(sudo cat $MYSQL_ROOT_PWD_FILE)" --single-transaction --skip-dump-date "$1"
+    # Declare an array to define the options of this helper.
+    local legacy_args=d
+    declare -Ar args_array=( [d]=database= )
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    mysqldump -u "root" -p"$(sudo cat $MYSQL_ROOT_PWD_FILE)" --single-transaction --skip-dump-date "$database"
 }
 
 # Create a user
@@ -89,17 +126,23 @@ ynh_mysql_dump_db() {
 # | arg: pwd - the password to identify user by
 ynh_mysql_create_user() {
     ynh_mysql_execute_as_root \
-        "CREATE USER '${1}'@'localhost' IDENTIFIED BY '${2}';"
+        --sql="CREATE USER '${1}'@'localhost' IDENTIFIED BY '${2}';"
 }
 
 # Check if a mysql user exists
 #
-# usage: ynh_mysql_user_exists user
-# | arg: user - the user for which to check existence
+# usage: ynh_mysql_user_exists --user=user
+# | arg: -u, --user - the user for which to check existence
 ynh_mysql_user_exists()
 {
-   local user=$1
-   if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]]
+   # Declare an array to define the options of this helper.
+   local legacy_args=u
+   declare -Ar args_array=( [u]=user= )
+   local user
+   # Manage arguments with getopts
+   ynh_handle_getopts_args "$@"
+
+   if [[ -z $(ynh_mysql_execute_as_root --sql="SELECT User from mysql.user WHERE User = '$user';") ]]
    then
       return 1
    else
@@ -114,7 +157,7 @@ ynh_mysql_user_exists()
 # usage: ynh_mysql_drop_user user
 # | arg: user - the user name to drop
 ynh_mysql_drop_user() {
-    ynh_mysql_execute_as_root "DROP USER '${1}'@'localhost';"
+    ynh_mysql_execute_as_root --sql="DROP USER '${1}'@'localhost';"
 }
 
 # Create a database, an user and its password. Then store the password in the app's config
@@ -122,28 +165,42 @@ ynh_mysql_drop_user() {
 # After executing this helper, the password of the created database will be available in $db_pwd
 # It will also be stored as "mysqlpwd" into the app settings.
 #
-# usage: ynh_mysql_setup_db user name [pwd]
-# | arg: user - Owner of the database
-# | arg: name - Name of the database
-# | arg: pwd - Password of the database. If not given, a password will be generated
+# usage: ynh_mysql_setup_db --db_user=user --db_name=name [--db_pwd=pwd]
+# | arg: -u, --db_user - Owner of the database
+# | arg: -n, --db_name - Name of the database
+# | arg: -p, --db_pwd - Password of the database. If not given, a password will be generated
 ynh_mysql_setup_db () {
-	local db_user="$1"
-	local db_name="$2"
+	# Declare an array to define the options of this helper.
+	local legacy_args=unp
+	declare -Ar args_array=( [u]=db_user= [n]=db_name= [p]=db_pwd= )
+	local db_user
+	local db_name
+	db_pwd=""
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local new_db_pwd=$(ynh_string_random)	# Generate a random password
-	# If $3 is not given, use new_db_pwd instead for db_pwd.
-	db_pwd="${3:-$new_db_pwd}"
+	# If $db_pwd is not given, use new_db_pwd instead for db_pwd
+	db_pwd="${db_pwd:-$new_db_pwd}"
+
 	ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd"	# Create the database
-	ynh_app_setting_set $app mysqlpwd $db_pwd	# Store the password in the app's config
+	ynh_app_setting_set --app=$app --key=mysqlpwd --value=$db_pwd	# Store the password in the app's config
 }
 
 # Remove a database if it exists, and the associated user
 #
-# usage: ynh_mysql_remove_db user name
-# | arg: user - Owner of the database
-# | arg: name - Name of the database
+# usage: ynh_mysql_remove_db --db_user=user --db_name=name
+# | arg: -u, --db_user - Owner of the database
+# | arg: -n, --db_name - Name of the database
 ynh_mysql_remove_db () {
-	local db_user="$1"
-	local db_name="$2"
+	# Declare an array to define the options of this helper.
+	local legacy_args=un
+	declare -Ar args_array=( [u]=db_user= [n]=db_name= )
+	local db_user
+	local db_name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE)
 	if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then	# Check if the database exists
 		echo "Removing database $db_name" >&2
@@ -153,7 +210,7 @@ ynh_mysql_remove_db () {
 	fi
 
 	# Remove mysql user if it exists
-        if $(ynh_mysql_user_exists $db_user); then
+        if $(ynh_mysql_user_exists --user=$db_user); then
 		ynh_mysql_drop_user $db_user
 	fi
 }
@@ -163,10 +220,17 @@ ynh_mysql_remove_db () {
 #
 # example: dbname=$(ynh_sanitize_dbid $app)
 #
-# usage: ynh_sanitize_dbid name
-# | arg: name - name to correct/sanitize
+# usage: ynh_sanitize_dbid --db_name=name
+# | arg: -n, --db_name - name to correct/sanitize
 # | ret: the corrected name
 ynh_sanitize_dbid () {
-	local dbid=${1//[-.]/_}	# We should avoid having - and . in the name of databases. They are replaced by _
-	echo $dbid
+	# Declare an array to define the options of this helper.
+	local legacy_args=n
+	declare -Ar args_array=( [n]=db_name= )
+	local db_name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	# We should avoid having - and . in the name of databases. They are replaced by _
+	echo ${db_name//[-.]/_}
 }

data/helpers.d/network

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # Normalize the url path syntax
 # Handle the slash at the beginning of path and its absence at ending
 # Return a normalized url path
@@ -8,11 +10,17 @@
 #          ynh_normalize_url_path /example/ -> /example
 #          ynh_normalize_url_path / -> /
 #
-# usage: ynh_normalize_url_path path_to_normalize
-# | arg: url_path_to_normalize - URL path to normalize before using it
+# usage: ynh_normalize_url_path --path_url=path_to_normalize
+# | arg: -p, --path_url - URL path to normalize before using it
 ynh_normalize_url_path () {
-	local path_url=$1
-	test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing."
+	# Declare an array to define the options of this helper.
+	local legacy_args=p
+	declare -Ar args_array=( [p]=path_url= )
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	test -n "$path_url" || ynh_die --message="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
@@ -24,13 +32,19 @@ ynh_normalize_url_path () {
 
 # Find a free port and return it
 #
-# example: port=$(ynh_find_port 8080)
+# example: port=$(ynh_find_port --port=8080)
 #
-# usage: ynh_find_port begin_port
-# | arg: begin_port - port to start to search
+# usage: ynh_find_port --port=begin_port
+# | arg: -p, --port - port to start to search
 ynh_find_port () {
-	local port=$1
-	test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port."
+	# Declare an array to define the options of this helper.
+	local legacy_args=p
+	declare -Ar args_array=( [p]=port= )
+	local port
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	test -n "$port" || ynh_die --message="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
 		port=$((port+1))	# Else, pass to next port
@@ -40,28 +54,40 @@ ynh_find_port () {
 
 # Check availability of a web path
 #
-# example: ynh_webpath_available some.domain.tld /coffee
+# example: ynh_webpath_available --domain=some.domain.tld --path_url=/coffee
 #
-# usage: ynh_webpath_available domain path
-# | arg: domain - the domain/host of the url
-# | arg: path - the web path to check the availability of
+# usage: ynh_webpath_available --domain=domain --path_url=path
+# | arg: -d, --domain - the domain/host of the url
+# | arg: -p, --path_url - the web path to check the availability of
 ynh_webpath_available () {
-	local domain=$1
-	local path=$2
-	sudo yunohost domain url-available $domain $path
+	# Declare an array to define the options of this helper.
+	local legacy_args=dp
+	declare -Ar args_array=( [d]=domain= [p]=path_url= )
+	local domain
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	sudo yunohost domain url-available $domain $path_url
 }
 
 # Register/book a web path for an app
 #
-# example: ynh_webpath_register wordpress some.domain.tld /coffee
+# example: ynh_webpath_register --app=wordpress --domain=some.domain.tld --path_url=/coffee
 #
-# usage: ynh_webpath_register app domain path
-# | arg: app - the app for which the domain should be registered
-# | arg: domain - the domain/host of the web path
-# | arg: path - the web path to be registered
+# usage: ynh_webpath_register --app=app --domain=domain --path_url=path
+# | arg: -a, --app - the app for which the domain should be registered
+# | arg: -d, --domain - the domain/host of the web path
+# | arg: -p, --path_url - the web path to be registered
 ynh_webpath_register () {
-	local app=$1
-	local domain=$2
-	local path=$3
-	sudo yunohost app register-url $app $domain $path
+	# Declare an array to define the options of this helper.
+	local legacy_args=adp
+	declare -Ar args_array=( [a]=app= [d]=domain= [p]=path_url= )
+	local app
+	local domain
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	sudo yunohost app register-url $app $domain $path_url
 }

data/helpers.d/nodejs

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 n_install_dir="/opt/node_n"
 node_version_path="$n_install_dir/n/versions/node"
 # N_PREFIX is the directory of n, it needs to be loaded as a environment variable.
@@ -15,7 +17,7 @@ ynh_install_n () {
 	echo "SOURCE_URL=https://github.com/tj/n/archive/v2.1.7.tar.gz
 SOURCE_SUM=2ba3c9d4dd3c7e38885b37e02337906a1ee91febe6d5c9159d89a9050f2eea8f" > "../conf/n.src"
 	# Download and extract n
-	ynh_setup_source "$n_install_dir/git" n
+	ynh_setup_source --dest_dir="$n_install_dir/git" --source_id=n
 	# Install n
 	(cd "$n_install_dir/git"
 	PREFIX=$N_PREFIX make install 2>&1)
@@ -35,7 +37,7 @@ SOURCE_SUM=2ba3c9d4dd3c7e38885b37e02337906a1ee91febe6d5c9159d89a9050f2eea8f" > "
 #
 # usage: ynh_use_nodejs
 ynh_use_nodejs () {
-	nodejs_version=$(ynh_app_setting_get $app nodejs_version)
+	nodejs_version=$(ynh_app_setting_get --app=$app --key=nodejs_version)
 
 	nodejs_use_version="echo \"Deprecated command, should be removed\""
 
@@ -53,13 +55,19 @@ ynh_use_nodejs () {
 #
 # ynh_install_nodejs will install the version of node provided as argument by using n.
 #
-# usage: ynh_install_nodejs [nodejs_version]
-# | arg: nodejs_version - Version of node to install.
+# usage: ynh_install_nodejs --nodejs_version=nodejs_version
+# | arg: -n, --nodejs_version - Version of node to install.
 #        If possible, prefer to use major version number (e.g. 8 instead of 8.10.0).
 #        The crontab will handle the update of minor versions when needed.
 ynh_install_nodejs () {
 	# Use n, https://github.com/tj/n to manage the nodejs versions
-	nodejs_version="$1"
+
+	# Declare an array to define the options of this helper.
+	local legacy_args=n
+	declare -Ar args_array=( [n]=nodejs_version= )
+	local nodejs_version
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
 
 	# Create $n_install_dir
 	mkdir -p "$n_install_dir"
@@ -80,7 +88,7 @@ ynh_install_nodejs () {
 	fi
 
 	# Modify the default N_PREFIX in n script
-	ynh_replace_string "^N_PREFIX=\${N_PREFIX-.*}$" "N_PREFIX=\${N_PREFIX-$N_PREFIX}" "$n_install_dir/bin/n"
+	ynh_replace_string --match_string="^N_PREFIX=\${N_PREFIX-.*}$" --replace_string="N_PREFIX=\${N_PREFIX-$N_PREFIX}" --target_file="$n_install_dir/bin/n"
 
 	# Restore /usr/local/bin in PATH
 	PATH=$CLEAR_PATH
@@ -106,7 +114,7 @@ ynh_install_nodejs () {
 	echo "$YNH_APP_ID:$nodejs_version" | tee --append "$n_install_dir/ynh_app_version"
 
 	# Store nodejs_version into the config of this app
-	ynh_app_setting_set $app nodejs_version $nodejs_version
+	ynh_app_setting_set --app=$app --key=nodejs_version --value=$nodejs_version
 
 	# Build the update script and set the cronjob
 	ynh_cron_upgrade_node
@@ -122,7 +130,7 @@ ynh_install_nodejs () {
 #
 # usage: ynh_remove_nodejs
 ynh_remove_nodejs () {
-	nodejs_version=$(ynh_app_setting_get $app nodejs_version)
+	nodejs_version=$(ynh_app_setting_get --app=$app --key=nodejs_version)
 
 	# Remove the line for this app
 	sed --in-place "/$YNH_APP_ID:$nodejs_version/d" "$n_install_dir/ynh_app_version"
@@ -136,8 +144,8 @@ ynh_remove_nodejs () {
 	# If no other app uses n, remove n
 	if [ ! -s "$n_install_dir/ynh_app_version" ]
 	then
-		ynh_secure_remove "$n_install_dir"
-		ynh_secure_remove "/usr/local/n"
+		ynh_secure_remove --file="$n_install_dir"
+		ynh_secure_remove --file="/usr/local/n"
 		sed --in-place "/N_PREFIX/d" /root/.bashrc
 		rm -f /etc/cron.daily/node_update
 	fi

data/helpers.d/package

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # Check if apt is free to use, or wait, until timeout.
 #
 # [internal]
@@ -23,26 +25,40 @@ ynh_wait_dpkg_free() {
 
 # Check either a package is installed or not
 #
-# example: ynh_package_is_installed 'yunohost' && echo "ok"
+# example: ynh_package_is_installed --package=yunohost && echo "ok"
 #
-# usage: ynh_package_is_installed name
-# | arg: name - the package name to check
+# usage: ynh_package_is_installed --package=name
+# | arg: -p, --package - the package name to check
 ynh_package_is_installed() {
+    # Declare an array to define the options of this helper.
+    local legacy_args=p
+    declare -Ar args_array=( [p]=package= )
+    local package
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
     ynh_wait_dpkg_free
-    dpkg-query -W -f '${Status}' "$1" 2>/dev/null \
+    dpkg-query -W -f '${Status}' "$package" 2>/dev/null \
         | grep -c "ok installed" &>/dev/null
 }
 
 # Get the version of an installed package
 #
-# example: version=$(ynh_package_version 'yunohost')
+# example: version=$(ynh_package_version --package=yunohost)
 #
-# usage: ynh_package_version name
-# | arg: name - the package name to get version
+# usage: ynh_package_version --package=name
+# | arg: -p, --package - the package name to get version
 # | ret: the version or an empty string
 ynh_package_version() {
-    if ynh_package_is_installed "$1"; then
-        dpkg-query -W -f '${Version}' "$1" 2>/dev/null
+    # Declare an array to define the options of this helper.
+    local legacy_args=p
+    declare -Ar args_array=( [p]=package= )
+    local package
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    if ynh_package_is_installed "$package"; then
+        dpkg-query -W -f '${Version}' "$package" 2>/dev/null
     else
         echo ''
     fi
@@ -135,7 +151,7 @@ ynh_package_install_from_equivs () {
     (cd "$TMPDIR"
     equivs-build ./control 1> /dev/null
     dpkg --force-depends -i "./${pkgname}_${pkgversion}_all.deb" 2>&1)
-    ynh_package_install -f || ynh_die "Unable to install dependencies"
+    ynh_package_install -f || ynh_die --message="Unable to install dependencies"
     [[ -n "$TMPDIR" ]] && rm -rf $TMPDIR	# Remove the temp dir.
 
     # check if the package is actually installed
@@ -176,9 +192,9 @@ Description: Fake package for ${app} (YunoHost app) dependencies
  This meta-package is only responsible of installing its dependencies.
 EOF
     ynh_package_install_from_equivs /tmp/${dep_app}-ynh-deps.control \
-        || ynh_die "Unable to install dependencies"	# Install the fake package and its dependencies
+        || ynh_die --message="Unable to install dependencies"	# Install the fake package and its dependencies
     rm /tmp/${dep_app}-ynh-deps.control
-    ynh_app_setting_set $app apt_dependencies $dependencies
+    ynh_app_setting_set --app=$app --key=apt_dependencies --value="$dependencies"
 }
 
 # Remove fake package and its dependencies

data/helpers.d/print

@@ -1,15 +1,32 @@
+#!/bin/bash
+
 # Print a message to stderr and exit
-# usage: ynh_die MSG [RETCODE]
+# usage: ynh_die --message=MSG [--ret_code=RETCODE]
 ynh_die() {
-  echo "$1" 1>&2
-  exit "${2:-1}"
+  # Declare an array to define the options of this helper.
+  local legacy_args=mc
+  declare -Ar args_array=( [m]=message= [c]=ret_code= )
+  local message
+  local ret_code
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
+
+  echo "$message" 1>&2
+  exit "${ret_code:-1}"
 }
 
 # Display a message in the 'INFO' logging category
 #
-# usage: ynh_print_info "Some message"
+# usage: ynh_print_info --message="Some message"
 ynh_print_info() {
-    echo "$1" >> "$YNH_STDINFO"
+    # Declare an array to define the options of this helper.
+    local legacy_args=m
+    declare -Ar args_array=( [m]=message= )
+    local message
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    echo "$message" >> "$YNH_STDINFO"
 }
 
 # Ignore the yunohost-cli log to prevent errors with conditional commands
@@ -39,18 +56,32 @@ ynh_print_log () {
 
 # Print a warning on stderr
 #
-# usage: ynh_print_warn "Text to print"
-# | arg: text - The text to print
+# usage: ynh_print_warn --message="Text to print"
+# | arg: -m, --message - The text to print
 ynh_print_warn () {
-  ynh_print_log "\e[93m\e[1m[WARN]\e[0m ${1}" >&2
+  # Declare an array to define the options of this helper.
+  local legacy_args=m
+  declare -Ar args_array=( [m]=message= )
+  local message
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
+
+  ynh_print_log "\e[93m\e[1m[WARN]\e[0m ${message}" >&2
 }
 
 # Print an error on stderr
 #
-# usage: ynh_print_err "Text to print"
-# | arg: text - The text to print
+# usage: ynh_print_err --message="Text to print"
+# | arg: -m, --message - The text to print
 ynh_print_err () {
-  ynh_print_log "\e[91m\e[1m[ERR]\e[0m ${1}" >&2
+  # Declare an array to define the options of this helper.
+  local legacy_args=m
+  declare -Ar args_array=( [m]=message= )
+  local message
+  # Manage arguments with getopts
+  ynh_handle_getopts_args "$@"
+
+  ynh_print_log "\e[91m\e[1m[ERR]\e[0m ${message}" >&2
 }
 
 # Execute a command and print the result as an error

data/helpers.d/setting

@@ -1,27 +1,54 @@
+#!/bin/bash
+
 # Get an application setting
 #
-# usage: ynh_app_setting_get app key
-# | arg: app - the application id
-# | arg: key - the setting to get
+# usage: ynh_app_setting_get --app=app --key=key
+# | arg: -a, --app - the application id
+# | arg: -k, --key - the setting to get
 ynh_app_setting_get() {
-    sudo yunohost app setting "$1" "$2" --output-as plain --quiet
+    # Declare an array to define the options of this helper.
+    local legacy_args=ak
+    declare -Ar args_array=( [a]=app= [k]=key= )
+    local app
+    local key
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    sudo yunohost app setting "$app" "$key" --output-as plain --quiet
 }
 
 # Set an application setting
 #
-# usage: ynh_app_setting_set app key value
-# | arg: app - the application id
-# | arg: key - the setting name to set
-# | arg: value - the setting value to set
+# usage: ynh_app_setting_set --app=app --key=key --value=value
+# | arg: -a, --app - the application id
+# | arg: -k, --key - the setting name to set
+# | arg: -v, --value - the setting value to set
 ynh_app_setting_set() {
-    sudo yunohost app setting "$1" "$2" --value="$3" --quiet
+    # Declare an array to define the options of this helper.
+    local legacy_args=akv
+    declare -Ar args_array=( [a]=app= [k]=key= [v]=value= )
+    local app
+    local key
+    local value
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    sudo yunohost app setting "$app" "$key" --value="$value" --quiet
 }
 
 # Delete an application setting
 #
-# usage: ynh_app_setting_delete app key
-# | arg: app - the application id
-# | arg: key - the setting to delete
+# usage: ynh_app_setting_delete --app=app --key=key
+# | arg: -a, --app - the application id
+# | arg: -k, --key - the setting to delete
 ynh_app_setting_delete() {
-    sudo yunohost app setting -d "$1" "$2" --quiet
+    # Declare an array to define the options of this helper.
+    local legacy_args=ak
+    declare -Ar args_array=( [a]=app= [k]=key= )
+    local app
+    local key
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    sudo yunohost app setting -d "$app" "$key" --quiet
 }

data/helpers.d/string

@@ -1,59 +1,79 @@
+#!/bin/bash
+
 # Generate a random string
 #
-# example: pwd=$(ynh_string_random 8)
+# example: pwd=$(ynh_string_random --length=8)
 #
-# usage: ynh_string_random [length]
-# | arg: length - the string length to generate (default: 24)
+# usage: ynh_string_random [--length=string_length]
+# | arg: -l, --length - the string length to generate (default: 24)
 ynh_string_random() {
+    # Declare an array to define the options of this helper.
+    local legacy_args=l
+    declare -Ar args_array=( [l]=length= )
+    local length
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    length=${length:-24}
+
     dd if=/dev/urandom bs=1 count=1000 2> /dev/null \
       | tr -c -d 'A-Za-z0-9' \
-      | sed -n 's/\(.\{'"${1:-24}"'\}\).*/\1/p'
+      | sed -n 's/\(.\{'"$length"'\}\).*/\1/p'
 }
 
 # Substitute/replace a string (or expression) by another in a file
 #
-# usage: ynh_replace_string match_string replace_string target_file
-# | arg: match_string - String to be searched and replaced in the file
-# | arg: replace_string - String that will replace matches
-# | arg: target_file - File in which the string will be replaced.
+# usage: ynh_replace_string --match_string=match_string --replace_string=replace_string --target_file=target_file
+# | arg: -m, --match_string - String to be searched and replaced in the file
+# | arg: -r, --replace_string - String that will replace matches
+# | arg: -f, --target_file - File in which the string will be replaced.
 #
 # As this helper is based on sed command, regular expressions and
 # references to sub-expressions can be used
 # (see sed manual page for more information)
 ynh_replace_string () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=mrf
+	declare -Ar args_array=( [m]=match_string= [r]=replace_string= [f]=target_file= )
+	local match_string
+	local replace_string
+	local target_file
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local delimit=@
-	local match_string=$1
-	local replace_string=$2
-	local workfile=$3
-  
 	# Escape the delimiter if it's in the string.
 	match_string=${match_string//${delimit}/"\\${delimit}"}
 	replace_string=${replace_string//${delimit}/"\\${delimit}"}
 
-	sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile"
+	sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$target_file"
 }
 
 # Substitute/replace a special string by another in a file
 #
-# usage: ynh_replace_special_string match_string replace_string target_file
-# | arg: match_string - String to be searched and replaced in the file
-# | arg: replace_string - String that will replace matches
-# | arg: target_file - File in which the string will be replaced.
+# usage: ynh_replace_special_string --match_string=match_string --replace_string=replace_string --target_file=target_file
+# | arg: -m, --match_string - String to be searched and replaced in the file
+# | arg: -r, --replace_string - String that will replace matches
+# | arg: -t, --target_file - File in which the string will be replaced.
 #
 # This helper will use ynh_replace_string, but as you can use special
 # characters, you can't use some regular expressions and sub-expressions.
 ynh_replace_special_string () {
-	local match_string=$1
-	local replace_string=$2
-	local workfile=$3
+	# Declare an array to define the options of this helper.
+	local legacy_args=mrf
+	declare -Ar args_array=( [m]=match_string= [r]=replace_string= [f]=target_file= )
+	local match_string
+	local replace_string
+	local target_file
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
 
-  # Escape any backslash to preserve them as simple backslash.
-  match_string=${match_string//\\/"\\\\"}
-  replace_string=${replace_string//\\/"\\\\"}
+	# Escape any backslash to preserve them as simple backslash.
+	match_string=${match_string//\\/"\\\\"}
+	replace_string=${replace_string//\\/"\\\\"}
 
 	# Escape the & character, who has a special function in sed.
 	match_string=${match_string//&/"\&"}
 	replace_string=${replace_string//&/"\&"}
 
-	ynh_replace_string "$match_string" "$replace_string" "$workfile"
+	ynh_replace_string --match_string="$match_string" --replace_string="$replace_string" --target_file="$target_file"
 }

data/helpers.d/system

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # Manage a fail of the script
 #
 # [internal]

data/helpers.d/user

@@ -1,23 +1,40 @@
+#!/bin/bash
+
 # Check if a YunoHost user exists
 #
 # example: ynh_user_exists 'toto' || exit 1
 #
-# usage: ynh_user_exists username
-# | arg: username - the username to check
+# usage: ynh_user_exists --username=username
+# | arg: -u, --username - the username to check
 ynh_user_exists() {
-    sudo yunohost user list --output-as json | grep -q "\"username\": \"${1}\""
+    # Declare an array to define the options of this helper.
+    local legacy_args=u
+    declare -Ar args_array=( [u]=username= )
+    local username
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    sudo yunohost user list --output-as json | grep -q "\"username\": \"${username}\""
 }
 
 # Retrieve a YunoHost user information
 #
 # example: mail=$(ynh_user_get_info 'toto' 'mail')
 #
-# usage: ynh_user_get_info username key
-# | arg: username - the username to retrieve info from
-# | arg: key - the key to retrieve
+# usage: ynh_user_get_info --username=username --key=key
+# | arg: -u, --username - the username to retrieve info from
+# | arg: -k, --key - the key to retrieve
 # | ret: string - the key's value
 ynh_user_get_info() {
-    sudo yunohost user info "$1" --output-as plain | ynh_get_plain_key "$2"
+    # Declare an array to define the options of this helper.
+    local legacy_args=uk
+    declare -Ar args_array=( [u]=username= [k]=key= )
+    local username
+    local key
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    sudo yunohost user info "$username" --output-as plain | ynh_get_plain_key "$key"
 }
 
 # Get the list of YunoHost users
@@ -33,10 +50,17 @@ ynh_user_list() {
 
 # Check if a user exists on the system
 #
-# usage: ynh_system_user_exists username
-# | arg: username - the username to check
+# usage: ynh_system_user_exists --username=username
+# | arg: -u, --username - the username to check
 ynh_system_user_exists() {
-    getent passwd "$1" &>/dev/null
+    # Declare an array to define the options of this helper.
+    local legacy_args=u
+    declare -Ar args_array=( [u]=username= )
+    local username
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    getent passwd "$username" &>/dev/null
 }
 
 # Create a system user
@@ -54,7 +78,7 @@ ynh_system_user_exists() {
 # If this argument is omitted, the user will be created with /usr/sbin/nologin shell
 ynh_system_user_create () {
 	# Declare an array to define the options of this helper.
-	local legacy_args=uh
+	local legacy_args=uhs
 	declare -Ar args_array=( [u]=username= [h]=home_dir= [s]=use_shell )
 	local username
 	local home_dir
@@ -82,14 +106,21 @@ ynh_system_user_create () {
 
 # Delete a system user
 #
-# usage: ynh_system_user_delete user_name
-# | arg: user_name - Name of the system user that will be create
+# usage: ynh_system_user_delete --username=user_name
+# | arg: -u, --username - Name of the system user that will be create
 ynh_system_user_delete () {
-    if ynh_system_user_exists "$1"	# Check if the user exists on the system
+    # Declare an array to define the options of this helper.
+    local legacy_args=u
+    declare -Ar args_array=( [u]=username= )
+    local username
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    if ynh_system_user_exists "$username"	# Check if the user exists on the system
     then
-		echo "Remove the user $1" >&2
-		sudo userdel $1
+		echo "Remove the user $username" >&2
+		sudo userdel $username
 	else
-		echo "The user $1 was not found" >&2
+		echo "The user $username was not found" >&2
     fi
 }

data/helpers.d/utils

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # Extract a key from a plain command output
 #
 # example: yunohost user info tata --output-as plain | ynh_get_plain_key mail
@@ -49,7 +51,7 @@ ynh_restore_upgradebackup () {
 			sudo yunohost app remove $app
 			# Restore the backup
 			sudo yunohost backup restore $app_bck-pre-upgrade$backup_number --apps $app --force --debug
-			ynh_die "The app was restored to the way it was before the failed upgrade."
+			ynh_die --message="The app was restored to the way it was before the failed upgrade."
 		fi
 	else
       		echo "\$NO_BACKUP_UPGRADE is set, that means there's no backup to restore. You have to fix this upgrade by yourself !" >&2
@@ -97,7 +99,7 @@ ynh_backup_before_upgrade () {
 				sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number > /dev/null
 			fi
 		else
-			ynh_die "Backup failed, the upgrade process was aborted."
+			ynh_die --message="Backup failed, the upgrade process was aborted."
 		fi
         else
                 echo "\$NO_BACKUP_UPGRADE is set, backup will be avoided. Be careful, this upgrade is going to be operated without a security backup"
@@ -118,6 +120,8 @@ ynh_backup_before_upgrade () {
 # SOURCE_FORMAT=tar.gz
 # # (Optional) Put false if sources are directly in the archive root
 # # default: true
+# # Instead of true, SOURCE_IN_SUBDIR could be the number of sub directories
+# # to remove.
 # SOURCE_IN_SUBDIR=false
 # # (Optionnal) Name of the local archive (offline setup support)
 # # default: ${src_id}.${src_format}
@@ -136,27 +140,35 @@ ynh_backup_before_upgrade () {
 # If it's ok, the source archive will be uncompressed in $dest_dir. If the
 # SOURCE_IN_SUBDIR is true, the first level directory of the archive will be
 # removed.
+# If SOURCE_IN_SUBDIR is a numeric value, 2 for example, the 2 first level
+# directories will be removed
 #
 # Finally, patches named sources/patches/${src_id}-*.patch and extra files in
 # sources/extra_files/$src_id will be applied to dest_dir
 #
 #
-# usage: ynh_setup_source dest_dir [source_id]
-# | arg: dest_dir  - Directory where to setup sources
-# | arg: source_id - Name of the app, if the package contains more than one app
+# usage: ynh_setup_source --dest_dir=dest_dir [--source_id=source_id]
+# | arg: -d, --dest_dir  - Directory where to setup sources
+# | arg: -s, --source_id - Name of the app, if the package contains more than one app
 ynh_setup_source () {
-    local dest_dir=$1
-    local src_id=${2:-app} # If the argument is not given, source_id equals "app"
+    # Declare an array to define the options of this helper.
+    local legacy_args=ds
+    declare -Ar args_array=( [d]=dest_dir= [s]=source_id= )
+    local dest_dir
+    local source_id
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    source_id="${source_id:-app}" # If the argument is not given, source_id equals "app"
 
     # Load value from configuration file (see above for a small doc about this file
     # format)
-    local src_url=$(grep 'SOURCE_URL=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_sum=$(grep 'SOURCE_SUM=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_extract=$(grep 'SOURCE_EXTRACT=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
-    local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_CWD/../conf/${src_id}.src" | cut -d= -f2-)
+    local src_url=$(grep 'SOURCE_URL=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_sum=$(grep 'SOURCE_SUM=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_extract=$(grep 'SOURCE_EXTRACT=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
+    local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_CWD/../conf/${source_id}.src" | cut -d= -f2-)
 
     # Default value
     src_sumprg=${src_sumprg:-sha256sum}
@@ -165,7 +177,7 @@ ynh_setup_source () {
     src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]')
     src_extract=${src_extract:-true}
     if [ "$src_filename" = "" ] ; then
-        src_filename="${src_id}.${src_format}"
+        src_filename="${source_id}.${src_format}"
     fi
     local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}"
 
@@ -173,16 +185,16 @@ ynh_setup_source () {
     then    # Use the local source file if it is present
         cp $local_src $src_filename
     else    # If not, download the source
-        local out=`wget -nv -O $src_filename $src_url 2>&1` || ynh_print_err $out
+        local out=`wget -nv -O $src_filename $src_url 2>&1` || ynh_print_err --message="$out"
     fi
 
     # Check the control sum
     echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \
-        || ynh_die "Corrupt source"
+        || ynh_die --message="Corrupt source"
 
     # Extract source into the app dir
     mkdir -p "$dest_dir"
-    
+
     if ! "$src_extract"
     then
         mv $src_filename $dest_dir
@@ -194,35 +206,41 @@ ynh_setup_source () {
             local tmp_dir=$(mktemp -d)
             unzip -quo $src_filename -d "$tmp_dir"
             cp -a $tmp_dir/*/. "$dest_dir"
-            ynh_secure_remove "$tmp_dir"
+            ynh_secure_remove --file="$tmp_dir"
         else
             unzip -quo $src_filename -d "$dest_dir"
         fi
     else
         local strip=""
-        if $src_in_subdir ; then
-            strip="--strip-components 1"
+        if [ "$src_in_subdir" != "false" ]
+        then
+            if [ "$src_in_subdir" == "true" ]; then
+                local sub_dirs=1
+            else
+                local sub_dirs="$src_in_subdir"
+            fi
+            strip="--strip-components $sub_dirs"
         fi
         if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then
             tar -xf $src_filename -C "$dest_dir" $strip
         else
-            ynh_die "Archive format unrecognized."
+            ynh_die --message="Archive format unrecognized."
         fi
     fi
 
     # Apply patches
-    if (( $(find $YNH_CWD/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then
+    if (( $(find $YNH_CWD/../sources/patches/ -type f -name "${source_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then
         local old_dir=$(pwd)
         (cd "$dest_dir" \
-            && for p in $YNH_CWD/../sources/patches/${src_id}-*.patch; do \
+            && for p in $YNH_CWD/../sources/patches/${source_id}-*.patch; do \
                 patch -p1 < $p; done) \
-            || ynh_die "Unable to apply patches"
+            || ynh_die --message="Unable to apply patches"
         cd $old_dir
     fi
 
     # Add supplementary files
-    if test -e "$YNH_CWD/../sources/extra_files/${src_id}"; then
-        cp -a $YNH_CWD/../sources/extra_files/$src_id/. "$dest_dir"
+    if test -e "$YNH_CWD/../sources/extra_files/${source_id}"; then
+        cp -a $YNH_CWD/../sources/extra_files/$source_id/. "$dest_dir"
     fi
 }
 

data/templates/dnsmasq/plain/resolv.dnsmasq.conf

@@ -14,15 +14,17 @@ nameserver 80.67.169.40
 nameserver 80.67.188.188
 # (FR) ARN
 nameserver 89.234.141.66
+# (FR) Aquilenet
+nameserver 185.233.100.100
+nameserver 185.233.100.101
 # (FR) gozmail / grifon
-nameserver 89.234.186.18
+nameserver 80.67.190.200
 # (DE) FoeBud / Digital Courage
 nameserver 85.214.20.141
-# (FR) Aquilenet [added manually, following comments from @sachaz]
-nameserver 141.255.128.100
-nameserver 141.255.128.101
 # (DE) CCC Berlin
-nameserver 213.73.91.35
+nameserver 195.160.173.53
+# (DE) AS250
+nameserver 194.150.168.168
 # (DE) Ideal-Hosting
 nameserver 84.200.69.80
 nameserver 84.200.70.40

data/templates/fail2ban/jail.conf

@@ -513,27 +513,27 @@ logpath  = %(vsftpd_log)s
 # ASSP SMTP Proxy Jail
 [assp]
 
-port     = smtp,465,submission
+port     = smtp,submission
 logpath  = /root/path/to/assp/logs/maillog.txt
 
 
 [courier-smtp]
 
-port     = smtp,465,submission
+port     = smtp,submission
 logpath  = %(syslog_mail)s
 backend  = %(syslog_backend)s
 
 
 [postfix]
 
-port     = smtp,465,submission
+port     = smtp,submission
 logpath  = %(postfix_log)s
 backend  = %(postfix_backend)s
 
 
 [postfix-rbl]
 
-port     = smtp,465,submission
+port     = smtp,submission
 logpath  = %(postfix_log)s
 backend  = %(postfix_backend)s
 maxretry = 1
@@ -541,14 +541,14 @@ maxretry = 1
 
 [sendmail-auth]
 
-port    = submission,465,smtp
+port    = submission,smtp
 logpath = %(syslog_mail)s
 backend = %(syslog_backend)s
 
 
 [sendmail-reject]
 
-port     = smtp,465,submission
+port     = smtp,submission
 logpath  = %(syslog_mail)s
 backend  = %(syslog_backend)s
 
@@ -556,7 +556,7 @@ backend  = %(syslog_backend)s
 [qmail-rbl]
 
 filter  = qmail
-port    = smtp,465,submission
+port    = smtp,submission
 logpath = /service/qmail/log/main/current
 
 
@@ -564,14 +564,14 @@ logpath = /service/qmail/log/main/current
 # but can be set by syslog_facility in the dovecot configuration.
 [dovecot]
 
-port    = pop3,pop3s,imap,imaps,submission,465,sieve
+port    = pop3,pop3s,imap,imaps,submission,sieve
 logpath = %(dovecot_log)s
 backend = %(dovecot_backend)s
 
 
 [sieve]
 
-port   = smtp,465,submission
+port   = smtp,submission
 logpath = %(dovecot_log)s
 backend = %(dovecot_backend)s
 
@@ -584,19 +584,19 @@ logpath = %(solidpop3d_log)s
 
 [exim]
 
-port   = smtp,465,submission
+port   = smtp,submission
 logpath = %(exim_main_log)s
 
 
 [exim-spam]
 
-port   = smtp,465,submission
+port   = smtp,submission
 logpath = %(exim_main_log)s
 
 
 [kerio]
 
-port    = imap,smtp,imaps,465
+port    = imap,smtp,imaps
 logpath = /opt/kerio/mailserver/store/logs/security.log
 
 
@@ -607,14 +607,14 @@ logpath = /opt/kerio/mailserver/store/logs/security.log
 
 [courier-auth]
 
-port     = smtp,465,submission,imaps,pop3,pop3s
+port     = smtp,submission,imaps,pop3,pop3s
 logpath  = %(syslog_mail)s
 backend  = %(syslog_backend)s
 
 
 [postfix-sasl]
 
-port     = smtp,465,submission,imap,imaps,pop3,pop3s
+port     = smtp,submission,imap,imaps,pop3,pop3s
 # You might consider monitoring /var/log/mail.warn instead if you are
 # running postfix since it would provide the same log lines at the
 # "warn" level but overall at the smaller filesize.
@@ -631,7 +631,7 @@ backend = %(syslog_backend)s
 
 [squirrelmail]
 
-port = smtp,465,submission,imap,imap2,imaps,pop3,pop3s,http,https,socks
+port = smtp,submission,imap,imap2,imaps,pop3,pop3s,http,https,socks
 logpath = /var/lib/squirrelmail/prefs/squirrelmail_access_log
 
 

data/templates/nginx/server.tpl.conf

@@ -12,7 +12,7 @@ server {
     }
 
     location /.well-known/autoconfig/mail/ {
-        alias /var/www/.well-known/{{ domain }}/autoconfig/mail;
+        alias /var/www/.well-known/{{ domain }}/autoconfig/mail/;
     }
 
     access_log /var/log/nginx/{{ domain }}-access.log;

debian/changelog

@@ -1,3 +1,43 @@
+yunohost (3.4.2.3) stable; urgency=low
+
+  - [fix] Admin password appearing in logs after logging in on webadmin
+  - [fix] Update friendly DNS resolver list
+
+ -- Alexandre Aubin <alex.aubin@mailoo.org>  Thu, 07 Feb 2019 03:20:10 +0000
+
+yunohost (3.4.2.2) stable; urgency=low
+
+  - Silly bug in migraton 8 :|
+
+ -- Alexandre Aubin <alex.aubin@mailoo.org>  Wed, 30 Jan 2019 21:17:00 +0000
+
+yunohost (3.4.2.1) stable; urgency=low
+
+  Small issues
+  - Fix parsing of the Meltdown vulnerability checker (ignore stderr :/)
+  - Mail autoconfig was broken, follow-up of #564
+  - Handle the fact that the archive folder might not exist, in migration 0008
+
+ -- Alexandre Aubin <alex.aubin@mailoo.org>  Wed, 30 Jan 2019 16:37:00 +0000
+
+yunohost (3.4.2) stable; urgency=low
+
+  - [fix] Do not log stretch migration in /tmp/ (#632)
+  - [fix] Some issues with ynh_handle_getopts_args (#628)
+  - [fix] Revert some stuff about separates php-ini file (c.f. #548) (#627)
+  - [fix] App conflicted with itself during change_url (#626)
+  - [fix] Improve `ynh_package_install_from_equivs` debuggability (#625)
+  - [enh] Add systemd log handling (#624)
+  - [enh] Update spectre meltdown checker (#620)
+  - [fix] Propagate HTTP2, more_set_headers and ecdh_curve changes to webadmin (#618)
+  - [enh] Control the login shell when creating users in ynh_system_user_create (#455, #629)
+  - [fix] Postgresql-9.4 was being detected as installed whereas it was in fact not (969577b)
+  - [fix] Restoring system failed because of temporary dumb password being refused (51712f9)
+
+ Thanks to all contributors (Aleks, frju365, JimboJoe, kay0u, Maniack, opi) ! <3
+
+ -- Alexandre Aubin <alex.aubin@mailoo.org>  Tue, 29 Jan 2019 16:42:00 +0000
+
 yunohost (3.4.1) testing; urgency=low
 
   * [fix] `_run_service_command` not properly returning False if command fails (#616)

locales/en.json

@@ -186,6 +186,7 @@
     "extracting": "Extracting…",
     "experimental_feature": "Warning: this feature is experimental and not consider stable, you shouldn't be using it except if you know what you are doing.",
     "field_invalid": "Invalid field '{:s}'",
+    "file_does_not_exist": "The file {path:s} does not exists.",
     "firewall_reload_failed": "Unable to reload the firewall",
     "firewall_reloaded": "The firewall has been reloaded",
     "firewall_rules_cmd_failed": "Some firewall rules commands have failed. For more information, see the log.",
@@ -468,7 +469,7 @@
     "unlimit": "No quota",
     "unrestore_app": "App '{app:s}' will not be restored",
     "update_cache_failed": "Unable to update APT cache",
-    "updating_apt_cache": "Updating the list of available packages…",
+    "updating_apt_cache": "Fetching available upgrades for system packages…",
     "upgrade_complete": "Upgrade complete",
     "upgrading_packages": "Upgrading packages…",
     "upnp_dev_not_found": "No UPnP device found",

locales/eu.json

@@ -0,0 +1 @@
+{}

src/yunohost/app.py

@@ -734,8 +734,8 @@ def app_install(operation_logger, auth, app, label=None, args=None, no_remove_on
         if answer.upper() != "Y":
             raise YunohostError("aborting")
 
-
     raw_app_list = app_list(raw=True)
+
     if app in raw_app_list or ('@' in app) or ('http://' in app) or ('https://' in app):
         if app in raw_app_list:
             state = raw_app_list[app].get("state", "notworking")
@@ -1173,7 +1173,7 @@ def app_makedefault(operation_logger, auth, app, domain=None):
         with open('/etc/ssowat/conf.json.persistent') as json_conf:
             ssowat_conf = json.loads(str(json_conf.read()))
     except ValueError as e:
-        raise YunohostError('ssowat_persistent_conf_read_error', error=e.strerror)
+        raise YunohostError('ssowat_persistent_conf_read_error', error=e)
     except IOError:
         ssowat_conf = {}
 
@@ -1186,7 +1186,7 @@ def app_makedefault(operation_logger, auth, app, domain=None):
         with open('/etc/ssowat/conf.json.persistent', 'w+') as f:
             json.dump(ssowat_conf, f, sort_keys=True, indent=4)
     except IOError as e:
-        raise YunohostError('ssowat_persistent_conf_write_error', error=e.strerror)
+        raise YunohostError('ssowat_persistent_conf_write_error', error=e)
 
     os.system('chmod 644 /etc/ssowat/conf.json.persistent')
 
@@ -1209,8 +1209,8 @@ def app_setting(app, key, value=None, delete=False):
     if value is None and not delete:
         try:
             return app_settings[key]
-        except:
-            logger.debug("cannot get app setting '%s' for '%s'", key, app)
+        except Exception as e:
+            logger.debug("cannot get app setting '%s' for '%s' (%s)", key, app, e)
             return None
     else:
         if delete and key in app_settings:
@@ -1394,7 +1394,8 @@ def app_ssowatconf(auth):
 
     try:
         apps_list = app_list(installed=True)['apps']
-    except:
+    except Exception as e:
+        logger.debug("cannot get installed app list because %s", e)
         apps_list = []
 
     def _get_setting(settings, name):
@@ -1824,7 +1825,7 @@ def _extract_app_from_file(path, remove=False):
     except IOError:
         raise YunohostError('app_install_files_invalid')
     except ValueError as e:
-        raise YunohostError('app_manifest_invalid', error=e.strerror)
+        raise YunohostError('app_manifest_invalid', error=e)
 
     logger.debug(m18n.n('done'))
 
@@ -1907,7 +1908,7 @@ def _fetch_app_from_git(app):
                 # we will be able to use it. Without this option all the history
                 # of the submodules repo is downloaded.
                 subprocess.check_call([
-                    'git', 'clone', '-b',  branch, '--single-branch', '--recursive', '--depth=1', url,
+                    'git', 'clone', '-b', branch, '--single-branch', '--recursive', '--depth=1', url,
                     extracted_app_folder])
                 subprocess.check_call([
                     'git', 'reset', '--hard', branch
@@ -1917,7 +1918,7 @@ def _fetch_app_from_git(app):
             except subprocess.CalledProcessError:
                 raise YunohostError('app_sources_fetch_failed')
             except ValueError as e:
-                raise YunohostError('app_manifest_invalid', error=e.strerror)
+                raise YunohostError('app_manifest_invalid', error=e)
             else:
                 logger.debug(m18n.n('done'))
 
@@ -1925,8 +1926,8 @@ def _fetch_app_from_git(app):
         manifest['remote'] = {'type': 'git', 'url': url, 'branch': branch}
         try:
             revision = _get_git_last_commit_hash(url, branch)
-        except:
-            pass
+        except Exception as e:
+            logger.debug("cannot get last commit hash because: %s ", e)
         else:
             manifest['remote']['revision'] = revision
     else:
@@ -1970,7 +1971,7 @@ def _fetch_app_from_git(app):
             except subprocess.CalledProcessError:
                 raise YunohostError('app_sources_fetch_failed')
             except ValueError as e:
-                raise YunohostError('app_manifest_invalid', error=e.strerror)
+                raise YunohostError('app_manifest_invalid', error=e)
             else:
                 logger.debug(m18n.n('done'))
 
@@ -2250,7 +2251,7 @@ def _parse_action_args_in_yunohost_format(args, action_args, auth=None):
             try:
                 user_info(auth, arg_value)
             except YunohostError as e:
-                raise YunohostError('app_argument_invalid', name=arg_name, error=e.strerror)
+                raise YunohostError('app_argument_invalid', name=arg_name, error=e)
         elif arg_type == 'app':
             if not _is_installed(arg_value):
                 raise YunohostError('app_argument_invalid', name=arg_name, error=m18n.n('app_unknown'))

src/yunohost/data_migrations/0008_ssh_conf_managed_by_yunohost_step2.py

@@ -1,3 +1,4 @@
+import os
 import re
 
 from moulinette import m18n
@@ -39,7 +40,8 @@ class MyMigration(Migration):
 
         # Update local archives folder permissions, so that
         # admin can scp archives out of the server
-        chown(ARCHIVES_PATH, uid="admin", gid="root")
+        if os.path.isdir(ARCHIVES_PATH):
+            chown(ARCHIVES_PATH, uid="admin", gid="root")
 
     def backward(self):
 

src/yunohost/hook.py

@@ -317,7 +317,7 @@ def hook_exec(path, args=None, raise_on_error=False, no_trace=False,
     if path[0] != '/':
         path = os.path.realpath(path)
     if not os.path.isfile(path):
-        raise YunohostError('file_not_exist', path=path)
+        raise YunohostError('file_does_not_exist', path=path)
 
     # Construct command variables
     cmd_args = ''

src/yunohost/tools.py

@@ -472,7 +472,7 @@ def tools_update(ignore_apps=False, ignore_packages=False):
         cache = apt.Cache()
 
         # Update APT cache
-        logger.debug(m18n.n('updating_apt_cache'))
+        logger.info(m18n.n('updating_apt_cache'))
         if not cache.update():
             raise YunohostError('update_cache_failed')
 
@@ -725,9 +725,14 @@ def _check_if_vulnerable_to_meltdown():
         call = subprocess.Popen("bash %s --batch json --variant 3" %
                                 SCRIPT_PATH, shell=True,
                                 stdout=subprocess.PIPE,
-                                stderr=subprocess.STDOUT)
+                                stderr=subprocess.PIPE)
 
-        output, _ = call.communicate()
+        # TODO / FIXME : here we are ignoring error messages ...
+        # in particular on RPi2 and other hardware, the script complains about
+        # "missing some kernel info (see -v), accuracy might be reduced"
+        # Dunno what to do about that but we probably don't want to harass
+        # users with this warning ...
+        output, err = call.communicate()
         assert call.returncode in (0, 2, 3), "Return code: %s" % call.returncode
 
         CVEs = json.loads(output)