From c1b73275f6905b9d0b6533cbdc9f8afea9ecedeb Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Fri, 30 Aug 2024 22:56:31 +0200
Subject: [PATCH 1/2] [autopatch] Automatic patch attempt for helpers 2.1
---
.gitignore | 3 +-
manifest.toml | 3 +-
scripts/_common.sh | 14 +-----
scripts/backup | 23 +++-------
scripts/change_url | 56 ++++++++++--------------
scripts/install | 88 +++++++++++++++++---------------------
scripts/remove | 28 +++++-------
scripts/restore | 39 +++++++----------
scripts/upgrade | 104 ++++++++++++++++++++-------------------------
9 files changed, 147 insertions(+), 211 deletions(-)
diff --git a/.gitignore b/.gitignore
index 90c63c5..795e2dd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
.DS_Store
-._.DS_Store
\ No newline at end of file
+._.DS_Store*~
+*.sw[op]
diff --git a/manifest.toml b/manifest.toml
index 3561a5e..518c04d 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -18,7 +18,8 @@ userdoc = "https://galene.org/faq.html"
code = "https://github.com/jech/galene"
[integration]
-yunohost = ">= 11.2.20"
+yunohost = ">= 11.2.18"
+helpers_version = "2.1"
architectures = "all"
multi_instance = false
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 157c97e..affddab 100755
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -1,19 +1,7 @@
#!/bin/bash
#=================================================
-# COMMON VARIABLES
+# COMMON VARIABLES AND CUSTOM HELPERS
#=================================================
go_version=1.22
-
-#=================================================
-# PERSONAL HELPERS
-#=================================================
-
-#=================================================
-# EXPERIMENTAL HELPERS
-#=================================================
-
-#=================================================
-# FUTURE OFFICIAL HELPERS
-#=================================================
diff --git a/scripts/backup b/scripts/backup
index c2cadee..e6176d5 100755
--- a/scripts/backup
+++ b/scripts/backup
@@ -1,43 +1,34 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
-#=================================================
-# DECLARE DATA AND CONF FILES TO BACKUP
-#=================================================
-ynh_print_info --message="Declaring files to be backed up..."
+ynh_print_info "Declaring files to be backed up..."
#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
-ynh_backup --src_path="$install_dir"
+ynh_backup "$install_dir"
#=================================================
# BACKUP THE DATA DIR
#=================================================
-ynh_backup --src_path="$data_dir" --is_big
+ynh_backup "$data_dir"
#=================================================
# SYSTEM CONFIGURATION
#=================================================
-ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
-ynh_backup --src_path="/etc/systemd/system/$app.service"
-ynh_backup --src_path="/etc/systemd/system/${app}_ldap.service"
+ynh_backup "/etc/systemd/system/$app.service"
+ynh_backup "/etc/systemd/system/${app}_ldap.service"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
+ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
diff --git a/scripts/change_url b/scripts/change_url
index af6eb2d..8b3e248 100755
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -1,80 +1,70 @@
#!/bin/bash
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+ynh_script_progression "Loading installation settings..."
-key=$(ynh_app_setting_get --app=$app --key=key)
-password_hash=$(ynh_app_setting_get --app=$app --key=password_hash)
+key=$(ynh_app_setting_get --key=key)
+password_hash=$(ynh_app_setting_get --key=password_hash)
-#=================================================
-# STANDARD MODIFICATIONS
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Stopping a systemd service..." --weight=1
+ynh_script_progression "Stopping $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="stop" --log_path="systemd"
+ynh_systemctl --service=$app --action="stop" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="stop" --log_path="systemd"
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
-ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2
+ynh_script_progression "Updating NGINX web server configuration..."
-ynh_change_url_nginx_config
+ynh_config_change_url_nginx
#=================================================
# SPECIFIC MODIFICATIONS
#=================================================
# UPDATE A CONFIG FILE
#=================================================
-ynh_script_progression --message="Updating a configuration file..." --weight=2
+ynh_script_progression "Updating configuration..."
domain="$new_domain"
# Configure Galène
-ynh_add_config --template="config.json" --destination="$install_dir/live/data/config.json"
-chmod 400 "$install_dir/live/data/config.json"
-chown $app:$app "$install_dir/live/data/config.json"
+ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galene LDAP
-#ynh_add_config --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
+#ynh_config_add --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
#chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
#chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
-#ynh_add_config --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-#chmod 400 "$data_dir/groups/$group_name.json"
-#chown $app:$app "$data_dir/groups/$group_name.json"
+#ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
+##REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
+##REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
-ynh_add_config --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-chmod 400 "$data_dir/groups/YunoHost_Users.json"
-chown $app:$app "$data_dir/groups/YunoHost_Users.json"
+ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
-#=================================================
-# GENERIC FINALISATION
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=3
+ynh_script_progression "Starting $app's systemd service..."
# Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="start" --log_path="systemd"
+ynh_systemctl --service=$app --action="start" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Change of URL completed for $app" --last
+ynh_script_progression "Change of URL completed for $app"
diff --git a/scripts/install b/scripts/install
index 0a2fcf1..48de33f 100755
--- a/scripts/install
+++ b/scripts/install
@@ -1,11 +1,5 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
@@ -14,22 +8,20 @@ source /usr/share/yunohost/helpers
#=================================================
password=$YNH_APP_ARG_PASSWORD
-ynh_app_setting_set --app=$app --key=password --value="$password"
+ynh_app_setting_set --key=password --value="$password"
-#=================================================
-# STANDARD MODIFICATIONS
#=================================================
# FIND AND OPEN A PORT
#=================================================
-ynh_script_progression --message="Configuring firewall..." --weight=1
+ynh_script_progression "Configuring firewall..."
# Reserve UDP Port range 49152:65535
-ynh_exec_warn_less yunohost firewall allow UDP -4 49152:65535
+ynh_hide_warnings yunohost firewall allow UDP -4 49152:65535
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Setting up source files..." --weight=1
+ynh_script_progression "Setting up source files..."
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir/build"
@@ -39,85 +31,83 @@ mkdir -p "$install_dir/live/data"
mkdir -p "$install_dir/live_ldap/data"
cp -r "$install_dir/build/static/" "$install_dir/live/"
-ynh_replace_string --match_string="
" --replace_string="" --target_file="$install_dir/live/static/galene.html"
-
-chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$install_dir"
+ynh_replace --match="" --replace="" --file="$install_dir/live/static/galene.html"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# SPECIFIC SETUP
#=================================================
# BUILD APP
#=================================================
-ynh_script_progression --message="Building app..." --weight=1
+ynh_script_progression "Building app..."
-ynh_exec_warn_less ynh_install_go --go_version=$go_version
-ynh_use_go
+ynh_go_install
pushd $install_dir/build/galene-password-generator/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -o $install_dir/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -o $install_dir/
popd
pushd $install_dir/build/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -ldflags='-s -w' -o $install_dir/live/
popd
pushd $install_dir/build_ldap/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live_ldap/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -ldflags='-s -w' -o $install_dir/live_ldap/
popd
-ynh_remove_go
-ynh_secure_remove --file="$install_dir/build/"
-ynh_secure_remove --file="$install_dir/build_ldap/"
-ynh_secure_remove --file="$install_dir/.cache/"
-ynh_secure_remove --file="$install_dir/go/"
-ynh_secure_remove --file="$install_dir/.go-version"
+ynh_go_remove
+ynh_safe_rm "$install_dir/build/"
+ynh_safe_rm "$install_dir/build_ldap/"
+ynh_safe_rm "$install_dir/.cache/"
+ynh_safe_rm "$install_dir/go/"
+ynh_safe_rm "$install_dir/.go-version"
chmod +x "$install_dir/galene-password-generator"
#=================================================
# ADD A CONFIGURATION
#=================================================
-ynh_script_progression --message="Adding a configuration file..." --weight=1
+ynh_script_progression "Adding $app's configuration..."
password_hash=$(echo $($install_dir/galene-password-generator $password))
-ynh_app_setting_set --app=$app --key=password_hash --value="$password_hash"
+ynh_app_setting_set --key=password_hash --value="$password_hash"
# Configure Galène
-ynh_add_config --template="config.json" --destination="$install_dir/live/data/config.json"
-chmod 400 "$install_dir/live/data/config.json"
-chown $app:$app "$install_dir/live/data/config.json"
+ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
-ynh_app_setting_set --app=$app --key=key --value="$key"
-ynh_add_config --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
+ynh_app_setting_set --key=key --value="$key"
+ynh_config_add --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
-ynh_add_config --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-chmod 400 "$data_dir/groups/$group_name.json"
-chown $app:$app "$data_dir/groups/$group_name.json"
+ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
-ynh_add_config --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-chmod 400 "$data_dir/groups/YunoHost_Users.json"
-chown $app:$app "$data_dir/groups/YunoHost_Users.json"
+ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# SYSTEM CONFIGURATION
#=================================================
-ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
+ynh_script_progression "Adding system configurations related to $app..."
public_ip4="$(curl -s ip.yunohost.org)" || true
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Create a dedicated systemd config
-ynh_add_systemd_config
-ynh_add_systemd_config --service=${app}_ldap --template="ldap.service"
+ynh_config_add_systemd
+ynh_config_add_systemd --service=${app}_ldap --template="ldap.service"
yunohost service add $app --description="Videoconferencing server" --needs_exposed_ports="$port_turn"
yunohost service add ${app}_ldap --description="LDAP integration for the videoconferencing server"
@@ -125,14 +115,14 @@ yunohost service add ${app}_ldap --description="LDAP integration for the videoco
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
+ynh_script_progression "Starting $app's systemd service..."
# Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="start" --log_path="systemd"
+ynh_systemctl --service=$app --action="start" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Installation of $app completed" --last
+ynh_script_progression "Installation of $app completed"
diff --git a/scripts/remove b/scripts/remove
index 7d80332..6e8756c 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -1,11 +1,5 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
@@ -14,27 +8,27 @@ source /usr/share/yunohost/helpers
#=================================================
# REMOVE SERVICE INTEGRATION IN YUNOHOST
#=================================================
-ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
+ynh_script_progression "Removing system configurations related to $app..."
# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
-if ynh_exec_warn_less yunohost service status $app >/dev/null
+if ynh_hide_warnings yunohost service status $app >/dev/null
then
- ynh_script_progression --message="Removing $app service integration..." --weight=1
+ ynh_script_progression "Removing $app service integration..."
yunohost service remove $app
fi
# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
-if ynh_exec_warn_less yunohost service status ${app}_ldap >/dev/null
+if ynh_hide_warnings yunohost service status ${app}_ldap >/dev/null
then
- ynh_script_progression --message="Removing ${app}_ldap service integration..." --weight=1
+ ynh_script_progression "Removing ${app}_ldap service integration..."
yunohost service remove ${app}_ldap
fi
# Remove the dedicated systemd config
-ynh_remove_systemd_config
-ynh_remove_systemd_config --service=${app}_ldap
+ynh_config_remove_systemd
+ynh_config_remove_systemd${app}_ldap
# Remove the dedicated NGINX config
-ynh_remove_nginx_config
+ynh_config_remove_nginx
#=================================================
# CLOSE A PORT
@@ -42,12 +36,12 @@ ynh_remove_nginx_config
if yunohost firewall list | grep -q "\- 49152:65535"
then
- ynh_script_progression --message="Closing UDP ports..." --weight=1
- ynh_exec_warn_less yunohost firewall disallow UDP 49152:65535
+ ynh_script_progression "Closing UDP ports..."
+ ynh_hide_warnings yunohost firewall disallow UDP 49152:65535
fi
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Removal of $app completed" --last
+ynh_script_progression "Removal of $app completed"
diff --git a/scripts/restore b/scripts/restore
index 9dbd5d9..ff5a255 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -1,11 +1,5 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
@@ -13,19 +7,18 @@ source /usr/share/yunohost/helpers
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
-ynh_script_progression --message="Restoring the app main directory..." --weight=1
+ynh_script_progression "Restoring the app main directory..."
-ynh_restore_file --origin_path="$install_dir"
-
-chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$install_dir"
+ynh_restore "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# RESTORE THE DATA DIRECTORY
#=================================================
-ynh_script_progression --message="Restoring the data directory..." --weight=1
+ynh_script_progression "Restoring the data directory..."
-ynh_restore_file --origin_path="$data_dir" --not_mandatory
+ynh_restore "$data_dir"
chown -R $app:www-data "$data_dir"
@@ -34,31 +27,29 @@ chown -R $app:www-data "$data_dir"
#=================================================
# RESTORE THE PHP-FPM CONFIGURATION
#=================================================
-ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
+ynh_script_progression "Restoring system configurations related to $app..."
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf"
-ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
-ynh_restore_file --origin_path="/etc/systemd/system/${app}_ldap.service"
+ynh_restore "/etc/systemd/system/$app.service"
+ynh_restore "/etc/systemd/system/${app}_ldap.service"
systemctl enable $app.service --quiet
yunohost service add $app --description="Videoconferencing server" --needs_exposed_ports="$port_turn"
yunohost service add ${app}_ldap --description="LDAP integration for the videoconferencing server"
-#=================================================
-# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
#=================================================
-ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
+ynh_script_progression "Reloading NGINX web server and $app's service..."
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="start" --log_path="systemd"
+ynh_systemctl --service=$app --action="start" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
-ynh_systemd_action --service_name=nginx --action=reload
+ynh_systemctl --service=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Restoration completed for $app" --last
+ynh_script_progression "Restoration completed for $app"
diff --git a/scripts/upgrade b/scripts/upgrade
index 5bf9c01..daa47c1 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,11 +1,5 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
@@ -13,22 +7,20 @@ source /usr/share/yunohost/helpers
# LOAD SETTINGS
#=================================================
-password=$(ynh_app_setting_get --app=$app --key=password)
+password=$(ynh_app_setting_get --key=password)
-#=================================================
-# STANDARD UPGRADE STEPS
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Stopping a systemd service..." --weight=3
+ynh_script_progression "Stopping $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="stop" --log_path="systemd"
+ynh_systemctl --service=$app --action="stop" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="stop" --log_path="systemd"
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
+ynh_script_progression "Ensuring downward compatibility..."
# For version 0.6~ynh1 and before
if [[ ! -d "$install_dir/live" ]]
@@ -39,104 +31,102 @@ then
mv $tempdir/$app/galene "$install_dir/live/"
mv $tempdir/$app/data/ "$install_dir/live/"
mv $tempdir/$app/static/ "$install_dir/live/"
- ynh_secure_remove --file="$tempdir"
+ ynh_safe_rm "$tempdir"
fi
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Upgrading source files..." --weight=2
+ynh_script_progression "Upgrading source files..."
-ynh_setup_source --dest_dir="$install_dir/build" --full_replace=1
-ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" --full_replace=1
+ynh_setup_source --dest_dir="$install_dir/build" --full_replace
+ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" --full_replace
mkdir -p "$install_dir/live/data"
mkdir -p "$install_dir/live_ldap/data"
-ynh_secure_remove --file="$install_dir/live/static/"
+ynh_safe_rm "$install_dir/live/static/"
cp -r "$install_dir/build/static/" "$install_dir/live/"
-ynh_replace_string --match_string="" --replace_string="" --target_file="$install_dir/live/static/galene.html"
+ynh_replace --match="" --replace="" --file="$install_dir/live/static/galene.html"
-chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$install_dir"
-
-#=================================================
-# SPECIFIC UPGRADE
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# BUILD APP
#=================================================
-ynh_script_progression --message="Building app..." --weight=1
+ynh_script_progression "Building app..."
-ynh_exec_warn_less ynh_install_go --go_version=$go_version
-ynh_use_go
+ynh_go_install
pushd $install_dir/build/galene-password-generator/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -o $install_dir/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -o $install_dir/
popd
pushd $install_dir/build/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -ldflags='-s -w' -o $install_dir/live/
popd
pushd $install_dir/build_ldap/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live_ldap/
+ ynh_hide_warnings ynh_exec_as_app CGO_ENABLED=0 go build -ldflags='-s -w' -o $install_dir/live_ldap/
popd
-ynh_remove_go
-ynh_secure_remove --file="$install_dir/build/"
-ynh_secure_remove --file="$install_dir/build_ldap/"
-ynh_secure_remove --file="$install_dir/.cache/"
-ynh_secure_remove --file="$install_dir/go/"
-ynh_secure_remove --file="$install_dir/.go-version"
+ynh_go_remove
+ynh_safe_rm "$install_dir/build/"
+ynh_safe_rm "$install_dir/build_ldap/"
+ynh_safe_rm "$install_dir/.cache/"
+ynh_safe_rm "$install_dir/go/"
+ynh_safe_rm "$install_dir/.go-version"
chmod +x "$install_dir/galene-password-generator"
#=================================================
# UPDATE A CONFIG FILE
#=================================================
-ynh_script_progression --message="Updating a configuration file..." --weight=2
+ynh_script_progression "Updating configuration..."
# If password_hash doesn't exist, create it
+# FIXMEhelpers2.1: maybe replace with: ynh_app_setting_set_default --key=password_hash --value=$(echo $($install_dir/galene-password-generator $password))
if [ -z "${password_hash:-}" ]; then
password_hash=$(echo $($install_dir/galene-password-generator $password))
- ynh_app_setting_set --app=$app --key=password_hash --value="$password_hash"
+ ynh_app_setting_set --key=password_hash --value="$password_hash"
fi
# Configure Galène
-ynh_add_config --template="config.json" --destination="$install_dir/live/data/config.json"
-chmod 400 "$install_dir/live/data/config.json"
-chown $app:$app "$install_dir/live/data/config.json"
+ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
# If key doesn't exist, create it
+# FIXMEhelpers2.1: maybe replace with: ynh_app_setting_set_default --key=key --value=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
if [ -z "${key:-}" ]; then
key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
- ynh_app_setting_set --app=$app --key=key --value=$key
+ ynh_app_setting_set --key=key --value=$key
fi
-ynh_add_config --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
+ynh_config_add --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
-ynh_add_config --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-chmod 400 "$data_dir/groups/$group_name.json"
-chown $app:$app "$data_dir/groups/$group_name.json"
+ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
-ynh_add_config --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-chmod 400 "$data_dir/groups/YunoHost_Users.json"
-chown $app:$app "$data_dir/groups/YunoHost_Users.json"
+ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# REAPPLY SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
+ynh_script_progression "Upgrading system configurations related to $app..."
public_ip4="$(curl -s ip.yunohost.org)" || true
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Create a dedicated systemd config
-ynh_add_systemd_config
-ynh_add_systemd_config --service=${app}_ldap --template="ldap.service"
+ynh_config_add_systemd
+ynh_config_add_systemd --service=${app}_ldap --template="ldap.service"
yunohost service add $app --description="Videoconferencing server" --needs_exposed_ports="$port_turn"
yunohost service add ${app}_ldap --description="LDAP integration for the videoconferencing server"
@@ -144,13 +134,13 @@ yunohost service add ${app}_ldap --description="LDAP integration for the videoco
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
+ynh_script_progression "Starting $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
-ynh_systemd_action --service_name=${app}_ldap --action="start" --log_path="systemd"
+ynh_systemctl --service=$app --action="start" --log_path="systemd"
+ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Upgrade of $app completed" --last
+ynh_script_progression "Upgrade of $app completed"
From 28eb50320602227400d67595f8ecd1e785fdc9d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?E=CC=81ric=20Gaspar?=
<46165813+ericgaspar@users.noreply.github.com>
Date: Sat, 31 Aug 2024 09:35:29 +0200
Subject: [PATCH 2/2] cleaning
---
manifest.toml | 2 +-
scripts/backup | 1 -
scripts/change_url | 9 ---------
scripts/install | 12 ------------
scripts/remove | 5 +----
scripts/restore | 5 -----
scripts/upgrade | 25 ++++---------------------
7 files changed, 6 insertions(+), 53 deletions(-)
diff --git a/manifest.toml b/manifest.toml
index 518c04d..7daabad 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -18,7 +18,7 @@ userdoc = "https://galene.org/faq.html"
code = "https://github.com/jech/galene"
[integration]
-yunohost = ">= 11.2.18"
+yunohost = ">= 11.2.29"
helpers_version = "2.1"
architectures = "all"
multi_instance = false
diff --git a/scripts/backup b/scripts/backup
index e6176d5..0411be2 100755
--- a/scripts/backup
+++ b/scripts/backup
@@ -1,6 +1,5 @@
#!/bin/bash
-# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
diff --git a/scripts/change_url b/scripts/change_url
index 8b3e248..35f5473 100755
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -36,30 +36,21 @@ ynh_script_progression "Updating configuration..."
domain="$new_domain"
# Configure Galène
ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galene LDAP
#ynh_config_add --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
-#chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
-#chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
#ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-##REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
-##REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression "Starting $app's systemd service..."
-# Start a systemd service
ynh_systemctl --service=$app --action="start" --log_path="systemd"
ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
diff --git a/scripts/install b/scripts/install
index 48de33f..da0a6ca 100755
--- a/scripts/install
+++ b/scripts/install
@@ -23,7 +23,6 @@ ynh_hide_warnings yunohost firewall allow UDP -4 49152:65535
#=================================================
ynh_script_progression "Setting up source files..."
-# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir/build"
ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap"
@@ -33,8 +32,6 @@ mkdir -p "$install_dir/live_ldap/data"
cp -r "$install_dir/build/static/" "$install_dir/live/"
ynh_replace --match="" --replace="" --file="$install_dir/live/static/galene.html"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# SPECIFIC SETUP
#=================================================
@@ -75,8 +72,6 @@ ynh_app_setting_set --key=password_hash --value="$password_hash"
# Configure Galène
ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
@@ -87,13 +82,9 @@ chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# SYSTEM CONFIGURATION
@@ -102,10 +93,8 @@ ynh_script_progression "Adding system configurations related to $app..."
public_ip4="$(curl -s ip.yunohost.org)" || true
-# Create a dedicated NGINX config
ynh_config_add_nginx
-# Create a dedicated systemd config
ynh_config_add_systemd
ynh_config_add_systemd --service=${app}_ldap --template="ldap.service"
@@ -117,7 +106,6 @@ yunohost service add ${app}_ldap --description="LDAP integration for the videoco
#=================================================
ynh_script_progression "Starting $app's systemd service..."
-# Start a systemd service
ynh_systemctl --service=$app --action="start" --log_path="systemd"
ynh_systemctl --service=${app}_ldap --action="start" --log_path="systemd"
diff --git a/scripts/remove b/scripts/remove
index 6e8756c..02d2565 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -10,24 +10,21 @@ source /usr/share/yunohost/helpers
#=================================================
ynh_script_progression "Removing system configurations related to $app..."
-# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
if ynh_hide_warnings yunohost service status $app >/dev/null
then
ynh_script_progression "Removing $app service integration..."
yunohost service remove $app
fi
-# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
+
if ynh_hide_warnings yunohost service status ${app}_ldap >/dev/null
then
ynh_script_progression "Removing ${app}_ldap service integration..."
yunohost service remove ${app}_ldap
fi
-# Remove the dedicated systemd config
ynh_config_remove_systemd
ynh_config_remove_systemd${app}_ldap
-# Remove the dedicated NGINX config
ynh_config_remove_nginx
#=================================================
diff --git a/scripts/restore b/scripts/restore
index ff5a255..bea4358 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -1,6 +1,5 @@
#!/bin/bash
-# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
@@ -11,8 +10,6 @@ ynh_script_progression "Restoring the app main directory..."
ynh_restore "$install_dir"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# RESTORE THE DATA DIRECTORY
#=================================================
@@ -25,8 +22,6 @@ chown -R $app:www-data "$data_dir"
#=================================================
# RESTORE SYSTEM CONFIGURATIONS
#=================================================
-# RESTORE THE PHP-FPM CONFIGURATION
-#=================================================
ynh_script_progression "Restoring system configurations related to $app..."
ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf"
diff --git a/scripts/upgrade b/scripts/upgrade
index daa47c1..2933a6a 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -49,8 +49,6 @@ ynh_safe_rm "$install_dir/live/static/"
cp -r "$install_dir/build/static/" "$install_dir/live/"
ynh_replace --match="" --replace="" --file="$install_dir/live/static/galene.html"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
-#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
#=================================================
# BUILD APP
#=================================================
@@ -83,36 +81,23 @@ chmod +x "$install_dir/galene-password-generator"
ynh_script_progression "Updating configuration..."
# If password_hash doesn't exist, create it
-# FIXMEhelpers2.1: maybe replace with: ynh_app_setting_set_default --key=password_hash --value=$(echo $($install_dir/galene-password-generator $password))
-if [ -z "${password_hash:-}" ]; then
- password_hash=$(echo $($install_dir/galene-password-generator $password))
- ynh_app_setting_set --key=password_hash --value="$password_hash"
-fi
+ynh_app_setting_set_default --key=password_hash --value=$(echo $($install_dir/galene-password-generator $password))
+
# Configure Galène
ynh_config_add --template="config.json" --destination="$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/live/data/config.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
-# If key doesn't exist, create it
-# FIXMEhelpers2.1: maybe replace with: ynh_app_setting_set_default --key=key --value=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
-if [ -z "${key:-}" ]; then
- key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
- ynh_app_setting_set --key=key --value=$key
-fi
+ynh_app_setting_set_default --key=key --value=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
+
ynh_config_add --template="galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
ynh_config_add --template="groupname.json" --destination="$data_dir/groups/$group_name.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/$group_name.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
ynh_config_add --template="groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$data_dir/groups/YunoHost_Users.json"
-#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# REAPPLY SYSTEM CONFIGURATIONS
@@ -121,10 +106,8 @@ ynh_script_progression "Upgrading system configurations related to $app..."
public_ip4="$(curl -s ip.yunohost.org)" || true
-# Create a dedicated NGINX config
ynh_config_add_nginx
-# Create a dedicated systemd config
ynh_config_add_systemd
ynh_config_add_systemd --service=${app}_ldap --template="ldap.service"