Fixed issue: https://github.com/YunoHost-Apps/yourls_ynh/issues/6 and Updated to 1.7.6

check_process

@@ -18,7 +18,6 @@
 		upgrade=1
 		backup_restore=1
 		multi_instance=1
-		incorrect_path=1
 		port_already_use=0
 		change_url=0
 ;;; Levels

conf/app.src

@@ -1,5 +1,5 @@
-SOURCE_URL=https://github.com/YOURLS/YOURLS/archive/1.7.3.zip
+SOURCE_URL=https://github.com/YOURLS/YOURLS/archive/1.7.6.zip
-SOURCE_SUM=994dbfc2d9372ea8f357c5d2074cb97ec8cb4ec2a928bbce1bed2d74d6be91d8
+SOURCE_SUM=ee17c844b4eb7323e5b22e633631703ded18eef8ed75fc42eb950378fba4f442
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=true

manifest.json

@@ -6,7 +6,7 @@
         "en": "An URL shortening service",
         "fr": "Un service de raccourcisseur d'url"
     },
-    "version": "1.7.3",
+    "version": "1.7.6",
     "url": "https://github.com/YOURLS/YOURLS",
     "license": "free",
     "maintainer": {

scripts/_common.sh

@@ -1,13 +1,20 @@
 #!/bin/bash
 
-# ============= FUTURE YUNOHOST HELPER =============
+#=================================================
-# Delete a file checksum from the app settings
+# COMMON VARIABLES
-#
+#=================================================
-# $app should be defined when calling this helper
+
-#
+# dependencies used by the app
-# usage: ynh_remove_file_checksum file
+pkg_dependencies="php-gmp php-bcmath php-curl"
-# | arg: file - The file for which the checksum will be deleted
+
-ynh_delete_file_checksum () {
+#=================================================
-	local checksum_setting_name=checksum_${1//[\/ ]/_}	# Replace all '/' and ' ' by '_'
+# PERSONAL HELPERS
-	ynh_app_setting_delete $app $checksum_setting_name
+#=================================================
-}
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================

scripts/backup

@@ -25,20 +25,22 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
 
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-domain=$(ynh_app_setting_get $app domain)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get $app db_name)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 
 #=================================================
 # STANDARD BACKUP STEPS
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Backing up the main app directory..." --time --weight=1
 
-ynh_backup "$final_path"
+ynh_backup --src_path="$final_path"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
@@ -47,17 +49,27 @@ ynh_backup "$final_path"
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Backing up nginx web server configuration..." --time --weight=1
 
-ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 #=================================================
 # BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Backing up php-fpm configuration..." --time --weight=1
 
-ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
+ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE MYSQL DATABASE
 #=================================================
+ynh_script_progression --message="Backing up the MySQL database..." --time --weight=1
+
+ynh_mysql_dump_db --database="$db_name" > db.sql
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --time --last
 
-ynh_mysql_dump_db "$db_name" > db.sql

scripts/install

@@ -13,6 +13,10 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+ynh_clean_setup () {
+	### Remove this function if there's nothing to clean before calling the remove script.
+	true
+}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -24,80 +28,133 @@ domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 admin=$YNH_APP_ARG_ADMIN
 
-# This is a multi-instance app, meaning it can be installed several times independently
+### If it's a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
+### The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
+### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
+### The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
+###    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
+###    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
+###    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
+### The app instance name is probably what interests you most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
+### guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
+### db names, ...
 app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
+### About --weight and --time
+### ynh_script_progression will show to your final users the progression of each scripts.
+### In order to do that, --weight will represent the relative time of execution compared to the other steps in the script.
+### --time is a packager option, it will show you the execution time since the previous call.
+### This option should be removed before releasing your app.
+### Use the execution time, given by --time, to estimate the weight of a step.
+### A common way to do it is to set a weight equal to the execution time in second +1.
+### The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.
+ynh_script_progression --message="Validating installation parameters..." --time --weight=1
 
-# Normalize the url path syntax
+### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
-path_url=$(ynh_normalize_url_path $path_url)
+### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
-# Check web path availability
-ynh_webpath_available $domain $path_url
-# Register (book) web path
-ynh_webpath_register $app $domain $path_url
-
 final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
+
+# Register (book) web path
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_script_progression --message="Storing installation settings..." --time --weight=1
 
-ynh_app_setting_set $app domain $domain
+ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set $app path $path_url
+ynh_app_setting_set --app=$app --key=path --value=$path_url
-ynh_app_setting_set $app admin $admin
+ynh_app_setting_set --app=$app --key=admin --value=$admin
+
+#=================================================
+# INSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Installing dependencies..." --time --weight=1
+
+### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
+### Those deb packages will be installed as dependencies of this package.
+### If you're not using this helper:
+###		- Remove the section "REMOVE DEPENDENCIES" in the remove script
+###		- Remove the variable "pkg_dependencies" in _common.sh
+###		- As well as the section "REINSTALL DEPENDENCIES" in the restore script
+###		- And the section "UPGRADE DEPENDENCIES" in the upgrade script
+
+ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
-# If your app uses a MySQL database, you can use these lines to bootstrap
+ynh_script_progression --message="Creating a MySQL database..." --time --weight=1
-# a database, an associated user and save the password in app settings
 
-db_name=$(ynh_sanitize_dbid $app)
+### Use these lines if you need a database for the application.
-ynh_app_setting_set $app db_name $db_name
+### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
-ynh_mysql_setup_db $db_name $db_name
+### The password will be stored as 'mysqlpwd' into the app settings,
+### and will be available as $db_pwd
+### If you're not using these lines:
+###		- Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
+###		- Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
+###		- As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
+
+db_name=$(ynh_sanitize_dbid --db_name=$app)
+db_user=$db_name
+ynh_app_setting_set --app=$app --key=db_name --value=$db_name
+ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_script_progression --message="Setting up source files..." --time --weight=1
 
-ynh_app_setting_set $app final_path $final_path
+### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
+### downloaded from an upstream source, like a git repository.
+### `ynh_setup_source` use the file conf/app.src
+
+ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source "$final_path"
+ynh_setup_source --dest_dir="$final_path"
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Configuring nginx web server..." --time --weight=1
+
+### `ynh_add_nginx_config` will use the file conf/nginx.conf
 
 # Create a dedicated nginx config
 if [ "$path_url" != "/" ]; then
-	ynh_replace_string "__PATHTOCHANGE__" "$path_url" "../conf/nginx.conf"
+	ynh_replace_string --match_string="__PATHTOCHANGE__" --replace_string="$path_url" --target_file="../conf/nginx.conf"
 else
-	ynh_replace_string "__PATHTOCHANGE__"  " "         "../conf/nginx.conf"
+	ynh_replace_string --match_string="__PATHTOCHANGE__"  --replace_string=" "         --target_file="../conf/nginx.conf"
 fi
 ynh_add_nginx_config
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Configuring system user..." --time --weight=1
 
 # Create a system user
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Configuring php-fpm..." --time --weight=1
+
+### `ynh_add_fpm_config` is used to set up a PHP config.
+### You can remove it if your app doesn't use PHP.
+### `ynh_add_fpm_config` will use the files conf/php-fpm.conf
+### If you're not using these lines:
+###		- You can remove these files in conf/.
+###		- Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
+###		- Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
+###		- As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
+###		With the reload at the end of the script.
+###		- And the section "PHP-FPM CONFIGURATION" in the upgrade script
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
@@ -105,50 +162,59 @@ ynh_add_fpm_config
 # copy index file 
 sudo cp ../conf/index.php $final_path/
 
-
+#=================================================
-# Change variable in yourls configuration
+# MODIFY A CONFIG FILE
+#=================================================
+### `ynh_replace_string` is used to replace a string in a file.
+### (It's compatible with sed regular expressions syntax)
 sudo cp ../conf/config.php $final_path/user/config.php
-ynh_replace_string "yunouser" "$db_name" "$final_path/user/config.php"
+ynh_replace_string --match_string="yunouser" --replace_string="$db_name" --target_file="$final_path/user/config.php"
-ynh_replace_string "yunopass" "$db_pwd" "$final_path/user/config.php"
+ynh_replace_string --match_string="yunopass" --replace_string="$db_pwd" --target_file="$final_path/user/config.php"
-ynh_replace_string "yunobase" "$db_name" "$final_path/user/config.php"
+ynh_replace_string --match_string="yunobase" --replace_string="$db_name" --target_file="$final_path/user/config.php"
-ynh_replace_string "yunodomain" "$domain" "$final_path/user/config.php"
+ynh_replace_string --match_string="yunodomain" --replace_string="$domain" --target_file="$final_path/user/config.php"
-ynh_replace_string "_yourlspath" "${path_url%/}" "$final_path/user/config.php"
+ynh_replace_string --match_string="_yourlspath" --replace_string="${path_url%/}" --target_file="$final_path/user/config.php"
-ynh_replace_string "modify this text with something random" "$(ynh_string_random 24)$(ynh_string_random 24)" "$final_path/user/config.php"
+ynh_replace_string --match_string="modify this text with something random" --replace_string="$(ynh_string_random 24)$(ynh_string_random 24)" --target_file="$final_path/user/config.php"
 
 # The script "add_sso_conf.py" will just add en entry for the path "/admin" in the sso conf.json.persistent file in the cathegory "protected_urls".
 cp ../conf/add_sso_conf.py    $final_path/add_sso_conf.py
 cp ../conf/remove_sso_conf.py $final_path/remove_sso_conf.py
-ynh_replace_string "__DOMAIN__" "$domain"   "$final_path/add_sso_conf.py"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain"   --target_file="$final_path/add_sso_conf.py"
 if [ "$path_url" != "/" ]; then
-	ynh_replace_string "__PATH__"   "$path_url" "$final_path/add_sso_conf.py"
+	ynh_replace_string --match_string="__PATH__"   --replace_string="$path_url" --target_file="$final_path/add_sso_conf.py"
-    ynh_replace_string "__PATH__"   "$path_url" "$final_path/remove_sso_conf.py"
+    ynh_replace_string --match_string="__PATH__"   --replace_string="$path_url" --target_file="$final_path/remove_sso_conf.py"
 else
-	ynh_replace_string "__PATH__"   "" "$final_path/add_sso_conf.py"
+	ynh_replace_string --match_string="__PATH__"   --replace_string="" --target_file="$final_path/add_sso_conf.py"
-    ynh_replace_string "__PATH__"   "" "$final_path/remove_sso_conf.py"
+    ynh_replace_string --match_string="__PATH__"   --replace_string="" --target_file="$final_path/remove_sso_conf.py"
 fi
-ynh_replace_string "__DOMAIN__" "$domain"   "$final_path/remove_sso_conf.py"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain"   --target_file="$final_path/remove_sso_conf.py"
 
 
-python3 $final_path/add_sso_conf.py || ynh_die "Your file /etc/ssowat/conf.json.persistent don't respect the json synaxe. Please fix the synaxe to install this app. For more information see here : https://github.com/YunoHost-Apps/synapse_ynh/issues/32"
+python3 $final_path/add_sso_conf.py || ynh_die "Your file /etc/ssowat/conf.json.persistent don't respect the json synaxe. Please fix the synaxe to install this app. For more information see here : https://github.com/YunoHost-Apps/yourls_ynh"
 
 
 # Set permissions
-sudo chown -R $app: $final_path
+chown -R $app: $final_path
 
 # Reload Nginx and regenerate SSOwat conf
 
-yunohost app setting $app unprotected_uris -v "/"
+# unprotected_uris allows SSO credentials to be passed anyway.
+ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
 
 # Restrict access to admin only
 yunohost app addaccess --users=$admin $app
 yunohost app ssowatconf
 
-# Reload Nginx
+#=================================================
-systemctl reload nginx
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
+
+ynh_systemd_action --service_name=nginx --action=reload
+sleep 10
 
 # Start Yourls install (database table creation)
 ynh_local_curl "admin/install.php" "install=dummy" 
-
+sleep 10
 
 # Calculate and store the config file checksum into the app settings
 ynh_store_file_checksum "$final_path/user/config.php"
@@ -156,6 +222,12 @@ ynh_store_file_checksum "$final_path/user/config.php"
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_systemd_action --service_name=nginx --action=reload
+yunohost app ssowatconf
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Installation of $app completed" --time --last
 
-sudo service nginx reload
-sudo yunohost app ssowatconf

scripts/remove

@@ -12,16 +12,30 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get $app domain)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get $app db_name)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
 
