Merge pull request #39 from YunoHost-Apps/testing

Testing

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+
+before_install:
+  - git clone https://github.com/YunoHost/package_linter /tmp/package_linter
+
+script:
+- /tmp/package_linter/package_linter.py ./

README.md

@@ -9,22 +9,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to
 ## Overview
 The federated image sharing service Pixelfed, for YunoHost
 
-**Shipped version:** 0.8.4
+**Shipped version:** 0.9.0
-
-I'm waiting for an official release (alpha/beta or stable) to invest more time on this package. 
-Don't hesitate to give a hand if you wish, I assume only the nginx file needs improvments.
-
-# State of this package
-
-* works fine:
-
-  * [x] basic install/remove process
-
-* to be confirmed
-  * [ ] 
-
-* to be added:
-  * [ ] everything
 
 ## Screenshots
 
@@ -38,10 +23,15 @@ After being first registered, you need to execute the folloing command to promot
 
 **Run:**
 
-    $ (cd /var/www/pixelfed && php artisan user:admin 1)
+    $ (cd /var/www/pixelfed && php7.2 artisan user:admin 1)
 
 and respond yes to the question ` Add admin privileges to this user?`
 
+### Allow/Close registration
+
+Registrations are open by default.
+To change that setting, edit `/var/www/pixelfed/.env` and set `OPEN_REGISTRATION=false` instead of `true`.
+
 ## Documentation
 
  * [Official documentation](https://docs.pixelfed.org/master/)
@@ -50,15 +40,15 @@ and respond yes to the question ` Add admin privileges to this user?`
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pixelfed%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/pixelfed/)
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pixelfed%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pixelfed/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pixelfed%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pixelfed/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pixelfed%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pixelfed/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/pixelfed%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/pixelfed/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/pixelfed%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/pixelfed/)
 
 ## Links
 
  * Report a bug about this package: https://github.com/YunoHost-Apps/pixelfed_ynh
  * Pixelfed website: https://pixelfed.org
- * Pixelfed github website: https://github.com/pixelfed/pixelfed
+ * Upstream app repository: https://github.com/pixelfed/pixelfed
  * YunoHost website: https://yunohost.org
 
 ---

check_process

@@ -7,12 +7,12 @@
 		setup_sub_dir=0
 		setup_root=1
 		setup_nourl=0
-		setup_private=0
+		setup_private=1
-		setup_public=0
+		setup_public=1
 		upgrade=1
 		backup_restore=1
-		multi_instance=0
+		multi_instance=1
-		incorrect_path=0
+		incorrect_path=1
 		port_already_use=0
 		change_url=0
 ;;; Levels

conf/.env

@@ -1,7 +1,7 @@
 APP_NAME=__APP__
 APP_ENV=production
-APP_KEY=
+APP_KEY=__APP_KEY__
-APP_DEBUG=true
+APP_DEBUG=false
 APP_URL=https://__DOMAIN__
 
 ADMIN_DOMAIN="__DOMAIN__"
@@ -44,11 +44,6 @@ OPEN_REGISTRATION=true
 RECAPTCHA_ENABLED=false
 ENFORCE_EMAIL_VERIFICATION=true
 
-PUSHER_APP_ID=
-PUSHER_APP_KEY=
-PUSHER_APP_SECRET=
-PUSHER_APP_CLUSTER=mt1
-
 MAX_PHOTO_SIZE=15000
 MAX_CAPTION_LENGTH=150
 MAX_ALBUM_LENGTH=4
@@ -68,5 +63,9 @@ HORIZON_DARKMODE=true
 #   php artisan cache:clear
 #   php artisan optimize:clear
 #   php artisan optimize
-ACTIVITY_PUB=false
+ACTIVITY_PUB=true
-REMOTE_FOLLOW=false
+REMOTE_FOLLOW=true
+
+CS_BLOCKED_DOMAINS='example.org,example.net,example.com'
+CS_CW_DOMAINS='example.org,example.net,example.com'
+CS_UNLISTED_DOMAINS='example.org,example.net,example.com'

conf/app.src

@@ -1,5 +1,5 @@
-SOURCE_URL=https://github.com/pixelfed/pixelfed/archive/ac53aea28884f0c49c110ac6d87a7b40e92171c9.tar.gz
+SOURCE_URL=https://github.com/pixelfed/pixelfed/archive/v0.9.0.tar.gz
-SOURCE_SUM=ca6156026eb1bb8d8995d247a895b88078e93f1127b75af07058d74f57830846
+SOURCE_SUM=ea69f3441991c9122638b1476ba11ec1b7847fac569fa77a8ed7b03481b19d88
 OURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true

conf/nginx.conf

