Normalization from example_ynh

README.md

@@ -1,14 +1,36 @@
-Roundcube for YunoHost
+# Roundcube for YunoHost
-----------------------
+
+[![Integration level](https://dash.yunohost.org/integration/roundcube.svg)](https://dash.yunohost.org/appci/app/roundcube)  
+[![Install Roundcube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=roundcube)
+
+> *This package allow you to install Roundcube quickly and simply on a YunoHost server.  
+If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
+## Overview
 
 [Roundcube](https://roundcube.net/) is a browser-based multilingual IMAP client with
 an application-like user interface.
 
 **Shipped version:** 1.3.6
 
-![](https://roundcube.net/images/screens/mailview.jpg)
+## Screenshots
 
-## Features
+![](https://roundcube.net/images/screens/mailbox.png)
+
+## Demo
+
+* [YunoHost demo](https://demo.yunohost.org/webmail/)
+
+## Configuration
+
+You can extend - or even override - the Roundcube configuration which is coming with this package in the file `conf/local.inc.php`. Do not edit the file `conf/config.inc.php` as future upgrades will overwrite it.
+
+## Documentation
+
+ * Official documentation: https://github.com/roundcube/roundcubemail/wiki
+ * YunoHost documentation: https://github.com/YunoHost/doc/blob/master/app_roundcube.md
+
+## YunoHost specific features
 
 In addition to Roundcube core features, the following are made available with
 this package:
@@ -24,20 +46,24 @@ this package:
    you have installed ownCloud or Baïkal, it will automatically add the
    corresponding and existing address book.
 
-## Extend and tweak
+#### Multi-users support
 
-### Configuration
+#### Supported architectures
 
-You can extend - or even override - the Roundcube configuration which is coming
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/roundcube%20%28Official%29.svg)](https://ci-apps.yunohost.org/ci/apps/roundcube/)
-with this package in the file `conf/local.inc.php`. Do not edit the file
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/roundcube%20%28Official%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/roundcube/)
-`conf/config.inc.php` as future upgrades will overwrite it.
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/roundcube%20%28Official%29.svg)](https://ci-stretch.nohost.me/ci/apps/roundcube/)
 
-### Plugins
+## Limitations
+
+## Additional information
+
+#### Plugins
 
 You can also install other plugins - which will not be removed with upgrades. To do so,
 you can use the official [Plugin Repository](https://plugins.roundcube.net/).
 
-#### From the Plugin Repository
+##### From the Plugin Repository
 
 Let's say for example that we want to install the
 [html5_notifier](https://plugins.roundcube.net/packages/kitist/html5_notifier) plugin.
@@ -71,12 +97,28 @@ Let's say for example that we want to install the
 Note that you should also check the plugin homepage for additional installation
 steps as needed.
 
-#### Manual installation
+##### Manual installation
 
 You can also download the plugin and put it under the `plugins/` directory. In this
 case, do not forget to change ownerships of this folder to `roundcube`.
 
 ## Links
 
+ * Report a bug: https://github.com/YunoHost-Apps/roundcube_ynh/issues
  * Roundcube website: https://roundcube.net/
  * YunoHost website: https://yunohost.org/
+
+---
+
+Developers info
+----------------
+
+**Only if you want to use a testing branch for coding, instead of merging directly into master.**
+Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/roundcube_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/roundcube_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade roundcube -u https://github.com/YunoHost-Apps/roundcube_ynh/tree/testing --debug
+```

conf/config.inc.php

@@ -32,7 +32,7 @@ $config = array();
 // Currently supported db_providers: mysql, pgsql, sqlite, mssql or sqlsrv
 // For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php
 // NOTE: for SQLite use absolute path: 'sqlite:////full/path/to/sqlite.db?mode=0646'
-$config['db_dsnw'] = 'mysql://#DBUSER#:#DBPASS#@localhost/#DBNAME#';
+$config['db_dsnw'] = 'mysql://__DBUSER__:__DBPASS__@localhost/__DBNAME__';
 
 // The mail host chosen to perform the log-in.
 // Leave blank to show a textbox at login, give a list of hosts
@@ -94,7 +94,7 @@ $config['product_name'] = 'YunoHost Webmail';
 // in the session record (and the client cookie if remember password is enabled).
 // please provide a string of exactly 24 chars.
 // YOUR KEY MUST BE DIFFERENT THAN THE SAMPLE VALUE FOR SECURITY REASONS
-$config['des_key'] = '#DESKEY#';
+$config['des_key'] = '__DESKEY__';
 
 // skin name: folder from skins/
 $config['skin'] = 'larry';

conf/nginx.conf

@@ -1,6 +1,10 @@
-location __PATH__ {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
+location __PATH__/ {
+
+  # Path to source
   alias __FINALPATH__/ ;
 
+  # Force usage of https
   if ($scheme = http) {
     rewrite ^ https://$server_name$request_uri? permanent;
   }
@@ -21,7 +25,7 @@ location __PATH__ {
     include fastcgi_params;
   }
 
-  # show YunoHost panel access
+  # show YunoHost panel access
   include conf.d/yunohost_panel.conf.inc;
 }
 

manifest.json

@@ -6,22 +6,22 @@
         "en": "Open Source Webmail software",
         "fr": "Webmail Open Source"
     },
+    "version": "1.3.6~ynh2",
     "url": "https://roundcube.net/",
     "license": "GPL-3",
-    "version": "1.3.6~ynh1",
     "maintainer": {
         "name": "YunoHost Contributors",
         "email": "apps@yunohost.org"
     },
+    "requirements": {
+        "yunohost": ">= 3.2.0"
+    },
     "multi_instance": true,
     "services": [
         "nginx",
         "php5-fpm",
         "mysql"
     ],
-    "requirements": {
-        "yunohost": ">= 2.7.2"
-    },
     "arguments": {
         "install" : [
             {

scripts/_common.sh

@@ -1,84 +1,60 @@
-
+#!/bin/bash
 
 # =============================================================================
 # COMMON VARIABLES
 # =============================================================================
 
 # Package dependencies
-pkg_dependencies="php5-cli php5-common php5-intl php5-json php5-mcrypt php-pear php-auth-sasl php-mail-mime php-patchwork-utf8 php-net-smtp php-net-socket php-net-ldap2 php-net-ldap3"
+pkg_dependencies="php-cli php-common php-intl php-json php-mcrypt php-pear php-auth-sasl php-mail-mime php-patchwork-utf8 php-net-smtp php-net-socket php-net-ldap2 php-net-ldap3 php-zip php-gd php-mbstring"
-if [ "$(lsb_release --codename --short)" != "jessie" ]; then
-  pkg_dependencies="$pkg_dependencies php-zip php-gd php-mbstring"
-else
-  pkg_dependencies="$pkg_dependencies php-crypt-gpg"
-fi
 
 # Plugins version
 contextmenu_version=2.3
 automatic_addressbook_version=v0.4.3
 carddav_version=2.0.4
 
-# =============================================================================
+#=================================================
-# COMMON ROUNDCUBE FUNCTIONS
+# EXPERIMENTAL HELPERS
-# =============================================================================
+#=================================================
 
-# Execute a composer command from a given directory
+# Execute a command with Composer
-# usage: composer_exec workdir COMMAND [ARG ...]
+#
-exec_composer() {
+# usage: ynh_composer_exec [--workdir=$final_path] --commands="commands"
-  local workdir=$1
+# | arg: -w, --workdir - The directory from where the command will be executed. Default $final_path.
-  shift 1
+# | arg: -c, --commands - Commands to execute.
+ynh_composer_exec () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=wc
+	declare -Ar args_array=( [w]=workdir= [c]=commands= )
+	local workdir
+	local commands
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	workdir="${workdir:-$final_path}"
 
-  COMPOSER_HOME="${workdir}/.composer" \
+	COMPOSER_HOME="$workdir/.composer" \
-    php "${workdir}/composer.phar" $@ \
+		php "$workdir/composer.phar" $commands \
-      -d "${workdir}" --quiet --no-interaction
+		-d "$workdir" --quiet --no-interaction
 }
 
 # Install and initialize Composer in the given directory
-# usage: init_composer destdir
+#
-init_composer() {
+# usage: ynh_install_composer [--workdir=$final_path]
-  local destdir=$1
+# | 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
+	declare -Ar args_array=( [w]=workdir= )
+	local workdir
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	workdir="${workdir:-$final_path}"
 
-  # install composer
 	curl -sS https://getcomposer.org/installer \
-    | COMPOSER_HOME="${destdir}/.composer" \
+		| COMPOSER_HOME="$workdir/.composer" \
-        php -- --quiet --install-dir="$destdir" \
+		php -- --quiet --install-dir="$workdir" \
-    || ynh_die "Unable to install Composer"
+		|| ynh_die "Unable to install Composer."
-
-  # install composer.json
-  cp "${destdir}/composer.json-dist" "${destdir}/composer.json"
 
 	# update dependencies to create composer.lock
-  exec_composer "$destdir" install --no-dev \
+	ynh_composer_exec --workdir="$workdir" --commands="install --no-dev" \
-    || ynh_die "Unable to update Roundcube core dependencies"
+		|| ynh_die "Unable to update core dependencies with Composer."
-}
-
-# Install and configure CardDAV plugin for Roundcube
-# usage: install_carddav destdir
-# https://plugins.roundcube.net/packages/roundcube/carddav
-install_carddav() {
-  local destdir=$1
-
-  local carddav_config="${destdir}/plugins/carddav/config.inc.php"
-  local carddav_tmp_config="../conf/carddav.config.inc.php"
-
-  exec_composer "$destdir" require \
-      "roundcube/carddav $carddav_version"
-
-  # Look for installed and supported CardDAV servers
-  for carddav_app in "owncloud" "baikal"; do
-    local app_id=$(yunohost app list --installed -f "$carddav_app" \
-            --output-as json | grep -Po '"id":[ ]?"\K.*?(?=")' | head -1)
-    [[ -z "$app_id" ]] || {
-      # Retrieve app settings and enable relevant preset
-      carddav_domain=$(ynh_app_setting_get "$app_id" domain)
-      carddav_path=$(ynh_app_setting_get "$app_id" path)
-      carddav_url="https://${carddav_domain}${carddav_path%/}"
-      sed -i "s#{${carddav_app}_url}#${carddav_url}#g" "$carddav_tmp_config"
-      sed -i \
-"/\/\/\/\/ PRESET FOR: ${carddav_app}/\
-,/\/\/\/\/ END: ${carddav_app}/s/^\/\///" "$carddav_tmp_config"
-    }
-  done
-
-  # Copy plugin the configuration file
-  cp "$carddav_tmp_config" "$carddav_config"
 }

scripts/_getopts_fix.sh

@@ -0,0 +1,213 @@
+#!/bin/bash
+
+#=================================================
+# FIX OF YNH_HANDLE_GETOPTS_ARGS FROM UNSTABLE
+#=================================================
+
+# Internal helper design to allow helpers to use getopts to manage their arguments
+#
+# [internal]
+#
+# example: function my_helper()
+# {
+#     declare -Ar args_array=( [a]=arg1= [b]=arg2= [c]=arg3 )
+#     local arg1
+#     local arg2
+#     local arg3
+#     ynh_handle_getopts_args "$@"
+#
+#     [...]
+# }
+# my_helper --arg1 "val1" -b val2 -c
+#
+# usage: ynh_handle_getopts_args "$@"
+# | arg: $@    - Simply "$@" to tranfert all the positionnal arguments to the function
+#
+# This helper need an array, named "args_array" with all the arguments used by the helper
+# 	that want to use ynh_handle_getopts_args
+# Be carreful, this array has to be an associative array, as the following example:
+# declare -Ar args_array=( [a]=arg1 [b]=arg2= [c]=arg3 )
+# Let's explain this array:
+# a, b and c are short options, -a, -b and -c
+# arg1, arg2 and arg3 are the long options associated to the previous short ones. --arg1, --arg2 and --arg3
+# For each option, a short and long version has to be defined.
+# Let's see something more significant
+# declare -Ar args_array=( [u]=user [f]=finalpath= [d]=database )
+#
+# NB: Because we're using 'declare' without -g, the array will be declared as a local variable.
+#
+# Please keep in mind that the long option will be used as a variable to store the values for this option.
+# For the previous example, that means that $finalpath will be fill with the value given as argument for this option.
+#
+# Also, in the previous example, finalpath has a '=' at the end. That means this option need a value.
+# So, the helper has to be call with --finalpath /final/path, --finalpath=/final/path or -f /final/path, the variable $finalpath will get the value /final/path
+# If there's many values for an option, -f /final /path, the value will be separated by a ';' $finalpath=/final;/path
+# For an option without value, like --user in the example, the helper can be called only with --user or -u. $user will then get the value 1.
+#
+# To keep a retrocompatibility, a package can still call a helper, using getopts, with positional arguments.
+# The "legacy mode" will manage the positional arguments and fill the variable in the same order than they are given in $args_array.
+# e.g. for `my_helper "val1" val2`, arg1 will be filled with val1, and arg2 with val2.
+ynh_handle_getopts_args () {
+	# Manage arguments only if there's some provided
+	set +x
+	if [ $# -ne 0 ]
+	then
+		# Store arguments in an array to keep each argument separated
+		local arguments=("$@")
+
+		# For each option in the array, reduce to short options for getopts (e.g. for [u]=user, --user will be -u)
+		# And built parameters string for getopts
+		# ${!args_array[@]} is the list of all option_flags in the array (An option_flag is 'u' in [u]=user, user is a value)
+		local getopts_parameters=""
+		local option_flag=""
+		for option_flag in "${!args_array[@]}"
+		do
+			# Concatenate each option_flags of the array to build the string of arguments for getopts
+			# Will looks like 'abcd' for -a -b -c -d
+			# If the value of an option_flag finish by =, it's an option with additionnal values. (e.g. --user bob or -u bob)
+			# Check the last character of the value associate to the option_flag
+			if [ "${args_array[$option_flag]: -1}" = "=" ]
+			then
+				# For an option with additionnal values, add a ':' after the letter for getopts.
+				getopts_parameters="${getopts_parameters}${option_flag}:"
+			else
+				getopts_parameters="${getopts_parameters}${option_flag}"
+			fi
+			# Check each argument given to the function
+			local arg=""
+			# ${#arguments[@]} is the size of the array
+			for arg in `seq 0 $(( ${#arguments[@]} - 1 ))`
+			do
+				# And replace long option (value of the option_flag) by the short option, the option_flag itself
+				# (e.g. for [u]=user, --user will be -u)
+				# Replace long option with =
+				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]}/-${option_flag} }"
+				# And long option without =
+				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]%=}/-${option_flag}}"
+			done
+		done
+
+		# Read and parse all the arguments
+		# Use a function here, to use standart arguments $@ and be able to use shift.
+		parse_arg () {
+			# Read all arguments, until no arguments are left
+			while [ $# -ne 0 ]
+			do
+				# Initialize the index of getopts
+				OPTIND=1
+				# Parse with getopts only if the argument begin by -, that means the argument is an option
+				# getopts will fill $parameter with the letter of the option it has read.
+				local parameter=""
+				getopts ":$getopts_parameters" parameter || true
+
+				if [ "$parameter" = "?" ]
+				then
+					ynh_die --message="Invalid argument: -${OPTARG:-}"
+				elif [ "$parameter" = ":" ]
+				then
+					ynh_die --message="-$OPTARG parameter requires an argument."
+				else
+					local shift_value=1
+					# Use the long option, corresponding to the short option read by getopts, as a variable
+					# (e.g. for [u]=user, 'user' will be used as a variable)
+					# Also, remove '=' at the end of the long option
+					# The variable name will be stored in 'option_var'
+					local option_var="${args_array[$parameter]%=}"
+					# If this option doesn't take values
+					# if there's a '=' at the end of the long option name, this option takes values
+					if [ "${args_array[$parameter]: -1}" != "=" ]
+					then
+						# 'eval ${option_var}' will use the content of 'option_var'
+						eval ${option_var}=1
+					else
+						# Read all other arguments to find multiple value for this option.
+						# Load args in a array
+						local all_args=("$@")
+
+						# If the first argument is longer than 2 characters,
+						# There's a value attached to the option, in the same array cell
+						if [ ${#all_args[0]} -gt 2 ]; then
+							# Remove the option and the space, so keep only the value itself.
+							all_args[0]="${all_args[0]#-${parameter} }"
+							# Reduce the value of shift, because the option has been removed manually
+							shift_value=$(( shift_value - 1 ))
+						fi
+
+						# Declare the content of option_var as a variable.
+						eval ${option_var}=""
+						# Then read the array value per value
+						local i
+						for i in `seq 0 $(( ${#all_args[@]} - 1 ))`
+						do
+							# If this argument is an option, end here.
+							if [ "${all_args[$i]:0:1}" == "-" ]
+							then
+								# Ignore the first value of the array, which is the option itself
+								if [ "$i" -ne 0 ]; then
+									break
+								fi
+							else
+								# Else, add this value to this option
+								# Each value will be separated by ';'
+								if [ -n "${!option_var}" ]
+								then
+									# If there's already another value for this option, add a ; before adding the new value
+									eval ${option_var}+="\;"
+								fi
+								# Escape double quote to prevent any interpretation during the eval
+								all_args[$i]="${all_args[$i]//\"/\\\"}"
+
+								eval ${option_var}+=\"${all_args[$i]}\"
+								shift_value=$(( shift_value + 1 ))
+							fi
+						done
+					fi
+				fi
+
+				# Shift the parameter and its argument(s)
+				shift $shift_value
+			done
+		}
+
+		# LEGACY MODE
+		# Check if there's getopts arguments
+		if [ "${arguments[0]:0:1}" != "-" ]
+		then
+			# If not, enter in legacy mode and manage the arguments as positionnal ones..
+			# Dot not echo, to prevent to go through a helper output. But print only in the log.
+			set -x; echo "! Helper used in legacy mode !" > /dev/null; set +x
+			local i
+			for i in `seq 0 $(( ${#arguments[@]} -1 ))`
+			do
+				# Try to use legacy_args as a list of option_flag of the array args_array
+				# Otherwise, fallback to getopts_parameters to get the option_flag. But an associative arrays isn't always sorted in the correct order...
+				# Remove all ':' in getopts_parameters
+				getopts_parameters=${legacy_args:-${getopts_parameters//:}}
+				# Get the option_flag from getopts_parameters, by using the option_flag according to the position of the argument.
+				option_flag=${getopts_parameters:$i:1}
+				if [ -z "$option_flag" ]; then
+						ynh_print_warn --message="Too many arguments ! \"${arguments[$i]}\" will be ignored."
+						continue
+				fi
+				# Use the long option, corresponding to the option_flag, as a variable
+				# (e.g. for [u]=user, 'user' will be used as a variable)
+				# Also, remove '=' at the end of the long option
+				# The variable name will be stored in 'option_var'
+				local option_var="${args_array[$option_flag]%=}"
+
+				# Escape double quote to prevent any interpretation during the eval
+				arguments[$i]="${arguments[$i]//\"/\\\"}"
+
+				# Store each value given as argument in the corresponding variable
+				# The values will be stored in the same order than $args_array
+				eval ${option_var}+=\"${arguments[$i]}\"
+			done
+			unset legacy_args
+		else
+			# END LEGACY MODE
+			# Call parse_arg and pass the modified list of args as an array of arguments.
+			parse_arg "${arguments[@]}"
+		fi
+	fi
+	set -x
+}

scripts/backup

@@ -2,25 +2,20 @@
 
 #=================================================
 # GENERIC START
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit on command errors and treat access to unset variables as an error
-set -eu
-
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
 
-if [ ! -e _common.sh ]; then
+source ../settings/scripts/_common.sh
-	# Get the _common.sh file if it's not in the current directory
-	cp ../settings/scripts/_common.sh ./_common.sh
-	chmod a+rx _common.sh
-fi
-source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # LOAD SETTINGS
 #=================================================

scripts/install

@@ -6,8 +6,11 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-source ./_common.sh
+source _common.sh
 source /usr/share/yunohost/helpers
+# Overload the helper ynh_handle_getopts_args to have fixes from unstable.
+# Needed for composer helpers
+source _getopts_fix.sh
 
 #=================================================
 # MANAGE SCRIPT FAILURE
@@ -31,14 +34,12 @@ app=$YNH_APP_INSTANCE_NAME
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
 
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
-
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-# Check web path availability
+# Normalize the url path syntax
-ynh_webpath_available $domain $path_url
+path_url=$(ynh_normalize_url_path $path_url)
+
 # Register (book) web path
 ynh_webpath_register $app $domain $path_url
 
@@ -57,14 +58,6 @@ ynh_app_setting_set $app with_enigma $with_enigma
 # INSTALL DEPENDENCIES
 #=================================================
 
-# jessie-backports is needed for php-net-ldap3
-if [ "$(lsb_release --codename --short)" = "jessie" ]; then
-      grep -q -R 'jessie-backports' /etc/apt/sources.list{,.d} || {
-         echo "deb http://httpredir.debian.org/debian jessie-backports main" \
-           | tee -a /etc/apt/sources.list.d/backports.list >/dev/null
-      }
-fi
-
 ynh_install_app_dependencies "$pkg_dependencies"
 
 #=================================================
@@ -110,69 +103,96 @@ ynh_add_fpm_config
 # INSTALL AND INITIALIZE COMPOSER
 #=================================================
 
-init_composer "$final_path"
+# Install composer.json
+cp "$final_path/composer.json-dist" "$final_path/composer.json"
+
+# Install composer
+ynh_install_composer
 
 #=================================================
 # INITIALIZE DATABASE
 #=================================================
 
 ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
-    < "${final_path}/SQL/mysql.initial.sql"
+    < "$final_path/SQL/mysql.initial.sql"
 
 #=================================================
 # CONFIGURE ROUNDCUBE
 #=================================================
+rc_conf="$final_path/config/config.inc.php"
 
-rc_conf="${final_path}/config/config.inc.php"
 cp ../conf/config.inc.php "$rc_conf"
 
-ynh_replace_string "#DESKEY#" "$(ynh_string_random 24)" "$rc_conf"
+ynh_replace_string "__DESKEY__" "$(ynh_string_random 24)" "$rc_conf"
-ynh_replace_string "#DBUSER#" "$db_name" "$rc_conf"
+ynh_replace_string "__DBUSER__" $db_name "$rc_conf"
-ynh_replace_string "#DBPASS#" "$db_pwd" "$rc_conf"
+ynh_replace_string "__DBPASS__" "$db_pwd" "$rc_conf"
-ynh_replace_string "#DBNAME#" "$db_name" "$rc_conf"
+ynh_replace_string "__DBNAME__" $db_name "$rc_conf"
 
 #=================================================
 # INSTALL ADDITIONAL PLUGINS
 #=================================================
 
 # Create logs and temp directories
-mkdir -p "${final_path}/logs" "${final_path}/temp"
+mkdir -p "$final_path/"{logs,temp}
 
 # Install contextmenu and automatic_addressbook plugins
 # https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook
 # https://plugins.roundcube.net/packages/johndoh/contextmenu
-exec_composer "$final_path" require \
+ynh_composer_exec --commands="require \
-    "johndoh/contextmenu $contextmenu_version" \
+    johndoh/contextmenu $contextmenu_version \
-    "sblaisot/automatic_addressbook $automatic_addressbook_version"
+    sblaisot/automatic_addressbook $automatic_addressbook_version"
+
 installed_plugins+=" 'contextmenu', 'automatic_addressbook',"
 
 # Install CardDAV plugin
-if [[ $with_carddav -eq 1 ]]; then
+if [ $with_carddav -eq 1 ]
-  install_carddav "$final_path" \
+then
-    && installed_plugins+=" 'carddav'," \
+    ynh_composer_exec --commands="require roundcube/carddav $carddav_version"
-    || echo "Unable to install CardDAV plugin" >&2
+
+    carddav_tmp_config="../conf/carddav.config.inc.php"
+
+    # Look for installed and supported CardDAV servers
+    for carddav_app in "owncloud" "baikal"
+    do
+        carddav_app_id=$(yunohost app list --installed -f $carddav_app \
+            --output-as json | grep -Po '"id":[ ]?"\K.*?(?=")' | head -1)
+        if [ -n "$carddav_app_id" ]
+        then
+            # Retrieve app settings and enable relevant preset
+            carddav_domain=$(ynh_app_setting_get $carddav_app_id domain)
+            carddav_path=$(ynh_app_setting_get $carddav_app_id path)
+            carddav_url="https://${carddav_domain}${carddav_path%/}"
+            ynh_replace_string "{${carddav_app}_url}" "$carddav_url" "$carddav_tmp_config"
+            sed -i "/\/\/\/\/ PRESET FOR: $carddav_app/,/\/\/\/\/ END: $carddav_app/s/^\/\///" "$carddav_tmp_config"
+        fi
+    done
+
+    # Copy the plugin configuration file
+    cp "$carddav_tmp_config" ""$final_path/plugins/carddav/config.inc.php""
+
+    installed_plugins+=" 'carddav',"
 fi
 
 # Install Enigma plugin
-if [[ $with_enigma -eq 1 ]]; then
+if [ $with_enigma -eq 1 ]
+then
     cp -a "$final_path/plugins/enigma/config.inc.php.dist" "$final_path/plugins/enigma/config.inc.php" \
         && installed_plugins+=" 'enigma'," \
-    || echo "Unable to install Enigma plugin" >&2
+        || ynh_print_warn "Unable to install Enigma plugin"
 fi
 
 #=================================================
 # UPDATE ROUNDCUBE CONFIGURATION
 #=================================================
 
-sed -i "s#^\s*// installed plugins#&\n ${installed_plugins}#" \
+ynh_replace_string "^\s*// installed plugins" "&\n $installed_plugins" "$rc_conf"
-    "${final_path}/config/config.inc.php"
 
 # Update javascript dependencies
-(cd "${final_path}"
+(cd "$final_path"
 /usr/bin/php -q ./bin/install-jsdeps.sh)
 
 # Store the config file checksum into the app settings
-ynh_store_file_checksum "${final_path}/config/config.inc.php"
+ynh_store_file_checksum "$rc_conf"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -182,8 +202,7 @@ ynh_store_file_checksum "${final_path}/config/config.inc.php"
 
 # Set permissions to app files
 chown -R root: "$final_path"
-chown -R $app: "${final_path}/temp/" "${final_path}/logs/"
+chown -R $app: "$final_path/"{temp,logs,plugins/enigma/home}
-chown -R $app: "$final_path/plugins/enigma/home"
 
 #=================================================
 # RELOAD NGINX

scripts/remove

@@ -6,12 +6,6 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-if [ ! -e _common.sh ]; then
-	# Get file fonction if not been to the current directory
-	cp ../settings/scripts/_common.sh ./_common.sh
-	chmod a+rx _common.sh
-fi
-# Source app helpers
 source _common.sh
 source /usr/share/yunohost/helpers
 
@@ -23,6 +17,7 @@ app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get $app domain)
 db_name=$(ynh_app_setting_get $app db_name)
+final_path=$(ynh_app_setting_get $app final_path)
 
 #=================================================
 # STANDARD REMOVE
@@ -45,7 +40,7 @@ ynh_mysql_remove_db $db_name $db_name
 #=================================================
 
 # Remove the app directory securely
-ynh_secure_remove "/var/www/$app"
+ynh_secure_remove "$final_path"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
@@ -61,14 +56,6 @@ ynh_remove_nginx_config
 # Remove the dedicated php-fpm config
 ynh_remove_fpm_config
 
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-
-# The following command is kept as a matter of transition with the previous way
-# of managing dependencies
-ynh_package_autoremove "roundcube-ynh-deps" || true
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================

scripts/restore

@@ -2,25 +2,20 @@
 
 #=================================================
 # GENERIC START
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit on command errors and treat access to unset variables as an error
-set -eu
-
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
 
-if [ ! -e _common.sh ]; then
+source ../settings/scripts/_common.sh
-	# Get the _common.sh file if it's not in the current directory
-	cp ../settings/scripts/_common.sh ./_common.sh
-	chmod a+rx _common.sh
-fi
-source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # LOAD SETTINGS
 #=================================================
@@ -41,20 +36,6 @@ ynh_webpath_available $domain $path_url \
 test ! -d $final_path \
 	|| ynh_die "There is already a directory: $final_path "
 
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-
-# jessie-backports is needed for php-net-ldap3
-if [ "$(lsb_release --codename --short)" = "jessie" ]; then
-      grep -q -R 'jessie-backports' /etc/apt/sources.list{,.d} || {
-         echo "deb http://httpredir.debian.org/debian jessie-backports main" \
-           | tee -a /etc/apt/sources.list.d/backports.list >/dev/null
-      }
-fi
-
-ynh_install_app_dependencies "$pkg_dependencies"
-
 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
@@ -69,14 +50,6 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 
 ynh_restore_file "$final_path"
 
-#=================================================
-# 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
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
@@ -90,19 +63,37 @@ ynh_system_user_create $app
 
 # Restore permissions on app files
 chown -R root: "$final_path"
-chown -R $app: "${final_path}/temp/" "${final_path}/logs/"
+chown -R $app: "$final_path/"{temp,logs,plugins/enigma/home}
 
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
+ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
-# GENERIC FINALISATION
+# SPECIFIC RESTORATION
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+
+# Define and install dependencies
+ynh_install_app_dependencies "$pkg_dependencies"
+
+#=================================================
+# 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
+
+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
 
 systemctl reload php5-fpm
 systemctl reload nginx
+

scripts/upgrade

@@ -8,6 +8,9 @@
 
 source _common.sh
 source /usr/share/yunohost/helpers
+# Overload the helper ynh_handle_getopts_args to have fixes from unstable.
+# Needed for composer helpers
+source _getopts_fix.sh
 
 #=================================================
 # LOAD SETTINGS
@@ -38,15 +41,40 @@ if [ -z "$final_path" ]; then
 	ynh_app_setting_set $app final_path $final_path
 fi
 
+# If with_carddav doesn't exist, create it
+if [ -z "$with_carddav" ]; then
+	if [ -f "$final_path/plugins/carddav/config.inc.php" ]
+	then
+		with_carddav=1
+	else
+		with_carddav=0
+	fi
+	ynh_app_setting_set $app with_carddav $with_carddav
+fi
+
+# If with_enigma doesn't exist, create it
+if [ -z "$with_enigma" ]; then
+	if [ -f "${final_path}/plugins/enigma/config.inc.php" ]
+	then
+		with_enigma=1
+	else
+		with_enigma=0
+	fi
+	ynh_app_setting_set $app with_enigma $with_enigma
+fi
+
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
 
-ynh_backup_before_upgrade	# Backup the current version of the app
+# Backup the current version of the app
+ynh_backup_before_upgrade
 ynh_clean_setup () {
-	ynh_restore_upgradebackup	# restore it if the upgrade fails
+	# restore it if the upgrade fails
+	ynh_restore_upgradebackup
 }
-ynh_abort_if_errors	# Active trap pour arrêter le script si une erreur est détectée.
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
 #=================================================
 # CHECK THE PATH
@@ -57,27 +85,6 @@ path_url=$(ynh_normalize_url_path $path_url)
 
 #=================================================
 # STANDARD UPGRADE STEPS
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-
-# jessie-backports is needed for php-net-ldap3
-if [ "$(lsb_release --codename --short)" = "jessie" ]; then
-      grep -q -R 'jessie-backports' /etc/apt/sources.list{,.d} || {
-         echo "deb http://httpredir.debian.org/debian jessie-backports main" \
-           | tee -a /etc/apt/sources.list.d/backports.list >/dev/null
-      }
-fi
-
-ynh_install_app_dependencies "$pkg_dependencies"
-
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-
-# Create a system user
-ynh_system_user_create $app
-
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -95,6 +102,19 @@ ynh_setup_source "$final_path"
 # Create a dedicated nginx config
 ynh_add_nginx_config
 
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+
+ynh_install_app_dependencies "$pkg_dependencies"
+
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+
+# Create a dedicated user (if not existing)
+ynh_system_user_create $app
+
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
@@ -108,93 +128,106 @@ ynh_add_fpm_config
 # CONFIGURE ROUNDCUBE
 #=================================================
 
-# Verify the checksum and backup the file if it's different
+rc_conf="$final_path/config/config.inc.php"
-ynh_backup_if_checksum_is_different "${final_path}/config/config.inc.php"
+
+# Verify the checksum and backup the file if it's different
+ynh_backup_if_checksum_is_different "$rc_conf"
 
-rc_conf="${final_path}/config/config.inc.php"
 cp ../conf/config.inc.php "$rc_conf"
-ynh_replace_string "#DESKEY#" "$(ynh_string_random 24)" "$rc_conf"
+
-ynh_replace_string "#DBUSER#" "$db_name" "$rc_conf"
+ynh_replace_string "__DESKEY__" "$(ynh_string_random 24)" "$rc_conf"
+ynh_replace_string "__DBUSER__" $db_name "$rc_conf"
 db_pwd=$(ynh_app_setting_get $app mysqlpwd)
-ynh_replace_string "#DBPASS#" "$db_pwd" "$rc_conf"
+ynh_replace_string "__DBPASS__" "$db_pwd" "$rc_conf"
-ynh_replace_string "#DBNAME#" "$db_name" "$rc_conf"
+ynh_replace_string "__DBNAME__" $db_name "$rc_conf"
 
 #=================================================
 # UPDATE DEPENDENCIES WITH COMPOSER
 #=================================================
 
 # Check if dependencies need to be updated with composer
-if [ -f "${final_path}/composer.json" ]; then
+if [ -f "$final_path/composer.json" ]
-  exec_composer "${final_path}" update --no-dev --prefer-dist
+then
+    ynh_exec_warn_less ynh_composer_exec --commands=\"update --no-dev --prefer-dist\"
 else
-  init_composer "${final_path}"
+    # Install composer.json
-fi
+    cp "$final_path/composer.json-dist" "$final_path/composer.json"
 
+    # Install composer
+    ynh_install_composer
+fi
 #=================================================
 # UPGRADE ADDITIONAL PLUGINS
 #=================================================
 
 # Create logs and temp directories
-mkdir -p "${final_path}/logs" "${final_path}/temp"
+mkdir -p "$final_path/"{logs,temp}
 
 # Update or install contextmenu and automatic_addressbook plugins
 # https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook
 # https://plugins.roundcube.net/packages/johndoh/contextmenu
-exec_composer "${final_path}" update --no-dev --prefer-dist \
+ynh_composer_exec --commands="update --no-dev --prefer-dist \
-    "johndoh/contextmenu $contextmenu_version" \
+    johndoh/contextmenu $contextmenu_version \
-    "sblaisot/automatic_addressbook $automatic_addressbook_version"
+    sblaisot/automatic_addressbook $automatic_addressbook_version"
+
 installed_plugins+=" 'contextmenu', 'automatic_addressbook',"
 
-# Guess with_carddav value if empty
-if [[ -z "${with_carddav:-}" ]]; then
-  [[ -f "${final_path}/plugins/carddav/config.inc.php" ]] \
-    && with_carddav=1 \
-    || with_carddav=0
-  ynh_app_setting_set "$app" with_carddav "$with_carddav"
-fi
-
 # Update or install CardDAV plugin
-if [[ $with_carddav -eq 1 ]]; then
+if [ $with_carddav -eq 1 ]
-  install_carddav "${final_path}" \
+then
-    && installed_plugins+=" 'carddav'," \
+    ynh_composer_exec --commands="require roundcube/carddav $carddav_version"
-    || echo "Unable to install CardDAV plugin" >&2
-fi
 
-# Guess with_enigma value if empty
+    carddav_tmp_config="../conf/carddav.config.inc.php"
-if [[ -z "${with_enigma:-}" ]]; then
+
-  [[ -f "${final_path}/plugins/enigma/config.inc.php" ]] \
+    # Look for installed and supported CardDAV servers
-    && with_enigma=1 \
+    for carddav_app in "owncloud" "baikal"
-    || with_enigma=0
+    do
-  ynh_app_setting_set "$app" with_enigma "$with_enigma"
+        carddav_app_id=$(yunohost app list --installed -f $carddav_app \
+            --output-as json | grep -Po '"id":[ ]?"\K.*?(?=")' | head -1)
+        if [ -n "$carddav_app_id" ]
+        then
+            # Retrieve app settings and enable relevant preset
+            carddav_domain=$(ynh_app_setting_get $carddav_app_id domain)
+            carddav_path=$(ynh_app_setting_get $carddav_app_id path)
+            carddav_url="https://${carddav_domain}${carddav_path%/}"
+            ynh_replace_string "{${carddav_app}_url}" "$carddav_url" "$carddav_tmp_config"
+            sed -i "/\/\/\/\/ PRESET FOR: $carddav_app/,/\/\/\/\/ END: $carddav_app/s/^\/\///" "$carddav_tmp_config"
+        fi
+    done
+
+    # Copy the plugin configuration file
+    cp "$carddav_tmp_config" ""$final_path/plugins/carddav/config.inc.php""
+
+    installed_plugins+=" 'carddav',"
 fi
 
 # Install Enigma plugin
-if [[ $with_enigma -eq 1 ]]; then
+if [ $with_enigma -eq 1 ]
+then
     cp -a "$final_path/plugins/enigma/config.inc.php.dist" "$final_path/plugins/enigma/config.inc.php" \
         && installed_plugins+=" 'enigma'," \
-    || echo "Unable to install Enigma plugin" >&2
+        || ynh_print_warn "Unable to install Enigma plugin"
 fi
 
 #=================================================
 # UPDATE ROUNDCUBE CONFIGURATION
 #=================================================
 
-sed -i "s#^\s*// installed plugins#&\n ${installed_plugins}#" \
+ynh_replace_string "^\s*// installed plugins" "&\n $installed_plugins" "$rc_conf"
-    "$rc_conf"
 
 # Update javascript dependencies
-( cd "${final_path}"
+(cd "$final_path"
 /usr/bin/php -q ./bin/install-jsdeps.sh)
 
 # Store the config file checksum into the app settings
-ynh_store_file_checksum "${final_path}/config/config.inc.php"
+ynh_store_file_checksum "$rc_conf"
 
 #=================================================
 # UPDATE ROUNDCUBE CORE
 #=================================================
 
-( cd "${final_path}"
+( cd "$final_path"
-./bin/update.sh --version=$oldversion -y) >&2
+ynh_exec_warn ./bin/update.sh --version=$oldversion -y)
 
 #=================================================
 # GENERIC FINALIZATION
@@ -204,9 +237,7 @@ ynh_store_file_checksum "${final_path}/config/config.inc.php"
 
 # Set permissions to app files
 chown -R root: "$final_path"
-chown -R $app: "${final_path}/temp/" "${final_path}/logs/"
+chown -R $app: "$final_path/"{temp,logs,plugins/enigma/home}
-chown -R $app: "$final_path/plugins/enigma/home"
-
 
 #=================================================
 # RELOAD NGINX