Merge branch 'testing' into update-0.5.3

README.md

@@ -36,9 +36,9 @@ this package:
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/baikal%20%28Official%29.svg)](https://ci-apps.yunohost.org/ci/apps/baikal/)
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/baikal%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/baikal/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/baikal%20%28Official%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/baikal/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/baikal%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/baikal/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/baikal%20%28Official%29.svg)](https://ci-stretch.nohost.me/ci/apps/baikal/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/baikal%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/baikal/)
 
 ## Limitations
 
@@ -48,6 +48,7 @@ this package:
 
  * Report a bug: https://github.com/YunoHost-Apps/baikal_ynh/issues
  * Baïkal website: http://baikal-server.com/
+ * Upstream app repository: https://github.com/sabre-io/Baikal
  * YunoHost website: https://yunohost.org/
 
 ---

check_process

@@ -16,20 +16,9 @@
 		multi_instance=0
 		incorrect_path=1
 		port_already_use=0
-		change_url=0
+		change_url=1
 ;;; Levels
-	Level 1=auto
+	Level 5=auto
-	Level 2=auto
-	Level 3=auto
-# Patch add-ldap-auth
-	Level 4=1
-# https://github.com/YunoHost-Apps/baikal_ynh/issues/19
-	Level 5=1
-	Level 6=auto
-	Level 7=auto
-	Level 8=0
-	Level 9=0
-	Level 10=0
 ;;; Options
 Email=
 Notification=none

manifest.json

@@ -14,7 +14,7 @@
         "email": "julien.malik@paraiso.me"
     },
     "requirements": {
-        "yunohost": ">= 3.2.0"
+        "yunohost": ">= 3.5.0"
     },
     "multi_instance": false,
     "services": [

pull_request_template.md

@@ -19,6 +19,6 @@
 - [ ] **Approval (LGTM)** : 
 - [ ] **Approval (LGTM)** : 
 - **CI succeeded** : 
-[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/)  
+[![Build Status](https://ci-apps-hq.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/badge/icon)](https://ci-apps-hq.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/)  
 *Please replace '-NUM-' in this link by the PR number.*  
 When the PR is marked as ready to merge, you have to wait for 3 days before really merging it.

scripts/_common.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+# Check if an URL is already handled
+# usage: is_url_handled URL
+is_url_handled() {
+    # Declare an array to define the options of this helper.
+    declare -Ar args_array=( [u]=url= )
+    local url
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    # Try to get the url with curl, and keep the http code and an eventual redirection url.
+    local curl_output="$(curl --insecure --silent --output /dev/null \
+      --write-out '%{http_code};%{redirect_url}' "$url")"
+
+    # Cut the output and keep only the first part to keep the http code
+    local http_code="${curl_output%%;*}"
+    # Do the same thing but keep the second part, the redirection url
+    local redirection="${curl_output#*;}"
+
+    # Return 1 if the url isn't handled.
+    # Which means either curl got a 404 (or the admin) or the sso.
+    # A handled url should redirect to a publicly accessible url.
+    # Return 1 if the url has returned 404
+    if [ "$http_code" = "404" ] || [[ $redirection =~ "/yunohost/admin" ]]; then
+        return 1
+    # Return 1 if the url is redirected to the SSO
+    elif [[ $redirection =~ "/yunohost/sso" ]]; then
+        return 1
+    fi
+}

scripts/backup

@@ -19,46 +19,46 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..."
 
 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_print_info "Backing up the main app directory..."
+ynh_script_progression --message="Backing up the main app directory..."
 
-ynh_backup "$final_path"
+ynh_backup --src_path="$final_path"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Backing up nginx web server configuration..."
+ynh_script_progression --message="Backing up nginx web server configuration..."
 
-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_print_info "Backing up php-fpm configuration..."
+ynh_script_progression --message="Backing up php-fpm configuration..."
 
-ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
+ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE MYSQL DATABASE
 #=================================================
-ynh_print_info "Backing up the MySQL database..."
+ynh_script_progression --message="Backing up the MySQL database..."
 
-ynh_mysql_dump_db "$db_name" > db.sql
+ynh_mysql_dump_db --database="$db_name" > db.sql
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
+ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --last

scripts/change_url

@@ -0,0 +1,114 @@
+#!/bin/bash
+
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+source _common.sh
+source /usr/share/yunohost/helpers
+
+#=================================================
+# RETRIEVE ARGUMENTS
+#=================================================
+
+old_domain=$YNH_APP_OLD_DOMAIN
+old_path=$YNH_APP_OLD_PATH
+
+new_domain=$YNH_APP_NEW_DOMAIN
+new_path=$YNH_APP_NEW_PATH
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..." --weight=2
+
+# Needed for helper "ynh_add_nginx_config"
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+
+#=================================================
+# CHECK WHICH PARTS SHOULD BE CHANGED
+#=================================================
+
+change_domain=0
+if [ "$old_domain" != "$new_domain" ]
+then
+	change_domain=1
+fi
+
+change_path=0
+if [ "$old_path" != "$new_path" ]
+then
+	change_path=1
+fi
+
+#=================================================
+# CHECK IF THE APP CAN BE MOVED WITH THESE ARGS
+#=================================================
+
+if [ $change_domain -eq 1 ]
+then
+	# Check if .well-known is available for the new domain.
+	if is_url_handled "https://$new_domain/.well-known/caldav" || is_url_handled "https://$new_domain/.well-known/carddav"
+	then
+		ynh_die --message="Another app already uses the domain $new_domain to serve a caldav/carddav feature. Please use another domain."
+	fi
+fi
+
+#=================================================
+# STANDARD MODIFICATIONS
+#=================================================
+# MODIFY URL IN NGINX CONF
+#=================================================
+ynh_script_progression --message="Updating nginx web server configuration..." --weight=2
+
+nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+
+# Change the path in the nginx config file
+if [ $change_path -eq 1 ]
+then
+	# Make a backup of the original nginx config file if modified
+	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
+	# Set global variables for nginx helper
+	domain="$old_domain"
+	path_url="$new_path"
+	# Create a dedicated nginx config
+	ynh_add_nginx_config
+fi
+
+# Change the domain for nginx
+if [ $change_domain -eq 1 ]
+then
+	# Delete file checksum for the old conf file location
+	ynh_delete_file_checksum --file="$nginx_conf_path"
+	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+	# Store file checksum for the new config file location
+	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+fi
+
+#=================================================
+# SPECIFIC MODIFICATIONS
+#=================================================
+# UPDATE CONFIGURATION
+#=================================================
+ynh_script_progression --message="Updating baikal configuration..."
+
+ynh_replace_string --match_string="_BASEURI\", \"$old_path" --replace_string="_BASEURI\", \"$new_path" --target_file="${final_path}/Specific/config.system.php"
+
+#=================================================
+# GENERIC FINALISATION
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading nginx web server..."
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Change of URL completed for $app" --last

scripts/install

@@ -6,7 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-#source ./_common.sh
+source ./_common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -29,49 +29,52 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_print_info "Validating installation parameters..."
+ynh_script_progression --message="Validating installation parameters..."
 
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
-
 # Register (book) web path
-ynh_webpath_register $app $domain $path_url
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+
+# Check if .well-known is available for this domain.
+if is_url_handled "https://$domain/.well-known/caldav" || is_url_handled "https://$domain/.well-known/carddav"
+then
+    ynh_die --message="Another app already uses the domain $domain to serve a caldav/carddav feature. Please use another domain."
+fi
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_print_info "Storing installation settings..."
+ynh_script_progression --message="Storing installation settings..." --weight=2
 
-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
 
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
-ynh_print_info "Creating a MySQL database..."
+ynh_script_progression --message="Creating a MySQL database..."
 
 db_name=$(ynh_sanitize_dbid $app)
-ynh_app_setting_set $app db_name $db_name
+ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_mysql_setup_db $db_name $db_name
+ynh_mysql_setup_db --db_user=$db_name --db_name=$db_name
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_print_info "Setting up source files..."
+ynh_script_progression --message="Setting up source files..." --weight=8
 
-ynh_app_setting_set $app final_path $final_path
+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_print_info "Configuring nginx web server..."
+ynh_script_progression --message="Configuring nginx web server..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -79,15 +82,15 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_print_info "Configuring system user..."
+ynh_script_progression --message="Configuring system user..." --weight=3
 
 # Create a system user
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Configuring php-fpm..."
+ynh_script_progression --message="Configuring php-fpm..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
@@ -97,9 +100,9 @@ ynh_add_fpm_config
 #=================================================
 # INITIALIZE DATABASE
 #=================================================
-ynh_print_info "Configuring baikal..."
+ynh_script_progression --message="Configuring baikal..." --weight=3
 
-ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
+ynh_mysql_connect_as --user=$db_name --password="$db_pwd" --database=$db_name \
     < "${final_path}/Core/Resources/Db/MySQL/db.sql"
 
 #=================================================
@@ -109,29 +112,29 @@ ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
 bk_conf="${final_path}/Specific/config.php"
 cp ../conf/config.php "$bk_conf"
 
-ynh_replace_string "__TIMEZONE__" "$(cat /etc/timezone)" "$bk_conf"
+ynh_replace_string --match_string="__TIMEZONE__" --replace_string="$(cat /etc/timezone)" --target_file="$bk_conf"
 # Create admin password hash
 password_hash=$(echo -n admin:BaikalDAV:$password | md5sum | cut -d ' ' -f 1)
-ynh_replace_string "__PASSWORDHASH__" "${password_hash}" "$bk_conf"
+ynh_replace_string --match_string="__PASSWORDHASH__" --replace_string="${password_hash}" --target_file="$bk_conf"
-ynh_app_setting_set $app password_hash $password_hash
+ynh_app_setting_set --app=$app --key=password_hash --value=$password_hash
 
 # Store the config file checksum into the app settings
-ynh_store_file_checksum "$bk_conf"
+ynh_store_file_checksum --file="$bk_conf"
 
 bk_conf="${final_path}/Specific/config.system.php"
 cp ../conf/config.system.php "$bk_conf"
 
-ynh_replace_string "__PATH__" "$path_url" "$bk_conf"
+ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$bk_conf"
-ynh_replace_string "__DBNAME__" "$db_name" "$bk_conf"
+ynh_replace_string --match_string="__DBNAME__" --replace_string="$db_name" --target_file="$bk_conf"
-ynh_replace_string "__DBUSER__" "$db_name" "$bk_conf"
+ynh_replace_string --match_string="__DBUSER__" --replace_string="$db_name" --target_file="$bk_conf"
-ynh_replace_string "__DBPASS__" "$db_pwd" "$bk_conf"
+ynh_replace_string --match_string="__DBPASS__" --replace_string="$db_pwd" --target_file="$bk_conf"
 
 deskey=$(ynh_string_random 24)
-ynh_app_setting_set $app encrypt_key "$deskey"
+ynh_app_setting_set --app=$app --key=encrypt_key --value="$deskey"
-ynh_replace_string "__DESKEY__" "$deskey" "$bk_conf"
+ynh_replace_string --match_string="__DESKEY__" --replace_string="$deskey" --target_file="$bk_conf"
 
 # Store the config file checksum into the app settings
-ynh_store_file_checksum "$bk_conf"
+ynh_store_file_checksum --file="$bk_conf"
 
 # Disable installation
 touch "${final_path}/Specific/INSTALL_DISABLED"
@@ -150,22 +153,22 @@ chmod 640 "$final_path/Specific/"{config.php,config.system.php}
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_print_info "Configuring SSOwat..."
+ynh_script_progression --message="Configuring SSOwat..." --weight=2
 
 # Allow public access on /
-ynh_app_setting_set $app skipped_uris "/"
+ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
 # But restrain on /admin
-ynh_app_setting_set $app protected_uris "/admin/"
+ynh_app_setting_set --app=$app --key=protected_uris --value="/admin/"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_script_progression --message="Reloading nginx web server..."
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Installation of $app completed"
+ynh_script_progression --message="Installation of $app completed" --last

scripts/remove

@@ -12,36 +12,36 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..."
 
 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)
 
 #=================================================
 # STANDARD REMOVE
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
-ynh_print_info "Removing the MySQL database"
+ynh_script_progression --message="Removing the MySQL database" --weight=2
 
 # 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_name --db_name=$db_name
 
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_print_info "Removing app main directory"
+ynh_script_progression --message="Removing app main directory"
 
 # Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Removing nginx web server configuration"
+ynh_script_progression --message="Removing nginx web server configuration"
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -49,7 +49,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Removing php-fpm configuration"
+ynh_script_progression --message="Removing php-fpm configuration"
 
 # Remove the dedicated php-fpm config
 ynh_remove_fpm_config
@@ -59,13 +59,13 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_print_info "Removing the dedicated system user"
+ynh_script_progression --message="Removing the dedicated system user"
 
 # Delete a system user
-ynh_system_user_delete $app
+ynh_system_user_delete --username=$app
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Removal of $app completed"
+ynh_script_progression --message="Removal of $app completed" --last

scripts/restore

@@ -6,7 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# source ../settings/scripts/_common.sh
+source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -19,24 +19,30 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading settings..."
+ynh_script_progression --message="Loading settings..."
 
 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)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
-ynh_print_info "Validating restoration parameters..."
+ynh_script_progression --message="Validating restoration parameters..." --weight=2
 
-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 "
+
+# Check if .well-known is available for this domain.
+if is_url_handled "https://$domain/.well-known/caldav" || is_url_handled "https://$domain/.well-known/carddav"
+then
+    ynh_die --message="Another app already uses the domain $domain to serve a caldav/carddav feature. Please use another domain."
+fi
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -44,31 +50,31 @@ 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_print_info "Restoring the app main directory..."
+ynh_script_progression --message="Restoring the app main directory..."
 
-ynh_restore_file "$final_path"
+ynh_restore_file --origin_path="$final_path"
 
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
-ynh_print_info "Restoring the MySQL database..."
+ynh_script_progression --message="Restoring the MySQL database..." --weight=2
 
-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_name --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_name --password=$db_pwd --database=$db_name < ./db.sql
 
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_print_info "Recreating the dedicated system user..."
+ynh_script_progression --message="Recreating the dedicated system user..." --weight=3
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
 
 #=================================================
 # RESTORE USER RIGHTS
@@ -82,20 +88,20 @@ chown $app "$final_path/Specific/"{config.php,config.system.php}
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
+ynh_restore_file --origin_path="/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-ynh_print_info "Reloading nginx web server and php-fpm..."
+ynh_script_progression --message="Reloading nginx web server and php-fpm..."
 
-systemctl reload php7.0-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_print_info "Restoration completed for $app"
+ynh_script_progression --message="Restoration completed for $app" --last

scripts/upgrade

@@ -12,36 +12,42 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..." --weight=2
 
 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)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+
+upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-ynh_print_info "Ensuring downward compatibility..."
+ynh_script_progression --message="Ensuring downward compatibility..."
 
 # 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
 
 # If db_name doesn't exist, create it
-if [ -z $db_name ]; then
+if [ -z "$db_name" ]; then
-	db_name=$(ynh_sanitize_dbid $app)
+	db_name=$(ynh_sanitize_dbid --db_name=$app)
-	ynh_app_setting_set $app db_name $db_name
+	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 fi
 
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_print_info "Backing up the app before upgrading (may take a while)..."
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=4
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -57,22 +63,26 @@ ynh_abort_if_errors
 #=================================================
 
 # Normalize the URL path syntax
-path_url=$(ynh_normalize_url_path $path_url)
+path_url=$(ynh_normalize_url_path --path_url=$path_url)
 
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_print_info "Upgrading source files..."
 
-# Download, check integrity, uncompress and patch the source from app.src
+if [ "$upgrade_type" == "UPGRADE_APP" ]
-ynh_setup_source "$final_path"
+then
+	ynh_script_progression --message="Upgrading source files..." --weight=3
+
+	# Download, check integrity, uncompress and patch the source from app.src
+	ynh_setup_source --dest_dir="$final_path"
+fi
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Upgrading nginx web server configuration..."
+ynh_script_progression --message="Upgrading nginx web server configuration..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -80,15 +90,15 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_print_info "Making sure dedicated system user exists..."
+ynh_script_progression --message="Making sure dedicated system user exists..."
 
 # Create a dedicated user (if not existing)
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Upgrading php-fpm configuration..."
+ynh_script_progression --message="Upgrading php-fpm configuration..." --weight=2
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
@@ -98,59 +108,63 @@ ynh_add_fpm_config
 #=================================================
 # UPGRADE BAIKAL
 #=================================================
