Merge branch 'master' into sury

README.md

@@ -1,13 +1,13 @@
 <p align="center"><img src="https://firefly-iii.org/static/img/logo-small-new.png"></p>
 
-# Firefly III v4.7.9 for YunoHost
+# Firefly III v5.2.0 for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/Firefly-III.svg)](https://ci-apps.yunohost.org/jenkins/job/firefly-iii%20%28Community%29/lastBuild/consoleFull)
 
 [![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly-iii)<br><br>
 
 
-*Please note that this app will install PHP 7.2*
+*Please note that this app will install PHP 7.3*
 
 ## Introduction
 "Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. You can [read all about it in the main repository](https://github.com/firefly-iii/firefly-iii) and in the [official documentation](https://firefly-iii.readthedocs.io/en/latest/).
@@ -19,61 +19,10 @@
 - [Firefly III on GitHub](https://github.com/firefly-iii/firefly-iii)
 - [Demo 1](https://demo.firefly-iii.org/login), [Demo 2](http://www.softaculous.com/softaculous/demos/Firefly_III)
 
-### Screenshots
-
-[![The index of Firefly III](https://firefly-iii.org/static/screenshots/4.7.4/tiny/index.png)](https://firefly-iii.org/static/screenshots/4.7.4/index.png) [![The account overview of Firefly III](https://firefly-iii.org/static/screenshots/4.7.4/tiny/account.png)](https://firefly-iii.org/static/screenshots/4.7.4/account.png)
-
-[![Overview of all budgets](https://firefly-iii.org/static/screenshots/4.7.4/tiny/budget.png)](https://firefly-iii.org/static/screenshots/4.7.4/budget.png) [![Overview of a category](https://firefly-iii.org/static/screenshots/4.7.4/tiny/category.png)](https://firefly-iii.org/static/screenshots/4.7.4/category.png)
-
-### Features
-
-Most importantly...
-
-* Firefly III runs on your own server, so you are fully in control of your data. It will not contact other sites or servers.
-* You can import from over 2500 financial providers, in 55 countries when you enable the [Spectre API](http://firefly-iii.readthedocs.io/en/latest/import/spectre.html).
-* You can import from [bunq](https://www.bunq.com/).
-* You can import CSV files from practically any bank.
-* Firefly III features an JSON REST API.
-
-But actually, it features:
-
-* [A double-entry bookkeeping system](http://firefly-iii.readthedocs.io/en/latest/concepts/transactions.html)
-* You can store, edit and remove [withdrawals, deposits and transfers](http://firefly-iii.readthedocs.io/en/latest/concepts/transactions.html). This allows you full financial management
-* You can manage different types of accounts
-  * [Asset](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html) accounts
-  * Shared [asset accounts](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html) ([household accounts](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html))
-  * Saving accounts
-  * Credit cards
-* It's possible to create, change and manage money using [budgets](http://firefly-iii.readthedocs.io/en/latest/concepts/budgets.html)
-* Organize transactions using [categories](http://firefly-iii.readthedocs.io/en/latest/concepts/categories.html)
-* Save towards a goal using [piggy banks](http://firefly-iii.readthedocs.io/en/latest/advanced/piggies.html)
-* Predict and anticipate [bills](http://firefly-iii.readthedocs.io/en/latest/advanced/bills.html)
-* View income / expense [reports](http://firefly-iii.readthedocs.io/en/latest/advanced/reports.html)
-* [Rule based](http://firefly-iii.readthedocs.io/en/latest/advanced/rules.html) transaction handling with the ability to create your own rules.
-* The ability to [export data](http://firefly-iii.readthedocs.io/en/latest/import/export.html) so you can move to another system.
-* The ability to [import data](http://firefly-iii.readthedocs.io/en/latest/import/csv.html) so you can move _from_ another system.
-* Organize expenses using [tags](http://firefly-iii.readthedocs.io/en/latest/concepts/tags.html)
-* 2 factor authentication for extra security 🔒
-* Supports any currency you want, including [crypto currencies](http://firefly-iii.readthedocs.io/en/latest/concepts/currencies.html) such as ₿itcoin  and Ξthereum
-* Lots of help text in case you don’t get it
-* Translations into 10(!) languages, proudly powered by Crowdin
-
-Everything is organised:
-
-* Clear views that should show you how you're doing
-* Easy navigation through your records
-* Browse back and forth to see previous months or even years
-* Lots of charts because we all love them
-* Financial reporting showing you how well you are doing
-* Lots of math because we all like math!
-
 ### Installation on YunoHost
 
-- Firefly III requires a **dedicated (sub)domain** (must install under web root like **https://firefly.example.com/** not **https://example.com/firefly/** )
+- Tested under a subdirectory on an existing domain
-
+- Tested on amd64 and arm64 arches
-#### Register a new domain and add it to YunoHost
-
-Firefly III requires a dedicated (sub)domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As Firefly III uses the full domain and is installed on the root, you can create a subdomain such as firefly.domain.tld. Don't forget to update your DNS if you manage them manually.
 
 #### Install the Firefly III application
 
@@ -89,5 +38,11 @@ Or use the command line to install the Firefly III app:
 $ yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh
 ```
 
-- The admin user should be a registered YunoHost user.
+- The admin user should be the first user to log into Firefly III
-- Important: when the installation is complete, you will have to visit the domain on which the app is installed and register the first account with the **primary email address of the Admin user given at the time of installayion** (otherwise you will not get admin rights). The registration will lock itself after the first registration.
+- SSO is not working yet
+- You will probably be warned about missing locale from your system. Once you change the language to those corresponding to your system, the warning will desapear
+
+TODO
+ - [ ] Make Firefly III admin user dependant of the user choosen at installation
+ - [ ] Make SSO work
+ - [ ] Define default language according to system language

check_process

@@ -37,3 +37,7 @@
 ;;; Options
 Email=anmol@datamol.org
 Notification=change
+;;; Upgrade options
+    ; commit=CommitHash
+        name=Name and date of the commit.
+        manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1&password=pass&

conf/.env

@@ -19,7 +19,7 @@ TZ=UTC
 
 # This variable must match your installation's external address but keep in mind that
 # it's only used on the command line as a fallback value.
-APP_URL=http://localhost
+APP_URL=https://yunoappurl
 
 # TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
 TRUSTED_PROXIES=
@@ -109,7 +109,7 @@ USE_ENCRYPTION=false
 # and "adldap" for LDAP servers.
 # For full instructions on these settings please visit:
 # https://firefly-iii.readthedocs.io/en/latest/installation/authentication.html
-LOGIN_PROVIDER=eloquent
+LOGIN_PROVIDER=ldap
 
 # LDAP connection configuration
 # OpenLDAP, FreeIPA or ActiveDirectory
@@ -117,10 +117,10 @@ ADLDAP_CONNECTION_SCHEME=OpenLDAP
 ADLDAP_AUTO_CONNECT=true
 
 # LDAP connection settings
-ADLDAP_CONTROLLERS=
+ADLDAP_CONTROLLERS=localhost
 ADLDAP_PORT=389
 ADLDAP_TIMEOUT=5
-ADLDAP_BASEDN=""
+ADLDAP_BASEDN="dc=yunohost,dc=org"
 ADLDAP_FOLLOW_REFFERALS=false
 ADLDAP_USE_SSL=false
 ADLDAP_USE_TLS=false
@@ -128,8 +128,8 @@ ADLDAP_USE_TLS=false
 ADLDAP_ADMIN_USERNAME=
 ADLDAP_ADMIN_PASSWORD=
 
-ADLDAP_ACCOUNT_PREFIX=
+ADLDAP_ACCOUNT_PREFIX="uid="
-ADLDAP_ACCOUNT_SUFFIX=
+ADLDAP_ACCOUNT_SUFFIX=",ou=users,dc=yunohost,dc=org"
 ADLDAP_ADMIN_ACCOUNT_PREFIX=
 ADLDAP_ADMIN_ACCOUNT_SUFFIX=
 
@@ -137,15 +137,15 @@ ADLDAP_ADMIN_ACCOUNT_SUFFIX=
 ADLDAP_PASSWORD_SYNC=false
 ADLDAP_LOGIN_FALLBACK=false
 
-ADLDAP_DISCOVER_FIELD=distinguishedname
+ADLDAP_DISCOVER_FIELD=uid
-ADLDAP_AUTH_FIELD=distinguishedname
+ADLDAP_AUTH_FIELD=uid
 
 # Will allow SSO if your server provides an AUTH_USER field.
 WINDOWS_SSO_DISCOVER=samaccountname
 WINDOWS_SSO_KEY=AUTH_USER
 
 # field to sync as local username.
-ADLDAP_SYNC_FIELD=userprincipalname
+ADLDAP_SYNC_FIELD=uid
 
 # You can disable the X-Frame-Options header if it interfears with tools like
 # Organizr. This is at your own risk.

conf/app.src

@@ -1,6 +1,6 @@
-SOURCE_URL=https://github.com/firefly-iii/firefly-iii/archive/4.7.9.tar.gz
+SOURCE_URL=https://github.com/firefly-iii/firefly-iii/archive/5.2.0.tar.gz
-SOURCE_SUM=7b57a8af0bfcb5c38534cf31944f465ce60348a4a20f93986647235dffe76569
+SOURCE_SUM=136ddb92167a63e0eeafc91c18d12285e28533f18441b80a683d69cb1ea05115
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=
+SOURCE_FILENAME=firefly-iii-5.2.0.tar.gz

conf/nginx.conf

@@ -1,24 +1,30 @@
-location ^~ __PATH__ {
+rewrite ^__PATH__$ __PATH__/ permanent;
+location ^~ __PATH__/ {
   alias __FINALPATH__/public/;
-try_files $uri $uri/ @firefly;  
+
-index index.php index.htm index.html;
+  index index.php;
+
   # Force https
   if ($scheme = http) {
     rewrite ^ https://$server_name$request_uri? permanent;
   }
-  location ~ \.php {
+
+  try_files $uri $uri/ /$uri /$uri/ @firefly;
+  
+  location ~* \.php(?:$|/) {
     fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-    fastcgi_pass unix:/var/run/php7.2-fpm-__NAME__.sock;
+    fastcgi_pass unix:/var/run/php7.3-fpm-__NAME__.sock;
-    fastcgi_index index.php;
+    fastcgi_param modHeadersAvailable true;
     include fastcgi_params;
     fastcgi_param REMOTE_USER     $remote_user;
     fastcgi_param PATH_INFO       $fastcgi_path_info;
     fastcgi_param SCRIPT_FILENAME $request_filename;
   }
-}
   
+  include conf.d/yunohost_panel.conf.inc;
+
+}
 
 location @firefly {
-    rewrite /(.*)$ /index.php?/$1 last;
+  rewrite __PATH__/(.*)$ __PATH__/index.php?/$1 last;
 }
-

conf/php-fpm.conf

@@ -30,7 +30,7 @@ group = __USER__
 ;                            specific port;
 ;   '/path/to/unix/socket' - to listen on a unix socket.
 ; Note: This value is mandatory.
-listen = /var/run/php7.2-fpm-__NAMETOCHANGE__.sock
+listen = /var/run/php7.3-fpm-__NAMETOCHANGE__.sock
 
 ; Set listen(2) backlog. A value of '-1' means unlimited.
 ; Default Value: 128 (-1 on FreeBSD and OpenBSD)

manifest.json

@@ -6,7 +6,7 @@
         "en": "Firefly III is a self-hosted financial manager.",
         "fr": "Firefly III est un gestionnaire de finances personnelles."
     },
-    "version": "4.7.9",
+    "version": "5.2.0",
     "url": "https://firefly-iii.org/",
     "license": "GPL v3",
     "maintainer": {
@@ -15,12 +15,12 @@
         "url": "https://datamol.org"
     },
     "requirements": {
-        "yunohost": ">= 2.7.2"
+        "yunohost": ">= 3.5.0"
     },
     "multi_instance": true,
     "services": [
         "nginx",
-        "php7.2-fpm",
+        "php7.3-fpm",
         "mysql"
     ],
     "arguments": {
@@ -34,6 +34,16 @@
                 },
                 "example": "example.com"
             },
+            {
+                "name": "path",
+                "type": "path",
+                "ask": {
+                    "en": "Choose a path for Firefly III",
+                    "fr": "Choisissez un chemin pour Firefly III"
+                },
+                "example": "/example",
+		"default": "/firefly"
+            },
             {
                 "name": "admin",
                 "type": "user",

scripts/_common.sh

@@ -1,5 +1,13 @@
 #!/bin/bash
 
+#=================================================
+# COMMON VARIABLES
+#=================================================
+
+# dependencies used by the app
+phpversion="7.3"
+pkg_dependencies="php${phpversion}-zip php${phpversion}-fpm php${phpversion}-mysql php${phpversion}-xml php${phpversion}-intl php${phpversion}-mbstring php${phpversion}-gd php${phpversion}-curl php${phpversion}-bcmath php${phpversion}-opcache php${phpversion}-ldap"
+
 # ============= FUTURE YUNOHOST HELPER =============
 # Delete a file checksum from the app settings
 #
@@ -12,50 +20,6 @@ ynh_delete_file_checksum () {
 	ynh_app_setting_delete $app $checksum_setting_name
 }
 
-# Create a dedicated php-fpm config
-#
-# usage: ynh_add_fpm_config
-ynh_add_fpm7.2_config () {
-	# Configure PHP-FPM 7.1 by default
-	ynh_secure_remove "/etc/php/7.1/fpm/pool.d/$app.conf"   2>&1
-	ynh_secure_remove "/etc/php/7.1/fpm/conf.d/20-$app.ini" 2>&1
-	local fpm_config_dir="/etc/php/7.2/fpm"
-	local fpm_service="php7.2-fpm"
-	ynh_app_setting_set $app fpm_config_dir "$fpm_config_dir"
-	ynh_app_setting_set $app fpm_service "$fpm_service"
-	finalphpconf="$fpm_config_dir/pool.d/$app.conf"
-	ynh_backup_if_checksum_is_different "$finalphpconf"
-	sudo cp ../conf/php-fpm.conf "$finalphpconf"
-	ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
-	ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
-	ynh_replace_string "__USER__" "$app" "$finalphpconf"
-	sudo chown root: "$finalphpconf"
-	ynh_store_file_checksum "$finalphpconf"
-
-	if [ -e "../conf/php-fpm.ini" ]
-	then
-		finalphpini="$fpm_config_dir/conf.d/20-$app.ini"
-		ynh_backup_if_checksum_is_different "$finalphpini"
-		sudo cp ../conf/php-fpm.ini "$finalphpini"
-		sudo chown root: "$finalphpini"
-		ynh_store_file_checksum "$finalphpini"
-	fi
-	sudo systemctl reload $fpm_service
-}
-
-# Remove the dedicated php-fpm config
-#
-# usage: ynh_remove_fpm7.1_config
-ynh_remove_fpm7.2_config () {
-	local fpm_config_dir=$(ynh_app_setting_get $app fpm_config_dir)
-	local fpm_service=$(ynh_app_setting_get $app fpm_service)
-	ynh_secure_remove "$fpm_config_dir/pool.d/$app.conf"
-	ynh_secure_remove "$fpm_config_dir/conf.d/20-$app.ini" 2>&1
-	sudo systemctl reload $fpm_service
-}
-
-
-
 # Execute a command as another user
 # usage: exec_as USER COMMAND [ARG ...]
 exec_as() {
@@ -74,58 +38,7 @@ exec_as() {
 # Composer helpers
 #
 
-# Execute a composer command from a given directory
-# usage: composer_exec AS_USER WORKDIR COMMAND [ARG ...]
-exec_composer() {
-  local WORKDIR=$1
-  shift 1
-
-  COMPOSER_HOME="${WORKDIR}/.composer" \
-    sudo /usr/bin/php7.2 "${WORKDIR}/composer.phar" $@ \
-      -d "${WORKDIR}"  --no-interaction
-}
-
-# Install and initialize Composer in the given directory
-# usage: init_composer DESTDIR [AS_USER]
-init_composer() {
-  local DESTDIR=$1
-  local AS_USER=${2:-admin}
-
-  # install composer
-  curl -sS https://getcomposer.org/installer \
-    | COMPOSER_HOME="${DESTDIR}/.composer" \
-        sudo /usr/bin/php7.2 -- --quiet --install-dir="$DESTDIR" \
-    || ynh_die "Unable to install Composer"
-
-  # update dependencies to create composer.lock
-  exec_composer "$DESTDIR" install  --no-dev --prefer-dist --no-scripts \
-    || ynh_die "Unable to update firefly-iii core dependencies"
-}
 
 sudo_path () {
 	sudo env "PATH=$PATH" $@
 }
-
-#
-# PHP7 helpers
-#
-
-ynh_install_php7 () {
-
-  ynh_package_update
-  ynh_package_install apt-transport-https --no-install-recommends
-
-  wget -q -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg
-  echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/php7.list
-
-  ynh_package_update
-  ynh_install_app_dependencies php7.2 php7.2-zip php7.2-fpm php7.2-mysql php7.2-xml php7.2-intl php7.2-mbstring php7.2-gd php7.2-curl php7.2-bcmath php7.2-opcache php7.2-ldap
-  sudo update-alternatives --install /usr/bin/php php /usr/bin/php5 70
-}
-
-ynh_remove_php7 () {
-  sudo rm -f /etc/apt/sources.list.d/php7.list
-  sudo apt-key del 4096R/89DF5277
-  sudo apt-key del 2048R/11A06851
-  ynh_remove_app_dependencies php7.2 php7.2-zip php7.2-fpm php7.2-mysql php7.2-xml php7.2-intl php7.2-mbstring php7.2-gd php7.2-curl php7.2-bcmath php7.2-opcache
-}

scripts/backup

@@ -11,9 +11,14 @@ if [ ! -e _common.sh ]; then
 	cp ../settings/scripts/_common.sh ./_common.sh
 	chmod a+rx _common.sh
 fi
+
 source _common.sh
+source ynh_add_extra_apt_repos__3
+source ynh_install_php__3
+source ynh_composer
 source /usr/share/yunohost/helpers
 
+
 #=================================================
 # MANAGE SCRIPT FAILURE
 #=================================================
@@ -24,39 +29,53 @@ 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
 #=================================================
+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/php/7.2/fpm/pool.d/$app.conf"
+ynh_backup --src_path="/etc/php/$phpversion/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 "$db_name" > db.sql
+ynh_mysql_dump_db --database="$db_name" > db.sql
 
+#=================================================
+# SPECIFIC BACKUP
+#=================================================
+# BACKUP LOGROTATE
+#=================================================
+ynh_script_progression --message="Backing up logrotate configuration..." --time --weight=1
 
+ynh_backup --src_path="/etc/logrotate.d/$app"
 
+#=================================================
+# END OF SCRIPT
+#=================================================
 
+ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --time --last

scripts/change_url

@@ -51,6 +51,7 @@ fi
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
+ynh_script_progression --message="Updating nginx web server configuration..." --time --weight=1
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
@@ -58,24 +59,24 @@ nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 if [ $change_path -eq 1 ]
 then
     # Make a backup of the original nginx config file if modified
-  ynh_backup_if_checksum_is_different "$nginx_conf_path"
+    ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
     # Replace locations starting with old_path
     # Look for every location possible patterns (see https://nginx.org/en/docs/http/ngx_http_core_module.html#location)
     ynh_replace_string "location\( \(=\|~\|~\*\|\^~\)\)\? $old_path" "location\1 $new_path"  "$nginx_conf_path"
     # Replace path in "return" directives
     ynh_replace_string "return \([[:digit:]]\{3\}\) $old_path" "return \1 $new_path"  "$nginx_conf_path"
     # Calculate and store the nginx config file checksum
-  ynh_store_file_checksum "$nginx_conf_path"
+    ynh_store_file_checksum --file="$nginx_conf_path"
 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 "$nginx_conf_path"
+    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 "/etc/nginx/conf.d/$new_domain.d/$app.conf"
+    ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 
 #=================================================
@@ -84,10 +85,15 @@ fi
 # ...
 #=================================================
 
-#=================================================
-# GENERIC FINALISATION
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Change of URL completed for $app" --time --last

scripts/install

@@ -7,6 +7,9 @@
 #=================================================
 
 source _common.sh
+source ynh_add_extra_apt_repos__3
+source ynh_install_php__3
+source ynh_composer
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -21,7 +24,7 @@ ynh_abort_if_errors
 #=================================================
 
 domain=$YNH_APP_ARG_DOMAIN
-path_url="/"
+path_url=$YNH_APP_ARG_PATH
 admin=$YNH_APP_ARG_ADMIN
 is_public=$YNH_APP_ARG_IS_PUBLIC
 random_key=$(ynh_string_random 32)
@@ -41,55 +44,55 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
+ynh_script_progression --message="Validating installation parameters..." --time --weight=1
 
 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"
 
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
-
-# Check web path availability
-ynh_webpath_available $domain $path_url
 # Register (book) web path
-ynh_webpath_register $app $domain $path_url
+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
-ynh_app_setting_set $app is_public $is_public
+ynh_app_setting_set --app=$app --key=is_public --value=$is_public
-ynh_app_setting_set $app random_key $random_key
+ynh_app_setting_set --app=$app --key=random_key --value=$random_key
 
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
 
-ynh_install_php7
+ynh_script_progression --message="Installing dependencies..." --time --weight=1
+ynh_install_php --phpversion="$phpversion" --package="$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)
+db_name=$(ynh_sanitize_dbid --db_name=$app)
-ynh_app_setting_set $app db_name $db_name
+db_user=$db_name
-ynh_mysql_setup_db $db_name $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_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
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -97,26 +100,34 @@ 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 7.2 CONFIGURATION
+# PHP-FPM 7.3 CONFIGURATION
 #=================================================
 
+ynh_script_progression --message="Configuring php-fpm..." --time --weight=1
+
 # Create a dedicated php-fpm7.1 config
-ynh_add_fpm7.2_config
+#ynh_add_fpm7.2_config
+ynh_add_fpm_config --phpversion="$phpversion"
 
 #=================================================
 # SPECIFIC SETUP
 #=================================================
 
+# Install via composer
+ynh_install_composer --phpversion="$phpversion"
+
 # create a user
 email=$(ynh_user_get_info $admin 'mail')
 
 # setup application config
 sudo  cp ../conf/.env $final_path/.env
+
 #=================================================
 # MODIFY A CONFIG FILE
 #=================================================
@@ -126,23 +137,23 @@ ynh_replace_string "yunopass"   "$db_pwd"     "$final_path/.env"
 ynh_replace_string "yunobase"   "$db_name"    "$final_path/.env"
 ynh_replace_string "yunomail"   "$email"      "$final_path/.env"
 ynh_replace_string "yunodomain" "$domain"     "$final_path/.env"
+ynh_replace_string "yunoappurl" "$domain$path_url" "$final_path/.env"
 
-init_composer $final_path
-( cd $final_path && sudo /usr/bin/php7.2 artisan config:clear )
 
-db_name=$(ynh_sanitize_dbid $app)
+#init_composer $final_path $app
+
+cd $final_path && php$phpversion artisan migrate:refresh --seed && cd $YNH_CWD 
+cd $final_path && php$phpversion artisan firefly-iii:upgrade-database && cd $YNH_CWD 
+cd $final_path && php$phpversion artisan passport:install && cd $YNH_CWD 
+
 
-# setup application config
-(
-cd $final_path && sudo /usr/bin/php7.2 artisan -q :refresh --seed --force
-cd $final_path && sudo /usr/bin/php7.2 artisan passport:install  --force
-)
 #=================================================
 # SETUP APPLICATION PERMISSIONS
 #=================================================
 
 # Set right permissions
-chown -R $app: $final_path
+chown -R $app:$app $final_path
+chmod -R 775 ${final_path}/storage
 
 #=================================================
 # STORE THE CHECKSUM OF THE CONFIG FILE
@@ -154,6 +165,7 @@ ynh_store_file_checksum "$final_path/.env"
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_script_progression --message="Configuring SSOwat..." --time --weight=1
 
 if [ $is_public -eq 0 ]
 then	# Remove the public access
@@ -166,14 +178,48 @@ then
     ynh_app_setting_set $app unprotected_uris "/"
 fi
 
+#=================================================
+# SETUP LOGROTATE
+#=================================================
+ynh_script_progression --message="Configuring log rotation..." --time --weight=1
+
+### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
+### Use this helper only if there is effectively a log file for this app.
+### If you're not using this helper:
+###		- Remove the section "BACKUP LOGROTATE" in the backup script
+###		- Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
+###		- As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
+###		- And the section "SETUP LOGROTATE" in the upgrade script
+
+# Use logrotate to manage application logfile(s)
+ynh_use_logrotate
+
+#=================================================
+# ADVERTISE SERVICE IN ADMIN PANEL
+#=================================================
+
+### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
+### You'll find the service in the 'services' section of YunoHost admin panel.
+### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
+### If you're not using these lines:
+###		- You can remove these files in conf/.
+###		- Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
+###		- As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
+
+#yunohost service add $app --log "/var/log/$app/$app.log"
+# if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
+
 #=================================================
 # RELOAD NGINX
 #=================================================
-systemctl reload php7.2-fpm
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
-systemctl reload nginx
+
-# Set default php to php5 or php7.0
+ynh_systemd_action --service_name=php${phpversion}-fpm --action=reload
-if [ "$(lsb_release --codename --short)" == "jessie" ]; then
+ynh_systemd_action --service_name=nginx --action=reload
-	update-alternatives --set php /usr/bin/php5
+
-else
+
-    update-alternatives --set php /usr/bin/php7.0
+#=================================================
-fi
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Installation of $app completed" --time --last

scripts/remove

@@ -7,36 +7,64 @@
 #=================================================
 
 source _common.sh
+source ynh_add_extra_apt_repos__3
+source ynh_install_php__3
 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)
+port=$(ynh_app_setting_get --app=$app --key=port)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$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 SERVICE FROM ADMIN PANEL
+#=================================================
+
+# Remove a service from the admin panel, added by `yunohost service add`
+if yunohost service status $app >/dev/null 2>&1
+then
+    ynh_script_progression --message="Removing $app service..." --time --weight=1
+    yunohost service remove $app
+fi
 
 #=================================================
 # 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_user $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
 #=================================================
+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,20 +72,39 @@ 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_fpm7.2_config
+ynh_remove_fpm_config
 
 #=================================================
-# SPECIFIC REMOVE
+# REMOVE DEPENDENCIES
 #=================================================
+ynh_script_progression --message="Removing dependencies..." --time --weight=1
 
+# Remove metapackage and its dependencies
+ynh_remove_php 
+
+#=================================================
+# REMOVE LOGROTATE CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing logrotate configuration..." --time --weight=1
+
+# Remove the app-specific logrotate config
+ynh_remove_logrotate
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # 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

@@ -11,9 +11,14 @@ if [ ! -e _common.sh ]; then
     cp ../settings/scripts/_common.sh ./_common.sh
     chmod a+rx _common.sh
 fi
+
 source _common.sh
+source ynh_add_extra_apt_repos__3
+source ynh_install_php__3
+source ynh_composer
 source /usr/share/yunohost/helpers
 
+
 #=================================================
 # MANAGE SCRIPT FAILURE
 #=================================================
@@ -24,32 +29,25 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Loading 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)
-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)
+db_user=$db_name
 
 #=================================================
 # 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 "s
-	
-	
-#=================================================
-# SPECIFIC RESTORATION
-#=================================================
-# REINSTALL DEPENDENCIES
-#=================================================
-
-# Define and install dependencies
-ynh_install_php7
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -57,29 +55,23 @@ ynh_install_php7
 # 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 MYSQL DATABASE
-#=================================================
-
-db_pwd=$(ynh_app_setting_get $app mysqlpwd)
-ynh_mysql_setup_db $db_name $db_name $db_pwd
-ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
 
-ynh_restore_file "$final_path"
+ynh_script_progression --message="Restoring the app main directory..." --time --weight=1
+
+ynh_restore_file --origin_path="$final_path"
 
 #=================================================
 # 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
 
 #=================================================
 # RESTORE USER RIGHTS
@@ -92,29 +84,76 @@ chown -R $app: $final_path
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php/7.2/fpm/pool.d/$app.conf"
+ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+
+#=================================================
+# SPECIFIC RESTORATION
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Reinstalling dependencies..." --time --weight=1
+
+# Define and install dependencies
+ynh_install_app_dependencies $pkg_dependencies
+
+#=================================================
+# RESTORE THE MYSQL DATABASE
+#=================================================
+ynh_script_progression --message="Restoring the MySQL database..." --time --weight=1
+
+db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
+ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
+
+#=================================================
+# ADVERTISE SERVICE IN ADMIN PANEL
+#=================================================
+
+yunohost service add $app --log "/var/log/$app/$app.log"
+
+#=================================================
+# RESTORE THE LOGROTATE CONFIGURATION
+#=================================================
+
+ynh_restore_file --origin_path="/etc/logrotate.d/$app"
 
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
-init_composer $final_path
+
-cd $final_path && sudo /usr/bin/php7.2 artisan migrate --env=production --force
+# Install via composer
-cd $final_path && sudo /usr/bin/php7.2 artisan cache:clear
+ynh_install_composer --phpversion="$phpversion"
-cd $final_path && sudo /usr/bin/php7.2 artisan firefly:upgrade-database
+
-cd $final_path && sudo /usr/bin/php7.2 artisan firefly:verify
+#cd $final_path && sudo /usr/bin/php$phpversion artisan migrate --env=production --force
-cd $final_path && sudo /usr/bin/php7.2 artisan passport:install
+#cd $final_path && sudo /usr/bin/php$phpversion artisan cache:clear
+#cd $final_path && sudo /usr/bin/php$phpversion artisan firefly:upgrade-database
+#cd $final_path && sudo /usr/bin/php$phpversion artisan firefly:verify
+#cd $final_path && sudo /usr/bin/php$phpversion artisan passport:install
+
+cd $final_path && php$phpversion artisan migrate:refresh --seed && cd $YNH_CWD 
+cd $final_path && php$phpversion artisan firefly-iii:upgrade-database  && cd $YNH_CWD 
+cd $final_path && php$phpversion artisan passport:install  && cd $YNH_CWD 
+
+#=================================================
+# SETUP APPLICATION PERMISSIONS
+#=================================================
+
+# Set right permissions
+chown -R $app:$app $final_path
+chmod -R 775 ${final_path}/storage
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
+ynh_script_progression --message="Reloading nginx web server and php-fpm..." --time --weight=1
 
-systemctl reload php7.2-fpm
+ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
-# Set default php to php5 or php7.0
+
-if [ "$(lsb_release --codename --short)" == "jessie" ]; then
+#=================================================
-	update-alternatives --set php /usr/bin/php5
+# END OF SCRIPT
-else
+#=================================================
-    update-alternatives --set php /usr/bin/php7.0
+
-fi
+ynh_script_progression --message="Restoration completed for $app" --time --last

scripts/upgrade

@@ -7,45 +7,63 @@
 #=================================================
 
 source _common.sh
+source ynh_add_extra_apt_repos__3
+source ynh_install_php__3
+source ynh_composer
 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)
-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)
-is_public=$(ynh_app_setting_get $app is_public)
+is_public=$(ynh_app_setting_get --app=$app --key=is_public)
-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)
-db_pwd=$(ynh_app_setting_get $app mysqlpwd)
+db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-random_key=$(ynh_app_setting_get $app random_key)
+random_key=$(ynh_app_setting_get --app=$app --key=random_key)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+
+upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
+ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
 
 # Fix is_public as a boolean value
 if [ "$is_public" = "Yes" ]; then
-	ynh_app_setting_set $app is_public 1
+	ynh_app_setting_set --app=$app --key=is_public --value=1
     is_public=1
     elif [ "$is_public" = "No" ]; then
-	ynh_app_setting_set $app is_public 0
+	ynh_app_setting_set --app=$app --key=is_public --value=0
     is_public=0
 fi
 
 # If db_name doesn't exist, create it
 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
+
+# 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)..." --time --weight=1
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -61,13 +79,19 @@ 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)
 
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
 
-ynh_install_php7
+ynh_script_progression --message="Installing dependencies..." --time --weight=1
+ynh_install_php --phpversion="$phpversion" --package="$pkg_dependencies"
+
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
+ynh_script_progression --message="Upgrading source files..." --time --weight=1
 
 # Create a temporary directory
 tmpdir="$(mktemp -d)"
@@ -78,60 +102,24 @@ mkdir -p "$final_path/storage/upload/"
 mkdir -p "$final_path/storage/export/"
 cp -a "$final_path/storage/upload/" "$tmpdir/storage/upload/"
 cp -a "$final_path/storage/export/" "$tmpdir/storage/export/"
-
+rm -Rf "$final_path"
-# Remove the app directory securely
-ynh_secure_remove "$final_path"
-
-#=================================================
-# DOWNLOAD, CHECK AND UNPACK SOURCE
-#=================================================
-
-# If final_path doesn't exist, create it
-if [ -z $final_path ]; then
-	final_path=/var/www/$app
-	ynh_app_setting_set $app final_path $final_path
-fi
 
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source "$final_path"
+ynh_setup_source --dest_dir="$final_path"
-
-
-rm -rf "$final_path/bootstrap/cache/*" 
-cp -a "$tmpdir/storage/upload/" "$final_path/storage/upload/" 
-cp -a "$tmpdir/storage/export/"  "$final_path/storage/export/" 
-
-#remove tmp dir
-sudo rm -Rf "$tmpdir"
 
 #=================================================
-# NGINX CONFIGURATION
+# SPECIFIC SETUP
 #=================================================
 
-# Create a dedicated nginx config
+# Install via composer
-ynh_add_nginx_config
+ynh_install_composer --phpversion="$phpversion"
 
-#=================================================
+# create a user
-# CREATE DEDICATED USER
-#=================================================
-
-# Create a system user
-ynh_system_user_create $app
-
-#=================================================
-# PHP-FPM 7.2 CONFIGURATION
-#=================================================
-
-# Create a dedicated php-fpm7.1 config
-ynh_add_fpm7.2_config
-
-#=================================================
-# SPECIFIC UPGRADE
-#=================================================
-# Get the admin email
 email=$(ynh_user_get_info $admin 'mail')
 
 # setup application config
 sudo  cp ../conf/.env $final_path/.env
+
 #=================================================
 # MODIFY A CONFIG FILE
 #=================================================
@@ -141,20 +129,29 @@ ynh_replace_string "yunopass"   "$db_pwd"     "$final_path/.env"
 ynh_replace_string "yunobase"   "$db_name"    "$final_path/.env"
 ynh_replace_string "yunomail"   "$email"      "$final_path/.env"
 ynh_replace_string "yunodomain" "$domain"     "$final_path/.env"
+ynh_replace_string "yunoappurl" "$domain$path_url" "$final_path/.env"
 
+#Run artisan stuff
 
-init_composer $final_path
+cd $final_path && php$phpversion artisan migrate:refresh --seed && cd $YNH_CWD
-cd $final_path && sudo /usr/bin/php7.2 artisan migrate --env=production --force
+cd $final_path && php$phpversion artisan firefly-iii:upgrade-database && cd $YNH_CWD 
-cd $final_path && sudo /usr/bin/php7.2 artisan cache:clear
+cd $final_path && php$phpversion artisan passport:install && cd $YNH_CWD 
-cd $final_path && sudo /usr/bin/php7.2 artisan firefly:upgrade-database
+
-cd $final_path && sudo /usr/bin/php7.2 artisan firefly:verify
+#rm -rf "$final_path/bootstrap/cache/*"
-cd $final_path && sudo /usr/bin/php7.2 artisan passport:install
+
+#cd $final_path && php$phpversion artisan cache:clear
+#cd $final_path && php$phpversion artisan migrate --seed
+#cd $final_path && php$phpversion artisan firefly-iii:upgrade-database
+#cd $final_path && php$phpversion artisan passport:install
+#cd $final_path && php$phpversion artisan cache:clear
 
 # Verify the checksum and backup the file if it's different
-ynh_backup_if_checksum_is_different "$final_path/.env"
+ynh_backup_if_checksum_is_different --file="$final_path/.env"
 # Recalculate and store the config file checksum into the app settings
-ynh_store_file_checksum "$final_path/.env"
+ynh_store_file_checksum --file="$final_path/.env"
 
+cp -a "$tmpdir/storage/upload/" "$final_path/storage/upload/"
+cp -a "$tmpdir/storage/export/"  "$final_path/storage/export/"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -164,30 +161,75 @@ ynh_store_file_checksum "$final_path/.env"
 
 # Set right permissions
 chown -R $app: $final_path
+chmod -R 775 ${final_path}/storage
+
+#remove tmp dir
+sudo 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
+
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
+
+# Create a dedicated user (if not existing)
+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 --phpversion="$phpversion"
+
+#=================================================
+# STORE THE CONFIG FILE CHECKSUM
+#=================================================
+
+### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
+### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
+ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE"
+# Recalculate and store the checksum of the file for the next upgrade.
+ynh_store_file_checksum --file="$final_path/CONFIG_FILE"
+
+#=================================================
+# SETUP LOGROTATE
+#=================================================
+ynh_script_progression --message="Upgrading logrotate configuration..." --time --weight=1
+
+# Use logrotate to manage app-specific logfile(s)
+ynh_use_logrotate --non-append
 
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_script_progression --message="Upgrading SSOwat configuration..." --time --weight=1
 
-if [ $is_public -eq 0 ]
-then	# Remove the public access
-	ynh_app_setting_delete $app skipped_uris
-fi
 # Make app public if necessary
 if [ $is_public -eq 1 ]
 then
     # unprotected_uris allows SSO credentials to be passed anyway
-	ynh_app_setting_set $app unprotected_uris "/"
+    ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
 fi
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-systemctl reload php7.2-fpm
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
-systemctl reload nginx
+
-# Set default php to php5 or php7.2
+ynh_systemd_action --service_name=php${phpversion}-fpm --action=reload
-if [ "$(lsb_release --codename --short)" == "jessie" ]; then
+ynh_systemd_action --service_name=nginx --action=reload
-	update-alternatives --set php /usr/bin/php5
+
-else
+#=================================================
-    update-alternatives --set php /usr/bin/php7.0
+# END OF SCRIPT
-fi
+#=================================================
+
+ynh_script_progression --message="Upgrade of $app completed" --time --last

scripts/ynh_add_extra_apt_repos__3

@@ -0,0 +1,295 @@
+#!/bin/bash
+
+# Pin a repository.
+#
+# usage: ynh_pin_repo --package=packages --pin=pin_filter [--priority=priority_value] [--name=name] [--append]
+# | arg: -p, --package - Packages concerned by the pin. Or all, *.
+# | arg: -i, --pin - Filter for the pin.
+# | arg: -p, --priority - Priority for the pin
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+# | arg: -a, --append - Do not overwrite existing files.
+#
+# See https://manpages.debian.org/stretch/apt/apt_preferences.5.en.html for information about pinning.
+#
+ynh_pin_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=pirna
+	declare -Ar args_array=( [p]=package= [i]=pin= [r]=priority= [n]=name= [a]=append )
+	local package
+	local pin
+	local priority
+	local name
+	local append
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	package="${package:-*}"
+	priority=${priority:-50}
+	name="${name:-$app}"
+	append=${append:-0}
+
+	if [ $append -eq 1 ]
+	then
+		append="tee -a"
+	else
+		append="tee"
+	fi
+
+	mkdir -p "/etc/apt/preferences.d"
+	echo "Package: $package
+Pin: $pin
+Pin-Priority: $priority" \
+	| $append "/etc/apt/preferences.d/$name"
+}
+
+# Add a repository.
+#
+# usage: ynh_add_repo --uri=uri --suite=suite --component=component [--name=name] [--append]
+# | arg: -u, --uri - Uri of the repository.
+# | arg: -s, --suite - Suite of the repository.
+# | arg: -c, --component - Component of the repository.
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+# | arg: -a, --append - Do not overwrite existing files.
+#
+# Example for a repo like deb http://forge.yunohost.org/debian/ stretch stable
+#                             uri                               suite   component
+# ynh_add_repo --uri=http://forge.yunohost.org/debian/ --suite=stretch --component=stable
+#
+ynh_add_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=uscna
+	declare -Ar args_array=( [u]=uri= [s]=suite= [c]=component= [n]=name= [a]=append )
+	local uri
+	local suite
+	local component
+	local name
+	local append
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	name="${name:-$app}"
+	append=${append:-0}
+
+	if [ $append -eq 1 ]
+	then
+		append="tee -a"
+	else
+		append="tee"
+	fi
+
+	mkdir -p "/etc/apt/sources.list.d"
+	# Add the new repo in sources.list.d
+	echo "deb $uri $suite $component" \
+		| $append "/etc/apt/sources.list.d/$name.list"
+}
+
+# Add an extra repository correctly, pin it and get the key.
+#
+# usage: ynh_install_extra_repo --repo="repo" [--key=key_url] [--priority=priority_value] [--name=name] [--append]
+# | arg: -r, --repo - Complete url of the extra repository.
+# | arg: -k, --key - url to get the public key.
+# | arg: -p, --priority - Priority for the pin
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+# | arg: -a, --append - Do not overwrite existing files.
+ynh_install_extra_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=rkpna
+	declare -Ar args_array=( [r]=repo= [k]=key= [p]=priority= [n]=name= [a]=append )
+	local repo
+	local key
+	local priority
+	local name
+	local append
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	name="${name:-$app}"
+	append=${append:-0}
+	key=${key:-0}
+	priority=${priority:-}
+
+	if [ $append -eq 1 ]
+	then
+		append="--append"
+		wget_append="tee -a"
+	else
+		append=""
+		wget_append="tee"
+	fi
+
+	# Split the repository into uri, suite and components.
+	# Remove "deb " at the beginning of the repo.
+	repo="${repo#deb }"
+
+	# Get the uri
+	local uri="$(echo "$repo" | awk '{ print $1 }')"
+
+	# Get the suite
+	local suite="$(echo "$repo" | awk '{ print $2 }')"
+
+	# Get the components
+	local component="${repo##$uri $suite }"
+
+	# Add the repository into sources.list.d
+	ynh_add_repo --uri="$uri" --suite="$suite" --component="$component" --name="$name" $append
+
+	# Pin the new repo with the default priority, so it won't be used for upgrades.
+	# Build $pin from the uri without http and any sub path
+	local pin="${uri#*://}"
+	pin="${pin%%/*}"
+	# Set a priority only if asked
+	if [ -n "$priority" ]
+	then
+		priority="--priority=$priority"
+	fi
+	ynh_pin_repo --package="*" --pin="origin \"$pin\"" $priority --name="$name" $append
+
+	# Get the public key for the repo
+	if [ -n "$key" ]
+	then
+		mkdir -p "/etc/apt/trusted.gpg.d"
+		wget -q "$key" -O - | gpg --dearmor | $wget_append /etc/apt/trusted.gpg.d/$name.gpg > /dev/null
+	fi
+
+	# Update the list of package with the new repo
+	ynh_package_update
+}
+
+# Remove an extra repository and the assiociated configuration.
+#
+# usage: ynh_remove_extra_repo [--name=name]
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+ynh_remove_extra_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=n
+	declare -Ar args_array=( [n]=name= )
+	local name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	name="${name:-$app}"
+
+	ynh_secure_remove "/etc/apt/sources.list.d/$name.list"
+	ynh_secure_remove "/etc/apt/preferences.d/$name"
+	ynh_secure_remove "/etc/apt/trusted.gpg.d/$name.gpg"
+	ynh_secure_remove "/etc/apt/trusted.gpg.d/$name.asc"
+
+	# Update the list of package to exclude the old repo
+	ynh_package_update
+}
+
+# Install packages from an extra repository properly.
+#
+# usage: ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name]
+# | arg: -r, --repo - Complete url of the extra repository.
+# | arg: -p, --package - The packages to install from this extra repository
+# | arg: -k, --key - url to get the public key.
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+ynh_install_extra_app_dependencies () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=rpkn
+	declare -Ar args_array=( [r]=repo= [p]=package= [k]=key= [n]=name= )
+	local repo
+	local package
+	local key
+	local name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	name="${name:-$app}"
+	key=${key:-0}
+
+	# Set a key only if asked
+	if [ -n "$key" ]
+	then
+		key="--key=$key"
+	fi
+	# Add an extra repository for those packages
+	ynh_install_extra_repo --repo="$repo" $key --priority=995 --name=$name
+
+	# Install requested dependencies from this extra repository.
+	ynh_add_app_dependencies --package="$package"
+
+	# Remove this extra repository after packages are installed
+	ynh_remove_extra_repo --name=$app
+}
+
+#=================================================
+
+# patched version of ynh_install_app_dependencies to be used with ynh_add_app_dependencies
+
+# Define and install dependencies with a equivs control file
+# This helper can/should only be called once per app
+#
+# usage: ynh_install_app_dependencies dep [dep [...]]
+# | arg: dep - the package name to install in dependence
+#   You can give a choice between some package with this syntax : "dep1|dep2"
+#   Example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
+#   This mean in the dependence tree : dep1 & dep2 & (dep3 | dep4 | dep5)
+#
+# Requires YunoHost version 2.6.4 or higher.
+ynh_install_app_dependencies () {
+    local dependencies=$@
+    dependencies="$(echo "$dependencies" | sed 's/\([^\<=\>]\)\ \([^(]\)/\1, \2/g')"
+    dependencies=${dependencies//|/ | }
+    local manifest_path="../manifest.json"
+    if [ ! -e "$manifest_path" ]; then
+    	manifest_path="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
+    fi
+
+    local version=$(grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4)	# Retrieve the version number in the manifest file.
+    if [ ${#version} -eq 0 ]; then
+        version="1.0"
+    fi
+    local dep_app=${app//_/-}	# Replace all '_' by '-'
+
+    # Handle specific versions
+    if [[ "$dependencies" =~ [\<=\>] ]]
+    then
+        # Replace version specifications by relationships syntax
+        # https://www.debian.org/doc/debian-policy/ch-relationships.html
+        # Sed clarification
+        # [^(\<=\>] ignore if it begins by ( or < = >. To not apply twice.
+        # [\<=\>] matches < = or >
+        # \+ matches one or more occurence of the previous characters, for >= or >>.
+        # [^,]\+ matches all characters except ','
+        # Ex: package>=1.0 will be replaced by package (>= 1.0)
+        dependencies="$(echo "$dependencies" | sed 's/\([^(\<=\>]\)\([\<=\>]\+\)\([^,]\+\)/\1 (\2 \3)/g')"
+    fi
+
+    cat > /tmp/${dep_app}-ynh-deps.control << EOF	# Make a control file for equivs-build
+Section: misc
+Priority: optional
+Package: ${dep_app}-ynh-deps
+Version: ${version}
+Depends: ${dependencies}
+Architecture: all
+Description: Fake package for $app (YunoHost app) dependencies
+ This meta-package is only responsible of installing its dependencies.
+EOF
+    ynh_package_install_from_equivs /tmp/${dep_app}-ynh-deps.control \
+        || ynh_die --message="Unable to install dependencies"	# Install the fake package and its dependencies
+    rm /tmp/${dep_app}-ynh-deps.control
+    ynh_app_setting_set --app=$app --key=apt_dependencies --value="$dependencies"
+}
+
+ynh_add_app_dependencies () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=pr
+	declare -Ar args_array=( [p]=package= [r]=replace)
+	local package
+	local replace
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	replace=${replace:-0}
+
+	local current_dependencies=""
+	if [ $replace -eq 0 ]
+	then
+		local dep_app=${app//_/-}	# Replace all '_' by '-'
+		if ynh_package_is_installed --package="${dep_app}-ynh-deps"
+		then
+			current_dependencies="$(dpkg-query --show --showformat='${Depends}' ${dep_app}-ynh-deps) "
+		fi
+
+		current_dependencies=${current_dependencies// | /|}
+	fi
+
+	ynh_install_app_dependencies "${current_dependencies}${package}"
+}
+

scripts/ynh_composer

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+# Execute a command with Composer
+#
+# usage: ynh_composer_exec --phpversion=phpversion [--workdir=$final_path] --commands="commands"
+# | arg: -w, --workdir - The directory from where the command will be executed. Default $final_path.
+# | arg: -c, --commands - Commands to execute.
+ynh_composer_exec () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=vwc
+	declare -Ar args_array=( [v]=phpversion= [w]=workdir= [c]=commands= )
+	local phpversion
+	local workdir
+	local commands
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	workdir="${workdir:-$final_path}"
+	phpversion="${phpversion:-7.0}"
+
+	COMPOSER_HOME="$workdir/.composer" \
+		php${phpversion} "$workdir/composer.phar" $commands \
+		-d "$workdir" --quiet --no-interaction
+}
+
+# Install and initialize Composer in the given directory
+#
+# usage: ynh_install_composer --phpversion=phpversion [--workdir=$final_path]
+# | arg: -w, --workdir - The directory from where the command will be executed. Default $final_path.
+ynh_install_composer () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=vw
+	declare -Ar args_array=( [v]=phpversion= [w]=workdir= )
+	local phpversion
+	local workdir
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	workdir="${workdir:-$final_path}"
+	phpversion="${phpversion:-7.0}"
+
+	curl -sS https://getcomposer.org/installer \
+		| COMPOSER_HOME="$workdir/.composer" \
+		php${phpversion} -- --quiet --install-dir="$workdir" \
+		|| ynh_die "Unable to install Composer."
+
+	# update dependencies to create composer.lock
+	ynh_composer_exec --phpversion="${phpversion}" --workdir="$workdir" --commands="install --no-dev" \
+		|| ynh_die "Unable to update core dependencies with Composer."
+}

scripts/ynh_install_php__3

@@ -0,0 +1,82 @@
+#!/bin/bash
+
+# Install another version of php.
+#
+# usage: ynh_install_php --phpversion=phpversion [--package=packages]
+# | arg: -v, --phpversion - Version of php to install. Can be one of 7.1, 7.2 or 7.3
+# | arg: -p, --package - Additionnal php packages to install
+ynh_install_php () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=vp
+	declare -Ar args_array=( [v]=phpversion= [p]=package= )
+	local phpversion
+	local package
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	package=${package:-}
+
+	# Store php_version into the config of this app
+	ynh_app_setting_set $app php_version $phpversion
+
+	if [ "$phpversion" == "7.0" ]
+	then
+		ynh_die "Do not use ynh_install_php to install php7.0"
+	fi
+
+	# Store the ID of this app and the version of php requested for it
+	echo "$YNH_APP_INSTANCE_NAME:$phpversion" | tee --append "/etc/php/ynh_app_version"
+
+	# Add an extra repository for those packages
+	if [ ! -f "/etc/apt/sources.list.d/sury.list" ]; then
+		ynh_install_extra_repo --repo="https://packages.sury.org/php/ $(lsb_release -sc) main" --key="https://packages.sury.org/php/apt.gpg" --priority=995 --name=extra_php_version
+	fi
+
+	# Install requested dependencies from this extra repository.
+	# Install php-fpm first, otherwise php will install apache as a dependency.
+	ynh_add_app_dependencies --package="php${phpversion}-fpm"
+	ynh_add_app_dependencies --package="php$phpversion php${phpversion}-common $package"
+
+	# Set php7.0 back as the default version for php-cli.
+	update-alternatives --set php /usr/bin/php7.0
+
+	# Remove this extra repository after packages are installed
+        if [ ! -f "/etc/apt/sources.list.d/sury.list" ]; then
+		ynh_remove_extra_repo --name=extra_php_version
+	fi
+
+	# Advertise service in admin panel
+	yunohost service add php${phpversion}-fpm --log "/var/log/php${phpversion}-fpm.log"
+}
+
+ynh_remove_php () {
+	# Get the version of php used by this app
+	local phpversion=$(ynh_app_setting_get $app php_version)
+
+	if [ "$phpversion" == "7.0" ] || [ -z "$phpversion" ]
+	then
+		if [ "$phpversion" == "7.0" ]
+		then
+			ynh_print_err "Do not use ynh_remove_php to install php7.0"
+		fi
+		return 0
+	fi
+
+	# Remove the line for this app
+	sed --in-place "/$YNH_APP_INSTANCE_NAME:$phpversion/d" "/etc/php/ynh_app_version"
+
+	# If no other app uses this version of php, remove it.
+	if ! grep --quiet "$phpversion" "/etc/php/ynh_app_version"
+	then
+		# Purge php dependences for this version.
+		ynh_package_autopurge "php$phpversion php${phpversion}-fpm php${phpversion}-common"
+		# Remove the service from the admin panel
+		yunohost service remove php${phpversion}-fpm
+	fi
+
+	# If no other app uses alternate php versions, remove the extra repo for php
+	if [ ! -s "/etc/php/ynh_app_version" ]
+	then
+		ynh_secure_remove /etc/php/ynh_app_version
+	fi
+}
+