From 9ac38c79ca9a34561febeb723f7a1e5580512f87 Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Sat, 31 Aug 2024 02:59:28 +0200
Subject: [PATCH] [autopatch] Automatic patch attempt for helpers 2.1

---
 .gitignore         |  1 +
 manifest.toml      |  3 ++-
 scripts/_common.sh | 55 ++++++++++++++++++++++------------------------
 scripts/backup     | 17 ++++----------
 scripts/change_url | 30 +++++++++----------------
 scripts/install    | 26 ++++++++--------------
 scripts/remove     | 17 +++++---------
 scripts/restore    | 24 +++++++-------------
 scripts/upgrade    | 52 +++++++++++++++++++------------------------
 9 files changed, 88 insertions(+), 137 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 2d75bf8..f2c05cf 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -18,7 +18,8 @@ userdoc = "https://docs.searxng.org/user/"
 code = "https://github.com/searxng/searxng"
 
 [integration]
-yunohost = ">= 11.2.14"
+yunohost = ">= 11.2.18"
+helpers_version = "2.1"
 architectures = "all"
 multi_instance = false
 ldap = "not_relevant"
diff --git a/scripts/_common.sh b/scripts/_common.sh
index e91855d..bfed19e 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -1,18 +1,14 @@
 #!/bin/bash
 
 #=================================================
