From 2784cb8bc89a5f003c52575d53af95c88a598b47 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sun, 20 Jan 2019 17:44:06 +0100 Subject: [PATCH] Advertise config-panel and actions --- README.md | 4 ++-- README_fr.md | 4 ++-- manifest.json | 4 ++-- scripts/_common.sh | 48 +++++++++++++++++++++++++++++++++++----------- scripts/install | 8 +++++++- scripts/restore | 8 +++++++- scripts/upgrade | 16 ++++++++++++++++ 7 files changed, 73 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 51f3aad..57fb11a 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Please do your pull request to the [testing branch](https://github.com/YunoHost- To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --verbose +sudo yunohost app install https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --debug or -sudo yunohost app upgrade lutim -u https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --verbose +sudo yunohost app upgrade lutim -u https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --debug ``` diff --git a/README_fr.md b/README_fr.md index 275a52e..b9511f3 100644 --- a/README_fr.md +++ b/README_fr.md @@ -62,7 +62,7 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour tester la branche testing, merci de procéder ainsi. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --verbose +sudo yunohost app install https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --debug ou -sudo yunohost app upgrade lutim -u https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --verbose +sudo yunohost app upgrade lutim -u https://github.com/YunoHost-Apps/lutim_ynh/tree/testing --debug ``` diff --git a/manifest.json b/manifest.json index b386c55..5986f16 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Self hosting images and sharing anonymous application", "fr": "Application d'hébergement et de partage d'images anonyme" }, - "version": "0.10.4~ynh2", + "version": "0.10.4~ynh3", "url": "https://lut.im", "license": "AGPL-3.0", "maintainer": { @@ -14,7 +14,7 @@ "email": "maniackc_dev@crudelis.fr" }, "requirements": { - "yunohost": ">= 2.7.14" + "yunohost": ">= 3.3.3" }, "multi_instance": false, "services": [ diff --git a/scripts/_common.sh b/scripts/_common.sh index 47521cf..caf8bc7 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -264,7 +264,7 @@ ynh_multimedia_build_main_dir () { local checksum="806a827ba1902d6911095602a9221181" # Download yunohost.multimedia scripts - wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz + wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz # Check the control sum echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \ @@ -607,6 +607,7 @@ ynh_systemd_action() { 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 @@ -630,21 +631,24 @@ ynh_clean_check_starting () { # Send an email to inform the administrator # -# usage: ynh_send_readme_to_admin app_message [recipients] +# 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: -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= ) + 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 "$@" - local app_message="${app_message:-...No specific information...}" - local recipients="${recipients:-root}" + app_message="${app_message:-...No specific information...}" + recipients="${recipients:-root}" + type="${type:-install}" # Retrieve the email of users find_mails () { @@ -670,7 +674,23 @@ ynh_send_readme_to_admin() { } 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. @@ -828,10 +848,16 @@ ynh_download_file () { # Load value from configuration file (see above for a small doc about this file # format) - local file_url=$(grep 'FILE_URL=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-) - local file_sum=$(grep 'FILE_SUM=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-) - local file_sumprg=$(grep 'FILE_SUM_PRG=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-) - local filename=$(grep 'FILENAME=' "$YNH_CWD/../conf/${source_id}.src_file" | cut -d= -f2-) + local src_file="$YNH_CWD/../conf/${source_id}.src_file" + # If the src_file doesn't exist, use the backup path instead, with a "settings" directory + if [ ! -e "$src_file" ] + then + src_file="$YNH_CWD/../settings/conf/${source_id}.src_file" + fi + local file_url=$(grep 'FILE_URL=' "$src_file" | cut -d= -f2-) + local file_sum=$(grep 'FILE_SUM=' "$src_file" | cut -d= -f2-) + local file_sumprg=$(grep 'FILE_SUM_PRG=' "$src_file" | cut -d= -f2-) + local filename=$(grep 'FILENAME=' "$src_file" | cut -d= -f2-) # Default value file_sumprg=${file_sumprg:-sha256sum} @@ -853,7 +879,7 @@ ynh_download_file () { # Create the destination directory, if it's not already. mkdir -p "$dest_dir" - + # Move the file to its destination mv $filename $dest_dir } diff --git a/scripts/install b/scripts/install index 2668972..e51f0a3 100644 --- a/scripts/install +++ b/scripts/install @@ -213,8 +213,14 @@ chown -R $app: $final_path # SEND A README FOR THE ADMIN #================================================= +# 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="You can find a config file at $final_path/lutim.conf +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. + 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/lutim_ynh" -ynh_send_readme_to_admin --app_message="$message" --recipients="root" +ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="install" diff --git a/scripts/restore b/scripts/restore index 19562d8..67b9af7 100644 --- a/scripts/restore +++ b/scripts/restore @@ -142,8 +142,14 @@ ynh_maintenance_mode_OFF # SEND A README FOR THE ADMIN #================================================= +# 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="You can find a config file at $final_path/lutim.conf +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. + 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/lutim_ynh" -ynh_send_readme_to_admin --app_message="$message" --recipients="root" +ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="restore" diff --git a/scripts/upgrade b/scripts/upgrade index 2241e7a..2cc37e7 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -262,3 +262,19 @@ ynh_systemd_action --action=restart --line_match="Manager.*started" --log_path=" #================================================= ynh_maintenance_mode_OFF + +#================================================= +# SEND A README FOR THE ADMIN +#================================================= + +# 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="You can find a config file at $final_path/lutim.conf + +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. + +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/lutim_ynh" + +ynh_send_readme_to_admin --app_message="$message" --recipients="root" --type="upgrade"