Merge pull request #21 from YunoHost-Apps/testing

Testing

.gitignore

@@ -1,3 +1,4 @@
 *.swp
 *~
 Notes
+*.kate-swp

README.md

@@ -13,7 +13,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to
 ## Overview
 The leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project.
 
-**Shipped version:** 2.121.1
+**Shipped version:** 2.150.2
 
 ## Screenshots
 
@@ -40,9 +40,9 @@ Supported, with LDAP and SSO.
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/jenkins%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/jenkins%20(Community)/)
+* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/jenkins%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/jenkins/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/jenkins%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/jenkins%20(Community)%20(%7EARM%7E)/) Really too slow on ARM architecture. Mostly not recommended to use it on ARM.
+* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/jenkins%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jenkins/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/jenkins%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/jenkins%20(Community)/)
+* Jessie x86-64b - [![](https://ci-stretch.nohost.me/ci/logs/jenkins%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/jenkins/)
 
 ## Limitations
 
@@ -65,7 +65,7 @@ Please do your pull request to the [testing branch](https://github.com/YunoHost-
 
 To try the testing branch, please proceed like that.
 ```
-sudo yunohost app install https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --verbose
+sudo yunohost app install https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --debug
 or
-sudo yunohost app upgrade jenkins -u https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --verbose
+sudo yunohost app upgrade jenkins -u https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --debug
 ```

README_fr.md

@@ -13,7 +13,7 @@ Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/inst
 ## Résumé
 Premier serveur d'automatisation open source, Jenkins fournit des centaines de plugins pour supporter la construction, le déploiement et l'automatisation de n'importe quel projet.
 
-**Version embarquée:** 2.121.1
+**Version embarquée:** 2.150.2
 
 ## Captures d'écran
 
@@ -40,9 +40,9 @@ Supportée, avec LDAP et SSO.
 
 #### Architectures supportées.
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/jenkins%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/jenkins%20(Community)/)
+* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/jenkins%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/jenkins/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/jenkins%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/jenkins%20(Community)%20(%7EARM%7E)/) Vraiment trop lent sur architecture ARM. Vraiment pas recommandé de l'utiliser sur ARM.
+* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/jenkins%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jenkins/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/jenkins%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/jenkins%20(Community)/)
+* Jessie x86-64b - [![](https://ci-stretch.nohost.me/ci/logs/jenkins%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/jenkins/)
 
 ## Limitations
 
@@ -65,7 +65,7 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
 
 Pour tester la branche testing, merci de procéder ainsi.
 ```
-sudo yunohost app install https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --verbose
+sudo yunohost app install https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --debug
 ou
-sudo yunohost app upgrade jenkins -u https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --verbose
+sudo yunohost app upgrade jenkins -u https://github.com/YunoHost-Apps/jenkins_ynh/tree/testing --debug
 ```

conf/app.src_file

@@ -0,0 +1,4 @@
+FILE_URL=https://pkg.jenkins.io/debian-stable/binary/jenkins_2.150.2_all.deb
+FILE_SUM=d00ff7066d51895bbd17d1b3a2efbf00
+FILE_SUM_PRG=md5sum
+FILENAME=jenkins.deb

manifest.json

@@ -6,7 +6,7 @@
 		"en": "Extendable continuous integration server",
 		"fr": "Serveur d'intégration continue extensible"
 	},
-	"version": "2.121.1~ynh2",
+	"version": "2.150.2~ynh1",
 	"url": "https://jenkins.io/index.html",
 	"license": "MIT",
 	"maintainer": {
@@ -14,7 +14,7 @@
 		"email": "maniackc_dev@crudelis.fr"
 	},
 	"requirements": {
-		"yunohost": ">= 3.0.0"
+		"yunohost": ">= 3.3.3"
 	},
 	"multi_instance": false,
 	"services": [

scripts/_common.sh

@@ -49,11 +49,13 @@ bool_to_true_false () {
 }
 
 #=================================================
-# EXPERIMENTAL HELPERS
+# FUTUR OFFICIAL HELPERS
 #=================================================
 
 # 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 )
@@ -103,33 +105,33 @@ ynh_handle_getopts_args () {
 
 		# 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 keys in the array (A key is 'u' in [u]=user, user is a value)
+		# ${!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 key=""
+		local option_flag=""
-		for key in "${!args_array[@]}"
+		for option_flag in "${!args_array[@]}"
 		do
-			# Concatenate each keys of the array to build the string of arguments for getopts
+			# 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 a key finish by =, it's an option with additionnal values. (e.g. --user bob or -u bob)
+			# 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 key
+			# Check the last character of the value associate to the option_flag
-			if [ "${args_array[$key]: -1}" = "=" ]
+			if [ "${args_array[$option_flag]: -1}" = "=" ]
 			then
 				# For an option with additionnal values, add a ':' after the letter for getopts.
-				getopts_parameters="${getopts_parameters}${key}:"
+				getopts_parameters="${getopts_parameters}${option_flag}:"
 			else
-				getopts_parameters="${getopts_parameters}${key}"
+				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 key) by the short option, the key itself
+				# 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[$key]}/-${key} }"
+				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]}/-${option_flag} }"
 				# And long option without =
-				arguments[arg]="${arguments[arg]//--${args_array[$key]%=}/-${key}}"
+				arguments[arg]="${arguments[arg]//--${args_array[$option_flag]%=}/-${option_flag}}"
 			done
 		done
 