@@ -1,4 +1,4 @@
-location __PATH__ {
+location __PATH__/ {
 
   # Path to source
   alias __FINALPATH__/public/ ;

manifest.json

@@ -5,17 +5,17 @@
     "description": {
         "en": "ActivityPub Federated Image Sharing"
     },
-    "version": "0.8.4~ynh3",
+    "version": "0.9.0~ynh1",
     "url": "https://pixelfed.org/",
     "license": "AGPL-3.0-or-later",
     "maintainer": {
-        "name": "jibec",
+        "name": "Jean-Baptiste Holcroft",
         "email": "jean-baptiste@holcroft.fr"
     },
     "requirements": {
-        "yunohost": ">= 3.0.0"
+        "yunohost": ">= 3.5"
     },
-    "multi_instance": false,
+    "multi_instance": true,
     "services": [
         "nginx"
     ],

pull_request_template.md

@@ -0,0 +1,23 @@
+## 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.
+
+## Validation
+---
+- [ ] **Code review**
+- [ ] **Approval (LGTM)**  
+*Code review and approval have to be from a member of @YunoHost/apps group*
+- **CI succeeded** : 
+[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/pixelfed_ynh%20-BRANCH-/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/pixelfed_ynh%20-BRANCH-/)  
+*Please replace '-BRANCH-' in this link by the name of the branch used.*  
+*If the PR is from a forked repository. Please provide public results from package_check.*  
+When the PR is marked as ready to merge, you have to wait for 3 days before really merging it.

scripts/_common.sh

@@ -5,12 +5,12 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="php7.2-pgsql php7.2-mbstring php7.2-bcmath php7.2-simplexml php7.2-curl postgresql redis-server \
+pkg_dependencies="postgresql redis-server \
-php7.2-intl php7.2-exif \
+libfreetype6 libjpeg62-turbo libpng16-16 libxpm4 libvpx4 libmagickwand-6.q16-3 libwebp6 \
-libfreetype6 libjpeg62-turbo libpng16-16 libxpm4 libvpx4 libwebp6 libmagickwand-6.q16-3 \
-php7.2-gd \
 pngquant jpegoptim gifsicle"
 
+extra_pkg_dependencies="php7.2-bcmath php7.2-cli php7.2-curl php7.2-exif php7.2-gd php7.2-intl php7.2-json php7.2-mbstring php7.2-pgsql php7.2-simplexml php7.2-xml php7.2-zip"
+
 #=================================================
 # PERSONAL HELPERS
 #=================================================
@@ -21,13 +21,14 @@ pngquant jpegoptim gifsicle"
 
 # Execute a command with Composer
 #
-# usage: ynh_composer_exec [--workdir=$final_path] --commands="commands"
+# 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=wc
+	local legacy_args=vwc
-	declare -Ar args_array=( [w]=workdir= [c]=commands= )
+	declare -Ar args_array=( [v]=phpversion= [w]=workdir= [c]=commands= )
+	local phpversion
 	local workdir
 	local commands
 	# Manage arguments with getopts
@@ -35,18 +36,19 @@ ynh_composer_exec () {
 	workdir="${workdir:-$final_path}"
 
 	COMPOSER_HOME="$workdir/.composer" \
-		php "$workdir/composer.phar" $commands \
+		php${phpversion} "$workdir/composer.phar" $commands \
 		-d "$workdir" --quiet --no-interaction
 }
 
 # Install and initialize Composer in the given directory
 #
-# usage: ynh_install_composer [--workdir=$final_path]
+# 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=w
+	local legacy_args=vw
-	declare -Ar args_array=( [w]=workdir= )
+	declare -Ar args_array=( [v]=phpversion= [w]=workdir= )
+	local phpversion
 	local workdir
 	# Manage arguments with getopts
 	ynh_handle_getopts_args "$@"
@@ -54,91 +56,54 @@ ynh_install_composer () {
 
 	curl -sS https://getcomposer.org/installer \
 		| COMPOSER_HOME="$workdir/.composer" \
-		php -- --quiet --install-dir="$workdir" \
+		php${phpversion} -- --quiet --install-dir="$workdir" \
-		|| ynh_die "Unable to install Composer."
+		|| ynh_die --message="Unable to install Composer."
 
 	# update dependencies to create composer.lock
-	ynh_composer_exec --workdir="$workdir" --commands="install --no-dev" \
+	ynh_composer_exec --phpversion="${phpversion}" --workdir="$workdir" --commands="install --no-dev" \
-		|| ynh_die "Unable to update core dependencies with Composer."
+		|| ynh_die --message="Unable to update core dependencies with Composer."
 }
 
 
 # Install another version of php.
 #
-# usage: ynh_install_php --phpversion=phpversion
+# 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=v
+	local legacy_args=vp
-	declare -Ar args_array=( [v]=phpversion= )
+	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
 
-	# Install an extra repo to get multiple php versions
+	if [ "$phpversion" == "7.0" ]
-	ynh_install_extra_repo --repo="https://packages.sury.org/php/ $(lsb_release -sc) main" --key="https://packages.sury.org/php/apt.gpg" --name=php
+	then
-
+		ynh_die --message="Do not use ynh_install_php to install php7.0"
-	if [ "$phpversion" == "7.0" ]; then
-		ynh_die "Do not use ynh_install_php to install php7.0"
-
-	# Php 7.1
-	elif [ "$phpversion" == "7.1" ]; then
-		# Get the current version available for libpcre3 on packages.sury.org
-		local libpcre3_version=$(apt-cache madison "libpcre3" | grep "packages.sury.org" | tail -n1 | awk '{print $3}')
-
-		# equivs doesn't handle correctly this dependence.
-		# Force the upgrade of libpcre3 for php7.1
-		ynh_package_install "libpcre3=$libpcre3_version"
-
-		local php_dependencies="php7.1, php7.1-fpm"
-
-	# Php 7.2
-	elif [ "$phpversion" == "7.2" ]; then
-		# Get the current version available for libpcre3 on packages.sury.org
-		local libpcre3_version=$(apt-cache madison "libpcre3" | grep "packages.sury.org" | tail -n1 | awk '{print $3}')
-
-		# equivs doesn't handle correctly this dependence.
-		# Force the upgrade of libpcre3 for php7.2
-		ynh_package_install "libpcre3=$libpcre3_version"
-
-		local php_dependencies="php7.2, php7.2-fpm"
-
-	# Php 7.3
-	elif [ "$phpversion" == "7.3" ]; then
-		# Get the current version available for libpcre2-8-0 on packages.sury.org
-		local libpcre2_version=$(apt-cache madison "libpcre2-8-0" | grep "packages.sury.org" | tail -n1 | awk '{print $3}')
-
-		# equivs doesn't handle correctly this dependence.
-		# Force the upgrade of libpcre2-8-0 for php7.3
-		ynh_package_install "libpcre2-8-0=$libpcre2_version"
-
-		local php_dependencies="php7.3, php7.3-fpm"
-
-	else
-		ynh_die "The version $phpversion of php isn't handle by this helper."
 	fi
 
 	# Store the ID of this app and the version of php requested for it
-	echo "$YNH_APP_ID:$phpversion" | tee --append "/etc/php/ynh_app_version"
+	echo "$YNH_APP_INSTANCE_NAME:$phpversion" | tee --append "/etc/php/ynh_app_version"
 
-	# Build a control file for equivs-build
+	# Add an extra repository for those packages
-    echo "Section: misc
+	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
-Priority: optional
-Package: php${phpversion}-ynh-deps
-Version: 1.0
-Depends: $php_dependencies
-Architecture: all
-Description: Fake package for php_$phpversion dependencies
- This meta-package is only responsible of installing its dependencies." \
-	> /tmp/php_${phpversion}-ynh-deps.control
 
-	# Install the fake package for php
+	# Install requested dependencies from this extra repository.
-	ynh_package_install_from_equivs /tmp/php_${phpversion}-ynh-deps.control \
+	# Install php-fpm first, otherwise php will install apache as a dependency.
-        || ynh_die --message="Unable to install dependencies"
+	ynh_add_app_dependencies --package="php${phpversion}-fpm"
-	ynh_secure_remove /tmp/php_${phpversion}-ynh-deps.control
+	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
+	ynh_remove_extra_repo --name=extra_php_version
 
 	# Advertise service in admin panel
 	yunohost service add php${phpversion}-fpm --log "/var/log/php${phpversion}-fpm.log"
@@ -158,37 +123,13 @@ ynh_remove_php () {
 	fi
 
 	# Remove the line for this app
-	sed --in-place "/$YNH_APP_ID:$phpversion/d" "/etc/php/ynh_app_version"
+	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
-		# Remove the metapackage for php
+		# Purge php dependences for this version.
-		ynh_package_autopurge php${phpversion}-ynh-deps
+		ynh_package_autopurge "php$phpversion php${phpversion}-fpm php${phpversion}-common"
-		# Then remove php-fpm php-cli for this version.
-		# The previous command won't remove them, but we have to remove those package to clean php
-		ynh_package_autopurge php${phpversion}-fpm php${phpversion}-cli
-
-		if [ "$phpversion" == "7.1" ] || [ "$phpversion" == "7.2" ]
-		then
-			# Do not restore libpcre3 if php7.1 or 7.2 is still used.
-			if ! grep --quiet --extended-regexp "7.1|7.2" "/etc/php/ynh_app_version"
-			then
-				# Get the current version available for libpcre3 on the standard repo
-				local libpcre3_version=$(apt-cache madison "libpcre3" | grep "debian.org" | tail -n1 | awk '{print $3}')
-
-				# Force to reinstall the standard version of libpcre3
-				ynh_package_install --allow-downgrades libpcre3=$libpcre3_version >&2
-			fi
-		elif [ "$phpversion" == "7.3" ]
-		then
-			# Get the current version available for libpcre2-8-0 on the standard repo
-			local libpcre2_version=$(apt-cache madison "libpcre2-8-0" | grep "debian.org" | tail -n1 | awk '{print $3}')
-
-			# Force to reinstall the standard version of libpcre2-8-0
-			ynh_package_install --allow-downgrades libpcre2-8-0=$libpcre2_version
-		fi
-
 		# Remove the service from the admin panel
 		yunohost service remove php${phpversion}-fpm
 	fi
@@ -196,19 +137,16 @@ ynh_remove_php () {
 	# If no other app uses alternate php versions, remove the extra repo for php
 	if [ ! -s "/etc/php/ynh_app_version" ]
 	then
-		ynh_remove_extra_repo --name=php
 		ynh_secure_remove /etc/php/ynh_app_version
 	fi
 }
 
-
-
 #=================================================
 # FUTURE OFFICIAL HELPERS
 #=================================================
 # Pin a repository.
 #
-# usage: ynh_pin_repo --package=packages --pin=pin_filter --priority=priority_value [--name=name] [--append]
+# 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
@@ -289,17 +227,19 @@ ynh_add_repo () {
 
 # Add an extra repository correctly, pin it and get the key.
 #
-# usage: ynh_install_extra_repo --repo="repo" [--key=key_url] [--name=name] [--append]
+# 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=rkna
+	local legacy_args=rkpna
-	declare -Ar args_array=( [r]=repo= [k]=key= [n]=name= [a]=append )
+	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
@@ -307,6 +247,7 @@ ynh_install_extra_repo () {
 	name="${name:-$app}"
 	append=${append:-0}
 	key=${key:-0}
+	priority=${priority:-}
 
 	if [ $append -eq 1 ]
 	then
@@ -337,19 +278,18 @@ ynh_install_extra_repo () {
 	# Build $pin from the uri without http and any sub path
 	local pin="${uri#*://}"
 	pin="${pin%%/*}"
-	ynh_pin_repo --package="*" --pin="origin \"$pin\"" --name="$name" $append
+	# 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"
-		if [[ "$(basename "$key")" =~ ".asc" ]]
+		wget -q "$key" -O - | gpg --dearmor | $wget_append /etc/apt/trusted.gpg.d/$name.gpg > /dev/null
-		then
-			local key_ext=asc
-		else
-			local key_ext=gpg
-		fi
-		wget -q "$key" -O - | gpg --dearmor | $wget_append /etc/apt/trusted.gpg.d/$name.$key_ext > /dev/null
 	fi
 
 	# Update the list of package with the new repo
@@ -377,3 +317,122 @@ ynh_remove_extra_repo () {
 	# 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/backup

@@ -20,46 +20,46 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_print_info --message="Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
-final_path=$(ynh_app_setting_get "$app" final_path)
+final_path=$(ynh_app_setting_get --app="$app" --key=final_path)
-domain=$(ynh_app_setting_get "$app" domain)
+domain=$(ynh_app_setting_get --app="$app" --key=domain)
-db_name=$(ynh_app_setting_get "$app" db_name)
+db_name=$(ynh_app_setting_get --app="$app" --key=db_name)
 
 #=================================================
 # STANDARD BACKUP STEPS
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
-ynh_print_info "Backing up the main app directory..."
+ynh_print_info --message="Backing up the main app directory..."
 
-ynh_backup "$final_path"
+ynh_backup --src_path="$final_path"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Backing up nginx web server configuration..."
+ynh_print_info --message="Backing up nginx web server configuration..."
 
-ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 #=================================================
 # BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Backing up php-fpm configuration..."
+ynh_print_info --message="Backing up php-fpm configuration..."
 
-ynh_backup "/etc/php/7.2/fpm/pool.d/$app.conf"
+ynh_backup --src_path="/etc/php/7.2/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE POSTGRESQL DATABASE
 #=================================================
-ynh_print_info "Backing up the PostgreSQL database..."
+ynh_print_info --message="Backing up the PostgreSQL database..."
 
-ynh_psql_dump_db "$db_name" > db.sql
+ynh_psql_dump_db --database="$db_name" > db.sql
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/change_url

@@ -14,24 +14,24 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
+old_path="/"
 
 new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
+new_path="/"
 
 app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_print_info --message="Loading installation settings..."
 
 # Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get "$app" final_path)
+final_path=$(ynh_app_setting_get --app="$app" --key=final_path)
 
 # Add settings here as needed by your application
-#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 db_pwd)
+#db_pwd=$(ynh_app_setting_get --app="$app" --key=db_pwd)
 
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
@@ -43,60 +43,69 @@ then
 	change_domain=1
 fi
 
-change_path=0
-if [ "$old_path" != "$new_path" ]
-then
-	change_path=1
-fi
-
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
-ynh_print_info "Updating nginx web server configuration..."
+ynh_print_info --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 "$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 ]
+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
 
 #=================================================
 # SPECIFIC MODIFICATIONS
 #=================================================
-# ...
+# UPDATE CONFIG FILE
 #=================================================
 
+config="$final_path/.env"
+ynh_replace_string --match_string="APP_URL=.*"           --replace_string="APP_URL=https://$new_domain"                --target_file="$config"
+ynh_replace_string --match_string="ADMIN_DOMAIN=.*"      --replace_string="ADMIN_DOMAIN=\"$new_domain\""               --target_file="$config"
+ynh_replace_string --match_string="APP_DOMAIN=.*"        --replace_string="APP_DOMAIN=\"$new_domain\""                 --target_file="$config"
+ynh_replace_string --match_string="MAIL_FROM_ADDRESS=.*" --replace_string="MAIL_FROM_ADDRESS=\"pixelfed@$new_domain\"" --target_file="$config"
+
+#=================================================
+# STORE THE CONFIG FILE CHECKSUM
+#=================================================
+
+ynh_backup_if_checksum_is_different --file="$config"
+
+# Recalculate and store the checksum of the file for the next upgrade.
+ynh_store_file_checksum --file="$config"
+
+#=================================================
+# APPLY CHANGES
+#=================================================
+
+pushd "$final_path"
+	php7.2 artisan config:clear
+	php7.2 artisan config:cache
+	php7.2 artisan route:clear
+	php7.2 artisan route:cache
+	php7.2 artisan horizon:purge
+popd
+
 #=================================================
 # GENERIC FINALISATION
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_print_info --message="Reloading nginx web server..."
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Change of URL completed for $app"
+ynh_print_info --message="Change of URL completed for $app"

scripts/install

@@ -23,69 +23,75 @@ ynh_abort_if_errors
 domain=$YNH_APP_ARG_DOMAIN
 path_url="/"
 is_public=$YNH_APP_ARG_IS_PUBLIC
+app_key=$(ynh_string_random --length=32 | base64)
+app_key="base64:$app_key"
 
 app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_print_info "Validating installation parameters..."
+ynh_print_info --message="Validating installation parameters..."
 
 final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
 
 # Register (book) web path
-ynh_webpath_register "$app" "$domain" "$path_url"
+ynh_webpath_register --app="$app" --domain="$domain" --path_url="$path_url"
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
 
-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" is_public "$is_public"
+ynh_app_setting_set --app="$app" --key=is_public --value="$is_public"
+ynh_app_setting_set --app="$app" --key=app_key --value="$app_key"
 
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_print_info "Installing dependencies..."
+ynh_print_info --message="Installing dependencies..."
-
-ynh_install_php --phpversion="7.2"
 
 ynh_install_app_dependencies "$pkg_dependencies"
 
+#=================================================
+# INSTALL PHP
+#=================================================
+ynh_print_info --message="Installing php..."
+
+ynh_install_php --phpversion="7.2" --package="$extra_pkg_dependencies"
+
 #=================================================
 # CREATE A POSTGRESQL DATABASE
 #=================================================
-ynh_print_info "Creating a PostgreSQL database..."
+ynh_print_info --message="Creating a PostgreSQL database..."
 
 ynh_psql_test_if_first_run
 
 db_name=$(ynh_sanitize_dbid "$app")
 db_user=$db_name
 db_pwd=$(ynh_string_random)
-ynh_app_setting_set "$app" db_name "$db_name"
+ynh_app_setting_set --app="$app" --key=db_name --value="$db_name"
-ynh_app_setting_set "$app" db_pwd  "$db_pwd"
+ynh_app_setting_set --app="$app" --key=db_pwd  --value="$db_pwd"
 
 # Initialize database and store postgres password for upgrade
-ynh_psql_setup_db "$db_user" "$db_name" "$db_pwd"
+ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" --db_pwd="$db_pwd"
-
-systemctl reload postgresql
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 
-ynh_app_setting_set "$app" final_path "$final_path"
+ynh_app_setting_set --app="$app" --key=final_path --value="$final_path"
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source "$final_path"
+ynh_setup_source --dest_dir="$final_path"
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Configuring nginx web server..."
+ynh_print_info --message="Configuring nginx web server..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -93,31 +99,26 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_print_info "Configuring system user..."
+ynh_print_info --message="Configuring system user..."
 
 # Create a system user
-ynh_system_user_create "$app"
+ynh_system_user_create --username="$app"
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Configuring php-fpm..."
+ynh_print_info --message="Configuring php-fpm..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config --phpversion="7.2"
 
-#Ugly move waiting 'ynh_add_fpm_config --phpversion='' released
-mv "/etc/php/7.0/fpm/pool.d/$app.conf" "/etc/php/7.2/fpm/pool.d/$app.conf"
-systemctl reload php7.0-fpm
-systemctl reload php7.2-fpm
-
 #=================================================
 # INSTALL PHP DEPENDENCIES
 #=================================================
 
 chown -R "$app": "$final_path"
 
-ynh_install_composer --workdir="$final_path"
+ynh_install_composer --phpversion="7.2" --workdir="$final_path"
 
 #=================================================
 # SPECIFIC SETUP
@@ -128,19 +129,20 @@ ynh_install_composer --workdir="$final_path"
 config="$final_path/.env"
 cp ../conf/.env "$config"
 
-ynh_replace_string "__APP__"     "$app"      "$config"
+ynh_replace_string --match_string="__APP__"     --replace_string="$app"      --target_file="$config"
-ynh_replace_string "__DOMAIN__"  "$domain"   "$config"
+ynh_replace_string --match_string="__APP_KEY__" --replace_string="$app_key"  --target_file="$config"
-ynh_replace_string "__PATH__"    "$path_url" "$config"
+ynh_replace_string --match_string="__DOMAIN__"  --replace_string="$domain"   --target_file="$config"
-ynh_replace_string "__DB_NAME__" "$db_name"  "$config"
+ynh_replace_string --match_string="__PATH__"    --replace_string="$path_url" --target_file="$config"
-ynh_replace_string "__DB_USER__" "$db_user"  "$config"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name"  --target_file="$config"
-ynh_replace_string "__DB_PWD__"  "$db_pwd"   "$config"
+ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user"  --target_file="$config"
+ynh_replace_string --match_string="__DB_PWD__"  --replace_string="$db_pwd"   --target_file="$config"
 
 #=================================================
 # STORE THE CHECKSUM OF THE CONFIG FILE
 #=================================================
 
 # Calculate and store the config file checksum into the app settings
-ynh_store_file_checksum "$config"
+ynh_store_file_checksum --file="$config"
 
 #=================================================
 # DEPLOYMENT
@@ -170,24 +172,24 @@ chown -R "$app": "$final_path/storage/"
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_print_info "Configuring SSOwat..."
+ynh_print_info --message="Configuring SSOwat..."
 
 # 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
 #=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_print_info --message="Reloading nginx web server..."
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Installation of $app completed"
+ynh_print_info --message="Installation of $app completed"

scripts/remove

@@ -12,53 +12,29 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_print_info --message="Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get "$app" domain)
+domain=$(ynh_app_setting_get --app="$app" --key=domain)
-db_name=$(ynh_app_setting_get "$app" db_name)
+db_name=$(ynh_app_setting_get --app="$app" --key=db_name)
 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 THE POSTGRESQL DATABASE
 #=================================================
-ynh_print_info "Removing the PostgreSQL database"
+ynh_print_info --message="Removing the PostgreSQL database..."
 
-ynh_psql_execute_as_root "\connect $db_name 
+ Remove a database if it exists, along with the associated user
-SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$db_name';"
+ynh_psql_remove_db --db_user="$db_user" --db_name="$db_name"
-
-# Remove a database if it exists, along with the associated user
-ynh_psql_remove_db "$db_user" "$db_name"
-
-#=================================================
-# REMOVE NGINX CONFIGURATION
-#=================================================
-ynh_print_info "Removing nginx web server configuration"
-
-# Remove the dedicated nginx config
-ynh_remove_nginx_config
-
-#=================================================
-# REMOVE PHP-FPM CONFIGURATION
-#=================================================
-ynh_print_info "Removing php-fpm configuration"
-
-#Ugly move waiting 'ynh_add_fpm_config --phpversion='' released
-mv "/etc/php/7.2/fpm/pool.d/$app.conf" "/etc/php/7.0/fpm/pool.d/$app.conf"
-systemctl reload php7.2-fpm
-systemctl reload php7.0-fpm
-
-# Remove the dedicated php-fpm config
-ynh_remove_fpm_config
 
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_print_info "Removing dependencies"
+ynh_print_info --message="Removing dependencies..."
 
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
@@ -67,31 +43,47 @@ ynh_remove_php
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_print_info "Removing app main directory"
+ynh_print_info --message="Removing app main directory..."
 
 # Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
+
+#=================================================
+# REMOVE NGINX CONFIGURATION
+#=================================================
+ynh_print_info --message="Removing nginx web server configuration..."
+
+# Remove the dedicated nginx config
+ynh_remove_nginx_config
+
+#=================================================
+# REMOVE PHP-FPM CONFIGURATION
+#=================================================
+ynh_print_info --message="Removing php-fpm configuration..."
+
+# Remove the dedicated php-fpm config
+ynh_remove_fpm_config
+
+#=================================================
+# RESTART PHP-FPM 7.0 FPM
+#=================================================
+ynh_print_info --message="Start php7.0-fpm..."
+
+#Sometimes with package_check php7.0-fpm fail to reload and stop. So starting the service, just in case.
+ynh_systemd_action --service_name=php7.0-fpm --action=start
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_print_info "Removing the dedicated system user"
+ynh_print_info --message="Removing the dedicated system user..."
 
 # Delete a system user
-ynh_system_user_delete "$app"
+ynh_system_user_delete --username="$app"
-
-#=================================================
-# START PHP-FPM 7.0 FPM
-#=================================================
-ynh_print_info "Start php7.0-fpm"
-
-#Sometimes with package_check php7.0-fpm fail to reload and stop. So starting the service, just in case.
-systemctl start php7.0-fpm
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Removal of $app completed"
+ynh_print_info --message="Removal of $app completed"

scripts/restore

@@ -20,25 +20,26 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading settings..."
+ynh_print_info --message="Loading settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get "$app" domain)
+domain=$(ynh_app_setting_get --app="$app" --key=domain)
-path_url=$(ynh_app_setting_get "$app" path)
+path_url=$(ynh_app_setting_get --app="$app" --key=path)
-final_path=$(ynh_app_setting_get "$app" final_path)
+final_path=$(ynh_app_setting_get --app="$app" --key=final_path)
-db_name=$(ynh_app_setting_get "$app" db_name)
+db_name=$(ynh_app_setting_get --app="$app" --key=db_name)
-db_pwd=$(ynh_app_setting_get "$app" db_pwd)
+db_user=$db_name
+db_pwd=$(ynh_app_setting_get --app="$app" --key=db_pwd)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
-ynh_print_info "Validating restoration parameters..."
+ynh_print_info --message="Validating restoration parameters..."
 
-ynh_webpath_available "$domain" "$path_url" \
+ynh_webpath_available --domain="$domain" --path_url="$path_url" \
-	|| ynh_die "Path not available: ${domain}${path_url}"
+	|| ynh_die --message="Path not available: ${domain}${path_url}"
 test ! -d "$final_path" \
-	|| ynh_die "There is already a directory: $final_path "
+	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -46,22 +47,22 @@ test ! -d "$final_path" \
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
-ynh_print_info "Restoring the app main directory..."
+ynh_print_info --message="Restoring the app main directory..."
 
-ynh_restore_file "$final_path"
+ynh_restore_file --origin_path="$final_path"
 
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_print_info "Recreating the dedicated system user..."
+ynh_print_info --message="Recreating the dedicated system user..."
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create "$app"
+ynh_system_user_create --username="$app"
 
 #=================================================
 # RESTORE USER RIGHTS
@@ -71,44 +72,49 @@ ynh_system_user_create "$app"
 chown -R "$app": "$final_path"
 
 #=================================================
-# SPECIFIC RESTORATION
+# INSTALL PHP
 #=================================================
-# REINSTALL DEPENDENCIES
+ynh_print_info --message="Installing php..."
-#=================================================
-ynh_print_info "Reinstalling dependencies..."
 
-# Define and install dependencies
+ynh_install_php --phpversion="7.2" --package="$extra_pkg_dependencies"
-ynh_install_php --phpversion="7.2"
-
-ynh_install_app_dependencies "$pkg_dependencies"
-
-#=================================================
-# RESTORE THE POSTGRESQL DATABASE
-#=================================================
-ynh_print_info "Restoring the PostgreSQL database..."
-
-ynh_psql_test_if_first_run
-ynh_psql_setup_db "$db_name" "$db_name" "$db_pwd"
-ynh_psql_execute_file_as_root ./db.sql "$db_name"
 
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php/7.2/fpm/pool.d/$app.conf"
+ynh_restore_file --origin_path="/etc/php/7.2/fpm/pool.d/$app.conf"
+
+#=================================================
+# SPECIFIC RESTORATION
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_print_info --message="Reinstalling dependencies..."
+
+# Define and install dependencies
+ynh_install_app_dependencies "$pkg_dependencies"
+
+#=================================================
+# RESTORE THE POSTGRESQL DATABASE
+#=================================================
+ynh_print_info --message="Restoring the PostgreSQL database..."
+
+ynh_psql_test_if_first_run
+ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" --db_pwd="$db_pwd"
+ynh_psql_execute_file_as_root --file="./db.sql" --database="$db_name"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-ynh_print_info "Reloading nginx web server and php-fpm..."
+ynh_print_info --message="Reloading nginx web server and php-fpm..."
 
-systemctl reload php7.2-fpm
+ynh_systemd_action --service_name=php7.2-fpm --action=reload
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Restoration completed for $app"
+ynh_print_info --message="Restoration completed for $app"

scripts/upgrade

@@ -12,48 +12,63 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info "Loading installation settings..."
+ynh_print_info --message="Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get "$app" domain)
+domain=$(ynh_app_setting_get --app="$app" --key=domain)
-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)
-language=$(ynh_app_setting_get "$app" language)
+language=$(ynh_app_setting_get --app="$app" --key=language)
-db_name=$(ynh_app_setting_get "$app" db_name)
+db_name=$(ynh_app_setting_get --app="$app" --key=db_name)
+db_user=$db_name
+db_pwd=$(ynh_app_setting_get --app="$app" --key=db_pwd)
+app_key=$(ynh_app_setting_get --app="$app" --key=app_key)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+
+upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-ynh_print_info "Ensuring downward compatibility..."
+ynh_print_info --message="Ensuring downward compatibility..."
 
 # 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" final_path "$final_path"
+	ynh_app_setting_set --app="$app" --key=final_path --value="$final_path"
+fi
+
+# If app_key doesn't exist, retrieve it
+if [ -z "$app_key" ]; then
+	app_key=$(grep -oP "APP_KEY=\Kbase64.*" "$final_path/.env")
+	ynh_app_setting_set --app="$app" --key=app_key --value="$app_key"
 fi
 
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_print_info "Backing up the app before upgrading (may take a while)..."
+ynh_print_info --message="Backing up the app before upgrading (may take a while)..."
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -64,32 +79,24 @@ ynh_clean_setup () {
 # 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")
-
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_print_info "Upgrading source files..."
 
-# Download, check integrity, uncompress and patch the source from app.src
+if [ "$upgrade_type" == "UPGRADE_APP" ]
-ynh_setup_source "$final_path"
+then
+	ynh_print_info --message="Upgrading source files..."
+
+	# Download, check integrity, uncompress and patch the source from app.src
+	ynh_setup_source --dest_dir="$final_path"
+fi
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Upgrading nginx web server configuration..."
+ynh_print_info --message="Upgrading nginx web server configuration..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -97,40 +104,33 @@ ynh_add_nginx_config
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
-ynh_print_info "Upgrading dependencies..."
+ynh_print_info --message="Upgrading dependencies..."
-
-ynh_install_php --phpversion="7.2"
 
 ynh_install_app_dependencies "$pkg_dependencies"
 
+#=================================================
+# UPGRADE PHP
+#=================================================
+ynh_print_info --message="Upgrading php..."
+
+ynh_install_php --phpversion="7.2" --package="$extra_pkg_dependencies"
+
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_print_info "Making sure dedicated system user exists..."
+ynh_print_info --message="Making sure dedicated system user exists..."
 
 # Create a dedicated user (if not existing)
-ynh_system_user_create "$app"
+ynh_system_user_create --username="$app"
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_print_info "Upgrading php-fpm configuration..."
+ynh_print_info --message="Upgrading php-fpm configuration..."
-
-#Ugly move waiting 'ynh_add_fpm_config --phpversion='' released
-mv -f "/etc/php/7.2/fpm/pool.d/$app.conf" "/etc/php/7.0/fpm/pool.d/$app.conf"
-sleep 5
-systemctl reload php7.2-fpm
-systemctl reload php7.0-fpm
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config --phpversion="7.2"
 
-#Ugly move waiting 'ynh_add_fpm_config --phpversion='' released
-mv -f "/etc/php/7.0/fpm/pool.d/$app.conf" "/etc/php/7.2/fpm/pool.d/$app.conf"
-sleep 5
-systemctl reload php7.0-fpm
-systemctl reload php7.2-fpm
-
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
@@ -139,7 +139,22 @@ systemctl reload php7.2-fpm
 
 chown -R "$app": "$final_path"
 
-ynh_install_composer --workdir="$final_path"
+ynh_install_composer --phpversion="7.2" --workdir="$final_path"
+
+#=================================================
+# MODIFY A CONFIG FILE
+#=================================================
+
+config="$final_path/.env"
+cp ../conf/.env "$config"
+
+ynh_replace_string --match_string="__APP__"     --replace_string="$app"      --target_file="$config"
+ynh_replace_string --match_string="__APP_KEY__" --replace_string="$app_key"  --target_file="$config"
+ynh_replace_string --match_string="__DOMAIN__"  --replace_string="$domain"   --target_file="$config"
+ynh_replace_string --match_string="__PATH__"    --replace_string="$path_url" --target_file="$config"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name"  --target_file="$config"
+ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user"  --target_file="$config"
+ynh_replace_string --match_string="__DB_PWD__"  --replace_string="$db_pwd"   --target_file="$config"
 
 #=================================================
 # DEPLOYMENT
@@ -156,11 +171,14 @@ pushd "$final_path"
 	php7.2 artisan horizon:purge
 popd
 
+#=================================================
+# STORE THE CONFIG FILE CHECKSUM
+#=================================================
 
+ynh_backup_if_checksum_is_different --file="$config"
 
-ynh_backup_if_checksum_is_different "$final_path/CONFIG_FILE"
 # Recalculate and store the checksum of the file for the next upgrade.
-ynh_store_file_checksum "$final_path/.env"
+ynh_store_file_checksum --file="$config"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -174,24 +192,24 @@ chown -R "$app": "$final_path"
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_print_info "Upgrading SSOwat configuration..."
+ynh_print_info --message="Upgrading SSOwat configuration..."
 
 # Make app public if necessary
-if [ $is_public -eq 1 ]
+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
 #=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_print_info --message="Reloading nginx web server..."
 
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Upgrade of $app completed"
+ynh_print_info --message="Upgrade of $app completed"