[autopatch] Automatic patch attempt for helpers 2.1

conf/extra_php-fpm.conf

@@ -1,5 +0,0 @@
-; Additional php.ini defines, specific to this pool of workers.
-
-php_admin_value[upload_max_filesize] = 512M
-php_admin_value[post_max_size] = 512M
-php_admin_value[memory_limit] = 512M

conf/nginx.conf

@@ -2,7 +2,7 @@
 location __PATH__/ {
 
   # Path to source
-  alias __INSTALL_DIR__/__NAME__/;
+  alias __INSTALL_DIR__/__APP__/;
 
   index index.php;
 
@@ -53,7 +53,7 @@ location __PATH__/ {
 
   location ~ '[^/]\.php$|^/update.php' {
     fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-    fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
+    fastcgi_pass unix:/var/run/php/php__PHP_VERSION__-fpm-__APP__.sock;
 
     fastcgi_index index.php;
     include fastcgi_params;

manifest.toml

@@ -18,7 +18,8 @@ admindoc = "https://www.drupal.org/docs/8"
 code = "https://github.com/drupal/drupal"
 
 [integration]
-yunohost = ">= 11.2"
+yunohost = ">= 11.2.18"
+helpers_version = "2.1"
 architectures = "all"
 multi_instance = true
 ldap = false
@@ -70,6 +71,7 @@ ram.runtime = "50M"
     [resources.system_user]
 
     [resources.install_dir]
+    group = "www-data:r-x"
 
     [resources.permissions]
     main.url = "/"

scripts/_common.sh

@@ -1,27 +1,15 @@
 #!/bin/bash
 
 #=================================================
-# COMMON VARIABLES
+# COMMON VARIABLES AND CUSTOM HELPERS
 #=================================================
 # PHP APP SPECIFIC
 #=================================================
 
 swap_needed=512
 
-#=================================================
-# PERSONAL HELPERS
-#=================================================
-
 _ynh_exec_with_drush_php() {
-    ynh_exec_warn_less ynh_exec_as "$app" \
+    ynh_hide_warnings ynh_exec_as_app \
-        env PATH="$PATH" DRUSH_PHP="/usr/bin/php$phpversion" \
+        env PATH="$PATH" DRUSH_PHP="/usr/bin/php$php_version" \
         "$@"
 }
-
-#=================================================
-# EXPERIMENTAL HELPERS
-#=================================================
-
-#=================================================
-# FUTURE OFFICIAL HELPERS
-#=================================================

scripts/backup

@@ -1,48 +1,39 @@
 #!/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
 
-#=================================================
+ynh_print_info "Declaring files to be backed up..."
-# 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="$install_dir"
+ynh_backup "$install_dir"
 
 #=================================================
 # SYSTEM CONFIGURATION
 #=================================================
 
 # Backup the PHP-FPM configuration
-ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+ynh_backup "/etc/php/$php_version/fpm/pool.d/$app.conf"
 
 # 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"
 
 # Backup the cron file
-ynh_backup --src_path="/etc/cron.d/$app"
+ynh_backup "/etc/cron.d/$app"
 
 #=================================================
 # BACKUP THE MYSQL DATABASE
 #=================================================
-ynh_print_info --message="Backing up the MySQL database..."
+ynh_print_info "Backing up the MySQL database..."
 
-ynh_mysql_dump_db --database="$db_name" > db.sql
+ynh_mysql_dump_db > db.sql
 
 #=================================================
 # 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)."

scripts/change_url

@@ -1,34 +1,26 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# STANDARD MODIFICATIONS
 #=================================================
 # 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
 #=================================================
 # UPDATE DRUSH ALIAS
 #=================================================
-ynh_script_progression --message="Updating Drush alias..." --weight=1
+ynh_script_progression "Updating Drush alias..."
 
-ynh_add_config --template="example.site.yml" --destination="$install_dir/drush/sites/$app.site.yml"
+ynh_config_add --template="example.site.yml" --destination="$install_dir/drush/sites/$app.site.yml"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Change of URL completed for $app" --last
+ynh_script_progression "Change of URL completed for $app"

scripts/install

@@ -1,15 +1,13 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source ynh_add_swap
 source /usr/share/yunohost/helpers
 
+ynh_app_setting_set --key=php_upload_max_filesize --value=512M
+
+ynh_app_setting_set --key=php_memory_limit --value=512M
+
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
@@ -19,66 +17,65 @@ admin_mail=$(ynh_user_get_info --username=$admin --key=mail)
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_script_progression --message="Setting up source files..." --weight=1
+ynh_script_progression "Setting up source files..."
 
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$install_dir"
 
 mkdir -p "$install_dir/$app"
 
-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 | chmod -R o-rwx "$install_dir"
-chown -R "$app:www-data" "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir"
-
 #=================================================
 # SYSTEM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
+ynh_script_progression "Adding system configurations related to $app..."
 
 # Create a dedicated PHP-FPM config
-ynh_add_fpm_config
+ynh_config_add_phpfpm
 
 # Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
 
 #=================================================
 # SPECIFIC SETUP
 #=================================================
 # ADD SWAP
 #=================================================
-ynh_script_progression --message="Adding swap..." --weight=1
+ynh_script_progression "Adding swap..."
 
-if [ "${PACKAGE_CHECK_EXEC:-0}" -eq 0 ]; then
+if ! ynh_in_ci_tests; then
     ynh_add_swap --size=$swap_needed
 fi
 
 #=================================================
 # CREATE DRUSH ALIAS
 #=================================================
-ynh_script_progression --message="Creating Drush alias..." --weight=1
+ynh_script_progression "Creating Drush alias..."
 
 mkdir -p "$install_dir/drush/sites/"
-ynh_add_config --template="example.site.yml" --destination="$install_dir/drush/sites/$app.site.yml"
+ynh_config_add --template="example.site.yml" --destination="$install_dir/drush/sites/$app.site.yml"
 
 #=================================================
 # INSTALL COMPOSER
 #=================================================
-ynh_script_progression --message="Installing Composer..." --weight=3
+ynh_script_progression "Installing Composer..."
 
 mkdir -p "$install_dir/.composer"
-ynh_add_config --template="composer.json" --destination="$install_dir/composer.json"
+ynh_config_add --template="composer.json" --destination="$install_dir/composer.json"
 
-ynh_install_composer --phpversion="$phpversion" --workdir="$install_dir"
+ynh_composer_install
+ynh_composer_exec install --no-dev
 
 export PATH="$install_dir/vendor/bin:$PATH"
 
 #=================================================
 # INSTALL DRUPAL
 #=================================================
-ynh_script_progression --message="Installing Drupal..." --weight=5
+ynh_script_progression "Installing Drupal..."
-
-chmod -R o-rwx "$install_dir"
-chown -R "$app:www-data" "$install_dir"
 
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir"
 pushd "$install_dir"
     _ynh_exec_with_drush_php \
         drush site:install "$install_profil" \
@@ -94,23 +91,23 @@ popd
 #=================================================
 # SETUP THE CRON FILE
 #=================================================
-ynh_script_progression --message="Setting up the cron file..." --weight=1
+ynh_script_progression "Setting up the cron file..."
 
-ynh_add_config --template="cron" --destination="/etc/cron.d/$app"
+ynh_config_add --template="cron" --destination="/etc/cron.d/$app"
 
 #=================================================
 # STORE THE CONFIG FILE CHECKSUM
 #=================================================
-ynh_script_progression --message="Storing the config file checksum..." --weight=1
+ynh_script_progression "Storing the config file checksum..."
 
 # Calculate and store the config file checksum into the app settings
-ynh_store_file_checksum --file="$install_dir/$app/sites/default/settings.php"
+ynh_store_file_checksum "$install_dir/$app/sites/default/settings.php"
 
-chmod 400 "$install_dir/$app/sites/default/settings.php"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/$app/sites/default/settings.php"
-chown "$app:$app" "$install_dir/$app/sites/default/settings.php"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown "$app:$app" "$install_dir/$app/sites/default/settings.php"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Installation of $app completed" --last
+ynh_script_progression "Installation of $app completed"

scripts/remove

@@ -1,11 +1,5 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source ynh_add_swap
 source /usr/share/yunohost/helpers
@@ -13,21 +7,21 @@ source /usr/share/yunohost/helpers
 #=================================================
 # REMOVE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
+ynh_script_progression "Removing system configurations related to $app..."
 
 # Remove the dedicated NGINX config
-ynh_remove_nginx_config
+ynh_config_remove_nginx
 
 # Remove the dedicated PHP-FPM config
-ynh_remove_fpm_config
+ynh_config_remove_phpfpm
 
 # Remove the cron file
-ynh_secure_remove --file="/etc/cron.d/$app"
+ynh_safe_rm "/etc/cron.d/$app"
 
 #=================================================
 # REMOVE SWAP
 #=================================================
-ynh_script_progression --message="Removing swap..."
+ynh_script_progression "Removing swap..."
 
 ynh_del_swap
 
@@ -35,4 +29,4 @@ ynh_del_swap
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Removal of $app completed" --last
+ynh_script_progression "Removal of $app completed"

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 ../settings/scripts/ynh_add_swap
@@ -14,52 +8,49 @@ 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"
-
-chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$install_dir"
 
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir"
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Restoring the MySQL database..." --weight=1
+ynh_script_progression "Restoring the MySQL database..."
 
-ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql
+ynh_mysql_db_shell < ./db.sql
 
 #=================================================
 # RESTORE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
+ynh_script_progression "Restoring system configurations related to $app..."
 
-ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+ynh_restore "/etc/php/$php_version/fpm/pool.d/$app.conf"
 
-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/cron.d/$app"
+ynh_restore "/etc/cron.d/$app"
 
 #=================================================
 # ADD SWAP
 #=================================================
-ynh_script_progression --message="Adding swap..." --weight=1
+ynh_script_progression "Adding swap..."
 
-if [ "${PACKAGE_CHECK_EXEC:-0}" -eq 0 ]; then
+if ! ynh_in_ci_tests; then
     ynh_add_swap --size=$swap_needed
 fi
 
-#=================================================
-# GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1
+ynh_script_progression "Reloading NGINX web server and PHP-FPM..."
 
-ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
+ynh_systemctl --service=php$php_version-fpm --action=reload
-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"

scripts/upgrade

@@ -1,84 +1,75 @@
 #!/bin/bash
 
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
 source _common.sh
 source ynh_add_swap
 source /usr/share/yunohost/helpers
 
-#=================================================
+ynh_app_setting_set_default --key=php_upload_max_filesize --value=512M
-# STANDARD UPGRADE STEPS
+
+ynh_app_setting_set_default --key=php_memory_limit --value=512M
+
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
+ynh_script_progression "Ensuring downward compatibility..."
-
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_script_progression --message="Upgrading source files..." --weight=1
+ynh_script_progression "Upgrading source files..."
 
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$install_dir" --full_replace --keep="app composer.json"
-ynh_store_file_checksum --file="$install_dir/composer.json"
+ynh_store_file_checksum "$install_dir/composer.json"
 mkdir -p "$install_dir/$app"
 
-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 | chmod -R o-rwx "$install_dir"
-chown -R "$app:www-data" "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir"
-
 #=================================================
 # REAPPLY SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
+ynh_script_progression "Upgrading system configurations related to $app..."
 
 # Create a dedicated PHP-FPM config
-ynh_add_fpm_config
+ynh_config_add_phpfpm
 
 # Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
 
-#=================================================
-# SPECIFIC UPGRADE
 #=================================================
 # ADD SWAP
 #=================================================
-ynh_script_progression --message="Adding swap..." --weight=1
+ynh_script_progression "Adding swap..."
 
-if [ "${PACKAGE_CHECK_EXEC:-0}" -eq 0 ]; then
+if ! ynh_in_ci_tests; then
     ynh_add_swap --size=$swap_needed
 fi
 
 #=================================================
 # UPGRADE COMPOSER
 #=================================================
-ynh_script_progression --message="Upgrading Composer..." --weight=3
+ynh_script_progression "Upgrading Composer..."
 
 mkdir -p "$install_dir/.composer"
-ynh_add_config --template="composer.json" --destination="$install_dir/composer.json"
+ynh_config_add --template="composer.json" --destination="$install_dir/composer.json"
 
-ynh_exec_warn_less ynh_composer_exec --phpversion="$phpversion" --workdir="$install_dir" --commands="update"
+ynh_composer_exec update
 
 export PATH="$install_dir/vendor/bin:$PATH"
 
 #=================================================
 # UPGRADE DRUPAL
 #=================================================
-ynh_script_progression --message="Upgrading Drupal..." --weight=3
+ynh_script_progression "Upgrading Drupal..."
 
-ynh_backup_if_checksum_is_different --file="$install_dir/$app/sites/default/settings.php"
+ynh_backup_if_checksum_is_different "$install_dir/$app/sites/default/settings.php"
-
-chmod -R o-rwx "$install_dir"
-chown -R "$app:www-data" "$install_dir"
 
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir"
+#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir"
 pushd "$install_dir"
     _ynh_exec_with_drush_php drush "@$app.prod" state:set system.maintenance_mode 1 --input-format=integer
-    _ynh_exec_with_drush_php "php$phpversion" composer.phar update drupal/core webflo/drupal-core-require-dev --with-dependencies
+    _ynh_exec_with_drush_php "php$php_version" composer.phar update drupal/core webflo/drupal-core-require-dev --with-dependencies
-    _ynh_exec_with_drush_php "php$phpversion" composer.phar update --with-dependencies
+    _ynh_exec_with_drush_php "php$php_version" composer.phar update --with-dependencies
     _ynh_exec_with_drush_php drush "@$app.prod" -y updatedb
     _ynh_exec_with_drush_php drush "@$app.prod" cache:rebuild
     _ynh_exec_with_drush_php drush "@$app.prod" state:set system.maintenance_mode 0 --input-format=integer
@@ -87,23 +78,23 @@ popd
 #=================================================
 # STORE THE CONFIG FILE CHECKSUM
 #=================================================
-ynh_script_progression --message="Storing the config file checksum..." --weight=1
+ynh_script_progression "Storing the config file checksum..."
 
 # Recalculate and store the checksum of the file for the next upgrade.
-ynh_store_file_checksum --file="$install_dir/$app/sites/default/settings.php"
+ynh_store_file_checksum "$install_dir/$app/sites/default/settings.php"
 
-chmod 400 "$install_dir/$app/sites/default/settings.php"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$install_dir/$app/sites/default/settings.php"
-chown $app:$app "$install_dir/$app/sites/default/settings.php"
+#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$install_dir/$app/sites/default/settings.php"
 
 #=================================================
 # SETUP THE CRON FILE
 #=================================================
-ynh_script_progression --message="Setting up the cron file" --weight=1
+ynh_script_progression "Setting up the cron file"
 
-ynh_add_config --template="cron" --destination="/etc/cron.d/$app"
+ynh_config_add --template="cron" --destination="/etc/cron.d/$app"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Upgrade of $app completed" --last
+ynh_script_progression "Upgrade of $app completed"