-ynh_print_info "Upgrading baikal..."
 
-# Run Baikal upgrade
+if [ "$upgrade_type" == "UPGRADE_APP" ]
-php "${final_path}/bin/upgrade.sh"
+then
+	ynh_script_progression --message="Upgrading baikal..."
 
-# Cleanup old baikal-admin sessions
+	# Run Baikal upgrade
-# since we may have changed owner of the session file
+	php "${final_path}/bin/upgrade.sh"
-grep --files-with-matches --recursive "CSRF_TOKEN|s:" /var/lib/php/sessions | xargs rm -f
 
-#=================================================
+	# Cleanup old baikal-admin sessions
-# UPGRADE BAIKAL CONFIGURATION
+	# since we may have changed owner of the session file
-#=================================================
+	grep --files-with-matches --recursive "CSRF_TOKEN|s:" /var/lib/php/sessions | xargs rm -f
-ynh_print_info "Upgrading baikal configuration..."
 
-bk_conf="${final_path}/Specific/config.php"
+	#=================================================
+	# UPGRADE BAIKAL CONFIGURATION
+	#=================================================
+	ynh_script_progression --message="Upgrading baikal configuration..." --weight=2
 
-# Verify the checksum and backup the file if it's different
+	bk_conf="${final_path}/Specific/config.php"
-ynh_backup_if_checksum_is_different "$bk_conf"
 
