YunoHost-Apps/lutim_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/lutim_ynh.git synced 2024-09-03 19:36:24 +02:00
Code Issues Activity Actions
lutim_ynh/scripts/_common.sh

449 lines
16 KiB
Bash
Raw Normal View History

Factorisation du code
2016-06-15 23:56:45 +02:00
#!/bin/bash
Update helpers
2020-01-02 18:44:20 +01:00
#=================================================
Upgrade to 0.12.0
2020-10-05 22:02:46 +02:00
# COMMON VARIABLES
Update helpers
2020-01-02 18:44:20 +01:00
#=================================================
Apply last example_ynh
2021-05-16 16:48:58 +02:00
# dependencies used by the app
pkg_dependencies="carton perlmagick libpq-dev shared-mime-info"
Upgrade to 0.12.0
2020-10-05 22:02:46 +02:00
Reprise globale du package
2017-03-19 19:16:10 +01:00
#=================================================
Apply last example_ynh
2021-05-16 16:48:58 +02:00
# PERSONAL HELPERS
Reprise globale du package
2017-03-19 19:16:10 +01:00
#=================================================
Require ynh 3.4
2019-01-30 19:58:36 +01:00
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
Use new helpers
2017-12-16 23:22:54 +01:00
# Send an email to inform the administrator
#
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
Changelog & html email
2019-01-30 19:27:17 +01:00
# | arg: -m --app_message= - The file with the content to send to the administrator.
Upgrade helpers
2018-07-13 17:33:54 +02:00
# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
Use new helpers
2017-12-16 23:22:54 +01:00
# 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"
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
Use new helpers
2017-12-16 23:22:54 +01:00
ynh_send_readme_to_admin() {
Upgrade helpers
2018-07-13 17:33:54 +02:00
# Declare an array to define the options of this helper.
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
Upgrade helpers
2018-07-13 17:33:54 +02:00
local app_message
local recipients
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
local type
Upgrade helpers
2018-07-13 17:33:54 +02:00
# Manage arguments with getopts
Changelog & html email
2019-01-30 19:27:17 +01:00
Upgrade helpers
2018-07-13 17:33:54 +02:00
ynh_handle_getopts_args "$@"
Changelog & html email
2019-01-30 19:27:17 +01:00
app_message="${app_message:-}"
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
recipients="${recipients:-root}"
type="${type:-install}"
Use new helpers
2017-12-16 23:22:54 +01:00
Changelog & html email
2019-01-30 19:27:17 +01:00
# 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}"
Use new helpers
2017-12-16 23:22:54 +01:00
# Retrieve the email of users
find_mails () {
local list_mails="$1"
local mail
local recipients=" "
# Read each mail in argument
for mail in $list_mails
do
# Keep root or a real email address as it is
if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
then
recipients="$recipients $mail"
else
# But replace an user name without a domain after by its email
if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
then
recipients="$recipients $mail"
fi
fi
done
echo "$recipients"
}
recipients=$(find_mails "$recipients")
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
# 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
Use new helpers
2017-12-16 23:22:54 +01:00
local mail_message="This is an automated message from your beloved YunoHost server.
Update helpers
2018-03-14 23:24:29 +01:00
Specific information for the application $app.
Use new helpers
2017-12-16 23:22:54 +01:00
Changelog & html email
2019-01-30 19:27:17 +01:00
$(if [ -n "$app_message" ]
then
cat "$app_message"
else
echo "...No specific information..."
fi)
Use new helpers
2017-12-16 23:22:54 +01:00
---
Automatic diagnosis data from YunoHost
Changelog & html email
2019-01-30 19:27:17 +01:00
__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 " " "\&#160;\&#160;" mail_to_send
ynh_replace_string "\t" "\&#160;\&#160;" 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
Use new helpers
2017-12-16 23:22:54 +01:00
Upgrade to 0.10.4
2018-05-20 20:55:15 +02:00
# Define binary to use for mail command
if [ -e /usr/bin/bsd-mailx ]
then
local mail_bin=/usr/bin/bsd-mailx
else
local mail_bin=/usr/bin/mail.mailutils
fi
Changelog & html email
2019-01-30 19:27:17 +01:00
if [ "$admin_mail_html" -eq 1 ]
then
content_type="text/html"
else
content_type="text/plain"
fi
Use new helpers
2017-12-16 23:22:54 +01:00
# Send the email to the recipients
Changelog & html email
2019-01-30 19:27:17 +01:00
cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
Use new helpers
2017-12-16 23:22:54 +01:00
}
Update package
2017-12-05 19:36:40 +01:00
Update helpers
2018-03-14 23:24:29 +01:00
Update package
2017-12-05 19:36:40 +01:00
#=================================================
Upgrade to 0.10.4
2018-05-20 20:55:15 +02:00
ynh_maintenance_mode_ON () {
Upgrade helpers
2018-07-13 17:33:54 +02:00
# Load value of $path_url and $domain from the config if their not set
if [ -z $path_url ]; then
path_url=$(ynh_app_setting_get $app path)
fi
if [ -z $domain ]; then
domain=$(ynh_app_setting_get $app domain)
fi
Update helpers
2020-01-02 18:44:20 +01:00
mkdir -p /var/www/html/
Upgrade to 0.10.4
2018-05-20 20:55:15 +02:00
# Create an html to serve as maintenance notice
echo "<!DOCTYPE html>
<html>
<head>
<meta http-equiv="refresh" content="3">
<title>Your app $app is currently under maintenance!</title>
<style>
body {
width: 70em;
margin: 0 auto;
}
</style>
</head>
<body>
<h1>Your app $app is currently under maintenance!</h1>
<p>This app has been put under maintenance by your administrator at $(date)</p>
<p>Please wait until the maintenance operation is done. This page will be reloaded as soon as your app will be back.</p>
</body>
</html>" > "/var/www/html/maintenance.$app.html"
# Create a new nginx config file to redirect all access to the app to the maintenance notice instead.
echo "# All request to the app will be redirected to ${path_url}_maintenance and fall on the maintenance notice
rewrite ^${path_url}/(.*)$ ${path_url}_maintenance/? redirect;
# Use another location, to not be in conflict with the original config file
location ${path_url}_maintenance/ {
alias /var/www/html/ ;
try_files maintenance.$app.html =503;
# Include SSOWAT user panel.
include conf.d/yunohost_panel.conf.inc;
}" > "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf"
# The current config file will redirect all requests to the root of the app.
# To keep the full path, we can use the following rewrite rule:
# rewrite ^${path_url}/(.*)$ ${path_url}_maintenance/\$1? redirect;
# The difference will be in the $1 at the end, which keep the following queries.
# But, if it works perfectly for a html request, there's an issue with any php files.
# This files are treated as simple files, and will be downloaded by the browser.
# Would be really be nice to be able to fix that issue. So that, when the page is reloaded after the maintenance, the user will be redirected to the real page he was.
systemctl reload nginx
}
ynh_maintenance_mode_OFF () {
Upgrade helpers
2018-07-13 17:33:54 +02:00
# Load value of $path_url and $domain from the config if their not set
if [ -z $path_url ]; then
path_url=$(ynh_app_setting_get $app path)
fi
if [ -z $domain ]; then
domain=$(ynh_app_setting_get $app domain)
fi
Upgrade to 0.10.4
2018-05-20 20:55:15 +02:00
# Rewrite the nginx config file to redirect from ${path_url}_maintenance to the real url of the app.
echo "rewrite ^${path_url}_maintenance/(.*)$ ${path_url}/\$1 redirect;" > "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf"
systemctl reload nginx
# Sleep 4 seconds to let the browser reload the pages and redirect the user to the app.
sleep 4
# Then remove the temporary files used for the maintenance.
rm "/var/www/html/maintenance.$app.html"
rm "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf"
systemctl reload nginx
}
Update to last standart
2019-01-13 19:10:28 +01:00
#=================================================
Update helpers
2020-01-02 18:44:20 +01:00
# Create a changelog for an app after an upgrade from the file CHANGELOG.md.
Update to last standart
2019-01-13 19:10:28 +01:00
#
Update helpers
2020-01-02 18:44:20 +01:00
# usage: ynh_app_changelog [--format=markdown/html/plain] [--output=changelog_file] --changelog=changelog_source]
# | arg: -f --format= - Format in which the changelog will be printed
# markdown: Default format.
# html: Turn urls into html format.
# plain: Plain text changelog
# | arg: -o --output= - Output file for the changelog file (Default ./changelog)
# | arg: -c --changelog= - CHANGELOG.md source (Default ../CHANGELOG.md)
Update to last standart
2019-01-13 19:10:28 +01:00
#
Update helpers
2020-01-02 18:44:20 +01:00
# The changelog is printed into the file ./changelog and ./changelog_lite
ynh_app_changelog () {
# Declare an array to define the options of this helper.
local legacy_args=foc
declare -Ar args_array=( [f]=format= [o]=output= [c]=changelog= )
local format
local output
local changelog
# Manage arguments with getopts
ynh_handle_getopts_args "$@"
format=${format:-markdown}
output=${output:-changelog}
changelog=${changelog:-../CHANGELOG.md}
local original_changelog="$changelog"
local temp_changelog="changelog_temp"
local final_changelog="$output"
if [ ! -n "$original_changelog" ]
then
echo "No changelog available..." > "$final_changelog"
echo "No changelog available..." > "${final_changelog}_lite"
return 0
fi
local current_version=$(ynh_read_manifest --manifest="/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json" --manifest_key="version")
local update_version=$(ynh_read_manifest --manifest="../manifest.json" --manifest_key="version")
# Get the line of the version to update to into the changelog
local update_version_line=$(grep --max-count=1 --line-number "^## \[$update_version" "$original_changelog" | cut -d':' -f1)
# If there's no entry for this version yet into the changelog
# Get the first available version
if [ -z "$update_version_line" ]
then
update_version_line=$(grep --max-count=1 --line-number "^##" "$original_changelog" | cut -d':' -f1)
fi
# Get the length of the complete changelog.
local changelog_length=$(wc --lines "$original_changelog" | awk '{print $1}')
# Cut the file before the version to update to.
tail --lines=$(( $changelog_length - $update_version_line + 1 )) "$original_changelog" > "$temp_changelog"
# Get the length of the troncated changelog.
changelog_length=$(wc --lines "$temp_changelog" | awk '{print $1}')
# Get the line of the current version into the changelog
# Keep only the last line found
local current_version_line=$(grep --line-number "^## \[$current_version" "$temp_changelog" | cut -d':' -f1 | tail --lines=1)
# If there's no entry for this version into the changelog
# Get the last available version
if [ -z "$current_version_line" ]
then
current_version_line=$(grep --line-number "^##" "$original_changelog" | cut -d':' -f1 | tail --lines=1)
fi
# Cut the file before the current version.
# Then grep the previous version into the changelog to get the line number of the previous version
local previous_version_line=$(tail --lines=$(( $changelog_length - $current_version_line )) \
"$temp_changelog" | grep --max-count=1 --line-number "^## " | cut -d':' -f1)
# If there's no previous version into the changelog
# Go until the end of the changelog
if [ -z "$previous_version_line" ]
then
previous_version_line=$changelog_length
fi
# Cut the file after the previous version to keep only the changelog between the current version and the version to update to.
head --lines=$(( $current_version_line + $previous_version_line - 1 )) "$temp_changelog" | tee "$final_changelog"
if [ "$format" = "html" ]
then
# Replace markdown links by html links
ynh_replace_string --match_string="\[\(.*\)\](\(.*\)))" --replace_string="<a href=\"\2\">\1</a>)" --target_file="$final_changelog"
ynh_replace_string --match_string="\[\(.*\)\](\(.*\))" --replace_string="<a href=\"\2\">\1</a>" --target_file="$final_changelog"
elif [ "$format" = "plain" ]
then
# Change title format.
ynh_replace_string --match_string="^##.*\[\(.*\)\](\(.*\)) - \(.*\)$" --replace_string="## \1 (\3) - \2" --target_file="$final_changelog"
# Change modifications lines format.
ynh_replace_string --match_string="^\([-*]\).*\[\(.*\)\]\(.*\)" --replace_string="\1 \2 \3" --target_file="$final_changelog"
fi
# else markdown. As the file is already in markdown, nothing to do.
# Keep only important changes into the changelog
# Remove all minor changes
sed '/^-/d' "$final_changelog" > "${final_changelog}_lite"
# Remove all blank lines (to keep a clear workspace)
sed --in-place '/^$/d' "${final_changelog}_lite"
# Add a blank line at the end
echo "" >> "${final_changelog}_lite"
# Clean titles if there's no significative changes
local line
local previous_line=""
while read line <&3
do
if [ -n "$previous_line" ]
then
# Remove the line if it's a title or a blank line, and the previous one was a title as well.
if ( [ "${line:0:1}" = "#" ] || [ ${#line} -eq 0 ] ) && [ "${previous_line:0:1}" = "#" ]
then
ynh_replace_special_string --match_string="${previous_line//[/.}" --replace_string="" --target_file="${final_changelog}_lite"
fi
fi
previous_line="$line"
done 3< "${final_changelog}_lite"
# Remove all blank lines again
sed --in-place '/^$/d' "${final_changelog}_lite"
# Restore changelog format with blank lines
ynh_replace_string --match_string="^##.*" --replace_string="\n\n&\n" --target_file="${final_changelog}_lite"
# Remove the 2 first blank lines
sed --in-place '1,2d' "${final_changelog}_lite"
# Add a blank line at the end
echo "" >> "${final_changelog}_lite"
# If changelog are empty, add an info
if [ $(wc --words "$final_changelog" | awk '{print $1}') -eq 0 ]
then
echo "No changes from the changelog..." > "$final_changelog"
fi
if [ $(wc --words "${final_changelog}_lite" | awk '{print $1}') -eq 0 ]
then
echo "No significative changes from the changelog..." > "${final_changelog}_lite"
fi
}
#=================================================
# Check the amount of available RAM
Update to last standart
2019-01-13 19:10:28 +01:00
#
Update helpers
2020-01-02 18:44:20 +01:00
# usage: ynh_check_ram [--required=RAM required in Mb] [--no_swap|--only_swap] [--free_ram]
# | arg: -r, --required= - Amount of RAM required in Mb. The helper will return 0 is there's enough RAM, or 1 otherwise.
# If --required isn't set, the helper will print the amount of RAM, in Mb.
# | arg: -s, --no_swap - Ignore swap
# | arg: -o, --only_swap - Ignore real RAM, consider only swap.
# | arg: -f, --free_ram - Count only free RAM, not the total amount of RAM available.
ynh_check_ram () {
Update to last standart
2019-01-13 19:10:28 +01:00
# Declare an array to define the options of this helper.
Update helpers
2020-01-02 18:44:20 +01:00
declare -Ar args_array=( [r]=required= [s]=no_swap [o]=only_swap [f]=free_ram )
local required
local no_swap
local only_swap
Update to last standart
2019-01-13 19:10:28 +01:00
# Manage arguments with getopts
ynh_handle_getopts_args "$@"
Update helpers
2020-01-02 18:44:20 +01:00
required=${required:-}
no_swap=${no_swap:-0}
only_swap=${only_swap:-0}
Update to last standart
2019-01-13 19:10:28 +01:00
Update helpers
2020-01-02 18:44:20 +01:00
local total_ram=$(vmstat --stats --unit M | grep "total memory" | awk '{print $1}')
local total_swap=$(vmstat --stats --unit M | grep "total swap" | awk '{print $1}')
local total_ram_swap=$(( total_ram + total_swap ))
Update to last standart
2019-01-13 19:10:28 +01:00
Update helpers
2020-01-02 18:44:20 +01:00
local free_ram=$(vmstat --stats --unit M | grep "free memory" | awk '{print $1}')
local free_swap=$(vmstat --stats --unit M | grep "free swap" | awk '{print $1}')
local free_ram_swap=$(( free_ram + free_swap ))
Update to last standart
2019-01-13 19:10:28 +01:00
Update helpers
2020-01-02 18:44:20 +01:00
# Use the total amount of ram
local ram=$total_ram_swap
if [ $free_ram -eq 1 ]
then
# Use the total amount of free ram
ram=$free_ram_swap
if [ $no_swap -eq 1 ]
then
# Use only the amount of free ram
ram=$free_ram
elif [ $only_swap -eq 1 ]
then
# Use only the amount of free swap
ram=$free_swap
fi
else
if [ $no_swap -eq 1 ]
then
# Use only the amount of free ram
ram=$total_ram
elif [ $only_swap -eq 1 ]
then
# Use only the amount of free swap
ram=$total_swap
fi
Update to last standart
2019-01-13 19:10:28 +01:00
fi
Update helpers
2020-01-02 18:44:20 +01:00
if [ -n "$required" ]
then
# Return 1 if the amount of ram isn't enough.
if [ $ram -lt $required ]
then
return 1
else
return 0
fi
Advertise config-panel and actions
2019-01-20 17:44:06 +01:00
Update helpers
2020-01-02 18:44:20 +01:00
# If no RAM is required, return the amount of available ram.
else
echo $ram
fi
Update to last standart
2019-01-13 19:10:28 +01:00
}
Reference in a new issue Copy permalink