From 109e21c78601f5f7cb014ce2dc1ca105094b0f4c Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Sat, 31 Aug 2024 02:56:20 +0200
Subject: [PATCH] [autopatch] Automatic patch attempt for helpers 2.1
---
.gitignore | 1 +
manifest.toml | 3 ++-
scripts/_common.sh | 14 +-------------
scripts/backup | 18 ++++++------------
scripts/change_url | 32 +++++++++++--------------------
scripts/config | 6 +++---
scripts/install | 43 ++++++++++++++++++------------------------
scripts/remove | 18 ++++++------------
scripts/restore | 37 +++++++++++++++---------------------
scripts/upgrade | 47 +++++++++++++++++-----------------------------
10 files changed, 80 insertions(+), 139 deletions(-)
diff --git a/.gitignore b/.gitignore
index 783a4ae..8f144f3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
*~
*.sw[op]
+.DS_Store
diff --git a/manifest.toml b/manifest.toml
index 2fea03e..52fc598 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -17,7 +17,8 @@ code = "https://github.com/Radarr/Radarr"
fund = "https://radarr.video/donate"
[integration]
-yunohost = ">= 11.2"
+yunohost = ">= 11.2.18"
+helpers_version = "2.1"
architectures = ["armhf", "arm64", "amd64", "i386"]
multi_instance = true
ldap = false
diff --git a/scripts/_common.sh b/scripts/_common.sh
index ffca845..0ff4320 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -1,19 +1,7 @@
#!/bin/bash
#=================================================
-# COMMON VARIABLES
+# COMMON VARIABLES AND CUSTOM HELPERS
#=================================================
version="3.2.2.5080"
-
-#=================================================
-# PERSONAL HELPERS
-#=================================================
-
-#=================================================
-# EXPERIMENTAL HELPERS
-#=================================================
-
-#=================================================
-# FUTURE OFFICIAL HELPERS
-#=================================================
diff --git a/scripts/backup b/scripts/backup
index 81559e2..026bdc3 100755
--- a/scripts/backup
+++ b/scripts/backup
@@ -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
@@ -14,19 +8,19 @@ source /usr/share/yunohost/helpers
# BACKUP THE APP MAIN DIR
#=================================================
-ynh_backup --src_path="$install_dir"
+ynh_backup "$install_dir"
#=================================================
# BACKUP THE APP DATA DIR
#=================================================
-ynh_backup --src_path="$data_dir"
+ynh_backup "$data_dir"
#=================================================
# BACKUP THE NGINX CONFIGURATION
#=================================================
-ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# SPECIFIC BACKUP
@@ -34,16 +28,16 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
# BACKUP LOGROTATE
#=================================================
-ynh_backup --src_path="/etc/logrotate.d/$app"
+ynh_backup "/etc/logrotate.d/$app"
#=================================================
# BACKUP SYSTEMD
#=================================================
-ynh_backup --src_path="/etc/systemd/system/$app.service"
+ynh_backup "/etc/systemd/system/$app.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 f4dd460..cea3d59 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -1,29 +1,21 @@
#!/bin/bash
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
-#=================================================
-# 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_systemctl --service=$app --action="stop" --log_path="systemd"
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
-ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
+ynh_script_progression "Updating NGINX web server configuration..."
-ynh_change_url_nginx_config
+ynh_config_change_url_nginx
#=================================================
# SPECIFIC MODIFICATIONS
@@ -31,23 +23,21 @@ ynh_change_url_nginx_config
# UPDATE CONFIGURATION FILE
#=================================================
-ynh_exec_warn_less 'ynh_add_config --template="../conf/config.xml" --destination="$data_dir/config.xml"'
+ynh_hide_warnings 'ynh_config_add --template="config.xml" --destination="$data_dir/config.xml"'
-chmod 750 "$data_dir/config.xml"
-chmod o-rwx "$data_dir/config.xml"
-chown $app "$data_dir/config.xml"
+#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 750 "$data_dir/config.xml"
+#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 o-rwx "$data_dir/config.xml"
+#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 "$data_dir/config.xml"
-#=================================================
-# GENERIC FINALISATION
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=2
+ynh_script_progression "Starting $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Application started" --timeout=30
+ynh_systemctl --service=$app --action="start" --log_path="systemd" --wait_until="Application started" --timeout=30
#=================================================
# 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/config b/scripts/config
index 02a7d01..7cccbbf 100644
--- a/scripts/config
+++ b/scripts/config
@@ -1,12 +1,12 @@
#!/bin/bash
source /usr/share/yunohost/helpers
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
-data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
+data_dir=$(ynh_app_setting_get --key=data_dir)
run__external_authentication() {
- ynh_replace_string --match_string="[[:alnum:]]*" --replace_string="External" --target_file="$data_dir/config.xml"
+ ynh_replace --match="[[:alnum:]]*" --replace="External" --file="$data_dir/config.xml"
}
ynh_app_config_run $1
diff --git a/scripts/install b/scripts/install
index 4b7d790..4aa7c53 100755
--- a/scripts/install
+++ b/scripts/install
@@ -1,58 +1,51 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Setting up source files..." --weight=3
+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"
-
-chmod -R o-rwx "$install_dir"
-chown -R $app: "$install_dir"
+ynh_setup_source --dest_dir="$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: "$install_dir"
#=================================================
# NGINX CONFIGURATION
#=================================================
-ynh_script_progression --message="Configuring NGINX web server..." --weight=1
+ynh_script_progression "Configuring NGINX web server..."
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Create a dedicated systemd config
-ynh_add_systemd_config
+ynh_config_add_systemd
-ynh_use_logrotate
-ynh_use_logrotate --logfile="$data_dir/logs"
+ynh_config_add_logrotate
+ynh_config_add_logrotate "$data_dir/logs"
yunohost service add $app --description="Radarr daemon" --log="$data_dir/logs/radarr.txt"
#=================================================
# ADD A CONFIGURATION
#=================================================
-ynh_script_progression --message="Configuring Radarr..." --weight=2
+ynh_script_progression "Configuring Radarr..."
api_key=$(ynh_string_random --length=32)
-ynh_app_setting_set --app=$app --key=api_key --value=$api_key
+ynh_app_setting_set --key=api_key --value=$api_key
-ynh_add_config --template="../conf/config.xml" --destination="$data_dir/config.xml"
+ynh_config_add --template="config.xml" --destination="$data_dir/config.xml"
-chmod 400 "$data_dir/config.xml"
-chown $app:$app "$data_dir/config.xml"
+#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/config.xml"
+#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/config.xml"
#=================================================
# YUNOHOST MULTIMEDIA INTEGRATION
#=================================================
-ynh_script_progression --message="Adding multimedia directories..." --weight=2
+ynh_script_progression "Adding multimedia directories..."
# Build YunoHost multimedia directories
ynh_multimedia_build_main_dir
@@ -62,13 +55,13 @@ ynh_multimedia_addaccess $app
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=2
+ynh_script_progression "Starting $app's systemd service..."
# Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Application started" --timeout=30
+ynh_systemctl --service=$app --action="start" --log_path="systemd" --wait_until="Application started" --timeout=30
#=================================================
# 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 d13cdf3..376e9d8 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
@@ -16,23 +10,23 @@ source /usr/share/yunohost/helpers
#=================================================
# 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 dedicated systemd config
-ynh_remove_systemd_config
+ynh_config_remove_systemd
# Remove the dedicated NGINX config
-ynh_remove_nginx_config
+ynh_config_remove_nginx
# Remove the app-specific logrotate config
-ynh_remove_logrotate
+ynh_config_remove_logrotate
#=================================================
# 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 16c8284..858280b 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=2
+ynh_script_progression "Restoring the app main directory..."
-ynh_restore_file --origin_path="$install_dir"
-
-chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$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:$app "$install_dir"
#=================================================
# RESTORE THE APP DATA DIR
#=================================================
-ynh_script_progression --message="Restoring the app data directory..." --weight=2
+ynh_script_progression "Restoring the app data directory..."
-ynh_restore_file --origin_path="$data_dir" --not_mandatory
+ynh_restore "$data_dir"
# (Same as for install dir)
chown -R $app: "$data_dir"
@@ -33,21 +26,21 @@ chown -R $app: "$data_dir"
#=================================================
# RESTORE SYSTEMD
#=================================================
-ynh_script_progression --message="Restoring the systemd configuration..." --weight=1
+ynh_script_progression "Restoring $app's systemd service..."
-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 "/etc/systemd/system/$app.service"
systemctl enable $app.service --quiet
-ynh_restore_file --origin_path="/etc/logrotate.d/$app"
+ynh_restore "/etc/logrotate.d/$app"
yunohost service add $app --description="Radarr daemon" --log="$data_dir/logs/radarr.txt"
#=================================================
# YUNOHOST MULTIMEDIA INTEGRATION
#=================================================
-ynh_script_progression --message="Adding multimedia directories..." --weight=2
+ynh_script_progression "Adding multimedia directories..."
# Build YunoHost multimedia directories
ynh_multimedia_build_main_dir
@@ -57,14 +50,14 @@ ynh_multimedia_addaccess $app
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=2
+ynh_script_progression "Starting $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Application started" --timeout=30
+ynh_systemctl --service=$app --action="start" --log_path="systemd" --wait_until="Application started" --timeout=30
-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 6050a1f..75ddc6c 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,67 +1,54 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
-#=================================================
-# CHECK VERSION
-#=================================================
-
-upgrade_type=$(ynh_check_app_version_changed)
-
-#=================================================
-# STANDARD UPGRADE STEPS
#=================================================
# 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_systemctl --service=$app --action="stop" --log_path="systemd"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-if [ "$upgrade_type" == "UPGRADE_APP" ]
+# FIXME: this is still supported but the recommendation is now to *always* re-setup the app sources wether or not the upstream sources changed
+if ynh_app_upstream_version_changed
then
- ynh_script_progression --message="Upgrading source files..." --weight=3
+ ynh_script_progression "Upgrading source files..."
# Download, check integrity, uncompress and patch the source from app.src
- ynh_setup_source --dest_dir="$install_dir"
+ ynh_setup_source --dest_dir="$install_dir"
+
fi
-chmod -R o-rwx "$install_dir"
-chown -R $app: "$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: "$install_dir"
#=================================================
# NGINX CONFIGURATION
#=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
+ynh_script_progression "Upgrading NGINX web server configuration..."
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Create a dedicated systemd config
-ynh_add_systemd_config
+ynh_config_add_systemd
# Use logrotate to manage app-specific logfile(s)
-ynh_use_logrotate --non-append
-ynh_use_logrotate --non-append --logfile="$data_dir/logs"
+ynh_config_add_logrotate
+ynh_config_add_logrotate "$data_dir/logs"
yunohost service add $app --description="Radarr daemon" --log="$data_dir/logs/radarr.txt"
#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=2
+ynh_script_progression "Starting $app's systemd service..."
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Application started" --timeout=30
+ynh_systemctl --service=$app --action="start" --log_path="systemd" --wait_until="Application started" --timeout=30
# We might need to wait a bit further for migrations to finish
sleep 5
@@ -69,4 +56,4 @@ sleep 5
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Upgrade of $app completed" --last
+ynh_script_progression "Upgrade of $app completed"