From 09d4d9f17b57eccd67a52a926f98403d763967d5 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Wed, 30 Jan 2019 19:16:04 +0100 Subject: [PATCH 1/5] Add progression bar --- scripts/_common.sh | 78 ++++++++++++++++++++++++++++ scripts/actions/add_remove_infcloud | 13 ++++- scripts/actions/reset_default_config | 10 ++++ scripts/backup | 13 +++++ scripts/change_url | 15 ++++++ scripts/install | 19 +++++++ scripts/remove | 14 +++++ scripts/restore | 14 +++++ scripts/upgrade | 19 +++++++ 9 files changed, 193 insertions(+), 2 deletions(-) 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/add_remove_infcloud b/scripts/actions/add_remove_infcloud index 028219f..953cf2d 100755 --- a/scripts/actions/add_remove_infcloud +++ b/scripts/actions/add_remove_infcloud @@ -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} infcloud=$(ynh_app_setting_get $app infcloud) @@ -23,10 +24,10 @@ final_path=$(ynh_app_setting_get $app final_path) if [ $infcloud -eq 1 ] then - ynh_print_info "InfCloud will be removed." >&2 + action_print="Remove" infcloud=0 else - ynh_print_info "InfCloud will be installed." >&2 + action_print="Install" infcloud=1 fi @@ -35,6 +36,7 @@ fi #================================================= # INSTALL OR REMOVE INFCLOUD #================================================= +ynh_script_progression --message="$action_print InfCloud." --weight=9 if [ $infcloud -eq 1 ] then @@ -164,8 +166,15 @@ else ynh_app_setting_set $app unprotected_uris "/" fi +ynh_script_progression --message="Reconfigure SSOwat" # Regen ssowat configuration yunohost app ssowatconf # Update the config of the app ynh_app_setting_set $app infcloud $infcloud + +#================================================= +# 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 7b644b7..42ca9cf 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) @@ -49,6 +50,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" @@ -144,5 +146,13 @@ fi # Calculate and store the config file checksum into the app settings ynh_store_file_checksum "$config_file" +ynh_script_progression --message="Restart Radicale" --weight=2 + # Restart uwsgi to restart radicale ynh_systemd_action --action=restart --service_name=uwsgi + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Execution completed" --last diff --git a/scripts/backup b/scripts/backup index b57fdaa..97939b2 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 @@ -31,6 +32,7 @@ infcloud=$(ynh_app_setting_get $app infcloud) #================================================= # BACKUP THE APP MAIN DIR #================================================= +ynh_script_progression --message="Backup the app main dir" --weight=2 CHECK_SIZE "$final_path" ynh_backup "$final_path" @@ -40,12 +42,14 @@ ynh_backup "/opt/yunohost/$app" #================================================= # BACKUP NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Backup nginx configuration" ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # BACKUP PHP-FPM CONFIGURATION #================================================= +ynh_script_progression --message="Backup php-fpm configuration" if [ $infcloud -eq 1 ] then @@ -57,12 +61,14 @@ fi #================================================= # BACKUP UWSGI CONFIG #================================================= +ynh_script_progression --message="Backup uWSGI configuration" ynh_backup "/etc/uwsgi/apps-available/radicale.ini" #================================================= # BACKUP RADICALE CONFIGURATION #================================================= +ynh_script_progression --message="Backup Radicale configuration" CHECK_SIZE "/etc/$app" ynh_backup "/etc/$app" @@ -70,5 +76,12 @@ ynh_backup "/etc/$app" #================================================= # BACKUP LOGROTATE CONFIGURATION #================================================= +ynh_script_progression --message="Backup logrotate configuration" ynh_backup "/etc/logrotate.d/$app" + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Backup completed" --last diff --git a/scripts/change_url b/scripts/change_url index 8bb83e0..4aeae7a 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 infcloud=$(ynh_app_setting_get $app infcloud) final_path=$(ynh_app_setting_get $app final_path) @@ -31,6 +33,7 @@ final_path=$(ynh_app_setting_get $app final_path) #================================================= # CHECK THE SYNTAX OF THE PATHS #================================================= +ynh_script_progression --message="Check the syntax of the paths" # Remove /infcloud in $old_path if [ $infcloud -eq 1 ] @@ -46,6 +49,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 @@ -79,6 +83,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 @@ -128,6 +133,7 @@ fi if [ $infcloud -eq 1 ] then + ynh_script_progression --message="Reconfigure SSOwat" # Add /infcloud to the path of radicale to access it from the portal echo "sudo yunohost --verbose app setting $app path -v \"${new_path%/}/infcloud\"; sudo yunohost app ssowatconf" | at now + 1 min >&2 domain_regex=$(echo "$new_domain" | sed 's@-@.@g') @@ -138,6 +144,7 @@ fi #================================================= # RESTART UWSGI #================================================= +ynh_script_progression --message="Restart Radicale" --weight=2 ynh_systemd_action --action=restart --service_name=uwsgi @@ -146,13 +153,21 @@ ynh_systemd_action --action=restart --service_name=uwsgi #================================================= # RELOAD NGINX #================================================= +ynh_script_progression --message="Reload nginx" ynh_systemd_action --action=reload --service_name=nginx #================================================= # DEACTIVE MAINTENANCE MODE #================================================= +ynh_script_progression --message="Disable maintenance mode" --weight=4 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 6bb1d34..d2ba3cf 100755 --- a/scripts/install +++ b/scripts/install @@ -21,6 +21,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 @@ -36,6 +37,7 @@ version=$(ynh_app_upstream_version) #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS #================================================= +ynh_script_progression --message="Check if the app can be installed" final_path=/var/www/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" @@ -49,6 +51,7 @@ ynh_webpath_register $app $domain $path_url #================================================= # STORE SETTINGS FROM MANIFEST #================================================= +ynh_script_progression --message="Store settings from manifest" --weight=4 ynh_app_setting_set $app domain $domain ynh_app_setting_set $app path $path_url @@ -66,12 +69,14 @@ ynh_app_setting_set $app overwrite_phpfpm "1" #================================================= # INSTALL DEPENDENCIES #================================================= +ynh_script_progression --message="Install dependencies" --weight=25 ynh_install_app_dependencies $app_depencencies #================================================= # NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Configure nginx" --weight=2 ynh_add_nginx_config if [ $infcloud -eq 1 ] @@ -84,6 +89,7 @@ ynh_store_file_checksum "$finalnginxconf" #================================================= # CREATE DEDICATED USER #================================================= +ynh_script_progression --message="Create a dedicated user" --weight=2 # Create a dedicated system user ynh_system_user_create $app @@ -93,6 +99,7 @@ ynh_system_user_create $app #================================================= # INSTALL RADICALE IN A VIRTUALENV #================================================= +ynh_script_progression --message="Install radicale in a virtualenv" --weight=15 # Init virtualenv virtualenv /opt/yunohost/$app @@ -102,6 +109,7 @@ version=$(ynh_app_setting_get $app version $version) #================================================= # COPY FILES INTO $FINAL_PATH #================================================= +ynh_script_progression --message="Download, check and unpack source" --weight=2 # Create the directory and set the path in the config mkdir "$final_path" @@ -130,6 +138,7 @@ fi #================================================= # CONFIGURE RADICALE #================================================= +ynh_script_progression --message="Configure Radicale" --weight=5 mkdir -p /etc/$app cp ../conf/config /etc/$app/ @@ -219,6 +228,7 @@ ln -s /etc/uwsgi/apps-available/radicale.ini /etc/uwsgi/apps-enabled/ #================================================= # GENERATE CALENDARS AND ADDRESS BOOKS FOR ALL USERS #================================================= +ynh_script_progression --message="Generate calendars and address books for all users" --weight=3 # Create default calendars and address books for each users while read user @@ -231,6 +241,7 @@ done <<< "$(yunohost user list | grep username | cut -d ":" -f 2 | cut -c 2-)" #================================================= # ADVERTISE SERVICE IN ADMIN PANEL #================================================= +ynh_script_progression --message="Restart Radicale" --weight=2 ynh_systemd_action --action=restart --service_name=uwsgi yunohost service add uwsgi --log "/var/log/uwsgi/app/radicale.log" @@ -248,6 +259,7 @@ ynh_replace_string "__FINALPATH__" "$final_path" ../hooks/post_user_delete #================================================= # SETUP SSOWAT #================================================= +ynh_script_progression --message="Setup SSOwat" --weight=3 if [ $infcloud -eq 1 ] then @@ -268,6 +280,7 @@ fi #================================================= # SETUP LOGROTATE #================================================= +ynh_script_progression --message="Configure logrotate" --weight=2 # Use logrotate to manage application logfile(s) ynh_use_logrotate @@ -278,6 +291,7 @@ ynh_use_logrotate if [ $infcloud -eq 1 ] then + ynh_script_progression --message="Configure php-fpm" --weight=4 # Create a dedicated php-fpm config ynh_add_fpm_config fi @@ -285,6 +299,7 @@ fi #================================================= # RELOAD NGINX #================================================= +ynh_script_progression --message="Reload nginx" --weight=4 ynh_systemd_action --action=reload --service_name=nginx @@ -312,5 +327,9 @@ You can configure this app easily by using the experimental config-panel feature You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions. 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/radicale_ynh" +#================================================= +# END OF SCRIPT +#================================================= ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="install" +ynh_script_progression --message="Installation completed" --last diff --git a/scripts/remove b/scripts/remove index 300fd7b..80f6e1e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Load settings" 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=3 # Delete uwsgi configuration ynh_systemd_action --action=stop --service_name=uwsgi @@ -34,6 +36,7 @@ ynh_secure_remove "/etc/uwsgi/apps-available/radicale.ini" #================================================= # REMOVE DEPENDENCIES #================================================= +ynh_script_progression --message="Remove dependencies" --weight=10 # Remove metapackage and its dependencies ynh_remove_app_dependencies @@ -41,6 +44,7 @@ ynh_remove_app_dependencies #================================================= # REMOVE APP MAIN DIR #================================================= +ynh_script_progression --message="Remove app main directory" ynh_secure_remove "/var/www/$app" ynh_secure_remove "/opt/yunohost/$app" @@ -48,6 +52,7 @@ ynh_secure_remove "/opt/yunohost/$app" #================================================= # REMOVE NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Remove nginx configuration" # Remove the dedicated nginx config ynh_remove_nginx_config @@ -55,6 +60,7 @@ ynh_remove_nginx_config #================================================= # REMOVE PHP-FPM CONFIGURATION #================================================= +ynh_script_progression --message="Remove php-fpm configuration" --weight=3 # Remove the dedicated php-fpm config ynh_remove_fpm_config @@ -62,6 +68,7 @@ ynh_remove_fpm_config #================================================= # REMOVE LOGROTATE CONFIG #================================================= +ynh_script_progression --message="Remove logrotate configuration" --weight=3 # Remove the app-specific logrotate config ynh_remove_logrotate @@ -96,5 +103,12 @@ fi #================================================= # REMOVE DEDICATED USER #================================================= +ynh_script_progression --message="Remove the dedicated user" ynh_system_user_delete $app + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Deletion completed" --last diff --git a/scripts/restore b/scripts/restore index 0a55788..69ea18a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -21,6 +21,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 "/opt/yunohost/$app" \ #================================================= # 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" #================================================= # REINSTALL DEPENDENCIES #================================================= +ynh_script_progression --message="Reinstall dependencies" --weight=25 ynh_install_app_dependencies $app_depencencies #================================================= # RESTORE THE APP MAIN DIR #================================================= +ynh_script_progression --message="Restore the app main directory" ynh_restore_file "$final_path" mkdir -p /opt/yunohost @@ -72,6 +76,7 @@ ynh_restore_file "/opt/yunohost/$app" #================================================= # RECREATE THE DEDICATED USER #================================================= +ynh_script_progression --message="Recreate the dedicated user" --weight=3 # Create the dedicated user (if not existing) ynh_system_user_create $app @@ -82,6 +87,7 @@ ynh_system_user_create $app if [ $infcloud -eq 1 ] then + ynh_script_progression --message="Reload php-fpm" --weight=2 ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf" ynh_systemd_action --action=reload --service_name=php5-fpm fi @@ -126,6 +132,7 @@ ynh_restore_file "/etc/logrotate.d/$app" #================================================= # RELOAD NGINX AND UWSGI #================================================= +ynh_script_progression --message="Reload nginx and restart Radicale" ynh_systemd_action --action=restart --service_name=uwsgi ynh_systemd_action --action=reload --service_name=nginx @@ -133,6 +140,7 @@ ynh_systemd_action --action=reload --service_name=nginx #================================================= # DEACTIVE MAINTENANCE MODE #================================================= +ynh_script_progression --message="Disable maintenance mode" --weight=4 ynh_maintenance_mode_OFF @@ -162,3 +170,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/radicale_ynh" ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="restore" + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Restoration completed" --last diff --git a/scripts/upgrade b/scripts/upgrade index 42af05f..daa01b7 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Load settings" --weight=6 app=$YNH_APP_INSTANCE_NAME @@ -45,6 +46,7 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= +ynh_script_progression --message="Ensure downward compatibility" ynh_app_setting_delete $app unprotected_regex @@ -103,6 +105,7 @@ fi #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= +ynh_script_progression --message="Backup the app before upgrading" --weight=9 # Backup the current version of the app ynh_backup_before_upgrade @@ -127,6 +130,7 @@ path_url=$(ynh_normalize_url_path $path_url) #================================================= # ACTIVATE MAINTENANCE MODE #================================================= +ynh_script_progression --message="Activate maintenance mode" ynh_maintenance_mode_ON @@ -139,6 +143,7 @@ ynh_maintenance_mode_ON # 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 if [ $infcloud -eq 1 ] then @@ -151,6 +156,7 @@ fi #================================================= # CREATE DEDICATED USER #================================================= +ynh_script_progression --message="Create a dedicated user" # Create a dedicated user (if not existing) ynh_system_user_create $app @@ -164,6 +170,7 @@ then # Overwrite the php-fpm configuration only if it's allowed if [ $overwrite_phpfpm -eq 1 ] then + ynh_script_progression --message="Reconfigure php-fpm" --weight=2 # Create a dedicated php-fpm config ynh_add_fpm_config fi @@ -177,6 +184,7 @@ fi if [ "$upgrade_type" == "UPGRADE_APP" ] then + ynh_script_progression --message="Upgrade Radicale in its virtualenv" --weight=6 # Upgrade pip packages ynh_secure_remove /opt/yunohost/$app virtualenv /opt/yunohost/$app @@ -187,6 +195,7 @@ fi #================================================= # COPY FILES INTO $FINAL_PATH #================================================= +ynh_script_progression --message="Download, check and unpack source" # Copy files to the right place mkdir -p $final_path/collections @@ -221,6 +230,7 @@ fi #================================================= # CONFIGURE RADICALE #================================================= +ynh_script_progression --message="Reconfigure Radicale" --weight=5 # Overwrite the logging config file only if it's allowed if [ $overwrite_logging -eq 1 ] @@ -345,6 +355,7 @@ cp ../conf/radicale.ini /etc/uwsgi/apps-available/ #================================================= # RESTART UWSGI #================================================= +ynh_script_progression --message="Restart Radicale" --weight=3 ynh_systemd_action --action=restart --service_name=uwsgi @@ -359,6 +370,7 @@ ynh_replace_string "__FINALPATH__" "$final_path" ../hooks/post_user_delete #================================================= # SETUP LOGROTATE #================================================= +ynh_script_progression --message="Reconfigure logrotate" --weight=3 ynh_use_logrotate --non-append @@ -367,6 +379,7 @@ ynh_use_logrotate --non-append #================================================= # SETUP SSOWAT #================================================= +ynh_script_progression --message="Reconfigure SSOwat" --weight=2 if [ $infcloud -eq 1 ] then @@ -387,12 +400,14 @@ fi #================================================= # RELOAD NGINX #================================================= +ynh_script_progression --message="Reload nginx" ynh_systemd_action --action=reload --service_name=nginx #================================================= # DEACTIVE MAINTENANCE MODE #================================================= +ynh_script_progression --message="Disable maintenance mode" --weight=5 ynh_maintenance_mode_OFF @@ -420,5 +435,9 @@ You can configure this app easily by using the experimental config-panel feature You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions. 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/radicale_ynh" +#================================================= +# END OF SCRIPT +#================================================= ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="upgrade" +ynh_script_progression --message="Upgrade completed" --last From 259596c76f44606bc457573155c16cbc4a04e82f Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Wed, 30 Jan 2019 19:30:41 +0100 Subject: [PATCH 2/5] Changelog & html email --- config_panel.json | 11 ++++ scripts/_common.sh | 125 +++++++++++++++++++++++++++++++++++++++++++-- scripts/config | 11 ++++ scripts/install | 14 +++-- scripts/restore | 10 ++-- scripts/upgrade | 20 ++++++-- 6 files changed, 171 insertions(+), 20 deletions(-) diff --git a/config_panel.json b/config_panel.json index 97e5d71..6b7ee0b 100644 --- a/config_panel.json +++ b/config_panel.json @@ -99,6 +99,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 "$" "
" mail_to_send + + # Insert starting HTML tags + sed --in-place '1s@^@\n\n\n\n@' mail_to_send + + # Keep tabulations + ynh_replace_string " " "\ \ " mail_to_send + ynh_replace_string "\t" "\ \ " mail_to_send + + # Insert url links tags + ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "\1" mail_to_send + + # Insert pre tags + ynh_replace_string "__PRE_TAG1__" "
" mail_to_send
+		ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
+
+		# Insert finishing HTML tags
+		echo -e "\n\n" >> 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 f2f169f..08844b7 100644
--- a/scripts/config
+++ b/scripts/config
@@ -90,6 +90,11 @@ old_overwrite_phpfpm="$(ynh_app_setting_get $app overwrite_phpfpm)"
 old_overwrite_phpfpm=$(bool_to_true_false $old_overwrite_phpfpm)
 overwrite_phpfpm="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_PHPFPM:-$old_overwrite_phpfpm}"
 