-# COMMON VARIABLES
-#=================================================
-
-#=================================================
-# PERSONAL HELPERS
+# COMMON VARIABLES AND CUSTOM HELPERS
 #=================================================
 
 # Install/Upgrade SearXNG in virtual environement
 myynh_source_searxng () {
 	# Retrieve info from manifest
-	repo_fullpath=$(ynh_read_manifest --manifest_key="upstream.code")
-	commit_sha=$(ynh_read_manifest --manifest_key="resources.sources.main.url" | xargs basename --suffix=".tar.gz")
+	repo_fullpath=$(ynh_read_manifest
+	commit_sha=$(ynh_read_manifest | xargs basename --suffix=".tar.gz")
 
 	# Download source
 	sudo -H -u $app -i bash << EOF
@@ -53,9 +49,9 @@ EOF
 
 # Set permissions
 myynh_set_permissions () {
-	chown -R $app: "$install_dir"
-	chmod 750 "$install_dir"
-	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"
+	#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 750 "$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"
 }
 
 #=================================================
@@ -66,7 +62,7 @@ myynh_set_permissions () {
 #
 # usage: ynh_check_global_uwsgi_config
 ynh_check_global_uwsgi_config () {
-	uwsgi --version || ynh_die --message="You need to add uwsgi (and appropriate plugin) as a dependency"
+	uwsgi --version || ynh_die "You need to add uwsgi (and appropriate plugin) as a dependency"
 
 	cat > "/etc/systemd/system/uwsgi-app@.service" <<EOF
 [Unit]
@@ -98,10 +94,11 @@ EOF
 #
 # To be able to customise the settings of the systemd unit you can override the rules with the file "conf/uwsgi-app@override.service".
 # This file will be automatically placed on the good place
-# 
+#
+
 # Note that the service need to be started manually at the end of the installation.
 # Generally you can start the service with this command:
-# ynh_systemd_action --service_name "uwsgi-app@$app.service" --line_match "WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path "/var/log/uwsgi/$app/$app.log"
+# ynh_systemctl --service "uwsgi-app@$app.service" --wait_until "WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path "/var/log/uwsgi/$app/$app.log"
 #
 # usage: ynh_add_uwsgi_service
 #
@@ -112,10 +109,10 @@ ynh_add_uwsgi_service () {
 	local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini"
 
 	# www-data group is needed since it is this nginx who will start the service
-	usermod --append --groups www-data "$app" || ynh_die --message="It wasn't possible to add user $app to group www-data"
+	usermod --append --groups www-data "$app" || ynh_die "It wasn't possible to add user $app to group www-data"
 
-	ynh_add_config --template="uwsgi.ini" --destination="$finaluwsgiini"
-	ynh_store_file_checksum --file="$finaluwsgiini"
+	ynh_config_add --template="uwsgi.ini" --destination="$finaluwsgiini"
+	ynh_store_file_checksum "$finaluwsgiini"
 	chown $app:root "$finaluwsgiini"
 
 	# make sure the folder for logs exists and set authorizations
@@ -127,11 +124,11 @@ ynh_add_uwsgi_service () {
 	mkdir -p "/etc/systemd/system/uwsgi-app@$app.service.d"
 	if [ -e "../conf/uwsgi-app@override.service" ]
 	then
-		ynh_add_config --template="uwsgi-app@override.service" --destination="/etc/systemd/system/uwsgi-app@$app.service.d/override.conf"
+		ynh_config_add --template="uwsgi-app@override.service" --destination="/etc/systemd/system/uwsgi-app@$app.service.d/override.conf"
 	fi
 
 	systemctl daemon-reload
-	ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="enable"
+	ynh_systemctl --service="uwsgi-app@$app.service" --action="enable"
 
 	# Add as a service
 	yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log"
@@ -145,12 +142,12 @@ ynh_remove_uwsgi_service () {
 	if [ -e "$finaluwsgiini" ]
 	then
 		yunohost service remove "uwsgi-app@$app"
-		ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop"
-		ynh_exec_fully_quiet ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="disable"
+		ynh_systemctl --service="uwsgi-app@$app.service" --action="stop"
+		ynh_systemctl --service="uwsgi-app@$app.service" --action="disable"
 
-		ynh_secure_remove --file="$finaluwsgiini"
-		ynh_secure_remove --file="/var/log/uwsgi/$app"
-		ynh_secure_remove --file="/etc/systemd/system/uwsgi-app@$app.service.d"
+		ynh_safe_rm "$finaluwsgiini"
+		ynh_safe_rm "/var/log/uwsgi/$app"
+		ynh_safe_rm "/etc/systemd/system/uwsgi-app@$app.service.d"
 	fi
 }
 
@@ -159,8 +156,8 @@ ynh_remove_uwsgi_service () {
 #
 # usage: ynh_backup_uwsgi_service
 ynh_backup_uwsgi_service () {
-	ynh_backup --src_path="/etc/uwsgi/apps-available/$app.ini"
-	ynh_backup --src_path="/etc/systemd/system/uwsgi-app@$app.service.d" --not_mandatory
+	ynh_backup "/etc/uwsgi/apps-available/$app.ini"
+	ynh_backup "/etc/systemd/system/uwsgi-app@$app.service.d" || true
 }
 
 # Restore the dedicated uwsgi config
@@ -169,13 +166,13 @@ ynh_backup_uwsgi_service () {
 # usage: ynh_restore_uwsgi_service
 ynh_restore_uwsgi_service () {
 	ynh_check_global_uwsgi_config
-	ynh_restore_file --origin_path="/etc/uwsgi/apps-available/$app.ini"
-	ynh_restore_file --origin_path="/etc/systemd/system/uwsgi-app@$app.service.d" --not_mandatory
+	ynh_restore "/etc/uwsgi/apps-available/$app.ini"
+	ynh_restore "/etc/systemd/system/uwsgi-app@$app.service.d" || true
 
 	mkdir -p "/var/log/uwsgi/$app"
 	chown $app:root "/var/log/uwsgi/$app"
 	chmod -R u=rwX,g=rX,o= "/var/log/uwsgi/$app"
-    
-	ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="enable"
+
+	ynh_systemctl --service="uwsgi-app@$app.service" --action="enable"
 	yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log"
 }
diff --git a/scripts/backup b/scripts/backup
index a40341f..86a7a53 100755
--- a/scripts/backup
+++ b/scripts/backup
@@ -1,30 +1,21 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 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 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
@@ -38,4 +29,4 @@ ynh_backup_uwsgi_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 272bde2..9de3f99 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -1,51 +1,41 @@
 #!/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="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
+ynh_systemctl --service="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
 
 #=================================================
 # 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
 #=================================================
 # RECONFIGURING SEARXNG
 #=================================================
-ynh_script_progression --message="Reconfiguring SearXNG..." --weight=2
+ynh_script_progression "Reconfiguring SearXNG..."
 
-ynh_replace_string --match_string="base_url: https://$old_domain$old_path" --replace_string="base_url: https://$new_domain$new_path" --target_file="$install_dir/settings.yml"
-ynh_replace_string --match_string="instance_name: SearXNG - $old_domain" --replace_string="instance_name: SearXNG - $new_domain" --target_file="$install_dir/settings.yml"
+ynh_replace --match="base_url: https://$old_domain$old_path" --replace="base_url: https://$new_domain$new_path" --file="$install_dir/settings.yml"
+ynh_replace --match="instance_name: SearXNG - $old_domain" --replace="instance_name: SearXNG - $new_domain" --file="$install_dir/settings.yml"
 
-#=================================================
-# GENERIC FINALISATION
 #=================================================
 # 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="uwsgi-app@$app.service" --action="start" --log_path="/var/log/uwsgi/$app/$app.log"
+ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --log_path="/var/log/uwsgi/$app/$app.log"
 
 #=================================================
 # 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 fa616c5..f84c5b2 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,18 +8,18 @@ source /usr/share/yunohost/helpers
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_script_progression --message="Setting up source files..." --weight=1
+ynh_script_progression "Setting up source files..."
 myynh_source_searxng
 
-ynh_script_progression --message="Installing SearXNG..." --weight=2
+ynh_script_progression "Installing SearXNG..."
 myynh_install_searxng
 
 #=================================================
 # SYSTEM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
+ynh_script_progression "Adding system configurations related to $app..."
 
-ynh_add_nginx_config
+ynh_config_add_nginx
 
 ynh_add_uwsgi_service
 
@@ -34,24 +28,22 @@ ynh_add_uwsgi_service
 #=================================================
 # ADD A CONFIGURATION
 #=================================================
-ynh_script_progression --message="Adding a configuration file..." --weight=1
+ynh_script_progression "Adding $app's configuration..."
 
 secret_key=$(ynh_string_random)
-ynh_add_config --template="../conf/settings.yml" --destination="$install_dir/settings.yml"
+ynh_config_add --template="settings.yml" --destination="$install_dir/settings.yml"
 
 myynh_set_permissions
 
-#=================================================
-# GENERIC FINALIZATION
 #=================================================
 # 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="uwsgi-app@$app.service" --action="start" --line_match="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
+ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
 
 #=================================================
 # 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 ef18fc1..7aaa86a 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -1,22 +1,17 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # REMOVE SYSTEM CONFIGURATIONS
 #=================================================
-# REMOVE SYSTEMD SERVICE 
-#=================================================
-ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
+# REMOVE SYSTEMD SERVICE
 
-ynh_remove_nginx_config
+#=================================================
+ynh_script_progression "Removing system configurations related to $app..."
+
+ynh_config_remove_nginx
 
 ynh_remove_uwsgi_service
 
@@ -24,4 +19,4 @@ ynh_remove_uwsgi_service
 # 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 4cd5198..b7d9b34 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -1,20 +1,14 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source ../settings/scripts/_common.sh
 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"
+ynh_restore "$install_dir"
 
 myynh_set_permissions
 
@@ -22,23 +16,21 @@ myynh_set_permissions
 # RESTORE SYSTEM CONFIGURATIONS
 #=================================================
 
-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_uwsgi_service
 
-#=================================================
-# 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="uwsgi-app@$app.service" --action="start" --line_match="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
- 
-ynh_systemd_action --service_name="nginx" --action="reload"
+ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
+
+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 d435a78..fdbf446 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,42 +1,33 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source /usr/share/yunohost/helpers
-upgrade_type=$(ynh_check_app_version_changed)
 
-#=================================================
-# STANDARD UPGRADE STEPS
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
+ynh_script_progression "Ensuring downward compatibility..."
 
 if [ -e "$install_dir/searx" ]; then
 	tempdir="$(mktemp -d)"
 	mv "$install_dir/searx/settings.yml" "$tempdir/settings.yml"
 	sed -i '1s/^/use_default_settings: true\n\n/' "$tempdir/settings.yml"
-	ynh_secure_remove --file="$install_dir"
+	ynh_safe_rm "$install_dir"
 	mkdir "$install_dir"
 	mv "$tempdir/settings.yml" "$install_dir/settings.yml"
-	ynh_secure_remove --file="$tempdir"
-	ynh_store_file_checksum --file="$install_dir/settings.yml"
-	ynh_delete_file_checksum --file="/opt/yunohost/$app/searx/settings.yml"
+	ynh_safe_rm "$tempdir"
+	ynh_store_file_checksum "$install_dir/settings.yml"
+	ynh_delete_file_checksum "/opt/yunohost/$app/searx/settings.yml"
 fi
 
-ynh_delete_file_checksum --file="etc/nginx_conf.d/$domain/$app.conf"
-	
+ynh_delete_file_checksum "etc/nginx_conf.d/$domain/$app.conf"
+
 #=================================================
 # 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="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
+ynh_systemctl --service="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
 
 #=================================================
 # "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...)
@@ -44,12 +35,13 @@ ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop" --log
 # 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_secure_remove --file="$install_dir/.profile"
-	ynh_secure_remove --file="$install_dir/.cache"
-	ynh_secure_remove --file="$install_dir/searxng-src"
-	ynh_secure_remove --file="$install_dir/searxng-pyenv"
+	ynh_safe_rm "$install_dir/.profile"
+	ynh_safe_rm "$install_dir/.cache"
+	ynh_safe_rm "$install_dir/searxng-src"
+	ynh_safe_rm "$install_dir/searxng-pyenv"
 	myynh_source_searxng
 	myynh_install_searxng
 fi
@@ -59,28 +51,28 @@ myynh_set_permissions
 #=================================================
 # REAPPLY SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
+ynh_script_progression "Upgrading system configurations related to $app..."
 
-ynh_add_nginx_config
+ynh_config_add_nginx
 
 #=================================================
 # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Updating a configuration file..." --weight=1
+ynh_script_progression "Updating configuration..."
 
 ynh_add_uwsgi_service
 
 #=================================================
 # START SYSTEMD SERVICE
 #=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
-                                                     
-ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="start" --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log"
+ynh_script_progression "Starting $app's systemd service..."
+
+ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Upgrade of $app completed" --last
+ynh_script_progression "Upgrade of $app completed"