@ -22,382 +22,35 @@ CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant
fi fi
} }
#=================================================
# FUTUR OFFICIAL HELPERS
#=================================================
# Create a dedicated fail2ban config (jail and filter conf files)
#
# usage: ynh_add_fail2ban_config log_file filter [max_retry [ports]]
# | 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 ( ) {
# 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."
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
tee $finalfail2banjailconf <<EOF
[ $app ]
enabled = true
port = $ports
filter = $app
logpath = $logpath
maxretry = $max_retry
EOF
tee $finalfail2banfilterconf <<EOF
[ INCLUDES]
before = common.conf
[ Definition]
failregex = $failregex
ignoreregex =
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
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 "
if [ " $( lsb_release --codename --short) " != "jessie" ] ; then
systemctl reload fail2ban
else
systemctl restart fail2ban
fi
}
#=================================================
# Read the value of a key in a ynh manifest file
#
# usage: ynh_read_manifest manifest key
# | arg: -m, --manifest= - Path of the manifest to read
# | arg: -k, --key= - Name of the key to find
ynh_read_manifest ( ) {
# 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
# 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 [-m manifest]
# | arg: -m, --manifest= - Path of the manifest to read
ynh_app_upstream_version ( ) {
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>
# For example : 4.3-2~ynh3
# This include the number after ~ynh
# In the last example it return 3
#
# usage: ynh_app_package_version [-m manifest]
# | arg: -m, --manifest= - Path of the manifest to read
ynh_app_package_version ( ) {
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:
# - 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 --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
}
#=================================================
# 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
}
#================================================= #=================================================
# EXPERIMENTAL HELPERS # EXPERIMENTAL HELPERS
#================================================= #=================================================
# Print a message as INFO and show progression during an app script
#
# usage: ynh_script_progression --message=message [--weight=weight] [--time]
# | arg: -m, --message= - The text to print
# | arg: -w, --weight= - The weight for this progression. This value is 1 by default. Use a bigger value for a longer part of the script.
# | arg: -t, --time= - Print the execution time since the last call to this helper. Especially usefull to define weights.
# | arg: -l, --last= - Use for the last call of the helper, to fill te progression bar.
increment_progression = 0
previous_weight = 0
# Define base_time when the file is sourced
base_time = $( date +%s)
ynh_script_progression ( ) {
# Declare an array to define the options of this helper.
declare -Ar args_array = ( [ m] = message = [ w] = weight = [ t] = time [ l] = last )
local message
local weight
local time
local last
# Manage arguments with getopts
ynh_handle_getopts_args " $@ "
weight = ${ weight :- 1 }
time = ${ time :- 0 }
last = ${ last :- 0 }
# Get execution time since the last $base_time
local exec_time = $(( $( date +%s) - $base_time ))
base_time = $( date +%s)
# Get the number of occurrences of 'ynh_script_progression' in the script. Except those are commented.
local helper_calls = " $( grep --count "^[^#]*ynh_script_progression" $0 ) "
# Get the number of call with a weight value
local weight_calls = $( grep --perl-regexp --count "^[^#]*ynh_script_progression.*(--weight|-w )" $0 )
# Get the weight of each occurrences of 'ynh_script_progression' in the script using --weight
local weight_valuesA = " $( grep --perl-regexp "^[^#]*ynh_script_progression.*--weight" $0 | sed 's/.*--weight[= ]\([[:digit:]].*\)/\1/g' ) "
# Get the weight of each occurrences of 'ynh_script_progression' in the script using -w
local weight_valuesB = " $( grep --perl-regexp "^[^#]*ynh_script_progression.*-w " $0 | sed 's/.*-w[= ]\([[:digit:]].*\)/\1/g' ) "
# Each value will be on a different line.
# Remove each 'end of line' and replace it by a '+' to sum the values.
local weight_values = $(( $( echo " $weight_valuesA " | tr '\n' '+' ) + $( echo " $weight_valuesB " | tr '\n' '+' ) 0 ))
# max_progression is a total number of calls to this helper.
# Less the number of calls with a weight value.
# Plus the total of weight values
local max_progression = $(( $helper_calls - $weight_calls + $weight_values ))
# Increment each execution of ynh_script_progression in this script by the weight of the previous call.
increment_progression = $(( $increment_progression + $previous_weight ))
# Store the weight of the current call in $previous_weight for next call
previous_weight = $weight
# Set the scale of the progression bar
local scale = 20
# progress_string(1,2) should have the size of the scale.
local progress_string1 = "####################"
local progress_string0 = "...................."
# Reduce $increment_progression to the size of the scale
if [ $last -eq 0 ]
then
local effective_progression = $(( $increment_progression * $scale / $max_progression ))
# If last is specified, fill immediately the progression_bar
else
local effective_progression = $scale
fi
# Build $progression_bar from progress_string(1,2) according to $effective_progression
local progression_bar = " ${ progress_string1 : 0 : $effective_progression } ${ progress_string0 : 0 : $(( $scale - $effective_progression )) } "
local print_exec_time = ""
if [ $time -eq 1 ]
then
print_exec_time = " [ $( date +%Hh%Mm,%Ss --date= " 0 + $exec_time sec " ) ] "
fi
ynh_print_info " [ $progression_bar ] > ${ message } ${ print_exec_time } "
}
#=================================================
# Send an email to inform the administrator # Send an email to inform the administrator
# #
# usage: ynh_send_readme_to_admin app_message [recipients]
# | arg: -m --app_message= - The message to send to the administrator.
# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
# | arg: -m --app_message= - The file with the content to send to the administrator.
# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root # | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
# example: "root admin@domain" # 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 # 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" # 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( ) { ynh_send_readme_to_admin( ) {
# Declare an array to define the options of this helper. # 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 app_message
local recipients local recipients
local type
# Manage arguments with getopts # Manage arguments with getopts
ynh_handle_getopts_args " $@ " ynh_handle_getopts_args " $@ "
local app_message = " ${ app_message :- ...No specific information... } "
local recipients = " ${ recipients :- root } "
app_message = " ${ app_message :- } "
recipients = " ${ recipients :- root } "
type = " ${ type :- install } "
# Get the value of admin_mail_html
admin_mail_html = $( ynh_app_setting_get $app admin_mail_html)
admin_mail_html = " ${ admin_mail_html :- 0 } "
# Retrieve the email of users # Retrieve the email of users
find_mails ( ) { find_mails ( ) {
@ -423,18 +76,75 @@ ynh_send_readme_to_admin() {
} }
recipients = $( find_mails " $recipients " ) 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. local mail_message = " This is an automated message from your beloved YunoHost server.
Specific information for the application $app .Specific information for the application $app .
$app_message
$( if [ -n " $app_message " ]
then
cat " $app_message "
else
echo "...No specific information..."
fi )
------
Automatic diagnosis data from YunoHostAutomatic diagnosis data from YunoHost
$( yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d' ) "
__PRE_TAG1__$( yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d' ) __PRE_TAG2__"
# Store the message into a file for further modifications.
echo " $mail_message " > mail_to_send
# If a html email is required. Apply html tags to the message.
if [ " $admin_mail_html " -eq 1 ]
then
# Insert 'br' tags at each ending of lines.
ynh_replace_string " $" "<br>" mail_to_send
# Insert starting HTML tags
sed --in-place '1s@^@<!DOCTYPE html>\n<html>\n<head></head>\n<body>\n@' mail_to_send
# Keep tabulations
ynh_replace_string " " "\ \ " mail_to_send
ynh_replace_string "\t" "\ \ " mail_to_send
# Insert url links tags
ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
# Insert pre tags
ynh_replace_string "__PRE_TAG1__" "<pre>" mail_to_send
ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
# Insert finishing HTML tags
echo -e "\n</body>\n</html>" >> mail_to_send
# Otherwise, remove tags to keep a plain text.
else
# Remove URL tags
ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
ynh_replace_string "__URL_TAG2__" ": " mail_to_send
# Remove PRE tags
ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
fi
# Define binary to use for mail command # Define binary to use for mail command
if [ -e /usr/bin/bsd-mailx ] if [ -e /usr/bin/bsd-mailx ]
@ -444,8 +154,15 @@ $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
local mail_bin = /usr/bin/mail.mailutils local mail_bin = /usr/bin/mail.mailutils
fi fi
if [ " $admin_mail_html " -eq 1 ]
then
content_type = "text/html"
else
content_type = "text/plain"
fi
# Send the email to the recipients # Send the email to the recipients
echo " $mail_message " | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s " $mail_subject " " $recipients "
cat mail_to_send | $mail_bin -a " Content-Type: $content_type ; charset=UTF-8 -s " $mail_subject " " $recipients "
} }
#================================================= #=================================================
@ -459,6 +176,8 @@ ynh_maintenance_mode_ON () {
domain = $( ynh_app_setting_get $app domain) domain = $( ynh_app_setting_get $app domain)
fi fi
mkdir -p /var/www/html/
# Create an html to serve as maintenance notice # Create an html to serve as maintenance notice
echo " <!DOCTYPE html> echo " <!DOCTYPE html>
<html><html>
Maniack Crudelis
7 years ago