mirror of
https://github.com/YunoHost-Apps/keeweb_ynh.git
synced 2024-09-03 19:26:33 +02:00
Helpers cleanup to make linter happier
This commit is contained in:
Alexandre Aubin
parent
daa398e2e0
commit
4d215fd890
4 changed files with 1 additions and 618 deletions
|
|
@ -17,18 +17,6 @@
|
||||||
incorrect_path=1
|
incorrect_path=1
|
||||||
port_already_use=0
|
port_already_use=0
|
||||||
change_url=1
|
change_url=1
|
||||||
;;; Levels
|
|
||||||
Level 1=auto
|
|
||||||
Level 2=auto
|
|
||||||
Level 3=auto
|
|
||||||
# Level 4: No users management.
|
|
||||||
Level 4=na
|
|
||||||
Level 5=auto
|
|
||||||
Level 6=auto
|
|
||||||
Level 7=auto
|
|
||||||
Level 8=0
|
|
||||||
Level 9=0
|
|
||||||
Level 10=0
|
|
||||||
;;; Options
|
;;; Options
|
||||||
Email=maniackc_dev@crudelis.fr
|
Email=maniackc_dev@crudelis.fr
|
||||||
Notification=down
|
Notification=down
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
"email": "pierre@kayou.io"
|
"email": "pierre@kayou.io"
|
||||||
},
|
},
|
||||||
"requirements": {
|
"requirements": {
|
||||||
"yunohost": ">= 3.2.0"
|
"yunohost": ">= 3.8.0"
|
||||||
},
|
},
|
||||||
"multi_instance": true,
|
"multi_instance": true,
|
||||||
"services": [
|
"services": [
|
||||||
|
|
|
||||||
|
|
@ -1,423 +1,9 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BACKUP
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain
|
|
||||||
human=$(numfmt --to=iec --from-unit=1K $1)
|
|
||||||
echo $human
|
|
||||||
}
|
|
||||||
|
|
||||||
CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant
|
|
||||||
file_to_analyse=$1
|
|
||||||
backup_size=$(du --summarize "$file_to_analyse" | cut -f1)
|
|
||||||
free_space=$(df --output=avail "/home/yunohost.backup" | sed 1d)
|
|
||||||
|
|
||||||
if [ $free_space -le $backup_size ]
|
|
||||||
then
|
|
||||||
ynh_print_err "Espace insuffisant pour sauvegarder $file_to_analyse."
|
|
||||||
ynh_print_err "Espace disponible: $(HUMAN_SIZE $free_space)"
|
|
||||||
ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# PACKAGE CHECK BYPASSING...
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
IS_PACKAGE_CHECK () {
|
|
||||||
return $(env | grep -c container=lxc)
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BOOLEAN CONVERTER
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
bool_to_01 () {
|
|
||||||
local var="$1"
|
|
||||||
[ "$var" = "true" ] && var=1
|
|
||||||
[ "$var" = "false" ] && var=0
|
|
||||||
echo "$var"
|
|
||||||
}
|
|
||||||
|
|
||||||
bool_to_true_false () {
|
|
||||||
local var="$1"
|
|
||||||
[ "$var" = "1" ] && var=true
|
|
||||||
[ "$var" = "0" ] && var=false
|
|
||||||
echo "$var"
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# EXPERIMENTAL HELPERS
|
# EXPERIMENTAL HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
# Internal helper design to allow helpers to use getopts to manage their arguments
|
|
||||||
#
|
|
||||||
# example: function my_helper()
|
|
||||||
# {
|
|
||||||
# declare -Ar args_array=( [a]=arg1= [b]=arg2= [c]=arg3 )
|
|
||||||
# local arg1
|
|
||||||
# local arg2
|
|
||||||
# local arg3
|
|
||||||
# ynh_handle_getopts_args "$@"
|
|
||||||
#
|
|
||||||
# [...]
|
|
||||||
# }
|
|
||||||
# my_helper --arg1 "val1" -b val2 -c
|
|
||||||
#
|
|
||||||
# usage: ynh_handle_getopts_args "$@"
|
|
||||||
# | arg: $@ - Simply "$@" to tranfert all the positionnal arguments to the function
|
|
||||||
#
|
|
||||||
# This helper need an array, named "args_array" with all the arguments used by the helper
|
|
||||||
# that want to use ynh_handle_getopts_args
|
|
||||||
# Be carreful, this array has to be an associative array, as the following example:
|
|
||||||
# declare -Ar args_array=( [a]=arg1 [b]=arg2= [c]=arg3 )
|
|
||||||
# Let's explain this array:
|
|
||||||
# a, b and c are short options, -a, -b and -c
|
|
||||||
# arg1, arg2 and arg3 are the long options associated to the previous short ones. --arg1, --arg2 and --arg3
|
|
||||||
# For each option, a short and long version has to be defined.
|
|
||||||
# Let's see something more significant
|
|
||||||
# declare -Ar args_array=( [u]=user [f]=finalpath= [d]=database )
|
|
||||||
#
|
|
||||||
# NB: Because we're using 'declare' without -g, the array will be declared as a local variable.
|
|
||||||
#
|
|
||||||
# Please keep in mind that the long option will be used as a variable to store the values for this option.
|
|
||||||
# For the previous example, that means that $finalpath will be fill with the value given as argument for this option.
|
|
||||||
#
|
|
||||||
# Also, in the previous example, finalpath has a '=' at the end. That means this option need a value.
|
|
||||||
# So, the helper has to be call with --finalpath /final/path, --finalpath=/final/path or -f /final/path, the variable $finalpath will get the value /final/path
|
|
||||||
# If there's many values for an option, -f /final /path, the value will be separated by a ';' $finalpath=/final;/path
|
|
||||||
# For an option without value, like --user in the example, the helper can be called only with --user or -u. $user will then get the value 1.
|
|
||||||
#
|
|
||||||
# To keep a retrocompatibility, a package can still call a helper, using getopts, with positional arguments.
|
|
||||||
# The "legacy mode" will manage the positional arguments and fill the variable in the same order than they are given in $args_array.
|
|
||||||
# e.g. for `my_helper "val1" val2`, arg1 will be filled with val1, and arg2 with val2.
|
|
||||||
ynh_handle_getopts_args () {
|
|
||||||
# Manage arguments only if there's some provided
|
|
||||||
set +x
|
|
||||||
if [ $# -ne 0 ]
|
|
||||||
then
|
|
||||||
# Store arguments in an array to keep each argument separated
|
|
||||||
local arguments=("$@")
|
|
||||||
|
|
||||||
# For each option in the array, reduce to short options for getopts (e.g. for [u]=user, --user will be -u)
|
|
||||||
# And built parameters string for getopts
|
|
||||||
# ${!args_array[@]} is the list of all keys in the array (A key is 'u' in [u]=user, user is a value)
|
|
||||||
local getopts_parameters=""
|
|
||||||
local key=""
|
|
||||||
for key in "${!args_array[@]}"
|
|
||||||
do
|
|
||||||
# Concatenate each keys 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}" = "=" ]
|
|
||||||
then
|
|
||||||
# For an option with additionnal values, add a ':' after the letter for getopts.
|
|
||||||
getopts_parameters="${getopts_parameters}${key}:"
|
|
||||||
else
|
|
||||||
getopts_parameters="${getopts_parameters}${key}"
|
|
||||||
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
|
|
||||||
# (e.g. for [u]=user, --user will be -u)
|
|
||||||
# Replace long option with =
|
|
||||||
arguments[arg]="${arguments[arg]//--${args_array[$key]}/-${key} }"
|
|
||||||
# And long option without =
|
|
||||||
arguments[arg]="${arguments[arg]//--${args_array[$key]%=}/-${key}}"
|
|
||||||
done
|
|
||||||
done
|
|
||||||
|
|
||||||
# Read and parse all the arguments
|
|
||||||
# Use a function here, to use standart arguments $@ and be able to use shift.
|
|
||||||
parse_arg () {
|
|
||||||
# Read all arguments, until no arguments are left
|
|
||||||
while [ $# -ne 0 ]
|
|
||||||
do
|
|
||||||
# Initialize the index of getopts
|
|
||||||
OPTIND=1
|
|
||||||
# Parse with getopts only if the argument begin by -, that means the argument is an option
|
|
||||||
# getopts will fill $parameter with the letter of the option it has read.
|
|
||||||
local parameter=""
|
|
||||||
getopts ":$getopts_parameters" parameter || true
|
|
||||||
|
|
||||||
if [ "$parameter" = "?" ]
|
|
||||||
then
|
|
||||||
ynh_die "Invalid argument: -${OPTARG:-}"
|
|
||||||
elif [ "$parameter" = ":" ]
|
|
||||||
then
|
|
||||||
ynh_die "-$OPTARG parameter requires an argument."
|
|
||||||
else
|
|
||||||
local shift_value=1
|
|
||||||
# Use the long option, corresponding to the short option read by getopts, as a variable
|
|
||||||
# (e.g. for [u]=user, 'user' will be used as a variable)
|
|
||||||
# Also, remove '=' at the end of the long option
|
|
||||||
# The variable name will be stored in 'option_var'
|
|
||||||
local option_var="${args_array[$parameter]%=}"
|
|
||||||
# If this option doesn't take values
|
|
||||||
# if there's a '=' at the end of the long option name, this option takes values
|
|
||||||
if [ "${args_array[$parameter]: -1}" != "=" ]
|
|
||||||
then
|
|
||||||
# 'eval ${option_var}' will use the content of 'option_var'
|
|
||||||
eval ${option_var}=1
|
|
||||||
else
|
|
||||||
# Read all other arguments to find multiple value for this option.
|
|
||||||
# Load args in a array
|
|
||||||
local all_args=("$@")
|
|
||||||
|
|
||||||
# If the first argument is longer than 2 characters,
|
|
||||||
# There's a value attached to the option, in the same array cell
|
|
||||||
if [ ${#all_args[0]} -gt 2 ]; then
|
|
||||||
# Remove the option and the space, so keep only the value itself.
|
|
||||||
all_args[0]="${all_args[0]#-${parameter} }"
|
|
||||||
# Reduce the value of shift, because the option has been removed manually
|
|
||||||
shift_value=$(( shift_value - 1 ))
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Then read the array value per value
|
|
||||||
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]}" ]
|
|
||||||
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}" ]
|
|
||||||
then
|
|
||||||
# If there's already another value for this option, add a ; before adding the new value
|
|
||||||
eval ${option_var}+="\;"
|
|
||||||
fi
|
|
||||||
eval ${option_var}+=\"${all_args[$i]}\"
|
|
||||||
shift_value=$(( shift_value + 1 ))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Shift the parameter and its argument(s)
|
|
||||||
shift $shift_value
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
# LEGACY MODE
|
|
||||||
# Check if there's getopts arguments
|
|
||||||
if [ "${arguments[0]:0:1}" != "-" ]
|
|
||||||
then
|
|
||||||
# If not, enter in legacy mode and manage the arguments as positionnal ones.
|
|
||||||
echo "! Helper used in legacy mode !"
|
|
||||||
for i in `seq 0 $(( ${#arguments[@]} -1 ))`
|
|
||||||
do
|
|
||||||
# Use getopts_parameters as a list of key of the array args_array
|
|
||||||
# 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
|
|
||||||
# (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]%=}"
|
|
||||||
|
|
||||||
# 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
|
|
||||||
else
|
|
||||||
# END LEGACY MODE
|
|
||||||
# Call parse_arg and pass the modified list of args as an array of arguments.
|
|
||||||
parse_arg "${arguments[@]}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
set -x
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# 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
|
# Install or update the main directory yunohost.multimedia
|
||||||
#
|
#
|
||||||
# usage: ynh_multimedia_build_main_dir
|
# usage: ynh_multimedia_build_main_dir
|
||||||
|
|
@ -493,159 +79,6 @@ 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
|
|
||||||
ynh_add_fail2ban_config () {
|
|
||||||
# Process parameters
|
|
||||||
logpath=$1
|
|
||||||
failregex=$2
|
|
||||||
max_retry=${3:-3}
|
|
||||||
ports=${4:-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."
|
|
||||||
|
|
||||||
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
|
|
||||||
[$app]
|
|
||||||
enabled = true
|
|
||||||
port = $ports
|
|
||||||
filter = $app
|
|
||||||
logpath = $logpath
|
|
||||||
maxretry = $max_retry
|
|
||||||
EOF
|
|
||||||
|
|
||||||
sudo tee $finalfail2banfilterconf <<EOF
|
|
||||||
[INCLUDES]
|
|
||||||
before = common.conf
|
|
||||||
[Definition]
|
|
||||||
failregex = $failregex
|
|
||||||
ignoreregex =
|
|
||||||
EOF
|
|
||||||
|
|
||||||
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
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# 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
|
|
||||||
ynh_read_manifest () {
|
|
||||||
manifest="$1"
|
|
||||||
key="$2"
|
|
||||||
python3 -c "import sys, json;print(json.load(open('$manifest', encoding='utf-8'))['$key'])"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Read the upstream 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 before ~ynh
|
|
||||||
# In the last example it return 4.3-2
|
|
||||||
#
|
|
||||||
# usage: ynh_app_upstream_version
|
|
||||||
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*/}"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# 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
|
|
||||||
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/}"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Checks the app version to upgrade with the existing app version and returns:
|
|
||||||
# - UPGRADE_APP if the upstream app version has changed
|
|
||||||
# - UPGRADE_PACKAGE if only the YunoHost package has changed
|
|
||||||
#
|
|
||||||
## It stops the current script without error if the package is up-to-date
|
|
||||||
#
|
|
||||||
# This helper should be used to avoid an upgrade of an app, or the upstream part
|
|
||||||
# of it, when it's not needed
|
|
||||||
#
|
|
||||||
# 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
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Send an email to inform the administrator
|
# Send an email to inform the administrator
|
||||||
#
|
#
|
||||||
# usage: ynh_send_readme_to_admin app_message [recipients]
|
# usage: ynh_send_readme_to_admin app_message [recipients]
|
||||||
|
|
@ -735,43 +168,6 @@ ynh_system_reload () {
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
ynh_debian_release () {
|
|
||||||
lsb_release --codename --short
|
|
||||||
}
|
|
||||||
|
|
||||||
is_stretch () {
|
|
||||||
if [ "$(ynh_debian_release)" == "stretch" ]
|
|
||||||
then
|
|
||||||
return 0
|
|
||||||
else
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
is_jessie () {
|
|
||||||
if [ "$(ynh_debian_release)" == "jessie" ]
|
|
||||||
then
|
|
||||||
return 0
|
|
||||||
else
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# 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 () {
|
ynh_maintenance_mode_ON () {
|
||||||
# Load value of $path_url and $domain from the config if their not set
|
# Load value of $path_url and $domain from the config if their not set
|
||||||
if [ -z $path_url ]; then
|
if [ -z $path_url ]; then
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,6 @@ domain=$(ynh_app_setting_get $app domain)
|
||||||
# BACKUP OF THE MAIN DIR OF THE APP
|
# BACKUP OF THE MAIN DIR OF THE APP
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
CHECK_SIZE "$final_path"
|
|
||||||
ynh_backup "$final_path"
|
ynh_backup "$final_path"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue