diff --git a/README.md b/README.md index 8f52e62..c355128 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,6 @@ See this [article](https://framablog.org/2016/10/05/framaforms-noffrez-plus-les- **Shipped version:** 1.1~ynh1 -## Disclaimers / important information - -## Configuration - -You can modify some configurations using the Framaforms administration panel. You can log in with the admin user and the password you gave during installation. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index fbabc87..dc64aff 100644 --- a/README_fr.md +++ b/README_fr.md @@ -21,12 +21,6 @@ See this [article](https://framablog.org/2016/10/05/framaforms-noffrez-plus-les- **Version incluse :** 1.1~ynh1 -## Avertissements / informations importantes - -## Configuration - -You can modify some configurations using the Framaforms administration panel. You can log in with the admin user and the password you gave during installation. - ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process deleted file mode 100644 index 6878b03..0000000 --- a/check_process +++ /dev/null @@ -1,30 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - language="fr" - admin="john" - password="password" - expiration="0" - deletion="0" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 1.0.3~ynh3 - upgrade=1 from_commit=79cdc1a139ff06805647cb56e5eab1d595ee0259 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email=ljf+framaforms_ynh@reflexlibre.net -Notification=yes -;;; Upgrade options - ; commit=25e97123f0e82ec1b9375774f3e86b7d8f5d73cf - name=#34 from YunoHost-Apps/testing diff --git a/conf/cron b/conf/cron index 4009261..00ac20e 100644 --- a/conf/cron +++ b/conf/cron @@ -1,5 +1,5 @@ SHELL=/bin/sh -PATH=__FINALPATH__/.composer/vendor/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin +PATH=__INSTALL_DIR__/.composer/vendor/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin # m h dom mon dow user command 30 * * * * __APP__ drush --quiet @__APP__ core-cron diff --git a/conf/default.settings.php b/conf/default.settings.php index 61d9419..b355445 100644 --- a/conf/default.settings.php +++ b/conf/default.settings.php @@ -679,4 +679,4 @@ $conf['file_scan_ignore_directories'] = array( */ $conf['x_frame_options'] = ''; -$conf['file_temporary_path'] = '__FINALPATH__/app/sites/default/files/tmp'; +$conf['file_temporary_path'] = '__INSTALL_DIR__/app/sites/default/files/tmp'; diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf new file mode 100644 index 0000000..e69de29 diff --git a/conf/nginx.conf b/conf/nginx.conf index 8293184..957d8fe 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/app/ ; + alias __INSTALL_DIR__/app/ ; index index.php; diff --git a/conf/yoursite.aliases.drushrc.php b/conf/yoursite.aliases.drushrc.php index 2c91f35..4b5b5ac 100644 --- a/conf/yoursite.aliases.drushrc.php +++ b/conf/yoursite.aliases.drushrc.php @@ -28,7 +28,7 @@ * Set the root and site_path values to point to your local site */ $aliases['__APP__'] = array( - 'root' => '__FINALPATH__/app/', + 'root' => '__INSTALL_DIR__/app/', 'uri' => 'https://__DOMAIN____PATH__', 'path-aliases' => array( '%dump-dir' => '/tmp', diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index 08d2fff..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,3 +0,0 @@ -## Configuration - -You can modify some configurations using the Framaforms administration panel. You can log in with the admin user and the password you gave during installation. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 39dba71..0000000 --- a/manifest.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "name": "Framaforms", - "id": "framaforms", - "packaging_format": 1, - "description": { - "en": "Create online webforms and surveys", - "fr": "Créez des formulaires et questionnaires en ligne" - }, - "version": "1.1~ynh1", - "url": "https://yakforms.org", - "upstream": { - "license": "GPL-2.0-only", - "website": "https://yakforms.org", - "code": "https://framagit.org/yakforms/yakforms" - }, - "license": "GPL-2.0-only", - "maintainer": { - "name": "ljf", - "email": "ljf+framaforms_ynh@reflexlibre.net", - "url": "https://reflexlibre.net" - }, - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx", - "php7.3-fpm", - "mysql" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/poll", - "default": "/poll" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If no, only person with an account on your server will be able to create forms. In all cases, visitors will be able to reply to form.", - "fr": "Si non, seule la personne disposant d'un compte sur votre serveur pourra créer des formulaires. Dans tous les cas, les visiteurs pourront répondre au formulaire." - }, - "default": true - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": ["de", "en", "es", "fr", "it", "pt"], - "default": "en" - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "password", - "type": "password" - }, - { - "name": "expiration", - "type": "string", - "ask": { - "en": "After how many weeks do the forms expire?", - "fr": "Après combien de semaines les formulaires expirent-ils ?" - }, - "help": { - "en": "Set 0 to disable expiration", - "fr": "Mettre 0 pour désactiver l'expiration" - }, - "default": "0" - }, - { - "name": "deletion", - "type": "string", - "ask": { - "en": "After how many weeks is the forms deleted?", - "fr": "Après combien de semaines les formulaires sont-ils supprimés ?" - }, - "help": { - "en": "Set 0 to disable deletion", - "fr": "Mettre 0 pour désactiver la suppression" - }, - "default": "0" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..bb7cb1c --- /dev/null +++ b/manifest.toml @@ -0,0 +1,93 @@ +packaging_format = 2 + +id = "framaforms" +name = "Framaforms" +description.en = "Create online webforms and surveys" +description.fr = "Créez des formulaires et questionnaires en ligne" + +version = "1.1~ynh1" + +maintainers = [] + +[upstream] +license = "GPL-2.0-only" +website = "https://yakforms.org" +code = "https://framagit.org/yakforms/yakforms" + +[integration] +yunohost = ">= 4.3.0" +architectures = "all" +multi_instance = true +ldap = true +sso = false +disk = "500M" +ram.build = "50M" +ram.runtime = "50M" + +[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 = "/poll" + + [install.init_main_permission] + help.en = "If no, only person with an account on your server will be able to create forms. In all cases, visitors will be able to reply to form." + help.fr = "Si non, seule la personne disposant d'un compte sur votre serveur pourra créer des formulaires. Dans tous les cas, les visiteurs pourront répondre au formulaire." + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "select" + 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" + + [install.password] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "password" + + [install.expiration] + ask.en = "After how many weeks do the forms expire?" + ask.fr = "Après combien de semaines les formulaires expirent-ils ?" + help.en = "Set 0 to disable expiration" + help.fr = "Mettre 0 pour désactiver l'expiration" + type = "string" + default = "0" + + [install.deletion] + ask.en = "After how many weeks is the forms deleted?" + ask.fr = "Après combien de semaines les formulaires sont-ils supprimés ?" + help.en = "Set 0 to disable deletion" + help.fr = "Mettre 0 pour désactiver la suppression" + type = "string" + default = "0" + +[resources] + [resources.sources.main] + url = "https://framagit.org/yakforms/yakforms/-/archive/1.0.3/yakforms-1.0.3.tar.gz" + sha256 = "f8a8ac8789c36f07f2d1a03d13f9f6d947e499967b79ea626f7f87271a357703" + + + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "postgresql, curl, libzip-dev, php7.4-fpm, php7.4-cli, php7.4-gd, php7.4-mysql, php7.4-xml, php7.4-ldap, php7.4-mbstring, php7.4-pgsql" + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 9d64b33..a29d197 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,23 +1,3 @@ #!/bin/bash -#================================================= -# COMMON VARIABLES -#================================================= - -YNH_PHP_VERSION="7.3" - -pkg_dependencies="postgresql curl libzip-dev php${YNH_PHP_VERSION}-fpm php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-pgsql" - YNH_COMPOSER_VERSION="1.10.17" - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= diff --git a/scripts/backup b/scripts/backup index 1ebbcaf..4fe1139 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,26 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -39,13 +19,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 diff --git a/scripts/change_url b/scripts/change_url index 9ddd691..980aa65 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,61 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -# Add settings here as needed by your application - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -71,29 +16,7 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -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" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - 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" - 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" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -103,18 +26,10 @@ fi ynh_script_progression --message="Updating Drush alias..." --weight=1 domain="$new_domain" -path_url="$new_path" +path="$new_path" -ynh_add_config --template="../conf/yoursite.aliases.drushrc.php" --destination="$final_path/.drush/$app.aliases.drushrc.php" +ynh_add_config --template="../conf/yoursite.aliases.drushrc.php" --destination="$install_dir/.drush/$app.aliases.drushrc.php" -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 878eb75..b004c4c 100644 --- a/scripts/install +++ b/scripts/install @@ -9,95 +9,20 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -admin=$YNH_APP_ARG_ADMIN -password=$YNH_APP_ARG_PASSWORD -expiration=$YNH_APP_ARG_EXPIRATION -deletion=$YNH_APP_ARG_DELETION - -app=$YNH_APP_INSTANCE_NAME - admin_mail=$(ynh_user_get_info --username=$admin --key=mail) -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." --weight=1 - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin -ynh_app_setting_set --app=$app --key=password --value=$password -ynh_app_setting_set --app=$app --key=expiration --value=$expiration -ynh_app_setting_set --app=$app --key=deletion --value=$deletion - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=7 - -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=3 - -# Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path - -#================================================= -# CREATE A POSTGRESQL DATABASE -#================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2 - -ynh_psql_test_if_first_run - -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=9 -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 --dest_dir="$final_path/app" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir/app" + +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # PHP-FPM CONFIGURATION @@ -105,8 +30,7 @@ chown -R $app:www-data "$final_path" ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --usage=low --footprint=low -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +ynh_add_fpm_config #================================================= # NGINX CONFIGURATION @@ -123,8 +47,8 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Creating Drush alias..." --weight=2 -mkdir -p "$final_path/.drush" -drush_aliasconfig="$final_path/.drush/$app.aliases.drushrc.php" +mkdir -p "$install_dir/.drush" +drush_aliasconfig="$install_dir/.drush/$app.aliases.drushrc.php" ynh_add_config --template="../conf/yoursite.aliases.drushrc.php" --destination="$drush_aliasconfig" @@ -136,50 +60,47 @@ chown $app:$app "$drush_aliasconfig" #================================================= ynh_script_progression --message="Installing Composer..." --weight=31 -mkdir -p "$final_path/.composer" +mkdir -p "$install_dir/.composer" -ynh_add_config --template="../conf/composer.json" --destination="$final_path/.composer/composer.json" +ynh_add_config --template="../conf/composer.json" --destination="$install_dir/.composer/composer.json" -ynh_install_composer --phpversion="$phpversion" --workdir="$final_path/.composer" +ynh_install_composer --phpversion="$phpversion" --workdir="$install_dir/.composer" -export PATH="$final_path/.composer/vendor/bin:$PATH" +export PATH="$install_dir/.composer/vendor/bin:$PATH" #================================================= # INITIALIZE TMP AND PRIVATE DIRECTORY #================================================= ynh_script_progression --message="Initializing tmp and private directory..." --weight=1 -mkdir -p "$final_path/app/sites/default/files" -mkdir -p "$final_path/app/sites/default/files/tmp" +mkdir -p "$install_dir/app/sites/default/files" +mkdir -p "$install_dir/app/sites/default/files/tmp" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -chmod 2775 "$final_path/app/sites/default/files" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" +chmod 2775 "$install_dir/app/sites/default/files" #================================================= # CREATE DATA DIRECTORY #================================================= ynh_script_progression --message="Creating a data directory..." -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir +mkdir -p $data_dir -mkdir -p $datadir - -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:www-data "$data_dir" #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=1 -ynh_add_config --template="../conf/default.settings.php" --destination="$final_path/app/sites/default/settings.php" +ynh_add_config --template="../conf/default.settings.php" --destination="$install_dir/app/sites/default/settings.php" -chmod 600 "$final_path/app/sites/default/settings.php" -chown $app:$app "$final_path/app/sites/default/settings.php" +chmod 600 "$install_dir/app/sites/default/settings.php" +chown $app:$app "$install_dir/app/sites/default/settings.php" #================================================= # INSTALLING FRAMAFORMS WITH DRUSH @@ -207,7 +128,7 @@ ynh_exec_as $app env PATH=$PATH drush @$app cache-clear drush -y 2>&1 ynh_exec_as $app env PATH=$PATH drush @$app l10n-update-refresh -y 2>&1 ynh_exec_as $app env PATH=$PATH drush @$app l10n-update -y 2>&1 -# We don't upgrade module to avoid to erase framaforms change +# We don't upgrade module to avoid to erase framaforms change # in drupal core and modules code # see https://framagit.org/framasoft/framaforms/-/wikis/modifications #ynh_exec_as $app env PATH=$PATH drush @$app pm-update -y @@ -232,7 +153,7 @@ ynh_exec_as $app env PATH=$PATH drush @$app pm-download ldap ynh_exec_as $app env PATH=$PATH drush @$app pm-enable -y ldap_servers ldap_user ldap_authentication ldap_authorization ldap_authorization_drupal_role # Generated with sudo -u postgres pg_dump -a -t ldap_servers --inserts framaforms ynh_exec_as $app env PATH=$PATH drush @$app sql-query "INSERT INTO public.ldap_servers VALUES ('localhost', 1, 'localhost', 1, 'default', 'ldap://127.0.0.1', 389, 0, 0, 3, '', NULL, 'a:2:{i:0;s:27:\"ou=users,dc=yunohost,dc=org\";i:1;s:32:\"ou=permission,dc=yunohost,dc=org\";}', 'uid', 'uid', 'mail', '', '', '', 0, 'cn=%username,ou=users,dc=yunohost,dc=org', '', '', '', 0, 'permissionynh', 0, 1, 'permission', 'memberuid', 'dn', 0, '', '$app.main', '', 0, 1000, 0);" -ynh_exec_as $app env PATH=$PATH drush @$app sql-query "INSERT INTO public.ldap_authorization VALUES (1, 'localhost', 'drupal_role', 'ldap_authorization_drupal_role', 1, 1, 0, 'a:2:{i:0;a:6:{s:12:\"user_entered\";s:24:\"utilisateur authentifié\";s:4:\"from\";s:51:\"cn=framaforms.main,ou=permission,dc=yunohost,dc=org\";s:10:\"normalized\";s:24:\"utilisateur authentifié\";s:10:\"simplified\";s:24:\"utilisateur authentifié\";s:5:\"valid\";b:0;s:13:\"error_message\";s:112:\"Role utilisateur authentifié_name does not exist and role creation is not enabled.\";}i:1;a:6:{s:12:\"user_entered\";s:13:\"administrator\";s:4:\"from\";s:52:\"cn=framaforms.admin,ou=permission,dc=yunohost,dc=org\";s:10:\"normalized\";s:13:\"administrator\";s:10:\"simplified\";s:13:\"administrator\";s:5:\"valid\";b:0;s:13:\"error_message\";s:101:\"Role administrator_name does not exist and role creation is not enabled.\";}}', 1, 0, 1, 1, 1, 1);" +ynh_exec_as $app env PATH=$PATH drush @$app sql-query "INSERT INTO public.ldap_authorization VALUES (1, 'localhost', 'drupal_role', 'ldap_authorization_drupal_role', 1, 1, 0, 'a:2:{i:0;a:6:{s:12:\"user_entered\";s:24:\"utilisateur authentifié\";s:4:\"from\";s:51:\"cn=$app.main,ou=permission,dc=yunohost,dc=org\";s:10:\"normalized\";s:24:\"utilisateur authentifié\";s:10:\"simplified\";s:24:\"utilisateur authentifié\";s:5:\"valid\";b:0;s:13:\"error_message\";s:112:\"Role utilisateur authentifié_name does not exist and role creation is not enabled.\";}i:1;a:6:{s:12:\"user_entered\";s:13:\"administrator\";s:4:\"from\";s:52:\"cn=$app.admin,ou=permission,dc=yunohost,dc=org\";s:10:\"normalized\";s:13:\"administrator\";s:10:\"simplified\";s:13:\"administrator\";s:5:\"valid\";b:0;s:13:\"error_message\";s:101:\"Role administrator_name does not exist and role creation is not enabled.\";}}', 1, 0, 1, 1, 1, 1);" cat ../conf/ldap.conf | ynh_exec_as $app env PATH=$PATH drush @$app variable-set --format=yaml ldap_authentication_conf - @@ -245,31 +166,6 @@ ynh_script_progression --message="Setuping the cron file..." ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -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" -fi - -# Only the admin can access the admin panel of the app (if the app has an admin panel) -ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 29fdc7b..38f107e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,92 +9,17 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE THE POSTGRESQL DATABASE -#================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1 - -# Remove a database if it exists, along with the associated user -ynh_psql_remove_db --db_user=$db_user --db_name=$db_name - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE DATA DIR -#================================================= - -# Remove the data directory if --purge option is used -if [ "${YNH_APP_PURGE:-0}" -eq 1 ] -then - ynh_script_progression --message="Removing app data directory..." - ynh_secure_remove --file="$datadir" -fi - #================================================= # REMOVE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 +ynh_script_progression --message="Removing system configurations for $app ..." -# Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1 - -# Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=7 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - -#================================================= -# SPECIFIC REMOVE -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." - -# Remove a cron file ynh_secure_remove --file="/etc/cron.d/$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 --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 889e89d..09aa400 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,81 +10,31 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" -chmod 2775 "$final_path/app/sites/default/files" +chmod 2775 "$install_dir/app/sites/default/files" #================================================= # RESTORE THE DATA DIRECTORY #================================================= ynh_script_progression --message="Restoring the data directory..." -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 -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=1 - -# Define and install dependencies -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:www-data "$data_dir" #================================================= # RESTORE THE PHP-FPM CONFIGURATION @@ -96,7 +46,6 @@ ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" # Recreate a dedicated php-fpm config ynh_add_fpm_config --usage=low --footprint=low -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # RESTORE THE NGINX CONFIGURATION @@ -108,11 +57,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=2 -ynh_psql_test_if_first_run -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_psql_execute_file_as_root --database=$db_name --file="./db.sql" #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 96e758a..47f3f24 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,20 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= # CHECK VERSION @@ -31,73 +17,18 @@ ynh_script_progression --message="Checking version..." --weight=1 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=21 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -if ! ynh_permission_exists --permission="admin"; then - # Create the required permissions - ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin -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 fi -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path + + +# If data_dir doesn't exist, create it +if [ -z "$data_dir" ]; then + data_dir=/home/yunohost.app/$app fi -# If datadir doesn't exist, create it -if [ -z "$datadir" ]; then - datadir=/home/yunohost.app/$app - ynh_app_setting_set --app=$app --key=datadir --value=$datadir -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -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 - - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=5 - -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - #================================================= # PHP-FPM CONFIGURATION #================================================= @@ -121,29 +52,29 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Creating a data directory..." -mkdir -p $datadir -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +mkdir -p $data_dir +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:www-data "$data_dir" #================================================= # Framaforms 2 Yakforms Backup #================================================= upgrade_to_yakforms=false -if test -d "$final_path/app/CHANGELOG-FRAMAFORMS.md" + then update-alternatives --set php /usr/bin/php$phpversion upgrade_to_yakforms=true - pushd "$final_path" + pushd "$install_dir" ynh_exec_as $app env PATH=$PATH php framaforms2yakforms.php backup - ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms - ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms + ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms + ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms_share_results - ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms_share_results - ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms_public_results - ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms_public_results - ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms_spam + ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms_share_results + ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms_public_results + ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms_public_results + ynh_exec_as $app env PATH=$PATH drush @$app dis framaforms_spam ynh_exec_as $app env PATH=$PATH drush @$app pm-uninstall framaforms_spam popd update-alternatives --set php /usr/bin/php${YNH_DEFAULT_PHP_VERSION} @@ -158,21 +89,21 @@ then ynh_script_progression --message="Upgrading source files..." --weight=9 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path/app" + ynh_setup_source --dest_dir="$install_dir/app" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # UPGRADE COMPOSER #================================================= ynh_script_progression --message="Upgrading Composer..." --weight=3 -ynh_install_composer --phpversion="$phpversion" --workdir="$final_path/.composer" +ynh_install_composer --phpversion="$phpversion" --workdir="$install_dir/.composer" -export PATH="$final_path/.composer/vendor/bin:$PATH" +export PATH="$install_dir/.composer/vendor/bin:$PATH" #================================================= # Framaforms 2 Yakforms Restore @@ -181,11 +112,11 @@ if [ "$upgrade_to_yakforms" = true ] then update-alternatives --set php /usr/bin/php$phpversion - pushd "$final_path" - ynh_exec_as $app env PATH=$PATH drush @$app en yakforms + pushd "$install_dir" + ynh_exec_as $app env PATH=$PATH drush @$app en yakforms ynh_exec_as $app env PATH=$PATH drush @$app dis yakforms_share_results - ynh_exec_as $app env PATH=$PATH drush @$app dis yakforms_public_results - ynh_exec_as $app env PATH=$PATH drush @$app dis yakforms_spam + ynh_exec_as $app env PATH=$PATH drush @$app dis yakforms_public_results + ynh_exec_as $app env PATH=$PATH drush @$app dis yakforms_spam ynh_exec_as $app env PATH=$PATH php framaforms2yakforms.php restore ynh_exec_as $app env PATH=$PATH php framaforms2yakforms.php clean popd @@ -199,17 +130,17 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading Drupal..." --weight=30 - ynh_backup_if_checksum_is_different --file="$final_path/app/sites/default/settings.php" + ynh_backup_if_checksum_is_different --file="$install_dir/app/sites/default/settings.php" update-alternatives --set php /usr/bin/php$phpversion - pushd "$final_path" - ynh_exec_as $app env PATH=$PATH drush @$app variable-set --exact maintenance_mode 1 - ynh_exec_as $app env PATH=$PATH drush @$app cache-clear all + pushd "$install_dir" + ynh_exec_as $app env PATH=$PATH drush @$app variable-set --exact maintenance_mode 1 + ynh_exec_as $app env PATH=$PATH drush @$app cache-clear all # ynh_exec_as $app env PATH=$PATH drush @$app pm-update -y drupal # ynh_exec_as $app env PATH=$PATH drush @$app updatedb -y - ynh_exec_as $app env PATH=$PATH drush @$app cache-clear all - ynh_exec_as $app env PATH=$PATH drush @$app variable-set --exact maintenance_mode 0 + ynh_exec_as $app env PATH=$PATH drush @$app cache-clear all + ynh_exec_as $app env PATH=$PATH drush @$app variable-set --exact maintenance_mode 0 popd update-alternatives --set php /usr/bin/php${YNH_DEFAULT_PHP_VERSION} @@ -220,17 +151,8 @@ fi #================================================= ynh_script_progression --message="Updating a configuration file..." -chmod 600 "$final_path/app/sites/default/settings.php" -chown $app:$app "$final_path/app/sites/default/settings.php" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +chmod 600 "$install_dir/app/sites/default/settings.php" +chown $app:$app "$install_dir/app/sites/default/settings.php" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..b1cf059 --- /dev/null +++ b/tests.toml @@ -0,0 +1,5 @@ +test_format = 1.0 + +[default] + + test_upgrade_from.79cdc1a13.name = "Upgrade from 1.0.3~ynh3"