+#=================================================
+# REMOVE THE MYSQL DATABASE
+#=================================================
+ynh_script_progression --message="Removing the MySQL database..." --time --weight=1
+
 # Remove a database if it exists, along with the associated user
-ynh_mysql_remove_db $db_name $db_name
+ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
+
+#=================================================
+# REMOVE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Removing dependencies..." --time --weight=1
+
+# Remove metapackage and its dependencies
+ynh_remove_app_dependencies
 
 #=================================================
 # REMOVE APP MAIN DIR
@@ -30,13 +44,19 @@ ynh_mysql_remove_db $db_name $db_name
 # Remove the protected_urls
 python3 $final_path/remove_sso_conf.py
 
+#=================================================
+# REMOVE APP MAIN DIR
+#=================================================
+ynh_script_progression --message="Removing app main directory..." --time --weight=1
+
 # Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
 
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Removing nginx web server configuration..." --time --weight=1
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -44,6 +64,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Removing php-fpm configuration..." --time --weight=1
 
 # Remove the dedicated php-fpm config
 ynh_remove_fpm_config
@@ -53,6 +74,13 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Removing the dedicated system user..." --time --weight=1
 
 # Delete a system user
-ynh_system_user_delete $app
+ynh_system_user_delete --username=$app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Removal of $app completed" --time --last

