This app has been put under maintenance by your administrator at $(date)
+Please wait until the maintenance operation is done. This page will be reloaded as soon as your app will be back.
+ + +" > "/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 () { + # 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 + + # 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 } #================================================= diff --git a/scripts/backup b/scripts/backup index 14e048a..d795ba6 100644 --- a/scripts/backup +++ b/scripts/backup @@ -56,7 +56,8 @@ ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf" # BACKUP THE MYSQL DATABASE #================================================= -if [ $with_mysql -eq 1 ]; then +if [ $with_mysql -eq 1 ] +then ynh_script_progression --message="Backing up the MySQL database..." ynh_mysql_dump_db --database="$db_name" > db.sql fi diff --git a/scripts/change_url b/scripts/change_url index 14c221d..56faad2 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -29,6 +29,32 @@ ynh_script_progression --message="Loading installation settings..." # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before changing its url (may take a while)..." --weight=5 + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. + ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" + + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# ACTIVATE MAINTENANCE MODE +#================================================= +ynh_script_progression --message="Activating maintenance mode..." + +path_url=$old_path +domain=$old_domain +ynh_maintenance_mode_ON + #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= @@ -59,9 +85,11 @@ if [ $change_path -eq 1 ] then # Make a backup of the original nginx config file if modified ynh_backup_if_checksum_is_different --file="$nginx_conf_path" + # Set global variables for nginx helper domain="$old_domain" path_url="$new_path" + # Create a dedicated nginx config ynh_add_nginx_config fi @@ -72,6 +100,7 @@ then # Delete file checksum for the old conf file location ynh_delete_file_checksum --file="$nginx_conf_path" mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Store file checksum for the new config file location ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" fi @@ -85,6 +114,15 @@ ynh_script_progression --message="Reloading nginx web server..." ynh_systemd_action --service_name=nginx --action=reload +#================================================= +# DEACTIVE MAINTENANCE MODE +#================================================= +ynh_script_progression --message="Disabling maintenance mode..." + +path_url=$old_path +domain=$old_domain +ynh_maintenance_mode_OFF + #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index facdddb..467fe9f 100644 --- a/scripts/install +++ b/scripts/install @@ -23,8 +23,8 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH -password=$YNH_APP_ARG_PASSWORD with_sftp=$YNH_APP_ARG_WITH_SFTP +ynh_print_OFF; password=$YNH_APP_ARG_PASSWORD; ynh_print_ON is_public=$YNH_APP_ARG_IS_PUBLIC with_mysql=$YNH_APP_ARG_WITH_MYSQL @@ -76,7 +76,8 @@ ynh_app_setting_set --app=$app --key=admin_mail_html --value=1 # CREATE A MYSQL DATABASE #================================================= -if [ $with_mysql -eq 1 ]; then +if [ $with_mysql -eq 1 ] +then ynh_script_progression --message="Creating a MySQL database..." --weight=2 db_name=$(ynh_sanitize_dbid --db_name=$app) @@ -145,11 +146,11 @@ fi if [ $with_mysql -eq 1 ]; then # Store the database access echo -e "# MySQL Database - name: ${db_name}\nuser: ${db_name}\npass: ${db_pwd}" > ../sources/db_access.txt -fi +name: ${db_name}\nuser: ${db_name}\npass: ${db_pwd}" > ../sources/db_access.txt -# Copy files to the right place -cp -r ../sources "$final_path" + # Copy files to the right place + cp -r "../sources/db_access.txt" "$final_path/db_access.txt" +fi #================================================= # PHP-FPM CONFIGURATION diff --git a/scripts/remove b/scripts/remove index 1252a37..bca4f75 100644 --- a/scripts/remove +++ b/scripts/remove @@ -86,7 +86,7 @@ fi ynh_script_progression --message="Removing the dedicated system user..." # Delete a system user -ynh_system_user_delete --username=$app +ynh_system_user_delete --username=$user #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 0eac9c3..e147dff 100644 --- a/scripts/restore +++ b/scripts/restore @@ -28,8 +28,8 @@ path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) db_name=$(ynh_app_setting_get --app=$app --key=db_name) with_mysql=$(ynh_app_setting_get --app=$app --key=with_mysql) -password=$(ynh_app_setting_get --app=$app --key=password) with_sftp=$(ynh_app_setting_get --app=$app --key=with_sftp) +ynh_print_OFF; password=$(ynh_app_setting_get --app=$app --key=password); ynh_print_ON user=$(ynh_app_setting_get --app=$app --key=user) #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 67714ca..6fdbaba 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -23,8 +23,8 @@ is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) db_name=$(ynh_app_setting_get --app=$app --key=db_name) with_mysql=$(ynh_app_setting_get --app=$app --key=with_mysql) -password=$(ynh_app_setting_get --app=$app --key=password) with_sftp=$(ynh_app_setting_get --app=$app --key=with_sftp) +ynh_print_OFF; password=$(ynh_app_setting_get --app=$app --key=password); ynh_print_ON user=$(ynh_app_setting_get --app=$app --key=user) overwrite_nginx=$(ynh_app_setting_get --app=$app --key=overwrite_nginx) @@ -34,6 +34,12 @@ admin_mail_html=$(ynh_app_setting_get --app=$app --key=admin_mail_html) fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) +#================================================= +# CHECK VERSION +#================================================= + +upgrade_type=$(ynh_check_app_version_changed) + #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= @@ -117,6 +123,13 @@ ynh_abort_if_errors # Normalize the URL path syntax path_url=$(ynh_normalize_url_path --path_url=$path_url) +#================================================= +# ACTIVATE MAINTENANCE MODE +#================================================= +ynh_script_progression --message="Activating maintenance mode..." + +ynh_maintenance_mode_ON + #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -217,6 +230,13 @@ ynh_script_progression --message="Reloading nginx web server..." ynh_systemd_action --service_name=nginx --action=reload +#================================================= +# DEACTIVE MAINTENANCE MODE +#================================================= +ynh_script_progression --message="Disabling maintenance mode..." + +ynh_maintenance_mode_OFF + #================================================= # SEND A README FOR THE ADMIN #=================================================