v2

conf/app.src

@@ -1,7 +0,0 @@
-SOURCE_URL=https://piwigo.org/download/dlcounter.php?code=13.8.0
-SOURCE_SUM=7f6a2a796693a4ce245fd67ebdd8bf873dc6cb1a33acd567104a10347af7fe1d
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=zip
-SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=
-SOURCE_EXTRACT=true

conf/ldap_plugin.src

@@ -1,5 +0,0 @@
-SOURCE_URL=https://piwigo.org/ext/download.php?rid=7036
-SOURCE_SUM=3c22652f6c0653aaeebe239435796748ee57612ad44e8e5f2553277545d36e5e
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=zip
-SOURCE_IN_SUBDIR=true

conf/log_failed_logins_plugin.src

@@ -1,5 +0,0 @@
-SOURCE_URL=http://piwigo.org/ext/download.php?rid=5525
-SOURCE_SUM=85b9a06f2c7ca8ae9698e6151c7631f519c945f696b02da72f9ff53243d7e4ca
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=zip
-SOURCE_IN_SUBDIR=false

conf/nginx.conf

@@ -2,7 +2,7 @@
 location __PATH__/ {
 
   # Path to source
-  alias __FINALPATH__/;
+  alias __INSTALL_DIR__/;
 
   index index.php;
 

manifest.toml

@@ -0,0 +1,82 @@
+packaging_format = 2
+
+id = "piwigo"
+name = "Piwigo"
+description.en = "Open source photo gallery for the web"
+description.fr = "Galerie de photos open source pour le web"
+
+version = "13.8.0~ynh1"
+
+maintainers = ["JimboJoe"]
+
+[upstream]
+license = "GPL-2.0"
+website = "http://piwigo.org"
+demo = "https://piwigo.org/demo"
+admindoc = "https://piwigo.org/guides"
+code = "https://github.com/Piwigo/Piwigo"
+cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
+fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
+
+[integration]
+yunohost = ">= 11.2"
+architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
+multi_instance = true
+ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials.
+sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
+disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
+ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+
+[install]
+    [install.domain]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "domain"
+
+    [install.path]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "path"
+    default = "/piwigo"
+
+    [install.init_main_permission]
+    type = "group"
+    default = "visitors"
+
+    [install.language]
+    ask.en = "Choose the application language"
+    ask.fr = "Choisissez la langue de l'application"
+    type = "string"
+    choices = ["de", "en", "es", "fr", "it", "pt"]
+    default = "en"
+
+    [install.admin]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "user"
+
+[resources]
+    [resources.sources]
+        [resources.sources.ldap_plugin]
+        url = "https://piwigo.org/ext/download.php?rid=7036"
+        sha256 = "3c22652f6c0653aaeebe239435796748ee57612ad44e8e5f2553277545d36e5e"
+
+        [resources.sources.main]
+        url = "https://piwigo.org/download/dlcounter.php?code=13.8.0"
+        sha256 = "7f6a2a796693a4ce245fd67ebdd8bf873dc6cb1a33acd567104a10347af7fe1d"
+
+        [resources.sources.log_failed_logins_plugin]
+        url = "http://piwigo.org/ext/download.php?rid=5525"
+        sha256 = "85b9a06f2c7ca8ae9698e6151c7631f519c945f696b02da72f9ff53243d7e4ca"
+        in_subdir = false
+
+
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.data_dir]
+
+    [resources.permissions]
+    main.url = "/"
+
+    [resources.database]
+    type = "mysql"

scripts/_common.sh

@@ -4,10 +4,10 @@
 # COMMON VARIABLES
 #=================================================
 
-YNH_PHP_VERSION="8.0"
+#REMOVEME? YNH_PHP_VERSION="8.0"
 
 # dependencies used by the app
-pkg_dependencies="imagemagick php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-imagick php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-mysqli php${YNH_PHP_VERSION}-ldap"
+#REMOVEME? pkg_dependencies="imagemagick php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-imagick php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-mysqli php${YNH_PHP_VERSION}-ldap"
 
 #=================================================
 # PERSONAL HELPERS

scripts/backup

