From feb93583a8cad7339e4a25a51042d250b3346f93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 8 Apr 2021 17:30:04 +0200 Subject: [PATCH] Testing (#24) * Remove is_public * Update manifest.json * Create change_url --- README.md | 4 +- README_fr.md | 4 +- check_process | 8 +-- manifest.json | 24 +------- scripts/_common.sh | 1 - scripts/change_url | 144 +++++++++++++++++++++++++++++++++++++++++++++ scripts/upgrade | 12 ---- 7 files changed, 154 insertions(+), 43 deletions(-) create mode 100644 scripts/change_url diff --git a/README.md b/README.md index 35f9ae2..90a6f94 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,8 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in #### Supported architectures -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) ## Limitations diff --git a/README_fr.md b/README_fr.md index 2130fd2..a6f45d7 100644 --- a/README_fr.md +++ b/README_fr.md @@ -40,8 +40,8 @@ Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install #### Architectures supportées -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) ## Limitations diff --git a/check_process b/check_process index db9a3ce..10490ea 100644 --- a/check_process +++ b/check_process @@ -18,14 +18,14 @@ setup_private=1 setup_public=1 upgrade=1 + upgrade=1 from_commit=80bdea70f80aafef673718911ad492ddc54aab5c backup_restore=1 multi_instance=0 - port_already_use=0 - change_url=0 + change_url=1 ;;; Options Email= Notification=none ;;; Upgrade options - ; commit= - name= + ; commit=80bdea70f80aafef673718911ad492ddc54aab5c + name=Testing (#23) manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=phrasedepasse&port=9537& diff --git a/manifest.json b/manifest.json index 42d847d..fb7fb09 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Web-based cross-platform XMPP client", "fr": "Client XMPP multiplateforme basé sur le Web" }, - "version": "0.19~ynh1", + "version": "0.19~ynh2", "url": "https://movim.eu", "license": "AGPL-3.0-or-later", "maintainer": { @@ -14,7 +14,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 4.0.0" + "yunohost": ">= 4.1.7" }, "multi_instance": false, "services": [ @@ -28,47 +28,27 @@ { "name": "domain", "type": "domain", - "ask": { - "en": "Choose a domain name for Movim", - "fr": "Choisissez un nom de domaine pour Movim" - }, "example": "domain.org" }, { "name": "path", "type": "path", - "ask": { - "en": "Choose a path for Movim", - "fr": "Choisissez un chemin pour Movim" - }, "example": "/movim", "default": "/movim" }, { "name": "admin", "type": "user", - "ask": { - "en": "Choose an admin user", - "fr": "Choisissez l'administrateur" - }, "example": "johndoe" }, { "name": "password", "type": "password", - "ask": { - "en": "Set the administrator password", - "fr": "Définissez le mot de passe administrateur" - }, "example": "Choose a password" }, { "name": "is_public", "type": "boolean", - "ask": { - "en": "Is it a public application?", - "fr": "Est-ce une application publique ?" - }, "default": true } ] diff --git a/scripts/_common.sh b/scripts/_common.sh index 58ebdd4..5617785 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -22,4 +22,3 @@ extra_php_dependencies="php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-mbstrin #================================================= # FUTURE OFFICIAL HELPERS #================================================= - diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..5aa3c0b --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,144 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN +old_path=$YNH_APP_OLD_PATH + +new_domain=$YNH_APP_NEW_DOMAIN +new_path=$YNH_APP_NEW_PATH + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." --weight=1 + +# Needed for helper "ynh_add_nginx_config" +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +phpversion=$(ynh_app_setting_get --app="$app" --key=phpversion) +port=$(ynh_app_setting_get --app=$app --key=port) + +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 + +# 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 + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 +if [ "$old_path" != "$new_path" ] +then + change_path=1 +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." --weight=2 + +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" + +#================================================= +# MODIFY URL IN NGINX CONF +#================================================= +ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 + +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the path in the NGINX config file +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 + +# Change the domain for NGINX +if [ $change_domain -eq 1 ] +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 + +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." --weight=11 + +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Configuring a systemd service..." --weight=4 + +ynh_replace_string --match_string="__DOMAIN__" --replace_string="$new_domain" --target_file=../conf/systemd.service +ynh_replace_string --match_string="__PATH__" --replace_string="$new_path" --target_file=../conf/systemd.service +ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file=../conf/systemd.service +ynh_replace_string --match_string="__PHPVERSION__" --replace_string="$phpversion" --target_file=../conf/systemd.service + +ynh_add_systemd_config + +#================================================= +# GENERIC FINALISATION +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." --weight=2 + +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" + +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index d54b3be..44d4183 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -20,7 +20,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) port=$(ynh_app_setting_get --app=$app --key=port) -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) db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) @@ -38,15 +37,6 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=4 -# Fix is_public as a boolean value -if [ "$is_public" = "Yes" ]; then - ynh_app_setting_set --app=$app --key=is_public --value=1 - is_public=1 -elif [ "$is_public" = "No" ]; then - ynh_app_setting_set --app=$app --key=is_public --value=0 - is_public=0 -fi - # If db_name doesn't exist, create it if [ -z "$db_name" ]; then db_name=$(ynh_sanitize_dbid --db_name=$app) @@ -161,8 +151,6 @@ pushd "$final_path" && php$phpversion composer.phar movim:migrate --quiet popd -#&& php$phpversion composer.phar install --no-interaction --quiet \ - #================================================= # SETUP SYSTEMD #=================================================