Merge pull request #24 from YunoHost-Apps/testing

Code refactored with the new_helpers

README.md

@@ -1,25 +1,42 @@
 # Cesium package for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/cesium.svg)](https://dash.yunohost.org/appci/app/cesium) ![](https://ci-apps.yunohost.org/ci/badges/cesium.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cesium.maintain.svg)  
-[![Install Custom Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=cesium)
+[![Install Cesium with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=cesium)
 
 
-> *This package allow you to install Cesium quickly and simply on a YunoHost server.  
+> *This package allows you to install Cesium quickly and simply on a YunoHost server.  
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
-
 [Cesium](https://cesium.app) is an [Unhosted webapp](https://unhosted.org) client for any [Duniter](https://duniter.org) crypto-currency.
 It allows you to manage your wallet, certify your friends, and more !
 
 **Shipped version:** v1.6.7
 
+## YunoHost specific features
+
+#### Supported architectures
+
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/cesium%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/cesium/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/cesium%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/cesium/)
+
 ## Links
 
-- [YunoHost website](https://yunohost.org)
+ * Report a bug: https://github.com/YunoHost-Apps/cesium_ynh/issues
-- [Duniter website](https://duniter.org)
+ * App website: https://duniter.org
-- [Cesium repository](https://github.com/duniter/cesium)
+ * Upstream app repository: https://github.com/duniter/cesium
+ * YunoHost website: https://yunohost.org/
 
-## License
+---
 
-This software is distributed under [GNU AGPL-3.0](https://raw.github.com/duniter/cesium/master/LICENSE).
+Developer info
+----------------
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cesium_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/cesium_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade cesium -u https://github.com/YunoHost-Apps/cesium_ynh/tree/testing --debug
+```

check_process

@@ -1,8 +1,7 @@
 ;; Test complet
-	auto_remove=1
 	; Manifest
 		domain="domain.tld"	(DOMAIN)
-		path="/cesium"	(PATH)
+		path="/path"	(PATH)
 		is_public=1	(PUBLIC|public=1|private=0)
 	; Checks
 		pkg_linter=1
@@ -12,12 +11,18 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# v1.6.7~ynh1
+		upgrade=1	from_commit=99330d46e45662b922de84e2e48ad1b15a63bb6e
 		backup_restore=1
 		multi_instance=0
-		wrong_user=0
-		wrong_path=1
-		incorrect_path=1
-		corrupt_source=0
-		fail_download_source=0
 		port_already_use=0
-		final_path_already_use=0
+		change_url=1
+;;; Levels
+	# If the level 5 (Package linter) is forced to 1. Please add justifications here.
+	Level 5=auto
+;;; Options
+Email=
+Notification=none
+;;; Upgrade options
+	; commit=99330d46e45662b922de84e2e48ad1b15a63bb6e
+		name=v1.6.7~ynh1

conf/nginx.conf

@@ -1,7 +1,8 @@
-location YNH_WWW_PATH {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
+location __PATH__/ {
 
   # Path to source
-  alias YNH_WWW_ALIAS ;
+  alias __FINALPATH__/ ;
 
   # Include SSOWAT user panel.
   include conf.d/yunohost_panel.conf.inc;

helper-update-version.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+!/bin/bash
 # Retrieve sources, get sha256sum, parse package version and update these strings in manifest, README and /conf/app.src
 
 URL=$(curl -s https://api.github.com/repos/duniter/cesium/releases/latest | grep "browser_" | grep "web" | head -1 | cut -d\" -f4)

issue_template.md

@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us debug, it would be nice to fill the template as much as you can to help us, help you and help us all.
+
+---
+
+**How to post a meaningful bug report**
+1. *Read this whole template first.*
+2. *Determine if you are on the right place:*
+   - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!*
+   - *Otherwise, the issue may be due to Cesium itself. Refer to its documentation or repository for help.*
+   - *If you have a doubt, post here, we will figure it out together.*
+3. *Delete the italic comments as you write over them below, and remove this guide.*
+--- 
+
+**Describe the bug**
+*A clear and concise description of what the bug is.*
+
+**Versions**
+- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
+- YunoHost version: x.x.x
+- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
+- Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes*
+  - If yes, please explain:
+- Using, or trying to install package version/branch:
+- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
+
+**To Reproduce**
+*Steps to reproduce the behavior.*
+- *If you performed a command from the CLI, the command itself is enough. For example:*
+    ```sh
+    sudo yunohost app install cesium
+    ```
+- *If you used the webadmin, please perform the equivalent command from the CLI first.*
+- *If the error occurs in your browser, explain what you did:*
+   1. *Go to '...'*
+   2. *Click on '....'*
+   3. *Scroll down to '....'*
+   4. *See error*
+
+**Expected behavior**
+*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
+
+**Logs**
+*After a failed command, YunoHost makes the log available to you, but also to others, thanks to `yunohost log display [log name] --share`. The actual command, with the correct log name, is displayed at the end of the failed attempt in the CLI. Execute it and copy here the share link it outputs.*
+*If applicable and useful, add screenshots to help explain your problem.*

manifest.json

@@ -15,7 +15,7 @@
         "url": "https://moul.re"
     },
     "requirements": {
-        "yunohost": ">> 2.4.0"
+        "yunohost": ">> 3.7.0"
     },
     "multi_instance": false,
     "services": [
@@ -49,6 +49,10 @@
                     "en": "Is it a public application?",
                     "fr": "Est-ce une application publique ?"
                 },
+                "help": {
+                    "en": "If it is a public application, there will not have authentification",
+                    "fr": "Si l'application est publique, il n'y aura pas d'authentification"
+                },
                 "default": false
             }
         ]

pull_request_template.md

@@ -0,0 +1,18 @@
+## Problem
+- *Description of why you made this PR*
+
+## Solution
+- *And how do you fix that problem*
+
+## PR Status
+- [ ] Code finished.
+- [ ] Tested with Package_check.
+- [ ] Fix or enhancement tested.
+- [ ] Upgrade from last version tested.
+- [ ] Can be reviewed and tested.
+
+## Package_check results
+---
+*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
+
+[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/cesium_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/cesium_ynh%20PR-NUM-%20(USERNAME)/)  

scripts/_common.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+#=================================================
+# COMMON VARIABLES
+#=================================================
+
+# dependencies used by the app
+pkg_dependencies=""
+
+#=================================================
+# PERSONAL HELPERS
+#=================================================
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================

scripts/backup

@@ -1,18 +1,54 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# See comments in install script
+#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
-app=$YNH_APP_INSTANCE_NAME
+source ../settings/scripts/_common.sh
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Backup sources & data
+#=================================================
-# Note: the last argument is where to save this path, see the restore script.
+# MANAGE SCRIPT FAILURE
-ynh_backup "/var/www/${app}" "sources"
+#=================================================
 
-# Copy NGINX configuration
+ynh_clean_setup () {
-domain=$(ynh_app_setting_get "$app" domain)
+  true
-ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf"
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_print_info --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+
+#=================================================
+# DECLARE DATA AND CONF FILES TO BACKUP
+#=================================================
+ynh_print_info --message="Declaring files to be backed up..."
+
+#=================================================
+# BACKUP THE APP MAIN DIR
+#=================================================
+
+ynh_backup --src_path="$final_path"
+
+#=================================================
+# BACKUP THE NGINX CONFIGURATION
+#=================================================
+
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/change_url

@@ -0,0 +1,90 @@
+#!/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..."
+
+# Needed for helper "ynh_add_nginx_config"
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+
+
+#=================================================
+# CHECK WHICH PARTS SHOULD BE CHANGED
+#=================================================
+ynh_script_progression --message="checking 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
+
+#=================================================
+# MODIFY URL IN NGINX CONF
+#=================================================
+ynh_script_progression --message="Updating nginx web server configuration..."
+
+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
+
+#=================================================
+# 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"

scripts/install

@@ -1,46 +1,114 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Retrieve arguments
+source _common.sh
-app=$YNH_APP_INSTANCE_NAME
-domain=$YNH_APP_ARG_DOMAIN
-path=$YNH_APP_ARG_PATH
-is_public=$YNH_APP_ARG_IS_PUBLIC
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Save app settings
+#=================================================
-ynh_app_setting_set "$app" is_public "$is_public"
+# MANAGE SCRIPT FAILURE
+#=================================================
 
-# Check domain/path availability
+ynh_clean_setup () {
-yunohost app checkurl "${domain}${path}" -a "$app" \
+  true
-    || ynh_die "Path not available: ${domain}${path}"
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
-# Retrieve sources and install them
+#=================================================
-src_path=/var/www/$app
+# RETRIEVE ARGUMENTS FROM THE MANIFEST
-mkdir -p $src_path
+#=================================================
+
+domain=$YNH_APP_ARG_DOMAIN
+path_url=$YNH_APP_ARG_PATH
+is_public=$YNH_APP_ARG_IS_PUBLIC
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
+#=================================================
+ynh_script_progression --message="Validating installation parameters..."
+
+final_path=/var/www/$app
+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..."
+
+ynh_app_setting_set --app=$app --key=domain --value=$domain
+ynh_app_setting_set --app=$app --key=path --value=$path_url
+ynh_app_setting_set --app=$app --key=is_public --value=$is_public
+
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
+ynh_script_progression --message="Setting up source files..."
+
+ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
-    ynh_script_progression --message="Setting up source files..." --time --weight=1
+ynh_setup_source --dest_dir="$final_path"
-	ynh_setup_source --dest_dir=$src_path
-chown -R www-data: $src_path
 
-# Modify Nginx configuration file and copy it to Nginx conf directory
+#=================================================
-nginx_conf=../conf/nginx.conf
+# NGINX CONFIGURATION
-sed -i "s@YNH_WWW_PATH@$path@g" $nginx_conf
+#=================================================
-sed -i "s@YNH_WWW_ALIAS@$src_path/@g" $nginx_conf
+ynh_script_progression --message="Configuring nginx web server..."
-cp $nginx_conf /etc/nginx/conf.d/$domain.d/$app.conf
 
-# If app is public, add url to SSOWat conf as skipped_uris
+### `ynh_add_nginx_config` will use the file conf/nginx.conf
-if [[ $is_public -eq 1 ]]; then
+# Create a dedicated nginx config
-  # unprotected_uris allows SSO credentials to be passed anyway.
+ynh_add_nginx_config
-  ynh_app_setting_set "$app" unprotected_uris "/"
 
-  # activate read-only mode
+
-  ynh_replace_string --match_string='"readonly": false,' --replace_string='"readonly": true,' --target_file="$src_path/config.js"
+if [ "$path_url" != "/" ]
+then
+  ynh_replace_string "^#sub_path_only" "" "/etc/nginx/conf.d/$domain.d/$app.conf"
 fi
 
-# Reload nginx service
+#=================================================
-systemctl reload nginx
+# GENERIC FINALIZATION
+#=================================================
+# SECURE FILES AND DIRECTORIES
+#=================================================
+ynh_script_progression --message="Securing files and directories..."
+
+# Set permissions to app files
+chown -R www-data: $final_path
+
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Configuring SSOwat..."
+
+# Remove the public access
+ynh_app_setting_delete --app=$app --key=skipped_uris
+
+# If app is public, add url to SSOWat conf as skipped_uris and read-only mode
+if [ $is_public -eq 1 ]
+then
+  # unprotected_uris allows SSO credentials to be passed anyway.
+  ynh_permission_update --permission "main" --add "visitors"
+  # activate read-only
+  ynh_replace_string --match_string='"readonly": false,' --replace_string='"readonly": true,' --target_file="$final_path/config.js"
+fi
+
+#=================================================
+# 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="Installation of $app completed"

scripts/remove

@@ -1,17 +1,43 @@
 #!/bin/bash
 
-# Source YunoHost helpers
+#=================================================
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+source _common.sh
 source /usr/share/yunohost/helpers
 
-# Retrieve app settings
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..."
+
 app=$YNH_APP_INSTANCE_NAME
-domain=$(ynh_app_setting_get "$app" domain)
 
-# Remove sources
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-ynh_secure_remove /var/www/$app
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
-# Remove configuration files
-rm -f /etc/nginx/conf.d/$domain.d/$app.conf
 
-# Reload nginx service
+#=================================================
-systemctl reload nginx
+# REMOVE APP MAIN DIR
+#=================================================
+ynh_script_progression --message="Removing app main directory..."
+
+# Remove the app directory securely
+ynh_secure_remove --file="$final_path"
+
+#=================================================
+# REMOVE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing nginx web server configuration..."
+
+# Remove the dedicated nginx config
+ynh_remove_nginx_config
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Removal of $app completed"

scripts/restore

@@ -1,35 +1,81 @@
 #!/bin/bash
 
-# Note: each files and directories you've saved using the ynh_backup helper
+#=================================================
-# will be located in the current directory, regarding the last argument.
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Exit on command errors and treat unset variables as an error
+#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
-set -eu
+source ../settings/scripts/_common.sh
-
-# See comments in install script
-app=$YNH_APP_INSTANCE_NAME
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Retrieve old app settings
+#=================================================
-domain=$(ynh_app_setting_get "$app" domain)
+# MANAGE SCRIPT FAILURE
-path=$(ynh_app_setting_get "$app" path)
+#=================================================
 
-# Check domain/path availability
+ynh_clean_setup () {
-yunohost app checkurl "${domain}${path}" -a "$app" \
+  true
-    || ynh_die "Path not available: ${domain}${path}"
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
-# Restore sources & data
+#=================================================
-src_path="/var/www/${app}"
+# LOAD SETTINGS
-cp -a ./sources "$src_path"
+#=================================================
+ynh_script_progression --message="Loading settings..."
 
-# Restore permissions to app files
+app=$YNH_APP_INSTANCE_NAME
-# you may need to make some file and/or directory writeable by www-data (nginx user)
-chown -R www-data: "$src_path"
 
-# Restore NGINX configuration
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf"
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
-# Restart webserver
+#=================================================
-systemctl reload nginx
+# CHECK IF THE APP CAN BE RESTORED
+#=================================================
+ynh_script_progression --message="Validating restoration parameters..."
+
+ynh_webpath_available --domain=$domain --path_url=$path_url \
+  || ynh_die --message="Path not available: ${domain}${path_url}"
+test ! -d $final_path \
+  || ynh_die --message="There is already a directory: $final_path "
+
+#=================================================
+# STANDARD RESTORATION STEPS
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the nginx configuration..."
+
+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..."
+
+ynh_restore_file --origin_path="$final_path"
+
+#=================================================
+# RESTORE USER RIGHTS
+#=================================================
+ynh_script_progression --message="Restoring user rights..."
+
+# Restore permissions on app files
+chown -R www-data: $final_path
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# 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="Restoration completed for $app"

scripts/upgrade

@@ -1,55 +1,135 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Source YunoHost helpers
+source _common.sh
 source /usr/share/yunohost/helpers
 
-# Retrieve app settings
+#=================================================
-app=$YNH_APP_INSTANCE_NAME
+# LOAD SETTINGS
-domain=$(ynh_app_setting_get "$app" domain)
+#=================================================
-path=$(ynh_app_setting_get "$app" path)
+ynh_script_progression --message="Loading installation settings..."
-is_public=$(ynh_app_setting_get "$app" is_public)
+
+app=$YNH_APP_INSTANCE_NAME
+
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+is_public=$(ynh_app_setting_get --app=$app --key=is_public)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+ynh_script_progression --message="Checking version..."
 
-### 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)
 
-# Remove trailing "/" for next commands
+#=================================================
-path=${path%/}
+# ENSURE DOWNWARD COMPATIBILITY
+#=================================================
+ynh_script_progression --message="Ensuring downward compatibility..."
+
+# Fix is_public as a boolean value
+if [ "$is_public" = "Yes" ]; then
+  ynh_app_setting_set --app=$app --key=is_public --value=1
+  is_public=1
+elif [ "$is_public" = "No" ]; then
+  ynh_app_setting_set --app=$app --key=is_public --value=0
+  is_public=0
+fi
+
+# If final_path doesn't exist, create it
+if [ -z "$final_path" ]; then
+  final_path=/var/www/$app
+  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)..."
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+  # restore it if the upgrade fails
+  ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# CHECK THE PATH
+#=================================================
+
+# Normalize the URL path syntax
+# 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)
+
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
 
-# Retreive sources and install them
-src_path=/var/www/$app
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
-	ynh_secure_remove $src_path
+  ynh_script_progression --message="Upgrading source files..."
-	mkdir -p $src_path
-	ynh_script_progression --message="Upgrading source files..." --time --weight=1
 
   # Download, check integrity, uncompress and patch the source from app.src
-	ynh_setup_source --dest_dir=$src_path
+  ynh_setup_source --dest_dir="$final_path"
-	chown -R www-data: $src_path
 fi
 
+#=================================================
+# NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Upgrading nginx web server configuration..."
 
-# Modify Nginx configuration file and copy it to Nginx conf directory
+# Create a dedicated nginx config
-nginx_conf=../conf/nginx.conf
+ynh_add_nginx_config
-sed -i "s@YNH_WWW_PATH@$path@g" $nginx_conf
-sed -i "s@YNH_WWW_ALIAS@$src_path/@g" $nginx_conf
-cp $nginx_conf /etc/nginx/conf.d/$domain.d/$app.conf
 
-# If app is public, add url to SSOWat conf as skipped_uris
+if [ "$path_url" != "/" ]
+then
+  ynh_replace_string "^#sub_path_only" "" "/etc/nginx/conf.d/$domain.d/$app.conf"
+fi
+
+#=================================================
+# SECURE FILES AND DIRECTORIES
+#=================================================
+ynh_script_progression --message="Securing files and directories..."
+
+# Set permissions on app files
+chown -R www-data: $final_path
+
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Upgrading SSOwat configuration..."
+
+# If app is public, add url to SSOWat conf as skipped_uris and read-only mode
 if [[ $is_public -eq 1 ]]; then
-  ynh_app_setting_set "$app" unprotected_uris "/"
+  # unprotected_uris allows SSO credentials to be passed anyway.
-
+  ynh_permission_update --permission "main" --add "visitors"
-  # activate read-only mode
+  # activate read-only
-  ynh_replace_string --match_string='"readonly": false,' --replace_string='"readonly": true,' --target_file="$src_path/config.js"
+  ynh_replace_string --match_string='"readonly": false,' --replace_string='"readonly": true,' --target_file="$final_path/config.js"
 fi
 
-# Reload nginx service
+#=================================================
-systemctl reload nginx
+# 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="Upgrade of $app completed"