scripts/restore

@@ -6,18 +6,18 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-if [ ! -e _common.sh ]; then
+#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
-	# Get the _common.sh file if it's not in the current directory
+source ../settings/scripts/_common.sh
-	sudo cp ../settings/scripts/_common.sh ./_common.sh
-	sudo chmod a+rx _common.sh
-fi
-source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+ynh_clean_setup () {
+	#### Remove this function if there's nothing to clean before calling the remove script.
+	true
+}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -27,20 +27,21 @@ ynh_abort_if_errors
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get $app domain)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get $app path)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-db_name=$(ynh_app_setting_get $app db_name)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-admin=$(ynh_app_setting_get $app admin)
+admin=$(ynh_app_setting_get --app=$app --key=admin)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
+ynh_script_progression --message="Validating restoration parameters..." --time --weight=1
 
-ynh_webpath_available $domain $path_url \
+ynh_webpath_available --domain=$domain --path_url=$path_url \
-	|| ynh_die "Path not available: ${domain}${path_url}"
+	|| ynh_die --message="Path not available: ${domain}${path_url}"
 test ! -d $final_path \
-	|| ynh_die "There is already a directory: $final_path "
+	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -48,13 +49,14 @@ test ! -d $final_path \
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Restoring the app main directory..." --time --weight=1
 
