Fix

scripts/_common.sh

@@ -5,8 +5,10 @@
 # COMMON VARIABLES
 #=================================================
 
+YNH_PHP_VERSION="7.3"
+
 # dependencies used by the app
-pkg_dependencies=""
+extra_php_dependencies="php${YNH_PHP_VERSION}-zip"
 
 #=================================================
 # PERSONAL HELPERS

scripts/backup

@@ -1,33 +1,63 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# See comments in install script
+source ../settings/scripts/_common.sh
-app=$YNH_APP_INSTANCE_NAME
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Backup sources & data
+#=================================================
-# Note: the last argument is where to save this path, see the restore script.
+# MANAGE SCRIPT FAILURE
-ynh_backup "/var/www/${app}" "sources"
+#=================================================
 
-### MySQL (remove if not used) ###
+# Exit if an error occurs during the execution of the script
-# If a MySQL database is used:
+ynh_abort_if_errors
-# # Dump the database
-# dbname=$app
-# dbuser=$app
-# dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
-# mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./dump.sql
-### MySQL end ###
 
-# Copy NGINX configuration
+#=================================================
-domain=$(ynh_app_setting_get "$app" domain)
+# LOAD SETTINGS
-ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf"
+#=================================================
+ynh_print_info --message="Loading installation settings..."
 
-### PHP (remove if not used) ###
+app=$YNH_APP_INSTANCE_NAME
-# If a dedicated php-fpm process is used:
+
-# # Copy PHP-FPM pool configuration
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-# ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "php-fpm.conf"
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-### PHP end ###
+phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+
+#=================================================
+# DECLARE DATA AND CONF FILES TO BACKUP
+#=================================================
+ynh_print_info --message="Declaring files to be backed up..."
+
+#=================================================
+# BACKUP THE APP MAIN DIR
+#=================================================
+
+ynh_backup --src_path="$final_path"
+
+#=================================================
+# BACKUP THE NGINX CONFIGURATION
+#=================================================
+
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+#=================================================
+# BACKUP THE PHP-FPM CONFIGURATION
+#=================================================
+
+ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+
+#=================================================
+# BACKUP THE MYSQL DATABASE
+#=================================================
+ynh_print_info --message="Backing up the MySQL database..."
+
+ynh_mysql_dump_db --database="$db_name" > db.sql
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/install

@@ -23,7 +23,6 @@ ynh_abort_if_errors
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-# Retrieve arguments
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
@@ -33,25 +32,22 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
+ynh_script_progression --message="Validating installation parameters..." --time --weight=1
 
 final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
 
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
-
-# Check web path availability
-ynh_webpath_available $domain $path_url
 # Register (book) web path
-ynh_webpath_register $app $domain $path_url
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_script_progression --message="Storing installation settings..." --time --weight=1
 
-ynh_app_setting_set $app domain $domain
+ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set $app path $path_url
+ynh_app_setting_set --app=$app --key=path --value=$path_url
-ynh_app_setting_set $app is_public $is_public
+ynh_app_setting_set --app=$app --key=is_public --value=$is_public
 
 #==============================================
 # INSTALL DEPS
@@ -69,35 +65,51 @@ port=$(ynh_find_port 8096)
 yunohost firewall allow --no-upnp TCP $port 2>&1
 ynh_app_setting_set $app port $port
 
+#=================================================
+# STANDARD MODIFICATIONS
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
+ynh_script_progression --message="Creating a MySQL database..." --weight=2
 
 db_name=$(ynh_sanitize_dbid $app)
-ynh_app_setting_set $app db_name $db_name
+ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_mysql_setup_db $db_name $db_name
+ynh_mysql_setup_db --db_user=$db_name --db_name=$db_name
+db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_script_progression --message="Setting up source files..." --weight=7
 
-ynh_app_setting_set $app final_path $final_path
+ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source "$final_path"
+ynh_setup_source --dest_dir="$final_path"
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Configuring system user..." --weight=2
 
 # Create a system user
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
+
+#=================================================
+# PHP-FPM CONFIGURATION
+#=================================================
+ynh_script_progression --message="Configuring PHP-FPM..." --weight=2
+
+# Create a dedicated PHP-FPM config
+ynh_add_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependencies"
+phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # MODIFY A CONFIG FILE
@@ -105,18 +117,14 @@ ynh_system_user_create $app
 
 cp -a ../conf/database.php $final_path/app/Config/database.php
 
-ynh_replace_string "__DBUSER__"   "$db_name"   "$final_path/app/Config/database.php"
+ynh_replace_string --match_string="__DBUSER__" --replace_string="$db_name" --target_file="$final_path/app/Config/database.php"
-ynh_replace_string "__DBPWD__"    "$db_pwd"    "$final_path/app/Config/database.php"
+ynh_replace_string --match_string="__DBPWD__"  --replace_string="$db_pwd"  --target_file="$final_path/app/Config/database.php"
-ynh_replace_string "__DBNAME__"   "$db_name"   "$final_path/app/Config/database.php"
+ynh_replace_string --match_string="__DBNAME__" --replace_string="$db_name" --target_file="$final_path/app/Config/database.php"
 
 #=================================================
 # STORE THE CONFIG FILE CHECKSUM
 #=================================================
 
-### `ynh_store_file_checksum` is used to store the checksum of a file.
-### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`,
-### you can make a backup of this file before modifying it again if the admin had modified it.
-
 # Calculate and store the config file checksum into the app settings
 ynh_store_file_checksum "$final_path/app/Config/database.php"
 
@@ -130,6 +138,7 @@ ynh_store_file_checksum "$final_path/app/Config/database.php"
 chown -R www-data:www-data $final_path
 chmod -R 775 $final_path
 
+
 #=================================================
 # SETUP SSOWAT
 #=================================================

scripts/remove

@@ -12,71 +12,79 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_script_progression --message="Loading installation settings..." --weight=3
 
 app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get $app domain)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-port=$(ynh_app_setting_get $app port)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
 #=================================================
 # STANDARD REMOVE
 #=================================================
-
+# REMOVE SERVICE FROM ADMIN PANEL
-ynh_package_remove emby-server
-
-#=================================================
-# REMOVE DEPENDENCIES
 #=================================================
 
-# Remove metapackage and its dependencies
+# Remove a service from the admin panel, added by `yunohost service add`
-#ynh_remove_app_dependencies
+if yunohost service status $app >/dev/null 2>&1
+then
+	ynh_script_progression --message="Removing $app service..." --weight=2
+	yunohost service remove $app
+fi
+
+#=================================================
+# STOP AND REMOVE SERVICE
+#=================================================
+ynh_script_progression --message="Stopping and removing the systemd service..." --weight=2
+
+# Remove the dedicated systemd config
+ynh_remove_systemd_config
+
+#=================================================
+# REMOVE THE MYSQL DATABASE
+#=================================================
+ynh_script_progression --message="Removing the MySQL database..." --weight=4
+
+# Remove a database if it exists, along with the associated user
+ynh_mysql_remove_db --db_user=$db_name --db_name=$db_name
 
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
+ynh_script_progression --message="Removing app main directory..." --weight=4
 
 # Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
 
-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
 #=================================================
-# CLOSE A PORT
+# REMOVE PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=3
 
-if yunohost firewall list | grep -q "\- $port$"
+# Remove the dedicated PHP-FPM config
-then
+ynh_remove_fpm_config
-	echo "Close port $port" >&2
-	yunohost firewall disallow TCP $port 2>&1
-fi
-
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE THE CRON FILE
-#=================================================
-
-# Remove a cron file
-ynh_secure_remove "/etc/cron.d/$app"
-
-# Remove a directory securely
-ynh_secure_remove "/etc/apt/sources.list.d/onlyoffice.list"
-
-
-# Remove the log files
-ynh_secure_remove "/var/log/$app/"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Removing the dedicated system user..." --weight=1
 
 # Delete a system user
-ynh_system_user_delete $app
+ynh_system_user_delete --username=$app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Removal of $app completed" --last