-cp ../conf/config.php "$bk_conf"
+	# Verify the checksum and backup the file if it's different
+	ynh_backup_if_checksum_is_different --file="$bk_conf"
 
-ynh_replace_string "__TIMEZONE__" "$(cat /etc/timezone)" "$bk_conf"
+	cp ../conf/config.php "$bk_conf"
 
-password_hash=$(ynh_app_setting_get $app password_hash)
+	ynh_replace_string --match_string="__TIMEZONE__" --replace_string="$(cat /etc/timezone)" --target_file="$bk_conf"
-# If the password_hash is not in the app's config, recreate it from the password.
+
-if [ -z "$password_hash" ]; then
+	password_hash=$(ynh_app_setting_get $app password_hash)
-    password=$(ynh_app_setting_get $app password)
+	# If the password_hash is not in the app's config, recreate it from the password.
-    password_hash=$(echo -n admin:BaikalDAV:$password | md5sum | cut -d ' ' -f 1)
+	if [ -z "$password_hash" ]; then
-    ynh_app_setting_set $app password_hash $password_hash
+		password=$(ynh_app_setting_get --app=$app --key=password)
+		password_hash=$(echo -n admin:BaikalDAV:$password | md5sum | cut -d ' ' -f 1)
+		ynh_app_setting_set --app=$app --key=password_hash --value=$password_hash
+	fi
+	ynh_replace_string --match_string="__PASSWORDHASH__" --replace_string="${password_hash}" --target_file="$bk_conf"
+
+	# Store the config file checksum into the app settings
+	ynh_store_file_checksum --file="$bk_conf"
+
+	bk_conf="${final_path}/Specific/config.system.php"
+
+	# Verify the checksum and backup the file if it's different
+	ynh_backup_if_checksum_is_different --file="$bk_conf"
+
+	cp ../conf/config.system.php "$bk_conf"
+
+	ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$bk_conf"
+	ynh_replace_string --match_string="__DBNAME__" --replace_string="$db_name" --target_file="$bk_conf"
+	ynh_replace_string --match_string="__DBUSER__" --replace_string="$db_name" --target_file="$bk_conf"
+	db_pwd=$(ynh_app_setting_get $app mysqlpwd)
+	ynh_replace_string --match_string="__DBPASS__" --replace_string="$db_pwd" --target_file="$bk_conf"
+
+	deskey=$(ynh_app_setting_get $app deskey)
+	ynh_replace_string --match_string="__DESKEY__" --replace_string="$deskey" --target_file="$bk_conf"
+
+	# Store the config file checksum into the app settings
+	ynh_store_file_checksum --file="$bk_conf"
 fi