-ynh_restore_file "$final_path"
+ynh_restore_file --origin_path="$final_path"
 
 # The script "add_sso_conf.py" will just add en entry for the path "/admin" in the sso conf.json.persistent file in the cathegory "protected_urls".
 python3 $final_path/add_sso_conf.py || ynh_die "Your file /etc/ssowat/conf.json.persistent don't respect the json synaxe. Please fix the synaxe to install this app. For more information see here : https://github.com/YunoHost-Apps/synapse_ynh/issues/32"
@@ -63,17 +65,27 @@ python3 $final_path/add_sso_conf.py || ynh_die "Your file /etc/ssowat/conf.json.
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
+ynh_script_progression --message="Restoring the MySQL database..." --time --weight=1
 
-db_pwd=$(ynh_app_setting_get $app mysqlpwd)
+db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-ynh_mysql_setup_db $db_name $db_name $db_pwd
+ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
-ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql
+ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
 
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Recreating the dedicated system user..." --time --weight=1
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
+
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Reinstalling dependencies..." --time --weight=1
+
+# Define and install dependencies
+ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # RESTORE USER RIGHTS
@@ -86,7 +98,7 @@ chown -R $app: $final_path
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
+ynh_restore_file --origin_path="/etc/php/7.0/fpm/pool.d/$app.conf"
 
 
 #=================================================