@@ -15,20 +15,20 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info --message="Loading installation settings..."
+#REMOVEME? ynh_print_info --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+#REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
@@ -39,13 +39,13 @@ ynh_print_info --message="Declaring files to be backed up..."
 # BACKUP THE APP MAIN DIR
 #=================================================
 
-ynh_backup --src_path="$final_path"
+ynh_backup --src_path="$install_dir"
 
 #=================================================
 # BACKUP THE DATA DIR
 #=================================================
 
-ynh_backup --src_path="$datadir" --is_big
+ynh_backup --src_path="$data_dir" --is_big
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION

scripts/change_url

@@ -13,36 +13,36 @@ source /usr/share/yunohost/helpers
 # RETRIEVE ARGUMENTS
 #=================================================
 
-old_domain=$YNH_APP_OLD_DOMAIN
+#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
+#REMOVEME? old_path=$YNH_APP_OLD_PATH
 
-new_domain=$YNH_APP_NEW_DOMAIN
+#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
+#REMOVEME? new_path=$YNH_APP_NEW_PATH
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-# Needed for helper "ynh_add_nginx_config"
+#REMOVEME? # Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
 
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
 #=================================================
 
-change_domain=0
+#REMOVEME? change_domain=0
-if [ "$old_domain" != "$new_domain" ]
+#REMOVEME? if [ "$old_domain" != "$new_domain" ]
 then
-	change_domain=1
+	#REMOVEME? change_domain=1
 fi
 
-change_path=0
+#REMOVEME? change_path=0
-if [ "$old_path" != "$new_path" ]
+#REMOVEME? if [ "$old_path" != "$new_path" ]
 then
-	change_path=1
+	#REMOVEME? change_path=1
 fi
 
 #=================================================
@@ -52,28 +52,30 @@ fi
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2
 
-nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+ynh_change_url_nginx_config
+
+#REMOVEME? nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
 # Change the path in the NGINX config file
 if [ $change_path -eq 1 ]
 then
 	# Make a backup of the original NGINX config file if modified
-	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
+#REMOVEME? 	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
 	# Set global variables for NGINX helper
-	domain="$old_domain"
+#REMOVEME? 	domain="$old_domain"
-	path_url="$new_path"
+#REMOVEME? 	path="$new_path"
 	# Create a dedicated NGINX config
-	ynh_add_nginx_config
+#REMOVEME? 	ynh_add_nginx_config
 fi
 
 # Change the domain for NGINX
 if [ $change_domain -eq 1 ]
 then
 	# Delete file checksum for the old conf file location
-	ynh_delete_file_checksum --file="$nginx_conf_path"
+#REMOVEME? 	ynh_delete_file_checksum --file="$nginx_conf_path"
-	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+#REMOVEME? 	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
 	# Store file checksum for the new config file location
-	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+#REMOVEME? 	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 
 #=================================================
@@ -81,9 +83,9 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..."
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -14,20 +14,20 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-domain=$YNH_APP_ARG_DOMAIN
+#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
-path_url=$YNH_APP_ARG_PATH
+#REMOVEME? path=$YNH_APP_ARG_PATH
-is_public=$YNH_APP_ARG_IS_PUBLIC
+#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
-language=$YNH_APP_ARG_LANGUAGE
+#REMOVEME? language=$YNH_APP_ARG_LANGUAGE
-admin=$YNH_APP_ARG_ADMIN
+#REMOVEME? admin=$YNH_APP_ARG_ADMIN
-phpversion=$YNH_PHP_VERSION
+#REMOVEME? phpversion=$YNH_PHP_VERSION
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 fpm_footprint="low"
 fpm_free_footprint=0
@@ -36,23 +36,23 @@ fpm_usage="low"
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_script_progression --message="Validating installation parameters..."
+#REMOVEME? ynh_script_progression --message="Validating installation parameters..."
 
-final_path=/var/www/$app
+#REMOVEME? install_dir=/var/www/$app
-test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
+#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
 
 # Register (book) web path
-ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_script_progression --message="Storing installation settings..."
+#REMOVEME? ynh_script_progression --message="Storing installation settings..."
 
-ynh_app_setting_set --app=$app --key=domain --value=$domain
+#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
+#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
 ynh_app_setting_set --app=$app --key=language --value=$language