@@ -148,10 +150,10 @@ ynh_handle_getopts_args () {
 
 				if [ "$parameter" = "?" ]
 				then
-					ynh_die "Invalid argument: -${OPTARG:-}"
+					ynh_die --message="Invalid argument: -${OPTARG:-}"
 				elif [ "$parameter" = ":" ]
 				then
-					ynh_die "-$OPTARG parameter requires an argument."
+					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
@@ -179,19 +181,20 @@ ynh_handle_getopts_args () {
 							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}" == "-" ] || [ -z "${all_args[$i]}" ]
+							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
-								# Declare the content of option_var as a variable.
-								eval ${option_var}=""
 								# Else, add this value to this option
 								# Each value will be separated by ';'
 								if [ -n "${!option_var}" ]
@@ -215,25 +218,33 @@ ynh_handle_getopts_args () {
 		# 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.
+			# If not, enter in legacy mode and manage the arguments as positionnal ones..
-			echo "! Helper used in legacy mode !"
+			# 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
-				# Use getopts_parameters as a list of key of the array args_array
+				# 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=${getopts_parameters//:}
+				getopts_parameters=${legacy_args:-${getopts_parameters//:}}
-				# Get the key from getopts_parameters, by using the key according to the position of the argument.
+				# Get the option_flag from getopts_parameters, by using the option_flag according to the position of the argument.
-				key=${getopts_parameters:$i:1}
+				option_flag=${getopts_parameters:$i:1}
-				# Use the long option, corresponding to the key, as a variable
+				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[$key]%=}"
+				local option_var="${args_array[$option_flag]%=}"
 
 				# 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.
@@ -245,185 +256,12 @@ ynh_handle_getopts_args () {
 
 #=================================================
 
-# Start or restart a service and follow its booting
-#
-# usage: ynh_check_starting "Line to match" [Log file] [Timeout] [Service name]
-#
-# | arg: -m, --line_to_match= - Line to match - The line to find in the log to attest the service have finished to boot.
-# | arg: -l, --app_log= - Log file - The log file to watch; specify "systemd" to read systemd journal for specified service
-#    /var/log/$app/$app.log will be used if no other log is defined.
-# | arg: -t, --timeout= - Timeout - The maximum time to wait before ending the watching. Defaut 300 seconds.
-# | arg: -n, --service_name= - Service name
-
-ynh_check_starting () {
-	# Declare an array to define the options of this helper.
-	declare -Ar args_array=( [m]=line_to_match= [l]=app_log= [t]=timeout= [n]=service_name= )
-	local line_to_match
-	local app_log
-	local timeout
-	local service_name
-	# Manage arguments with getopts
-	ynh_handle_getopts_args "$@"
-	local app_log="${app_log:-/var/log/$service_name/$service_name.log}"
-	local timeout=${timeout:-300}
-	local service_name="${service_name:-$app}"
-
-	echo "Starting of $service_name" >&2
-	systemctl stop $service_name
-	local templog="$(mktemp)"
-	# Following the starting of the app in its log
-	if [ "$app_log" == "systemd" ] ; then
-		# Read the systemd journal
-		journalctl -u $service_name -f --since=-45 > "$templog" &
-	else
-		# Read the specified log file
-		tail -F -n0 "$app_log" > "$templog" &
-	fi
-	# Get the PID of the last command
-	local pid_tail=$!
-	systemctl start $service_name
-
-	local i=0
-	for i in `seq 1 $timeout`
-	do
-		# Read the log until the sentence is found, which means the app finished starting. Or run until the timeout.
-		if grep --quiet "$line_to_match" "$templog"
-		then
-			echo "The service $service_name has correctly started." >&2
-			break
-		fi
-		echo -n "." >&2
-		sleep 1
-	done
-	if [ $i -eq $timeout ]
-	then
-		echo "The service $service_name didn't fully start before the timeout." >&2
-	fi
-
-	echo ""
-	ynh_clean_check_starting
-}
-
-# Clean temporary process and file used by ynh_check_starting
-# (usually used in ynh_clean_setup scripts)
-#
-# usage: ynh_clean_check_starting
-ynh_clean_check_starting () {
-	# Stop the execution of tail.
-	kill -s 15 $pid_tail 2>&1
-	ynh_secure_remove "$templog" 2>&1
-}
-
-#=================================================
-
-ynh_print_log () {
-  echo "${1}"
-}
-
-# Print an info on stdout
-#
-# usage: ynh_print_info "Text to print"
-# | arg: text - The text to print
-ynh_print_info () {
-  ynh_print_log "[INFO] ${1}"
-}
-
-# Print a warning on stderr
-#
-# usage: ynh_print_warn "Text to print"
-# | arg: text - The text to print
-ynh_print_warn () {
-  ynh_print_log "[WARN] ${1}" >&2
-}
-
-# Print a error on stderr
-#
-# usage: ynh_print_err "Text to print"
-# | arg: text - The text to print
-ynh_print_err () {
-  ynh_print_log "[ERR] ${1}" >&2
-}
-
-# Execute a command and print the result as an error
-#
-# usage: ynh_exec_err command to execute
-# usage: ynh_exec_err "command to execute | following command"
-# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe.
-#
-# | arg: command - command to execute
-ynh_exec_err () {
-	ynh_print_err "$(eval $@)"
-}
-
-# Execute a command and print the result as a warning
-#
-# usage: ynh_exec_warn command to execute
-# usage: ynh_exec_warn "command to execute | following command"
-# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe.
-#
-# | arg: command - command to execute
-ynh_exec_warn () {
-	ynh_print_warn "$(eval $@)"
-}
-
-# Execute a command and force the result to be printed on stdout
-#
-# usage: ynh_exec_warn_less command to execute
-# usage: ynh_exec_warn_less "command to execute | following command"
-# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe.
-#
-# | arg: command - command to execute
-ynh_exec_warn_less () {
-	eval $@ 2>&1
-}
-
-# Execute a command and redirect stdout in /dev/null
-#
-# usage: ynh_exec_quiet command to execute
-# usage: ynh_exec_quiet "command to execute | following command"
-# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe.
-#
-# | arg: command - command to execute
-ynh_exec_quiet () {
-	eval $@ > /dev/null
-}
-
-# Execute a command and redirect stdout and stderr in /dev/null
-#
-# usage: ynh_exec_fully_quiet command to execute
-# usage: ynh_exec_fully_quiet "command to execute | following command"
-# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe.
-#
-# | arg: command - command to execute
-ynh_exec_fully_quiet () {
-	eval $@ > /dev/null 2>&1
-}
-
-# Remove any logs for all the following commands.
-#
-# usage: ynh_print_OFF
-# WARNING: You should be careful with this helper, and never forgot to use ynh_print_ON as soon as possible to restore the logging.
-ynh_print_OFF () {
-	set +x
-}
-
-# Restore the logging after ynh_print_OFF
-#
-# usage: ynh_print_ON
-ynh_print_ON () {
-	set -x
-	# Print an echo only for the log, to be able to know that ynh_print_ON has been called.
-	echo ynh_print_ON > /dev/null
-}
-
-#=================================================
-
 # Install or update the main directory yunohost.multimedia
 #
 # usage: ynh_multimedia_build_main_dir
 ynh_multimedia_build_main_dir () {
-        local ynh_media_release="v1.0"
+	local ynh_media_release="v1.2"
-        local checksum="4852c8607db820ad51f348da0dcf0c88"
+	local checksum="806a827ba1902d6911095602a9221181"
 
 	# Download yunohost.multimedia scripts
 	wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz
@@ -432,6 +270,10 @@ ynh_multimedia_build_main_dir () {
 	echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \
 		|| ynh_die "Corrupt source"
 
+	# Check if the package acl is installed. Or install it.
+	ynh_package_is_installed 'acl' \
+		|| ynh_package_install acl
+
 	# Extract
 	mkdir yunohost.multimedia-master
 	tar -xf ${ynh_media_release}.tar.gz -C yunohost.multimedia-master --strip-components 1
@@ -496,16 +338,21 @@ ynh_multimedia_addaccess () {
 # Create a dedicated fail2ban config (jail and filter conf files)
 #
 # usage: ynh_add_fail2ban_config log_file filter [max_retry [ports]]
-# | arg: log_file - Log file to be checked by fail2ban
+# | arg: -l, --logpath= - Log file to be checked by fail2ban
-# | arg: failregex - Failregex to be looked for by fail2ban
+# | arg: -r, --failregex= - Failregex to be looked for by fail2ban
-# | arg: max_retry - Maximum number of retries allowed before banning IP address - default: 3
+# | arg: -m, --max_retry= - Maximum number of retries allowed before banning IP address - default: 3
-# | arg: ports - Ports blocked for a banned IP address - default: http,https
+# | arg: -p, --ports= - Ports blocked for a banned IP address - default: http,https
 ynh_add_fail2ban_config () {
-   # Process parameters
+	# Declare an array to define the options of this helper.
-   logpath=$1
+	declare -Ar args_array=( [l]=logpath= [r]=failregex= [m]=max_retry= [p]=ports= )
-   failregex=$2
+	local logpath
-   max_retry=${3:-3}
+	local failregex
-   ports=${4:-http,https}
+	local max_retry
+	local ports
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	max_retry=${max_retry:-3}
+	ports=${ports:-http,https}
 
 	test -n "$logpath" || ynh_die "ynh_add_fail2ban_config expects a logfile path as first argument and received nothing."
 	test -n "$failregex" || ynh_die "ynh_add_fail2ban_config expects a failure regex as second argument and received nothing."
@@ -515,7 +362,7 @@ ynh_add_fail2ban_config () {
 	ynh_backup_if_checksum_is_different "$finalfail2banjailconf" 1
 	ynh_backup_if_checksum_is_different "$finalfail2banfilterconf" 1
 
-  sudo tee $finalfail2banjailconf <<EOF
+	tee $finalfail2banjailconf <<EOF
 [$app]
 enabled = true
 port = $ports
@@ -524,7 +371,7 @@ logpath = $logpath
 maxretry = $max_retry
 EOF
 
-  sudo tee $finalfail2banfilterconf <<EOF
+  tee $finalfail2banfilterconf <<EOF
 [INCLUDES]
 before = common.conf
 [Definition]
@@ -535,7 +382,11 @@ EOF
 	ynh_store_file_checksum "$finalfail2banjailconf"
 	ynh_store_file_checksum "$finalfail2banfilterconf"
 
+	if [ "$(lsb_release --codename --short)" != "jessie" ]; then
+		systemctl reload fail2ban
+	else
 		systemctl restart fail2ban
+	fi
 	local fail2ban_error="$(journalctl -u fail2ban | tail -n50 | grep "WARNING.*$app.*")"
 	if [ -n "$fail2ban_error" ]
 	then
@@ -550,7 +401,11 @@ EOF
 ynh_remove_fail2ban_config () {
 	ynh_secure_remove "/etc/fail2ban/jail.d/$app.conf"
 	ynh_secure_remove "/etc/fail2ban/filter.d/$app.conf"
+	if [ "$(lsb_release --codename --short)" != "jessie" ]; then
+		systemctl reload fail2ban
+	else
 		systemctl restart fail2ban
+	fi
 }
 
 #=================================================
@@ -558,12 +413,17 @@ ynh_remove_fail2ban_config () {
 # Read the value of a key in a ynh manifest file
 #
 # usage: ynh_read_manifest manifest key
-# | arg: manifest - Path of the manifest to read
+# | arg: -m, --manifest= - Path of the manifest to read
-# | arg: key - Name of the key to find
+# | arg: -k, --key= - Name of the key to find
 ynh_read_manifest () {
-	manifest="$1"
+	# Declare an array to define the options of this helper.
-	key="$2"
+	declare -Ar args_array=( [m]=manifest= [k]=manifest_key= )
-	python3 -c "import sys, json;print(json.load(open('$manifest', encoding='utf-8'))['$key'])"
+	local manifest
+	local manifest_key
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	python3 -c "import sys, json;print(json.load(open('$manifest', encoding='utf-8'))['$manifest_key'])"
 }
 
 # Read the upstream version from the manifest
@@ -572,30 +432,41 @@ ynh_read_manifest () {
 # This include the number before ~ynh
 # In the last example it return 4.3-2
 #
-# usage: ynh_app_upstream_version
+# usage: ynh_app_upstream_version [-m manifest]
+# | arg: -m, --manifest= - Path of the manifest to read
 ynh_app_upstream_version () {
-    manifest_path="../manifest.json"
+	declare -Ar args_array=( [m]=manifest= )
-    if [ ! -e "$manifest_path" ]; then
+	local manifest
-        manifest_path="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	manifest="${manifest:-../manifest.json}"
+	if [ ! -e "$manifest" ]; then
+		manifest="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
 	fi
-    version_key=$(ynh_read_manifest "$manifest_path" "version")
+	version_key=$(ynh_read_manifest --manifest="$manifest" --manifest_key="version")
 	echo "${version_key/~ynh*/}"
 }
 
-
 # Read package version from the manifest
 # The version number in the manifest is defined by <upstreamversion>~ynh<packageversion>
 # For example : 4.3-2~ynh3
 # This include the number after ~ynh
 # In the last example it return 3
 #
-# usage: ynh_app_package_version
+# usage: ynh_app_package_version [-m manifest]
+# | arg: -m, --manifest= - Path of the manifest to read
 ynh_app_package_version () {
-    manifest_path="../manifest.json"
+	declare -Ar args_array=( [m]=manifest= )
-    if [ ! -e "$manifest_path" ]; then
+	local manifest
-        manifest_path="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	manifest="${manifest:-../manifest.json}"
+	if [ ! -e "$manifest" ]; then
+		manifest="../settings/manifest.json"	# Into the restore script, the manifest is not at the same place
 	fi
-    version_key=$(ynh_read_manifest "$manifest_path" "version")
+	version_key=$(ynh_read_manifest --manifest="$manifest" --manifest_key="version")
 	echo "${version_key/*~ynh/}"
 }
 
@@ -611,7 +482,7 @@ ynh_app_package_version () {
 # To force an upgrade, even if the package is up to date,
 # you have to set the variable YNH_FORCE_UPGRADE before.
 # example: sudo YNH_FORCE_UPGRADE=1 yunohost app upgrade MyApp
-
+#
 # usage: ynh_check_app_version_changed
 ynh_check_app_version_changed () {
 	local force_upgrade=${YNH_FORCE_UPGRADE:-0}
@@ -620,10 +491,10 @@ ynh_check_app_version_changed () {
 	# By default, upstream app version has changed
 	local return_value="UPGRADE_APP"
 
-  local current_version=$(ynh_read_manifest "/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json" "version" || echo 1.0)
+	local current_version=$(ynh_read_manifest --manifest="/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json" --manifest_key="version" || echo 1.0)
-  local current_upstream_version="${current_version/~ynh*/}"
+	local current_upstream_version="$(ynh_app_upstream_version --manifest="/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json")"
-  local update_version=$(ynh_read_manifest "../manifest.json" "version" || echo 1.0)
+	local update_version=$(ynh_read_manifest --manifest="../manifest.json" --manifest_key="version" || echo 1.0)
-  local update_upstream_version="${update_version/~ynh*/}"
+	local update_upstream_version="$(ynh_app_upstream_version)"
 
 	if [ "$current_version" == "$update_version" ] ; then
 		# Complete versions are the same
@@ -646,23 +517,138 @@ ynh_check_app_version_changed () {
 
 #=================================================
 
+# Delete a file checksum from the app settings
+#
+# $app should be defined when calling this helper
+#
+# usage: ynh_remove_file_checksum file
+# | arg: -f, --file= - The file for which the checksum will be deleted
+ynh_delete_file_checksum () {
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [f]=file= )
+	local file
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	local checksum_setting_name=checksum_${file//[\/ ]/_}	# Replace all '/' and ' ' by '_'
+	ynh_app_setting_delete $app $checksum_setting_name
+}
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+# Start (or other actions) a service,  print a log in case of failure and optionnaly wait until the service is completely started
+#
+# usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
+# | arg: -n, --service_name= - Name of the service to reload. Default : $app
+# | arg: -a, --action=       - Action to perform with systemctl. Default: start
+# | arg: -l, --line_match=   - Line to match - The line to find in the log to attest the service have finished to boot.
+#                              If not defined it don't wait until the service is completely started.
+# | arg: -p, --log_path=     - Log file - Path to the log file. Default : /var/log/$app/$app.log
+# | arg: -t, --timeout=      - Timeout - The maximum time to wait before ending the watching. Default : 300 seconds.
+# | arg: -e, --length=       - Length of the error log : Default : 20
+ynh_systemd_action() {
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [n]=service_name= [a]=action= [l]=line_match= [p]=log_path= [t]=timeout= [e]=length= )
+	local service_name
+	local action
+	local line_match
+	local length
+	local log_path
+	local timeout
+
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	local service_name="${service_name:-$app}"
+	local action=${action:-start}
+	local log_path="${log_path:-/var/log/$service_name/$service_name.log}"
+	local length=${length:-20}
+	local timeout=${timeout:-300}
+
+	# Start to read the log
+	if [[ -n "${line_match:-}" ]]
+	then
+		local templog="$(mktemp)"
+	# Following the starting of the app in its log
+	if [ "$log_path" == "systemd" ] ; then
+		# Read the systemd journal
+		journalctl -u $service_name -f --since=-45 > "$templog" &
+	else
+		# Read the specified log file
+		tail -F -n0 "$log_path" > "$templog" &
+	fi
+		# Get the PID of the tail command
+		local pid_tail=$!
+	fi
+
+	echo "${action^} the service $service_name" >&2
+	systemctl $action $service_name \
+		|| ( journalctl --lines=$length -u $service_name >&2 \
+		; test -n "$log_path" && echo "--" && tail --lines=$length "$log_path" >&2 \
+		; false )
+
+	# Start the timeout and try to find line_match
+	if [[ -n "${line_match:-}" ]]
+	then
+		local i=0
+		for i in $(seq 1 $timeout)
+		do
+			# Read the log until the sentence is found, that means the app finished to start. Or run until the timeout
+			if grep --quiet "$line_match" "$templog"
+			then
+				echo "The service $service_name has correctly started." >&2
+				break
+			fi
+			echo -n "." >&2
+			sleep 1
+		done
+		if [ $i -eq $timeout ]
+		then
+			echo "The service $service_name didn't fully started before the timeout." >&2
+			echo "Please find here an extract of the end of the log of the service $service_name:"
+			journalctl --lines=$length -u $service_name >&2
+			test -n "$log_path" && echo "--" && tail --lines=$length "$log_path" >&2
+		fi
+
+		echo ""
+		ynh_clean_check_starting
+	fi
+}
+
+# Clean temporary process and file used by ynh_check_starting
+# (usually used in ynh_clean_setup scripts)
+#
+# usage: ynh_clean_check_starting
+ynh_clean_check_starting () {
+	# Stop the execution of tail.
+	kill -s 15 $pid_tail 2>&1
+	ynh_secure_remove "$templog" 2>&1
+}
+
+#=================================================
+
 # Send an email to inform the administrator
 #
-# usage: ynh_send_readme_to_admin app_message [recipients]
+# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
 # | arg: -m --app_message= - The message to send to the administrator.
 # | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
 #	example: "root admin@domain"
 #	If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
 #	example: "root admin@domain user1 user2"
+# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
 ynh_send_readme_to_admin() {
 	# Declare an array to define the options of this helper.
-	declare -Ar args_array=( [m]=app_message= [r]=recipients= )
+	declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
 	local app_message
 	local recipients
+	local type
 	# Manage arguments with getopts
 	ynh_handle_getopts_args "$@"
-	local app_message="${app_message:-...No specific information...}"
+	app_message="${app_message:-...No specific information...}"
-	local recipients="${recipients:-root}"
+	recipients="${recipients:-root}"
+	type="${type:-install}"
 
 	# Retrieve the email of users
 	find_mails () {
@@ -688,7 +674,23 @@ ynh_send_readme_to_admin() {
 	}
 	recipients=$(find_mails "$recipients")
 
-	local mail_subject="☁️🆈🅽🅷☁️: \`$app\` was just installed!"
+	# Subject base
+	local mail_subject="☁️🆈🅽🅷☁️: \`$app\`"
+
+	# Adapt the subject according to the type of mail required.
+	if [ "$type" = "backup" ]; then
+		mail_subject="$mail_subject has just been backup."
+	elif [ "$type" = "change_url" ]; then
+		mail_subject="$mail_subject has just been moved to a new URL!"
+	elif [ "$type" = "remove" ]; then
+		mail_subject="$mail_subject has just been removed!"
+	elif [ "$type" = "restore" ]; then
+		mail_subject="$mail_subject has just been restored!"
+	elif [ "$type" = "upgrade" ]; then
+		mail_subject="$mail_subject has just been upgraded!"
+	else	# install
+		mail_subject="$mail_subject has just been installed!"
+	fi
 
 	local mail_message="This is an automated message from your beloved YunoHost server.
 
@@ -715,26 +717,6 @@ $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
 
 #=================================================
 
-# Reload (or other actions) a service and print a log in case of failure.
-#
-# usage: ynh_system_reload service_name [action]
-# | arg: -n, --service_name= - Name of the service to reload
-# | arg: -a, --action= - Action to perform with systemctl. Default: reload
-ynh_system_reload () {
-        # Declare an array to define the options of this helper.
-        declare -Ar args_array=( [n]=service_name= [a]=action= )
-        local service_name
-        local action
-        # Manage arguments with getopts
-        ynh_handle_getopts_args "$@"
-        local action=${action:-reload}
-
-        # Reload, restart or start and print the log if the service fail to start or reload
-        systemctl $action $service_name || ( journalctl --lines=20 -u $service_name >&2 && false)
-}
-
-#=================================================
-
 ynh_debian_release () {
 	lsb_release --codename --short
 }
@@ -759,19 +741,6 @@ is_jessie () {
 
 #=================================================
 
-# Delete a file checksum from the app settings
-#
-# $app should be defined when calling this helper
-#
-# usage: ynh_remove_file_checksum file
-# | arg: file - The file for which the checksum will be deleted
-ynh_delete_file_checksum () {
-	local checksum_setting_name=checksum_${1//[\/ ]/_}	# Replace all '/' and ' ' by '_'
-	ynh_app_setting_delete $app $checksum_setting_name
-}
-
-#=================================================
-
 ynh_maintenance_mode_ON () {
 	# Load value of $path_url and $domain from the config if their not set
 	if [ -z $path_url ]; then
@@ -848,3 +817,69 @@ ynh_maintenance_mode_OFF () {
 
 	systemctl reload nginx
 }
+
+#=================================================
+
+# Download and check integrity of a file from app.src_file
+#
+# The file conf/app.src_file need to contains:
+#
+# FILE_URL=Address to download the file
+# FILE_SUM=Control sum
+# # (Optional) Program to check the integrity (sha256sum, md5sum...)
+# # default: sha256
+# FILE_SUM_PRG=sha256
+# # (Optionnal) Name of the local archive (offline setup support)
+# # default: Name of the downloaded file.
+# FILENAME=example.deb
+#
+# usage: ynh_download_file --dest_dir="/destination/directory" [--source_id=myfile]
+# | arg: -d, --dest_dir=  - Directory where to download the file
+# | arg: -s, --source_id= - Name of the source file 'app.src_file' if it isn't '$app'
+ynh_download_file () {
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [d]=dest_dir= [s]=source_id= )
+	local dest_dir
+	local source_id
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	source_id=${source_id:-app} # If the argument is not given, source_id equals "$app"
+
+	# Load value from configuration file (see above for a small doc about this file
+	# format)
+	local src_file="$YNH_CWD/../conf/${source_id}.src_file"
+	# If the src_file doesn't exist, use the backup path instead, with a "settings" directory
+	if [ ! -e "$src_file" ]
+	then
+		src_file="$YNH_CWD/../settings/conf/${source_id}.src_file"
+	fi
+	local file_url=$(grep 'FILE_URL=' "$src_file" | cut -d= -f2-)
+	local file_sum=$(grep 'FILE_SUM=' "$src_file" | cut -d= -f2-)
+	local file_sumprg=$(grep 'FILE_SUM_PRG=' "$src_file" | cut -d= -f2-)
+	local filename=$(grep 'FILENAME=' "$src_file" | cut -d= -f2-)
+
+	# Default value
+	file_sumprg=${file_sumprg:-sha256sum}
+	if [ "$filename" = "" ] ; then
+		filename="$(basename "$file_url")"
+	fi
+	local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${filename}"
+
+	if test -e "$local_src"
+	then    # Use the local source file if it is present
+		cp $local_src $filename
+	else    # If not, download the source
+		local out=`wget -nv -O $filename $file_url 2>&1` || ynh_print_err $out
+	fi
+
+	# Check the control sum
+	echo "${file_sum} ${filename}" | ${file_sumprg} -c --status \
+		|| ynh_die "Corrupt file"
+
+	# Create the destination directory, if it's not already.
+	mkdir -p "$dest_dir"
+
+	# Move the file to its destination
+	mv $filename $dest_dir
+}

scripts/_variables

@@ -2,6 +2,3 @@
 
 # Dependencies
 app_depencencies="default-jre-headless daemon net-tools"
-
-# Jenkins version
-jenkins_version=2.121.1

scripts/actions/public_private

@@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
+source scripts/_common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -41,7 +42,8 @@ fi
 if [ $is_public -eq 0 ]
 then
 	ynh_app_setting_delete $app unprotected_uris
-	ynh_app_setting_set $app skipped_uris "/github-webhook"	# /path/github-webhook doit rester accessible pour les webhooks de github.
+	# /path/github-webhook has to be accessible for github's webhooks
+	ynh_app_setting_set $app skipped_uris "/github-webhook" pour les webhooks de github.
 else
 	ynh_app_setting_delete $app skipped_uris
 	ynh_app_setting_set $app unprotected_uris "/"
@@ -57,4 +59,4 @@ ynh_app_setting_set $app is_public $is_public
 # RELOAD NGINX
 #=================================================
 
-systemctl reload nginx
+ynh_systemd_action --action=reload --service_name=nginx

scripts/backup

@@ -31,17 +31,17 @@ domain=$(ynh_app_setting_get $app domain)
 #=================================================
 # STANDARD BACKUP STEPS
 #=================================================
-# BACKUP OF THE MAIN DIR OF THE APP
+# BACKUP THE APP MAIN DIR
 #=================================================
 
-ynh_system_reload --service_name=jenkins --action=stop
+ynh_systemd_action --action=stop --service_name=jenkins
 sleep 1
 
 CHECK_SIZE "$final_path"
 ynh_backup "$final_path"
 
 #=================================================
-# BACKUP OF THE NGINX CONFIGURATION
+# BACKUP THE NGINX CONFIGURATION
 #=================================================
 
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
@@ -49,7 +49,7 @@ ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # SPECIFIC BACKUP
 #=================================================
-# BACKUP OF THE JENKINS' BOOT CONFIG
+# BACKUP THE JENKINS' BOOT CONFIG
 #=================================================
 
 ynh_backup /etc/default/$app
@@ -58,5 +58,5 @@ ynh_backup /etc/default/$app
 # CHECK JENKINS STARTING
 #=================================================
 
-# Wait for Jenkins fully started
+# Wait for Jenkins to be fully started
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="300"
+ynh_systemd_action --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="300"

scripts/change_url

@@ -114,7 +114,7 @@ fi
 
 if [ $change_path -eq 1 ]
 then
-	# Ajoute le path en cas d'installation en sous-dossier dans les options de démarrage de Jenkins
+	# Add the path, in case of sub-path installation, into jenkins' boot options
 
 	# Change to root
 	if [ "$new_path" == "/" ]
@@ -135,14 +135,14 @@ fi
 # RESTART JENKINS IN BACKGROUND
 #=================================================
 
-# Wait for Jenkins fully started
+# Wait for Jenkins to be fully started
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="300"
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="300"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
 
-ynh_system_reload --service_name=nginx
+ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # DEACTIVE MAINTENANCE MODE

scripts/install

@@ -16,14 +16,16 @@ source _variables
 #=================================================
 
 ynh_clean_setup () {
-# Nettoyage des résidus d'installation non pris en charge par le script remove.
+	# Clean installation remaining that are not handle by the remove script.
 	ynh_clean_check_starting
-	ynh_exec_warn_less kill -s 15 $pid_change_port	# Arrête l'exécution de change_port
+	# Stop change_port()
+	ynh_exec_warn_less kill -s 15 $pid_change_port
 
 	# Clean hosts
 	sed -i '/#jenkins/d' /etc/hosts
 }
-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
 
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
@@ -45,8 +47,6 @@ test ! -e "$final_path" || ynh_die "This path already contains a folder"
 # Normalize the url path syntax
 path_url=$(ynh_normalize_url_path $path_url)
 
-# Check web path availability
-ynh_webpath_available $domain $path_url
 # Register (book) web path
 ynh_webpath_register $app $domain $path_url
 
@@ -66,7 +66,8 @@ ynh_app_setting_set $app overwrite_nginx "1"
 # FIND AND OPEN A PORT
 #=================================================
 
-port=$(ynh_find_port 8080)	# Cherche un port libre.
+# Find a free port
+port=$(ynh_find_port 8080)
 ynh_app_setting_set $app port $port
 
 #=================================================
@@ -79,6 +80,7 @@ ynh_install_app_dependencies $app_depencencies
 # NGINX CONFIGURATION
 #=================================================
 
+# Create a dedicated nginx config
 ynh_add_nginx_config
 
 #=================================================
@@ -89,9 +91,15 @@ ynh_add_nginx_config
 
 change_port() {
 	# Wait for the creation of the jenkins service file
-	while [ ! -e /etc/default/jenkins ]
+	timeout=600
+	for j in `seq 1 $timeout`
 	do
+		# Wait for an update of plugin repositories
+		if test -e /etc/default/jenkins; then
+			break;
+		else
 			sleep 0.5
+		fi
 	done
 	# And modify the port as soon as possible, to prevent a crach of jenkins if the default port is already used.
 	ynh_replace_string "^HTTP_PORT=.*" "HTTP_PORT=$port" /etc/default/jenkins
@@ -103,18 +111,20 @@ pid_change_port=$!
 # INSTALL JENKINS
 #=================================================
 
-wget --no-verbose https://pkg.jenkins.io/debian-stable/binary/jenkins_${jenkins_version}_all.deb
+# Download jenkins deb file and install it.
-dpkg --install jenkins_${jenkins_version}_all.deb
+ynh_download_file --dest_dir="../conf"
+dpkg --install --force-confnew ../conf/jenkins.deb
 
 #=================================================
 # SETUP JENKINS
 #=================================================
 
-# Ignore le Setup Wizard
+# Ignore Setup Wizard
 ynh_replace_string "-Djava.awt.headless=true" "& -Djenkins.install.runSetupWizard=false" /etc/default/jenkins
 
 if [ "$path_url" != "/" ];
-then	# Ajoute le path en cas d'installation en sous-dossier dans les options de démarrage de Jenkins
+then
+	# Add the path, in case of sub-path installation, into jenkins' boot options
 	sed -i "$ s@--httpPort=\$HTTP_PORT@& --prefix=$path_url@g" /etc/default/jenkins
 fi
 
@@ -122,14 +132,14 @@ fi
 # FORCE PUBLIC ACCESS
 #=================================================
 
-# Jenkins est public par défaut, au moins pour le téléchargement de jenkins-cli.jar
+# Jenkins has to be public, at least for jenkins-cli.jar
 ynh_app_setting_set $app unprotected_uris "/"
 
-ynh_system_reload --service_name=nginx
+ynh_systemd_action --action=reload --service_name=nginx
 yunohost app ssowatconf
 
 #=================================================
-# ENABLE SERVICE IN ADMIN PANEL
+# ADVERTISE SERVICE IN ADMIN PANEL
 #=================================================
 
 yunohost service add $app --log /var/log/$app/$app.log
@@ -140,18 +150,24 @@ yunohost service add $app --log /var/log/$app/$app.log
 
 config_OK=0
 timeout=3600
-echo "127.0.0.1 $domain #jenkins" | tee -a /etc/hosts	# Renseigne le domain dans le host, pour prévenir d'un dns pas encore propagé.
+# Add the domain to /etc/hosts, to prevent any dns delay
+echo "127.0.0.1 $domain #jenkins" | tee -a /etc/hosts
 
-jenkins_cli="java -jar /var/lib/jenkins/jenkins-cli.jar -remoting -s http://$domain$path_url"
+# Wait for Jenkins to be fully started
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="$timeout"
 
-# Wait for Jenkins fully started
+# Enable Jenkins CLI Protocol/2 for jenkins-cli
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="$timeout"
+# That the only protocol that allow connection without an authenticated user...
+ynh_replace_string "<slaveAgentPort>0</slaveAgentPort>" "&\n<enabledAgentProtocols><string>CLI2-connect</string></enabledAgentProtocols>" /var/lib/jenkins/config.xml
 
+# Wait for Jenkins to be fully started
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="$timeout"
 
-# Si le log annonce une première fois le démarrage de jenkins. Installe les plugins
+# If the log says that jenkins has started, install the plugins
 wget -nv --no-check-certificate https://$domain$path_url/jnlpJars/jenkins-cli.jar -O /var/lib/jenkins/jenkins-cli.jar
 for i in `seq 1 $timeout`
-do	# La boucle attend la mise à jour des dépôts de plugins.
+do
+	# Wait for an update of plugin repositories
 	if test -e /var/lib/jenkins/updates/default.json; then
 		break;
 	else
@@ -160,10 +176,12 @@ do	# La boucle attend la mise à jour des dépôts de plugins.
 	fi
 done
 
-# Installation du plugin pour l'authentification ldap et http auth
+jenkins_cli="ynh_exec_warn_less java -jar /var/lib/jenkins/jenkins-cli.jar -remoting -s http://$domain$path_url"
+
+# Install plugins for http authentication and ldap.
 $jenkins_cli install-plugin reverse-proxy-auth-plugin
 
-# Installation des plugins recommandés (Lors de l'install avec le Setup Wizard)
+# Install recommended plugins (those from Setup Wizard)
 $jenkins_cli install-plugin cloudbees-folder	# Folders Plugin
 $jenkins_cli install-plugin antisamy-markup-formatter	# OWASP Markup Formatter Plugin
 $jenkins_cli install-plugin pam-auth	# PAM Authentication plugin
@@ -184,26 +202,29 @@ $jenkins_cli install-plugin subversion	# Subversion Plug-in
 $jenkins_cli install-plugin email-ext	# Email Extension Plugin
 $jenkins_cli install-plugin ssh-slaves	# SSH Slaves plugin
 
-# Installation de plugins supplémentaires pour le confort
+# Install extra comfort plugins
-$jenkins_cli install-plugin ansicolor	# Prise en charge des couleurs pour la sortie console. Améliore la lisibilité de la console (par contre les couleurs ne passent pas...)
+# Handle terminal colours. Enhance the readability of the terminal.
-$jenkins_cli install-plugin fstrigger # Monitoring sur le système de fichier local. Pour surveiller des dossiers de code et builder sur les changements.
+$jenkins_cli install-plugin ansicolor
+# MOnitoring of the local file system. Allow to monitor a directory and trig a job if a file has been modified.
+$jenkins_cli install-plugin fstrigger
 
-# Configure la sécurité globale avec ldap par défaut.
+# Set global security with ldap
 cp ../conf/config.xml /var/lib/jenkins/
 chown jenkins: /var/lib/jenkins/config.xml
 
-# Wait for Jenkins fully started
+# Wait for Jenkins to be fully started
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="$timeout"
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="$timeout"
 
 #=================================================
 # SETUP SSOWAT
 #=================================================
 
-# Si Jenkins est privé, retire l'autorisation publique.
 if [ $is_public -eq 0 ]
-then	# Retire l'accès public
+then
+	# Remove the public access
 	ynh_app_setting_delete $app unprotected_uris
-	ynh_app_setting_set $app skipped_uris "/github-webhook"	# /path/github-webhook doit rester accessible pour les webhooks de github.
+	# /path/github-webhook has to be accessible for github's webhooks
+	ynh_app_setting_set $app skipped_uris "/github-webhook"
 fi
 
 #=================================================
@@ -216,6 +237,12 @@ sed -i '/#jenkins/d' /etc/hosts
 # SEND A README FOR THE ADMIN
 #=================================================
 
-message="If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/jenkins_ynh"
+# Get main domain and buid the url of the admin panel of the app.
+admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="root"
+message="You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
+You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+
+If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/jenkins_ynh"
+
+ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="install"

scripts/remove

@@ -20,10 +20,11 @@ domain=$(ynh_app_setting_get $app domain)
 #=================================================
 # STANDARD REMOVE
 #=================================================
-# DISABLE SERVICE IN ADMIN PANEL
+# REMOVE SERVICE FROM ADMIN PANEL
 #=================================================
 
-if yunohost service status | grep -q $app	# Test l'existence du service dans Yunohost
+# Check if the service is declared in YunoHost
+if yunohost service status | grep -q $app
 then
 	ynh_print_info "Remove $app service" >&2
 	yunohost service remove $app
@@ -34,6 +35,7 @@ fi
 #=================================================
 
 ynh_apt purge jenkins
+# Remove metapackage and its dependencies
 ynh_remove_app_dependencies
 ynh_secure_remove "/var/lib/jenkins"
 
@@ -41,4 +43,5 @@ ynh_secure_remove "/var/lib/jenkins"
 # REMOVE THE NGINX CONFIGURATION
 #=================================================
 
-ynh_remove_nginx_config	# Suppression de la configuration nginx résidus.
+# Remove the dedicated nginx config
+ynh_remove_nginx_config

scripts/restore

@@ -16,8 +16,10 @@ source ../settings/scripts/_variables
 #=================================================
 
 ynh_clean_setup () {
-# Nettoyage des résidus d'installation non pris en charge par le script remove.
+	# Clean installation remaining that are not handle by the remove script.
 	ynh_clean_check_starting
+	# Stop change_port()
+	ynh_exec_warn_less kill -s 15 $pid_change_port
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@@ -51,13 +53,13 @@ ynh_maintenance_mode_ON
 #=================================================
 # STANDARD RESTORE STEPS
 #=================================================
-# RESTORE OF THE NGINX CONFIGURATION
+# RESTORE THE NGINX CONFIGURATION
 #=================================================
 
 ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 
-# Reload webserver
+# Reload nginx
-ynh_system_reload --service_name=nginx
+ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # SPECIFIC RESTORE
@@ -73,9 +75,15 @@ ynh_install_app_dependencies $app_depencencies
 
 change_port() {
 	# Wait for the creation of the jenkins service file
-	while [ ! -e /etc/default/jenkins ]
+	timeout=600
+	for j in `seq 1 $timeout`
 	do
+		# Wait for an update of plugin repositories
+		if test -e /etc/default/jenkins; then
+			break;
+		else
 			sleep 0.5
+		fi
 	done
 	# And modify the port as soon as possible, to prevent a crach of jenkins if the default port is already used.
 	ynh_replace_string "^HTTP_PORT=.*" "HTTP_PORT=$port" /etc/default/jenkins
@@ -87,24 +95,25 @@ pid_change_port=$!
 # INSTALL JENKINS
 #=================================================
 
-wget --no-verbose https://pkg.jenkins.io/debian-stable/binary/jenkins_${jenkins_version}_all.deb
+# Download jenkins deb file and install it.
-dpkg --install jenkins_${jenkins_version}_all.deb
+ynh_download_file --dest_dir="../conf"
+dpkg --install --force-confnew ../conf/jenkins.deb
 
 #=================================================
-# RESTORE OF THE MAIN DIR OF THE APP
+# RESTORE THE APP MAIN DIR
 #=================================================
 
 ynh_restore_file "$final_path"
 
 #=================================================
-# RESTORE OF THE JENKINS' BOOT CONFIG
+# RESTORE THE JENKINS' BOOT CONFIG
 #=================================================
 
 ynh_secure_remove "/etc/default/jenkins"
 ynh_restore_file /etc/default/$app
 
 #=================================================
-# ENABLE SERVICE IN ADMIN PANEL
+# ADVERTISE SERVICE IN ADMIN PANEL
 #=================================================
 
 yunohost service add $app --log "/var/log/$app/$app.log"
@@ -113,8 +122,8 @@ yunohost service add $app --log "/var/log/$app/$app.log"
 # CHECK JENKINS STARTING
 #=================================================
 
-# Wait for Jenkins fully started
+# Wait for Jenkins to be fully started
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="300"
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="3600"
 
 #=================================================
 # DEACTIVE MAINTENANCE MODE
@@ -126,6 +135,12 @@ ynh_maintenance_mode_OFF
 # SEND A README FOR THE ADMIN
 #=================================================
 
-message="If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/jenkins_ynh"
+# Get main domain and buid the url of the admin panel of the app.
+admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
 
-ynh_send_readme_to_admin --app_message="$message" --recipients="root"
+message="You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
+You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+
+If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/jenkins_ynh"
+
+ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="restore"

scripts/upgrade

@@ -15,7 +15,6 @@ source _variables
 # LOAD SETTINGS
 #=================================================
 
-# Récupère les infos de l'application.
 app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get $app domain)
@@ -34,8 +33,9 @@ upgrade_type=$(ynh_check_app_version_changed)
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
 
+# Fix is_public as a boolean
 if [ "$is_public" = "Yes" ]; then
-	ynh_app_setting_set $app is_public 1	# Fixe is_public en booléen
+	ynh_app_setting_set $app is_public 1
 	is_public=1
 elif [ "$is_public" = "No" ]; then
 	ynh_app_setting_set $app is_public 0
@@ -52,9 +52,10 @@ fi
 if [ -e "/etc/apt/sources.list.d/jenkins.list" ]
 then
 	ynh_secure_remove /etc/apt/sources.list.d/jenkins.list
-	# Récupère l'id de la clé APT de jenkins
+	# Get APT key id for jenkins
 	apt_key=$(apt-key list | grep -B1 "Kohsuke Kawaguchi" | grep pub | cut -d'/' -f2 | cut -d' ' -f1)
-	apt-key del $apt_key	# Supprime la clé APT
+	# Delete the APT key
+	apt-key del $apt_key
 	apt-get update
 fi
 
@@ -84,15 +85,17 @@ ynh_maintenance_mode_ON
 
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
-	wget --no-verbose https://pkg.jenkins.io/debian-stable/binary/jenkins_${jenkins_version}_all.deb
+	# Download jenkins deb file and install it.
-	dpkg --install --force-confold jenkins_${jenkins_version}_all.deb
+	ynh_download_file --dest_dir="../conf"
+	dpkg --install --force-confnew ../conf/jenkins.deb
 
 	#=================================================
 	# FIX JENKINS SETUP
 	#=================================================
 
 	if [ "$path_url" != "/" ];
-	then	# Ajoute le path en cas d'installation en sous-dossier dans les options de démarrage de Jenkins
+	then
+		# Add the path, in case of sub-path installation, into jenkins' boot options
 		if ! grep --quiet "prefix=$path_url" /etc/default/jenkins
 		then
 			sed -i "$ s@--httpPort=\$HTTP_PORT@& --prefix=$path_url@g" /etc/default/jenkins
@@ -100,6 +103,12 @@ then
 	fi
 fi
 
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+
+ynh_install_app_dependencies $app_depencencies
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -125,14 +134,14 @@ fi
 # RELOAD NGINX
 #=================================================
 
-ynh_system_reload --service_name=nginx
+ynh_systemd_action --action=reload --service_name=nginx
 
 #=================================================
 # CHECK JENKINS STARTING
 #=================================================
 
-# Wait for Jenkins fully started
+# Wait for Jenkins to be fully started
-ynh_check_starting --line_to_match="Jenkins is fully up and running" --app_log="/var/log/$app/$app.log" --timeout="300"
+ynh_systemd_action --action=restart --line_match="Jenkins is fully up and running" --log_path="/var/log/$app/$app.log" --timeout="3600"
 
 #=================================================
 # UPGRADE JENKINS-CLI.PHAR
@@ -145,3 +154,17 @@ wget -nv --no-check-certificate https://$domain$path_url/jnlpJars/jenkins-cli.ja
 #=================================================
 
 ynh_maintenance_mode_OFF
+
+#=================================================
+# SEND A README FOR THE ADMIN
+#=================================================
+
+# Get main domain and buid the url of the admin panel of the app.
+admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
+
+message="You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
+You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+
+If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/jenkins_ynh"
+
+ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="upgrade"