@@ -102,12 +114,20 @@ sudo yunohost app setting $app unprotected_uris -v "/"
 
 # Restrict access to admin only
 yunohost app addaccess --users=$admin $app
+yunohost app ssowatconf
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
+ynh_script_progression --message="Reloading nginx web server and php-fpm..." --time --weight=1
 
-systemctl reload php5-fpm
+ynh_systemd_action --service_name=php7.0-fpm --action=reload
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Restoration completed for $app" --time --last

scripts/upgrade

@@ -15,28 +15,45 @@ source /usr/share/yunohost/helpers
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get $app domain)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get $app path)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
-admin=$(ynh_app_setting_get $app admin)
+admin=$(ynh_app_setting_get --app=$app --key=admin)
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-db_name=$(ynh_app_setting_get $app db_name)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 
 
 
-if [ -z $db_name ]; then	# If db_name doesn't exist, create it
+=================================================
-	db_name=$(ynh_sanitize_dbid $app)
+# CHECK VERSION
-	ynh_app_setting_set $app db_name $db_name
+#=================================================
+
+### This helper will compare the version of the currently installed app and the version of the upstream package.
+### $upgrade_type can have 2 different values
+### - UPGRADE_APP if the upstream app version has changed
+### - UPGRADE_PACKAGE if only the YunoHost package has changed
+### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
+### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
+upgrade_type=$(ynh_check_app_version_changed)
+
+#=================================================
+# ENSURE DOWNWARD COMPATIBILITY
+#=================================================
+
+# If db_name doesn't exist, create it
+if [ -z "$db_name" ]; then
+	db_name=$(ynh_sanitize_dbid --db_name=$app)
+	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 fi
 
 # If final_path doesn't exist, create it
-if [ -z $final_path ]; then
+if [ -z "$final_path" ]; then
 	final_path=/var/www/$app
-	ynh_app_setting_set $app final_path $final_path
+	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 fi
-
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --time --weight=1
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -52,7 +69,12 @@ ynh_abort_if_errors
 #=================================================
 
 # Normalize the URL path syntax
-path_url=$(ynh_normalize_url_path $path_url)
+# N.B. : this is for app installations before YunoHost 2.7
+# where this value might be something like /foo/ or foo/
+# instead of /foo ....
+# If nobody installed your app before 2.7, then you may
+# safely remove this line
+path_url=$(ynh_normalize_url_path --path_url=$path_url)
 
 #=================================================
 # STANDARD UPGRADE STEPS
@@ -65,62 +87,72 @@ tmpdir="$(mktemp -d)"
 mkdir -p "$tmpdir/user/"
 
 # Backup the app files in the temp dir