-ynh_app_setting_set --app=$app --key=admin --value=$admin
+#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin
 ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
 ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint
 ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
@@ -62,34 +62,34 @@ ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=40
+#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=40
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Configuring system user..." --weight=3
+#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=3
 
 # Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Creating a MySQL database..."
+#REMOVEME? ynh_script_progression --message="Creating a MySQL database..."
 
-db_name=$(ynh_sanitize_dbid --db_name=$app)
+#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-ynh_app_setting_set --app=$app --key=db_name --value=$db_name
+#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
+#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 ynh_script_progression --message="Setting up source files..." --weight=5
 
-ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 
 # Create tmp directory and fetch app inside
 tmpdir="$(ynh_smart_mktemp --min_size=300)"
@@ -104,12 +104,12 @@ ynh_setup_source --dest_dir="$tmpdir/plugins" --source_id=log_failed_logins_plug
 shopt -s extglob
 
 # Install files and set permissions
-mkdir $final_path
+mkdir $install_dir
-cp -a $tmpdir/!(upload|_data|galleries) $final_path
+cp -a $tmpdir/!(upload|_data|galleries) $install_dir
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # PHP-FPM CONFIGURATION
@@ -118,7 +118,7 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=2
 
 # Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+#REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # NGINX CONFIGURATION
@@ -135,26 +135,26 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Creating a data directory..."
 
-datadir=/home/yunohost.app/$app
+#REMOVEME? data_dir=/home/yunohost.app/$app
-ynh_app_setting_set --app=$app --key=datadir --value=$datadir
+#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
 
-mkdir -p $datadir/_data
+mkdir -p $data_dir/_data
-mkdir -p $datadir/upload
+mkdir -p $data_dir/upload
-mkdir -p $datadir/galleries
+mkdir -p $data_dir/galleries
 
-ln -sd $datadir/_data $final_path/_data
+ln -sd $data_dir/_data $install_dir/_data
-ln -sd $datadir/upload $final_path/upload
+ln -sd $data_dir/upload $install_dir/upload
-ln -sd $datadir/galleries $final_path/galleries
+ln -sd $data_dir/galleries $install_dir/galleries
 
-cp -Rp $tmpdir/_data/. $final_path/_data
+cp -Rp $tmpdir/_data/. $install_dir/_data
-cp -Rp $tmpdir/upload/. $final_path/upload
+cp -Rp $tmpdir/upload/. $install_dir/upload
-cp -Rp $tmpdir/galleries/. $final_path/galleries
+cp -Rp $tmpdir/galleries/. $install_dir/galleries
 
 ynh_secure_remove --file="$tmpdir"
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R $app:www-data "$datadir"
+chown -R $app:www-data "$data_dir"
 
 #=================================================
 # SETUP APPLICATION WITH CURL
@@ -164,14 +164,14 @@ ynh_script_progression --message="Setuping application with CURL..." --weight=5
 # Set the app as temporarily public for curl call
 ynh_script_progression --message="Configuring SSOwat..."
 # Making the app public for curl
-ynh_permission_update --permission="main" --add="visitors"
+#REMOVEME? ynh_permission_update --permission="main" --add="visitors"
 
 # Reload NGINX
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 # Generate random password for admin
 adm_pwd=$(ynh_string_random --length=24)
-ynh_app_setting_set --app=$app --key=admin_pwd --value="$adm_pwd"
+#REMOVEME? ynh_app_setting_set --app=$app --key=admin_pwd --value="$adm_pwd"
 
 if [ "$language" = "fr" ]; then
   applanguage="fr_FR"
@@ -191,14 +191,14 @@ ynh_local_curl "/install.php?language=$applanguage" "install=true" "dbhost=127.0
 ynh_script_progression --message="Configuring Piwigo..."
 
 # Change local config
-ynh_add_config --template="../conf/config.inc.php" --destination="$final_path/local/config/config.inc.php"
+ynh_add_config --template="../conf/config.inc.php" --destination="$install_dir/local/config/config.inc.php"
 
 # Setup database in local/config/database.inc.php
-ynh_add_config --template="../conf/database.inc.php" --destination="$final_path/local/config/database.inc.php"
+ynh_add_config --template="../conf/database.inc.php" --destination="$install_dir/local/config/database.inc.php"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # ADD LDAP PLUGIN
@@ -227,7 +227,7 @@ UPDATE piwigo_ldap_login_config SET value='0' WHERE param = 'allow_new_users';
 UPDATE piwigo_ldap_login_config SET value='0' WHERE param = 'ld_group_user_active';"
 
 # Remove the public access
-ynh_permission_update --permission="main" --remove="visitors"
+#REMOVEME? ynh_permission_update --permission="main" --remove="visitors"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -248,22 +248,22 @@ ynh_add_fail2ban_config --logpath="/var/log/${app}FailedLogins.log" --failregex=
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..."
+#REMOVEME? ynh_script_progression --message="Configuring permissions..."
 
 # Make app public if necessary
-if [ $is_public -eq 1 ]
+#REMOVEME? if [ $is_public -eq 1 ]
 then
 	# Everyone can access the app.
 	# The "main" permission is automatically created before the install script.
-	ynh_permission_update --permission="main" --add="visitors"
+#REMOVEME? 	ynh_permission_update --permission="main" --add="visitors"
 fi
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..."
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT

scripts/remove

@@ -12,33 +12,33 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
 #=================================================
 # STANDARD REMOVE
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Removing the MySQL database..."
+#REMOVEME? ynh_script_progression --message="Removing the MySQL database..."
 
 # Remove a database if it exists, along with the associated user
-ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
+#REMOVEME? ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
 
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing app main directory..."
+#REMOVEME? ynh_script_progression --message="Removing app main directory..."
 
 # Remove the app directory securely
-ynh_secure_remove --file="$final_path"
+#REMOVEME? ynh_secure_remove --file="$install_dir"
 
 #=================================================
 # REMOVE DATA DIR
@@ -48,7 +48,7 @@ ynh_secure_remove --file="$final_path"
 if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
 then
 	ynh_script_progression --message="Removing app data directory..." --weight=1
-	ynh_secure_remove --file="$datadir"
+#REMOVEME? 	ynh_secure_remove --file="$data_dir"
 fi
 
 #=================================================
@@ -70,10 +70,10 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Removing dependencies..."
+#REMOVEME? ynh_script_progression --message="Removing dependencies..."
 
 # Remove metapackage and its dependencies
-ynh_remove_app_dependencies
+#REMOVEME? ynh_remove_app_dependencies
 
 #=================================================
 # REMOVE FAIL2BAN CONFIGURATION
@@ -88,10 +88,10 @@ ynh_remove_fail2ban_config
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user..."
+#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..."
 
 # Delete a system user
-ynh_system_user_delete --username=$app
+#REMOVEME? ynh_system_user_delete --username=$app
 
 #=================================================
 # END OF SCRIPT

scripts/restore

@@ -15,67 +15,67 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
 ynh_script_progression --message="Loading settings..." --weight=2
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
-phpversion=$YNH_PHP_VERSION
+#REMOVEME? phpversion=$YNH_PHP_VERSION
 
-fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
+#REMOVEME? fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
-fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
+#REMOVEME? fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
-ynh_script_progression --message="Validating restoration parameters..." --weight=1
+#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1
 
-test ! -d $final_path \
+#REMOVEME? test ! -d $install_dir \
-	|| ynh_die --message="There is already a directory: $final_path "
+	|| ynh_die --message="There is already a directory: $install_dir "
 
 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=3
+#REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." --weight=3
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
 ynh_script_progression --message="Restoring the app main directory..." --weight=4
 
-ynh_restore_file --origin_path="$final_path"
+ynh_restore_file --origin_path="$install_dir"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # RESTORE THE DATA DIRECTORY
 #=================================================
 ynh_script_progression --message="Restoring the data directory..." --weight=2
 
-ynh_restore_file --origin_path="$datadir" --not_mandatory
+ynh_restore_file --origin_path="$data_dir" --not_mandatory
 
-mkdir -p $datadir
+mkdir -p $data_dir
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R $app:www-data "$datadir"
+chown -R $app:www-data "$data_dir"
 
 #=================================================
 # RESTORE FAIL2BAN CONFIGURATION