+# 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
 #=================================================
@@ -148,6 +153,8 @@ show_config() {
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_INFCLOUD=$overwrite_infcloud"
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_NGINX=$overwrite_nginx"
 	echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_PHPFPM=$overwrite_phpfpm"
+
+	echo "YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE=$admin_mail_html"
 }
 
 #=================================================
@@ -251,6 +258,10 @@ apply_config() {
 	# Set overwrite_phpfpm
 	overwrite_phpfpm=$(bool_to_01 $overwrite_phpfpm)
 	ynh_app_setting_set $app overwrite_phpfpm "$overwrite_phpfpm"
+
+	# 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 d2ba3cf..3ca413e 100755
--- a/scripts/install
+++ b/scripts/install
@@ -58,11 +58,13 @@ ynh_app_setting_set $app path $path_url
 ynh_app_setting_set $app admin $admin
 ynh_app_setting_set $app infcloud $infcloud
 ynh_app_setting_set $app version $version
+
 ynh_app_setting_set $app overwrite_logging "1"
 ynh_app_setting_set $app overwrite_config "1"
 ynh_app_setting_set $app overwrite_infcloud "1"
 ynh_app_setting_set $app overwrite_nginx "1"
 ynh_app_setting_set $app overwrite_phpfpm "1"
+ynh_app_setting_set $app admin_mail_html "1"
 
 #=================================================
 # STANDARD MODIFICATIONS
@@ -319,17 +321,19 @@ else
 	infcloud_config=""
 fi
 
-message="Use the file /etc/radicale/config to change the main configuration of radicale.
+echo "Use the file /etc/radicale/config to change the main configuration of radicale.
 The file /etc/radicale/logging to change the level of logging.
 And the file /etc/radicale/rights to edit the way the calendars will be shared.
 $infcloud_config
-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 __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/radicale_ynh__URL_TAG3__." > mail_to_send
+
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type="install"
 
-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/radicale_ynh"
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="install"
 ynh_script_progression --message="Installation completed" --last
diff --git a/scripts/restore b/scripts/restore
index 69ea18a..1f22062 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -160,16 +160,16 @@ else
 	infcloud_config=""
 fi
 
-message="Use the file /etc/radicale/config to change the main configuration of radicale.
+echo "Use the file /etc/radicale/config to change the main configuration of radicale.
 The file /etc/radicale/logging to change the level of logging.
 And the file /etc/radicale/rights to edit the way the calendars will be shared.
 $infcloud_config
-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/radicale_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/radicale_ynh__URL_TAG3__." > mail_to_send
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="restore"
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type="restore"
 
 #=================================================
 # END OF SCRIPT
diff --git a/scripts/upgrade b/scripts/upgrade
index daa01b7..4416c1a 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -418,6 +418,9 @@ 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"
 
+# Build the changelog
+ynh_app_changelog || true
+
 if [ $infcloud -eq 1 ]
 then
 	infcloud_config="
@@ -427,17 +430,24 @@ else
 	infcloud_config=""
 fi
 
-message="Use the file /etc/radicale/config to change the main configuration of radicale.
+echo "Use the file /etc/radicale/config to change the main configuration of radicale.
 The file /etc/radicale/logging to change the level of logging.
 And the file /etc/radicale/rights to edit the way the calendars will be shared.
 $infcloud_config
-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 __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/radicale_ynh__URL_TAG3__.
+
+---
+
+Changelog since your last upgrade:
+$(cat changelog)" > mail_to_send
+
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type="upgrade"
 
-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/radicale_ynh"
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="$admin" --type="upgrade"
 ynh_script_progression --message="Upgrade completed" --last

From 350945dc37386cea49411967d19767d1d745d0b1 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis 
Date: Wed, 30 Jan 2019 20:00:20 +0100
Subject: [PATCH 3/5] Require ynh 3.4

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

diff --git a/manifest.json b/manifest.json
index 465f6bf..3060816 100644
--- a/manifest.json
+++ b/manifest.json
@@ -6,7 +6,7 @@
 		"en": "CalDAV (calendar) and CardDAV (contact) synchronization server",
 		"fr": "Serveur de synchronisation CalDAV et CardDAV"
 	},