-sudo cp -a "$final_path/index.php" "$tmpdir"
+cp -a "$final_path/index.php" "$tmpdir"
-sudo cp -a "$final_path/.htaccess" "$tmpdir"
+cp -a "$final_path/.htaccess" "$tmpdir"
-sudo cp -a "$final_path/user/config.php" "$tmpdir/user"
+cp -a "$final_path/user/config.php" "$tmpdir/user"
 
 # Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
 
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source "$final_path"
+ynh_setup_source --dest_dir="$final_path"
 
 # Copy the app files from tmp to final_path
-sudo cp -a "$tmpdir/index.php" "$final_path"
+cp -a "$tmpdir/index.php" "$final_path"
-sudo cp -a "$tmpdir/.htaccess" "$final_path"
+cp -a "$tmpdir/.htaccess" "$final_path"
-sudo cp -a "$tmpdir/user/config.php" "$final_path/user"
+cp -a "$tmpdir/user/config.php" "$final_path/user"
 
 # The script "add_sso_conf.py" will just add en entry for the path "/admin" in the sso conf.json.persistent file in the cathegory "protected_urls".
 cp ../conf/add_sso_conf.py $final_path
 cp ../conf/remove_sso_conf.py $final_path
-ynh_replace_string "__DOMAIN__" "$domain"   "$final_path/add_sso_conf.py"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain"   --target_file="$final_path/add_sso_conf.py"
 if [ "$path_url" != "/" ]; then
-	ynh_replace_string "__PATH__"   "$path_url" "$final_path/add_sso_conf.py"
+	ynh_replace_string --match_string="__PATH__"   --replace_string="$path_url" --target_file="$final_path/add_sso_conf.py"
-    ynh_replace_string "__PATH__"   "$path_url" "$final_path/remove_sso_conf.py"
+    ynh_replace_string --match_string="__PATH__"   --replace_string="$path_url" --target_file="$final_path/remove_sso_conf.py"
 else
-	ynh_replace_string "__PATH__"   "" "$final_path/add_sso_conf.py"
+	ynh_replace_string --match_string="__PATH__"   --replace_string="" --target_file="$final_path/add_sso_conf.py"
-    ynh_replace_string "__PATH__"   "" "$final_path/remove_sso_conf.py"
+    ynh_replace_string --match_string="__PATH__"   --replace_string="" --target_file="$final_path/remove_sso_conf.py"
 fi
-ynh_replace_string "__DOMAIN__" "$domain"   "$final_path/remove_sso_conf.py"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain"   --target_file="$final_path/remove_sso_conf.py"
 
 #remove tmp dir
-sudo rm -Rf "$tmpdir"
+rm -Rf "$tmpdir"
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Upgrading nginx web server configuration..." --time --weight=1
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
 
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Upgrading dependencies..." --time --weight=1
+
+ynh_install_app_dependencies $pkg_dependencies
+
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
 
-# Create a system user
+# Create a dedicated user (if not existing)
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Upgrading php-fpm configuration..." --time --weight=1
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
 
 # Verify the checksum and backup the file if it's different
-ynh_backup_if_checksum_is_different "$final_path/user/config.php"
+ynh_backup_if_checksum_is_different --file="$final_path/user/config.php"
 # Recalculate and store the config file checksum into the app settings
-ynh_store_file_checksum "$final_path/user/config.php"
+ynh_store_file_checksum --file="$final_path/user/config.php"
 
 # Set right permissions for curl installation
 chown -R $app: $final_path
@@ -129,7 +161,7 @@ chown -R $app: $final_path
 # SETUP SSOWAT
 #=================================================
 
-ynh_app_setting_set $app unprotected_uris "/"
+ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
 
 # Restrict access to admin only
 yunohost app addaccess --users=$admin $app
@@ -139,5 +171,12 @@ yunohost app ssowatconf
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
 
-sudo systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Upgrade of $app completed" --time --last