@@ -94,10 +94,10 @@ ynh_systemd_action --action=restart --service_name=fail2ban
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --weight=40
+#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=40
 
 # Define and install dependencies
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
@@ -119,10 +119,10 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Restoring the MySQL database..." --weight=2
+#REMOVEME? ynh_script_progression --message="Restoring the MySQL database..." --weight=2
 
-db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
+#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
 ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
 
 #=================================================

scripts/upgrade

@@ -12,25 +12,25 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=2
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=2
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-language=$(ynh_app_setting_get --app=$app --key=language)
+#REMOVEME? language=$(ynh_app_setting_get --app=$app --key=language)
-admin=$(ynh_app_setting_get --app=$app --key=admin)
+#REMOVEME? admin=$(ynh_app_setting_get --app=$app --key=admin)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-admin_pwd=$(ynh_app_setting_get --app=$app --key=admin_pwd)
+#REMOVEME? admin_pwd=$(ynh_app_setting_get --app=$app --key=admin_pwd)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
-phpversion=$YNH_PHP_VERSION
+#REMOVEME? phpversion=$YNH_PHP_VERSION
 
-fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
+#REMOVEME? fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
-fpm_free_footprint=$(ynh_app_setting_get --app=$app --key=fpm_free_footprint)
+#REMOVEME? fpm_free_footprint=$(ynh_app_setting_get --app=$app --key=fpm_free_footprint)
-fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
+#REMOVEME? fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
 
 #=================================================
 # CHECK VERSION
@@ -41,16 +41,16 @@ upgrade_type=$(ynh_check_app_version_changed)
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=6
+#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=6
 
 # Backup the current version of the app
-ynh_backup_before_upgrade
+#REMOVEME? ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
+#REMOVEME? 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # STANDARD UPGRADE STEPS
@@ -78,26 +78,26 @@ if [ -z "$fpm_usage" ]; then
 fi
 
 # Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
+#REMOVEME? if ynh_legacy_permissions_exists; then
-	ynh_legacy_permissions_delete_all
+#REMOVEME? 	ynh_legacy_permissions_delete_all
 fi
 
-# If datadir doesn't exist, create it
+# If data_dir doesn't exist, create it
-if [ -z "$datadir" ]; then
+if [ -z "$data_dir" ]; then
-	datadir=/home/yunohost.app/$app
+	data_dir=/home/yunohost.app/$app
-	ynh_app_setting_set --app=$app --key=datadir --value=$datadir
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
 fi
 
 # If db_name doesn't exist, create it
 if [ -z "$db_name" ]; then
 	db_name=$(ynh_sanitize_dbid --db_name=$app)
-	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 fi
 
-# If final_path doesn't exist, create it
+# If install_dir doesn't exist, create it
-if [ -z "$final_path" ]; then
+if [ -z "$install_dir" ]; then
-	final_path=/var/www/$app
+#REMOVEME? 	install_dir=/var/www/$app
-	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 fi
 
 # Compatibility with previous version; password was not set
@@ -106,33 +106,33 @@ if [ -z "$admin_pwd" ] ; then
   admin_pwd=$(ynh_string_random --length=24)
 
   # Compute password hash with the Piwigo function
-  cp ../conf/hash_password.php $final_path
+  cp ../conf/hash_password.php $install_dir
-  hashed_password=$(cd $final_path ; php hash_password.php $admin_pwd)
+  hashed_password=$(cd $install_dir ; php hash_password.php $admin_pwd)
 
   # Update password hash in database
-  db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME?   db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
   ynh_mysql_connect_as --user=$db_name --password=$db_pwd --database=$db_name <<< "UPDATE users SET password='$hashed_password' WHERE username='$admin';"
-  ynh_app_setting_set --app=$app --key=admin_pwd --value="$admin_pwd"
+#REMOVEME?   ynh_app_setting_set --app=$app --key=admin_pwd --value="$admin_pwd"
 
   # Remove the temporary hash generation script
-  ynh_secure_remove --file="$final_path/hash_password.php"
+#REMOVEME?   ynh_secure_remove --file="$install_dir/hash_password.php"
 fi
 
