|
|
@@ -710,7 +710,7 @@ ynh_script_progression () {
|
|
|
# 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 message to send to the administrator.
|
|
|
+# | 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
|
|
|
@@ -723,11 +723,16 @@ ynh_send_readme_to_admin() {
|
|
|
local recipients
|
|
|
local type
|
|
|
# Manage arguments with getopts
|
|
|
+
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
- app_message="${app_message:-...No specific information...}"
|
|
|
+ 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"
|
|
|
@@ -774,12 +779,53 @@ ynh_send_readme_to_admin() {
|
|
|
|
|
|
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 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
|
|
|
if [ -e /usr/bin/bsd-mailx ]
|
|
|
@@ -789,8 +835,15 @@ $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
|
|
|
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
|
|
|
- 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"
|
|
|
}
|
|
|
|
|
|
#=================================================
|
|
|
@@ -961,3 +1014,65 @@ ynh_download_file () {
|
|
|
# Move the file to its destination
|
|
|
mv $filename $dest_dir
|
|
|
}
|
|
|
+
|
|
|
+#=================================================
|
|
|
+
|
|
|
+# Create a changelog for an app after an upgrade.
|
|
|
+#
|
|
|
+# The changelog is printed into the file ./changelog for the time of the upgrade.
|
|
|
+#
|
|
|
+# In order to create a changelog, ynh_app_changelog will get info from /etc/yunohost/apps/$app/status.json
|
|
|
+# In order to find the current commit use by the app.
|
|
|
+# The remote repository, and the branch.
|
|
|
+# The changelog will be only the commits since the current revision.
|
|
|
+#
|
|
|
+# Because of the need of those info, ynh_app_changelog works only
|
|
|
+# with apps that have been installed from a list.
|
|
|
+#
|
|
|
+# usage: ynh_app_changelog
|
|
|
+ynh_app_changelog () {
|
|
|
+ get_value_from_settings ()
|
|
|
+ {
|
|
|
+ local value="$1"
|
|
|
+ # Extract a value from the status.json file of an installed app.
|
|
|
+
|
|
|
+ grep "$value\": \"" /etc/yunohost/apps/$app/status.json | sed "s/.*$value\": \"\([^\"]*\).*/\1/"
|
|
|
+ }
|
|
|
+
|
|
|
+ local current_revision="$(get_value_from_settings revision)"
|
|
|
+ local repo="$(get_value_from_settings url)"
|
|
|
+ local branch="$(get_value_from_settings branch)"
|
|
|
+ # ynh_app_changelog works only with an app installed from a list.
|
|
|
+ if [ -z "$current_revision" ] || [ -z "$repo" ] || [ -z "$branch" ]
|
|
|
+ then
|
|
|
+ ynh_print_warn "Unable to build the changelog..."
|
|
|
+ touch changelog
|
|
|
+ return 0
|
|
|
+ fi
|
|
|
+
|
|
|
+ # Fetch the history of the repository, without cloning it
|
|
|
+ mkdir git_history
|
|
|
+ (cd git_history
|
|
|
+ ynh_exec_warn_less git init
|
|
|
+ ynh_exec_warn_less git remote add -f origin $repo
|
|
|
+ # Get the line of the current commit of the installed app in the history.
|
|
|
+ local line_to_head=$(git log origin/$branch --pretty=oneline | grep --line-number "$current_revision" | cut -d':' -f1)
|
|
|
+ # Cut the history before the current commit, to keep only newer commits.
|
|
|
+ # Then use sed to reorganise each lines and have a nice list of commits since the last upgrade.
|
|
|
+ # This list is redirected into the file changelog
|
|
|
+ git log origin/$branch --pretty=oneline | head --lines=$(($line_to_head-1)) | sed 's/^\([[:alnum:]]*\)\(.*\)/*(\1) -> \2/g' > ../changelog)
|
|
|
+ # Remove 'Merge pull request' commits
|
|
|
+ sed -i '/Merge pull request #[[:digit:]]* from/d' changelog
|
|
|
+ # As well as conflict resolving commits
|
|
|
+ sed -i '/Merge branch .* into/d' changelog
|
|
|
+
|
|
|
+ # 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}"
|
|
|
+
|
|
|
+ # If a html email is required. Apply html to the changelog.
|
|
|
+ if [ "$admin_mail_html" -eq 1 ]
|
|
|
+ then
|
|
|
+ sed -in-place "s@\*(\([[:alnum:]]*\)) -> \(.*\)@* __URL_TAG1__\2__URL_TAG2__${repo}/commit/\1__URL_TAG3__@g" changelog
|
|
|
+ fi
|
|
|
+}
|