|
|
@@ -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=""
|
|
|
- for key in "${!args_array[@]}"
|
|
|
+ local option_flag=""
|
|
|
+ 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)
|
|
|
- # Check the last character of the value associate to the key
|
|
|
- if [ "${args_array[$key]: -1}" = "=" ]
|
|
|
+ # 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}${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.
|
|
|
- echo "! Helper used in legacy mode !"
|
|
|
+ # 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
|
|
|
- # 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//:}
|
|
|
- # Get the key from getopts_parameters, by using the key according to the position of the argument.
|
|
|
- key=${getopts_parameters:$i:1}
|
|
|
- # Use the long option, corresponding to the key, as a variable
|
|
|
+ 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[$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,197 +256,28 @@ 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 checksum="4852c8607db820ad51f348da0dcf0c88"
|
|
|
+ local ynh_media_release="v1.2"
|
|
|
+ local checksum="806a827ba1902d6911095602a9221181"
|
|
|
|
|
|
- # Download yunohost.multimedia scripts
|
|
|
- wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz
|
|
|
+ # Download yunohost.multimedia scripts
|
|
|
+ wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz
|
|
|
|
|
|
- # Check the control sum
|
|
|
- echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \
|
|
|
- || ynh_die "Corrupt source"
|
|
|
+ # Check the control sum
|
|
|
+ echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \
|
|
|
+ || ynh_die "Corrupt source"
|
|
|
|
|
|
- # Extract
|
|
|
- mkdir yunohost.multimedia-master
|
|
|
- tar -xf ${ynh_media_release}.tar.gz -C yunohost.multimedia-master --strip-components 1
|
|
|
- ./yunohost.multimedia-master/script/ynh_media_build.sh
|
|
|
+ # 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
|
|
|
+ ./yunohost.multimedia-master/script/ynh_media_build.sh
|
|
|
}
|
|
|
|
|
|
# Add a directory in yunohost.multimedia
|
|
|
@@ -496,26 +338,31 @@ 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: failregex - Failregex to be looked for by fail2ban
|
|
|
-# | arg: 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: -l, --logpath= - Log file to be checked by fail2ban
|
|
|
+# | arg: -r, --failregex= - Failregex to be looked for by fail2ban
|
|
|
+# | arg: -m, --max_retry= - Maximum number of retries allowed before banning IP address - default: 3
|
|
|
+# | arg: -p, --ports= - Ports blocked for a banned IP address - default: http,https
|
|
|
ynh_add_fail2ban_config () {
|
|
|
- # Process parameters
|
|
|
- logpath=$1
|
|
|
- failregex=$2
|
|
|
- max_retry=${3:-3}
|
|
|
- ports=${4:-http,https}
|
|
|
+ # Declare an array to define the options of this helper.
|
|
|
+ declare -Ar args_array=( [l]=logpath= [r]=failregex= [m]=max_retry= [p]=ports= )
|
|
|
+ local logpath
|
|
|
+ local failregex
|
|
|
+ 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."
|
|
|
+ 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."
|
|
|
|
|
|
- finalfail2banjailconf="/etc/fail2ban/jail.d/$app.conf"
|
|
|
- finalfail2banfilterconf="/etc/fail2ban/filter.d/$app.conf"
|
|
|
- ynh_backup_if_checksum_is_different "$finalfail2banjailconf" 1
|
|
|
- ynh_backup_if_checksum_is_different "$finalfail2banfilterconf" 1
|
|
|
+ finalfail2banjailconf="/etc/fail2ban/jail.d/$app.conf"
|
|
|
+ finalfail2banfilterconf="/etc/fail2ban/filter.d/$app.conf"
|
|
|
+ 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]
|
|
|
@@ -532,25 +379,33 @@ failregex = $failregex
|
|
|
ignoreregex =
|
|
|
EOF
|
|
|
|
|
|
- ynh_store_file_checksum "$finalfail2banjailconf"
|
|
|
- ynh_store_file_checksum "$finalfail2banfilterconf"
|
|
|
+ ynh_store_file_checksum "$finalfail2banjailconf"
|
|
|
+ ynh_store_file_checksum "$finalfail2banfilterconf"
|
|
|
|
|
|
- systemctl restart fail2ban
|
|
|
- local fail2ban_error="$(journalctl -u fail2ban | tail -n50 | grep "WARNING.*$app.*")"
|
|
|
- if [ -n "$fail2ban_error" ]
|
|
|
- then
|
|
|
- echo "[ERR] Fail2ban failed to load the jail for $app" >&2
|
|
|
- echo "WARNING${fail2ban_error#*WARNING}" >&2
|
|
|
- fi
|
|
|
+ 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
|
|
|
+ echo "[ERR] Fail2ban failed to load the jail for $app" >&2
|
|
|
+ echo "WARNING${fail2ban_error#*WARNING}" >&2
|
|
|
+ fi
|
|
|
}
|
|
|
|
|
|
# Remove the dedicated fail2ban config (jail and filter conf files)
|
|
|
#
|
|
|
# usage: ynh_remove_fail2ban_config
|
|
|
ynh_remove_fail2ban_config () {
|
|
|
- ynh_secure_remove "/etc/fail2ban/jail.d/$app.conf"
|
|
|
- ynh_secure_remove "/etc/fail2ban/filter.d/$app.conf"
|
|
|
- systemctl restart fail2ban
|
|
|
+ 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: key - Name of the key to find
|
|
|
+# | arg: -m, --manifest= - Path of the manifest to read
|
|
|
+# | arg: -k, --key= - Name of the key to find
|
|
|
ynh_read_manifest () {
|
|
|
- manifest="$1"
|
|
|
- key="$2"
|
|
|
- python3 -c "import sys, json;print(json.load(open('$manifest', encoding='utf-8'))['$key'])"
|
|
|
+ # Declare an array to define the options of this helper.
|
|
|
+ declare -Ar args_array=( [m]=manifest= [k]=manifest_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,16 +432,21 @@ 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"
|
|
|
- if [ ! -e "$manifest_path" ]; then
|
|
|
- manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place
|
|
|
- fi
|
|
|
- version_key=$(ynh_read_manifest "$manifest_path" "version")
|
|
|
- echo "${version_key/~ynh*/}"
|
|
|
-}
|
|
|
+ declare -Ar args_array=( [m]=manifest= )
|
|
|
+ local manifest
|
|
|
+ # 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="$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>
|
|
|
@@ -589,14 +454,20 @@ ynh_app_upstream_version () {
|
|
|
# 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"
|
|
|
- if [ ! -e "$manifest_path" ]; then
|
|
|
- manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place
|
|
|
- fi
|
|
|
- version_key=$(ynh_read_manifest "$manifest_path" "version")
|
|
|
- echo "${version_key/*~ynh/}"
|
|
|
+ declare -Ar args_array=( [m]=manifest= )
|
|
|
+ local manifest
|
|
|
+ # 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="$manifest" --manifest_key="version")
|
|
|
+ echo "${version_key/*~ynh/}"
|
|
|
}
|
|
|
|
|
|
# Checks the app version to upgrade with the existing app version and returns:
|
|
|
@@ -611,37 +482,148 @@ 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}
|
|
|
- local package_check=${PACKAGE_CHECK_EXEC:-0}
|
|
|
-
|
|
|
- # 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_upstream_version="${current_version/~ynh*/}"
|
|
|
- local update_version=$(ynh_read_manifest "../manifest.json" "version" || echo 1.0)
|
|
|
- local update_upstream_version="${update_version/~ynh*/}"
|
|
|
-
|
|
|
- if [ "$current_version" == "$update_version" ] ; then
|
|
|
- # Complete versions are the same
|
|
|
- if [ "$force_upgrade" != "0" ]
|
|
|
- then
|
|
|
- echo "Upgrade forced by YNH_FORCE_UPGRADE." >&2
|
|
|
- unset YNH_FORCE_UPGRADE
|
|
|
- elif [ "$package_check" != "0" ]
|
|
|
- then
|
|
|
- echo "Upgrade forced for package check." >&2
|
|
|
- else
|
|
|
- ynh_die "Up-to-date, nothing to do" 0
|
|
|
- fi
|
|
|
- elif [ "$current_upstream_version" == "$update_upstream_version" ] ; then
|
|
|
- # Upstream versions are the same, only YunoHost package versions differ
|
|
|
- return_value="UPGRADE_PACKAGE"
|
|
|
- fi
|
|
|
- echo $return_value
|
|
|
+ local force_upgrade=${YNH_FORCE_UPGRADE:-0}
|
|
|
+ local package_check=${PACKAGE_CHECK_EXEC:-0}
|
|
|
+
|
|
|
+ # By default, upstream app version has changed
|
|
|
+ local return_value="UPGRADE_APP"
|
|
|
+
|
|
|
+ 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="$(ynh_app_upstream_version --manifest="/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json")"
|
|
|
+ local update_version=$(ynh_read_manifest --manifest="../manifest.json" --manifest_key="version" || echo 1.0)
|
|
|
+ local update_upstream_version="$(ynh_app_upstream_version)"
|
|
|
+
|
|
|
+ if [ "$current_version" == "$update_version" ] ; then
|
|
|
+ # Complete versions are the same
|
|
|
+ if [ "$force_upgrade" != "0" ]
|
|
|
+ then
|
|
|
+ echo "Upgrade forced by YNH_FORCE_UPGRADE." >&2
|
|
|
+ unset YNH_FORCE_UPGRADE
|
|
|
+ elif [ "$package_check" != "0" ]
|
|
|
+ then
|
|
|
+ echo "Upgrade forced for package check." >&2
|
|
|
+ else
|
|
|
+ ynh_die "Up-to-date, nothing to do" 0
|
|
|
+ fi
|
|
|
+ elif [ "$current_upstream_version" == "$update_upstream_version" ] ; then
|
|
|
+ # Upstream versions are the same, only YunoHost package versions differ
|
|
|
+ return_value="UPGRADE_PACKAGE"
|
|
|
+ fi
|
|
|
+ echo $return_value
|
|
|
+}
|
|
|
+
|
|
|
+#=================================================
|
|
|
+
|
|
|
+# 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
|
|
|
+ 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
|
|
|
}
|
|
|
|
|
|
#=================================================
|
|
|
@@ -715,26 +697,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 +721,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 +797,63 @@ 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 file_url=$(grep 'FILE_URL=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-)
|
|
|
+ local file_sum=$(grep 'FILE_SUM=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-)
|
|
|
+ local file_sumprg=$(grep 'FILE_SUM_PRG=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-)
|
|
|
+ local filename=$(grep 'FILENAME=' "$YNH_CWD/../conf/${source_id}.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
|
|
|
+}
|
Maniack Crudelis