-# Use path instead of path_url in settings.yml...
+# Use path instead of path in settings.yml...
-if [ -z "$path_url" ]
+if [ -z "$path" ]
 then
-	path_url=$(ynh_app_setting_get --app=$app --key=path_url)
+#REMOVEME? 	path=$(ynh_app_setting_get --app=$app --key=path)
-	ynh_app_setting_set --app=$app --key=path --value=$path_url
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=path --value=$path
-	ynh_app_setting_delete --app=$app --key=path_url
+	ynh_app_setting_delete --app=$app --key=path
 fi
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
 
 # Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -155,41 +155,41 @@ then
 	ynh_setup_source --dest_dir="$tmpdir/plugins" --source_id=log_failed_logins_plugin
 
 	# Install files and set permissions
-	cp -a $tmpdir/!(upload|_data|galleries) $final_path
+	cp -a $tmpdir/!(upload|_data|galleries) $install_dir
 
 	# Backward compatibility:
 	# If the _data subdirectory wasn't already moved to /home/yunohost.app/$app,
 	# then move it there
-	if [ ! -h $final_path/_data ] ; then
+	if [ ! -h $install_dir/_data ] ; then
-		mv $final_path/_data $datadir
+		mv $install_dir/_data $data_dir
-		ln -sd $datadir/_data $final_path/_data
+		ln -sd $data_dir/_data $install_dir/_data
 	fi
 
 	# Backward compatibility:
 	# If the galleries subdirectory wasn't already moved to /home/yunohost.app/$app,
 	# then move it there
-	if [ ! -h $final_path/galleries ] ; then
+	if [ ! -h $install_dir/galleries ] ; then
-		mv $final_path/galleries $datadir
+		mv $install_dir/galleries $data_dir
-		ln -sd $datadir/galleries $final_path/galleries
+		ln -sd $data_dir/galleries $install_dir/galleries
 	fi
 
 	ynh_secure_remove --file="$tmpdir"
 fi
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R $app:www-data "$datadir"
+chown -R $app:www-data "$data_dir"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=6
+#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=6
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # PHP-FPM CONFIGURATION
@@ -198,7 +198,7 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=3
 
 # Create a dedicated PHP-FPM config
 ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+#REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # NGINX CONFIGURATION
@@ -216,7 +216,7 @@ ynh_add_nginx_config
 ynh_script_progression --message="Upgrading Piwigo with cURL..." --weight=6
 
 # Reload NGINX
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 if [ "$language" = "fr" ] ; then
   applanguage="fr_FR"
@@ -233,14 +233,14 @@ ynh_local_curl "/upgrade.php?language=$applanguage&now=true" "language=$applangu
 ynh_script_progression --message="Configuring Piwigo..."
 
 # Change local config
-ynh_add_config --template="../conf/config.inc.php" --destination="$final_path/local/config/config.inc.php"
+ynh_add_config --template="../conf/config.inc.php" --destination="$install_dir/local/config/config.inc.php"
 
 # Setup database in local/config/database.inc.php
-ynh_add_config --template="../conf/database.inc.php" --destination="$final_path/local/config/database.inc.php"
+ynh_add_config --template="../conf/database.inc.php" --destination="$install_dir/local/config/database.inc.php"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # CONFIGURE LDAP PLUGIN
@@ -269,8 +269,8 @@ UPDATE piwigo_ldap_login_config SET value='' WHERE param = 'ld_binddn';
 UPDATE piwigo_ldap_login_config SET value='0' WHERE param = 'allow_new_users';
 UPDATE piwigo_ldap_login_config SET value='0' WHERE param = 'ld_group_user_active';"
 # Remove configuration file for older plugin version
-if [ -f $final_path/plugins/Ldap_Login/data.dat ] ; then
+if [ -f $install_dir/plugins/Ldap_Login/data.dat ] ; then
-	ynh_secure_remove --file=$final_path/plugins/Ldap_Login/data.dat
+#REMOVEME? 	ynh_secure_remove --file=$install_dir/plugins/Ldap_Login/data.dat
 fi
 
 #=================================================
@@ -292,9 +292,9 @@ ynh_add_fail2ban_config --logpath="/var/log/${app}FailedLogins.log" --failregex=
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT