diff --git a/config_panel.json b/config_panel.json
index 24f1076..4a7484e 100644
--- a/config_panel.json
+++ b/config_panel.json
@@ -64,6 +64,17 @@
"type": "bool",
"default": true
}]
+ },
+ {
+ "name": "Global configuration",
+ "id": "global_config",
+ "options": [{
+ "name": "Send HTML email to admin ?",
+ "help": "Allow app scripts to send HTML mails instead of plain text.",
+ "id": "email_type",
+ "type": "bool",
+ "default": true
+ }]
}]
}
]
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 278d8c7..e1d5b28 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -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 "$" "
" mail_to_send
+
+ # Insert starting HTML tags
+ sed --in-place '1s@^@\n\n\n\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__" "\1" mail_to_send
+
+ # Insert pre tags
+ ynh_replace_string "__PRE_TAG1__" "" mail_to_send
+ ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
+
+ # Insert finishing HTML tags
+ echo -e "\n\n" >> 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
+}
diff --git a/scripts/config b/scripts/config
index 5a56e39..b76e02d 100644
--- a/scripts/config
+++ b/scripts/config
@@ -72,6 +72,11 @@ old_overwrite_cron="$(ynh_app_setting_get $app overwrite_cron)"
old_overwrite_cron=$(bool_to_true_false $old_overwrite_cron)
overwrite_cron="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_CRON:-$old_overwrite_cron}"
+# Type of admin mail configuration
+old_admin_mail_html="$(ynh_app_setting_get $app admin_mail_html)"
+old_admin_mail_html=$(bool_to_true_false $old_admin_mail_html)
+admin_mail_html="${YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE:-$old_admin_mail_html}"
+
#=================================================
# SHOW_CONFIG FUNCTION FOR 'SHOW' COMMAND
#=================================================
@@ -89,6 +94,8 @@ show_config() {
echo "YNH_CONFIG_MAIN_BACKUP_OPTIONS_MAX_SIZE=$max_size"
echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_CRON=$overwrite_cron"
+
+ echo "YNH_CONFIG_MAIN_GLOBAL_CONFIG_EMAIL_TYPE=$admin_mail_html"
}
#=================================================
@@ -157,6 +164,10 @@ apply_config() {
# Set overwrite_cron
overwrite_cron=$(bool_to_01 $overwrite_cron)
ynh_app_setting_set $app overwrite_cron "$overwrite_cron"
+
+ # Set admin_mail_html
+ admin_mail_html=$(bool_to_01 $admin_mail_html)
+ ynh_app_setting_set $app admin_mail_html "$admin_mail_html"
}
#=================================================
diff --git a/scripts/install b/scripts/install
index a718a07..3ef4870 100755
--- a/scripts/install
+++ b/scripts/install
@@ -54,7 +54,9 @@ ynh_app_setting_set $app frequency "$frequency"
ynh_app_setting_set $app encrypt "$encrypt"
ynh_app_setting_set $app core_backup "$core_backup"
ynh_app_setting_set $app apps_backup "$apps_backup"
+
ynh_app_setting_set $app overwrite_cron "1"
+ynh_app_setting_set $app admin_mail_html "1"
#=================================================
# STANDARD MODIFICATIONS
@@ -203,12 +205,13 @@ $Informations" >&2
# SEND A README FOR THE ADMIN
#=================================================
-ynh_print_OFF
if [ "$encrypt" = "true" ]
then
+ ynh_print_OFF
encrypt_message="Your password for encryption is '$encryption_pwd'
"
+ ynh_print_ON
else
encrypt_message=""
fi
@@ -216,20 +219,21 @@ fi
# Get main domain and buid the url of the admin panel of the app.
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
-message="${encrypt_message}Archivist is going to run $run_freq.
+ynh_print_OFF
+echo "${encrypt_message}Archivist is going to run $run_freq.
If you want to change the frequency, have a look to the file /etc/cron.d/$app.
$Informations
-Please read the documentation (https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md) about the configuration of archivist for more information.
+Please read the __URL_TAG1__documentation__URL_TAG2__https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md__URL_TAG3__ about the configuration of archivist for more information.
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/archivist_ynh"
-
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="install"
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/archivist_ynh__URL_TAG3__." > mail_to_send
ynh_print_ON
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="install"
+
#=================================================
# END OF SCRIPT
#=================================================
diff --git a/scripts/restore b/scripts/restore
index d2d823f..44b3f3f 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -92,17 +92,17 @@ mkdir -p "/home/yunohost.app/${app}/backup"
# Get main domain and buid the url of the admin panel of the app.
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
-message="If you want to change the frequency of Archivist, have a look to the file /etc/cron.d/$app.
+echo "If you want to change the frequency of Archivist, have a look to the file /etc/cron.d/$app.
The configuration file of Archivist has been restored at $final_path/Backup_list.conf
-Please read the documentation (https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md) about the configuration of archivist for more information.
+Please read the __URL_TAG1__documentation__URL_TAG2__https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md__URL_TAG3__ about the configuration of archivist for more information.
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/archivist_ynh"
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/archivist_ynh__URL_TAG3__." > mail_to_send
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="restore"
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="restore"
#=================================================
# END OF SCRIPT
diff --git a/scripts/upgrade b/scripts/upgrade
index eede57f..e2dff2d 100755
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -65,6 +65,13 @@ if [ -z "$overwrite_cron" ]; then
ynh_app_setting_set $app overwrite_cron $overwrite_cron
fi
+admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
+# If admin_mail_html doesn't exist, create it
+if [ -z "$admin_mail_html" ]; then
+ admin_mail_html=1
+ ynh_app_setting_set $app admin_mail_html $admin_mail_html
+fi
+
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
@@ -171,17 +178,25 @@ chown -R root: $final_path
# Get main domain and buid the url of the admin panel of the app.
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
-message="Archivist is going to run $run_freq.
+# Build the changelog
+ynh_app_changelog || true
+
+echo "Archivist is going to run $run_freq.
If you want to change the frequency, have a look to the file /etc/cron.d/$app.
-Please read the documentation (https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md) about the configuration of archivist for more information.
+Please read the __URL_TAG1__documentation__URL_TAG2__https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md__URL_TAG3__ about the configuration of archivist for more information.
-You can configure this app easily by using the experimental config-panel feature: $admin_panel/config-panel.
-You can also find some specific actions for this app by using the experimental action feature: $admin_panel/actions.
+You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
+You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
-If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/archivist_ynh"
+If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/archivist_ynh__URL_TAG3__.
-ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="upgrade"
+---
+
+Changelog since your last upgrade:
+$(cat changelog)" > mail_to_send
+
+ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="root" --type="upgrade"
#=================================================
# END OF SCRIPT