284 lines
11 KiB
Bash
284 lines
11 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# EXPERIMENTAL HELPERS
|
|
#=================================================
|
|
|
|
# Send an email to inform 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
|
|
# example: "root admin@domain"
|
|
# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
|
|
# example: "root admin@domain user1 user2"
|
|
# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
|
|
ynh_send_readme_to_admin() {
|
|
# Declare an array to define the options of this helper.
|
|
declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
|
|
local app_message
|
|
local recipients
|
|
local type
|
|
# Manage arguments with getopts
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
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
|
|
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")
|
|
|
|
# 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.
|
|
|
|
Specific information for the application $app.
|
|
|
|
$(if [ -n "$app_message" ]
|
|
then
|
|
cat "$app_message"
|
|
else
|
|
echo "...No specific information..."
|
|
fi)
|
|
|
|
---
|
|
Automatic diagnosis data from YunoHost
|
|
|
|
__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
|
|
if [ -e /usr/bin/bsd-mailx ]
|
|
then
|
|
local mail_bin=/usr/bin/bsd-mailx
|
|
else
|
|
local mail_bin=/usr/bin/mail.mailutils
|
|
fi
|
|
|
|
if [ "$admin_mail_html" -eq 1 ]
|
|
then
|
|
content_type="text/html"
|
|
else
|
|
content_type="text/plain"
|
|
fi
|
|
|
|
# Send the email to the recipients
|
|
cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
|
|
}
|
|
|
|
}
|
|
|
|
#=================================================
|
|
|
|
# Create a changelog for an app after an upgrade from the file CHANGELOG.md.
|
|
#
|
|
# 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)
|
|
#
|
|
# 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
|
|
}
|