-	"version": "1.1.6~ynh4",
+	"version": "1.1.6~ynh5",
 	"url": "http://radicale.org",
 	"license": "GPL-3.0,AGPL-3.0",
 	"maintainer": {
@@ -14,12 +14,12 @@
 		"email": "maniackc_dev@crudelis.fr"
 	},
 	"requirements": {
-		"yunohost": ">= 3.3.3"
+		"yunohost": ">= 3.4"
 	},
 	"multi_instance": false,
 	"services": [
 		"nginx",
-		"php5-fpm"
+		"php7.0-fpm"
 	],
 	"arguments": {
 		"install" : [
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]
diff --git a/scripts/backup b/scripts/backup
index 97939b2..2984097 100644
--- a/scripts/backup
+++ b/scripts/backup
@@ -53,7 +53,7 @@ ynh_script_progression --message="Backup php-fpm configuration"
 
 if [ $infcloud -eq 1 ]
 then
-	ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
+	ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
 fi
 
 #=================================================
diff --git a/scripts/restore b/scripts/restore
index 1f22062..5966201 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -88,8 +88,8 @@ ynh_system_user_create $app
 if [ $infcloud -eq 1 ]
 then
 	ynh_script_progression --message="Reload php-fpm" --weight=2
-	ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
-	ynh_systemd_action --action=reload --service_name=php5-fpm
+	ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
+	ynh_systemd_action --action=reload --service_name=php7.0-fpm
 fi
 
 #=================================================

From e8aee56d3b3b1b7542ba63ffb4d1e61bcf342c87 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis 
Date: Wed, 30 Jan 2019 20:17:09 +0100
Subject: [PATCH 4/5] Update php and nginx conf files to php7

---
 conf/nginx.conf   |  2 +-
 conf/php-fpm.conf | 88 +++++++++++++++++++++++++++++++----------------
 2 files changed, 60 insertions(+), 30 deletions(-)

diff --git a/conf/nginx.conf b/conf/nginx.conf
index 089f907..89d720c 100644
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@@ -34,7 +34,7 @@ location @radicale {
 #INFCLOUD#	try_files $uri $uri/ index.php;
 #INFCLOUD#	location ~ [^/]\.php(/|$) {
 #INFCLOUD#		fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-#INFCLOUD#		fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock;
+#INFCLOUD#		fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock;
 #INFCLOUD#		fastcgi_index index.php;
 #INFCLOUD#		include fastcgi_params;
 #INFCLOUD#		fastcgi_param REMOTE_USER $remote_user;
diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf
index 6c69660..9b4aaa2 100644
--- a/conf/php-fpm.conf
+++ b/conf/php-fpm.conf
@@ -1,10 +1,11 @@
 ; Start a new pool named 'www'.
-; the variable $pool can we used in any directive and will be replaced by the
+; the variable $pool can be used in any directive and will be replaced by the
 ; pool name ('www' here)
 [__NAMETOCHANGE__]
 
 ; Per pool prefix
 ; It only applies on the following directives:
+; - 'access.log'
 ; - 'slowlog'
 ; - 'listen' (unixsocket)
 ; - 'chroot'
@@ -24,28 +25,38 @@ group = __USER__
 
 ; The address on which to accept FastCGI requests.
 ; Valid syntaxes are:
-;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific address on
+;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific IPv4 address on
 ;                            a specific port;
 ;   'port'                 - to listen on a TCP socket to all addresses on a
 ;                            specific port;
+;   '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
+;                            a specific port;
+;   'port'                 - to listen on a TCP socket to all addresses
+;                            (IPv6 and IPv4-mapped) on a specific port;
 ;   '/path/to/unix/socket' - to listen on a unix socket.
 ; Note: This value is mandatory.
-listen = /var/run/php5-fpm-__NAMETOCHANGE__.sock
+ listen = /var/run/php/php7.0-fpm-__NAMETOCHANGE__.sock
 
 ; Set listen(2) backlog.
-; Default Value: 128 (-1 on FreeBSD and OpenBSD)
-;listen.backlog = 128
+; Default Value: 511 (-1 on FreeBSD and OpenBSD)
+;listen.backlog = 511
 
 ; Set permissions for unix socket, if one is used. In Linux, read/write
 ; permissions must be set in order to allow connections from a web server. Many
-; BSD-derived systems allow connections regardless of permissions. 
+; BSD-derived systems allow connections regardless of permissions.
 ; Default Values: user and group are set as the running user
 ;                 mode is set to 0660
 listen.owner = www-data
 listen.group = www-data
 ;listen.mode = 0660
  
-; List of ipv4 addresses of FastCGI clients which are allowed to connect.
+; When POSIX Access Control Lists are supported you can set them using
+; these options, value is a comma separated list of user/group names.
+; When set, listen.owner and listen.group are ignored
+;listen.acl_users =
+;listen.acl_groups =
+
+; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect.
 ; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
 ; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
 ; must be separated by a comma. If this value is left blank, connections will be
@@ -59,7 +70,13 @@ listen.group = www-data
 ;       - The pool processes will inherit the master process priority
 ;         unless it specified otherwise
 ; Default Value: no set
-; priority = -19
+; process.priority = -19
+
+; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user
+; or group is differrent than the master process user. It allows to create process
+; core dump and ptrace the process for the pool user.
+; Default Value: no
+; process.dumpable = yes
 
 ; Choose how the process manager will control the number of child processes.
 ; Possible Values:
@@ -117,12 +134,12 @@ pm.max_spare_servers = 3
 ; Note: Used only when pm is set to 'ondemand'
 ; Default Value: 10s
 ;pm.process_idle_timeout = 10s;
- 
+
 ; The number of requests each child process should execute before respawning.
 ; This can be useful to work around memory leaks in 3rd party libraries. For
 ; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
 ; Default Value: 0
-pm.max_requests = 500
+; pm.max_requests = 500
 
 ; The URI to view the FPM status page. If this value is not set, no URI will be
 ; recognized as a status page. It shows the following informations:
@@ -170,7 +187,7 @@ pm.max_requests = 500
 ;
 ; By default the status page only outputs short status. Passing 'full' in the
 ; query string will also return status for each pool process.
-; Example: 
+; Example:
 ;   http://www.foo.bar/status?full
 ;   http://www.foo.bar/status?json&full
 ;   http://www.foo.bar/status?html&full
@@ -215,7 +232,7 @@ pm.max_requests = 500
 ;   last request memory:  0
 ;
 ; Note: There is a real-time FPM status monitoring sample web page available
-;       It's available in: ${prefix}/share/fpm/status.html
+;       It's available in: /usr/share/php/7.0/fpm/status.html
 ;
 ; Note: The value must start with a leading slash (/). The value can be
 ;       anything, but it may not be a good idea to use the .php extension or it
@@ -275,7 +292,7 @@ pm.max_requests = 500
 ;      - %{megabytes}M
 ;      - %{mega}M
 ;  %n: pool name
-;  %o: ouput header
+;  %o: output header
 ;      it must be associated with embraces to specify the name of the header:
 ;      - %{Content-Type}o
 ;      - %{X-Powered-By}o
@@ -283,7 +300,7 @@ pm.max_requests = 500
 ;      - ....
 ;  %p: PID of the child that serviced the request
 ;  %P: PID of the parent of the child that serviced the request
-;  %q: the query string 
+;  %q: the query string
 ;  %Q: the '?' character if query string exists
 ;  %r: the request URI (without the query string, see %q and %Q)
 ;  %R: remote IP address
@@ -291,47 +308,51 @@ pm.max_requests = 500
 ;  %t: server time the request was received
 ;      it can accept a strftime(3) format:
 ;      %d/%b/%Y:%H:%M:%S %z (default)
+;      The strftime(3) format must be encapsuled in a %{}t tag
+;      e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
 ;  %T: time the log has been written (the request has finished)
 ;      it can accept a strftime(3) format:
 ;      %d/%b/%Y:%H:%M:%S %z (default)
+;      The strftime(3) format must be encapsuled in a %{}t tag
+;      e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
 ;  %u: remote user
 ;
 ; Default: "%R - %u %t \"%m %r\" %s"
-;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"
- 
+; access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"
+
 ; The log file for slow requests
 ; Default Value: not set
 ; Note: slowlog is mandatory if request_slowlog_timeout is set
-slowlog = /var/log/nginx/__NAMETOCHANGE__.slow.log
- 
+; slowlog = log/$pool.log.slow
+
 ; The timeout for serving a single request after which a PHP backtrace will be
 ; dumped to the 'slowlog' file. A value of '0s' means 'off'.
 ; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
 ; Default Value: 0
-request_slowlog_timeout = 5s
- 
+;request_slowlog_timeout = 0
+
 ; The timeout for serving a single request after which the worker process will
 ; be killed. This option should be used when the 'max_execution_time' ini option
 ; does not stop script execution for some reason. A value of '0' means 'off'.
 ; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
 ; Default Value: 0
 request_terminate_timeout = 1d
- 
+
 ; Set open file descriptor rlimit.
 ; Default Value: system defined value
 ;rlimit_files = 1024
- 
+
 ; Set max core size rlimit.
 ; Possible Values: 'unlimited' or an integer greater or equal to 0
 ; Default Value: system defined value
 ;rlimit_core = 0
- 
+
 ; Chroot to this directory at the start. This value must be defined as an
 ; absolute path. When this value is not set, chroot is not used.
 ; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
 ; of its subdirectories. If the pool prefix is not set, the global prefix
 ; will be used instead.
-; Note: chrooting is a great security feature and should be used whenever 
+; Note: chrooting is a great security feature and should be used whenever
 ;       possible. However, all PHP paths will be relative to the chroot
 ;       (error_log, sessions.save_path, ...).
 ; Default Value: not set
@@ -347,16 +368,25 @@ chdir = __FINALPATH__
 ; Note: on highloaded environement, this can cause some delay in the page
 ; process time (several ms).
 ; Default Value: no
-catch_workers_output = yes
+;catch_workers_output = yes
+
+; Clear environment in FPM workers
+; Prevents arbitrary environment variables from reaching FPM worker processes
+; by clearing the environment in workers before env vars specified in this
+; pool configuration are added.
+; Setting to "no" will make all environment variables available to PHP code
+; via getenv(), $_ENV and $_SERVER.
+; Default Value: yes
+;clear_env = no
 
 ; Limits the extensions of the main script FPM will allow to parse. This can
 ; prevent configuration mistakes on the web server side. You should only limit
 ; FPM to .php extensions to prevent malicious users to use other extensions to
-; exectute php code.
+; execute php code.
 ; Note: set an empty value to allow all extensions.
 ; Default Value: .php
-;security.limit_extensions = .php .php3 .php4 .php5
- 
+;security.limit_extensions = .php .php3 .php4 .php5 .php7
+
 ; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
 ; the current environment.
 ; Default Value: clean env
@@ -370,7 +400,7 @@ catch_workers_output = yes
 ; overwrite the values previously defined in the php.ini. The directives are the
 ; same as the PHP SAPI:
 ;   php_value/php_flag             - you can set classic ini defines which can
-;                                    be overwritten from PHP call 'ini_set'. 
+;                                    be overwritten from PHP call 'ini_set'.
 ;   php_admin_value/php_admin_flag - these directives won't be overwritten by
 ;                                     PHP call 'ini_set'
 ; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.

From 33e59de32cdfc0643db609eb5b10d1630d056f72 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis 
Date: Thu, 31 Jan 2019 14:27:16 +0100
Subject: [PATCH 5/5] Upgrade dependencies

---
 scripts/upgrade | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/scripts/upgrade b/scripts/upgrade
index 4416c1a..8ba908a 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -8,6 +8,8 @@
 
 source _common.sh
 source /usr/share/yunohost/helpers
+# Load common variables for all scripts.
+source _variables
 
 #=================================================
 # LOAD SETTINGS
@@ -136,6 +138,13 @@ ynh_maintenance_mode_ON
 
 #=================================================
 # STANDARD UPGRADE STEPS
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Upgrade dependencies"
+
+ynh_install_app_dependencies $app_depencencies
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================