-ynh_replace_string "__PASSWORDHASH__" "${password_hash}" "$bk_conf"
-
-# Store the config file checksum into the app settings
-ynh_store_file_checksum "$bk_conf"
-
-bk_conf="${final_path}/Specific/config.system.php"
-
-# Verify the checksum and backup the file if it's different
-ynh_backup_if_checksum_is_different "$bk_conf"
-
-cp ../conf/config.system.php "$bk_conf"
-
-ynh_replace_string "__PATH__" "$path_url" "$bk_conf"
-ynh_replace_string "__DBNAME__" "$db_name" "$bk_conf"
-ynh_replace_string "__DBUSER__" "$db_name" "$bk_conf"
-db_pwd=$(ynh_app_setting_get $app mysqlpwd)
-ynh_replace_string "__DBPASS__" "$db_pwd" "$bk_conf"
-
-deskey=$(ynh_app_setting_get $app deskey)
-ynh_replace_string "__DESKEY__" "$deskey" "$bk_conf"
-
-# Store the config file checksum into the app settings
-ynh_store_file_checksum "$bk_conf"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -166,22 +180,22 @@ chmod 640 "$final_path/Specific/"{config.php,config.system.php}
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_print_info "Upgrading SSOwat configuration..."
+ynh_script_progression --message="Configuring SSOwat..." --weight=2
 
 # Allow public access on /
-ynh_app_setting_set $app skipped_uris "/"
+ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
 # But restrain on /admin
-ynh_app_setting_set $app protected_uris "/admin/"
+ynh_app_setting_set --app=$app --key=protected_uris --value="/admin/"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_script_progression --message="Reloading nginx web server..."
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Upgrade of $app completed"
+ynh_script_progression --message="Upgrade of $app completed" --last