Merge pull request #30 from YunoHost-Apps/example

Apply last example_ynh

README.md

@@ -1,7 +1,7 @@
 # Drupal 7 for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/drupal7.svg)](https://dash.yunohost.org/appci/app/drupal7) ![](https://ci-apps.yunohost.org/ci/badges/drupal7.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/drupal7.maintain.svg)  
-[![Install Drupal 7 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=drupal7)
+[![Install Drupal 7 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=drupal7)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
@@ -11,7 +11,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 ## Overview
 Free and open-source content management framework.
 
-**Shipped version:** 7.73
+**Shipped version:** 7.78
 
 ## Screenshots
 
@@ -23,7 +23,7 @@ Free and open-source content management framework.
 
 ## YunoHost specific features
 
-#### Multi-users support
+#### Multi-user support
 
 LDAP module can be installed
 
@@ -40,8 +40,7 @@ LDAP module can be installed
 
 ---
 
-Developer info
+## Developer info
-----------------
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/drupal7_ynh/tree/testing).
 

README_fr.md

@@ -1,17 +1,17 @@
 # Drupal 7 pour YunoHost
 
 [![Niveau d'intégration](https://dash.yunohost.org/integration/drupal7.svg)](https://dash.yunohost.org/appci/app/drupal7) ![](https://ci-apps.yunohost.org/ci/badges/drupal7.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/drupal7.maintain.svg)  
-[![Installer Drupal 7 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=drupal7)
+[![Installer drupal7 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=drupal7)
 
 *[Read this readme in english.](./README.md)* 
 
-> *Ce package vous permet d'installer Drupal 7 rapidement et simplement sur un serveur Yunohost.  
+> *Ce package vous permet d'installer drupal7 rapidement et simplement sur un serveur YunoHost.  
 Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
 
 ## Vue d'ensemble
 Framework de gestion de contenu libre et open-source.
 
-**Version incluse:** 7.73
+**Version incluse:** 7.78
 
 ## Captures d'écran
 
@@ -29,19 +29,18 @@ Le module d'authentification LDAP peut être installé
 
 #### Architectures supportées
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/drupal7%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/drupal7/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/drupal7%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/drupal7/)
 * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/drupal7%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/drupal7/)
 
 ## Liens
 
- * Signaler un bug: https://github.com/YunoHost-Apps/drupal7_ynh/issues
+ * Signaler un bug : https://github.com/YunoHost-Apps/drupal7_ynh/issues
- * Site de l'application: https://www.drupal.org
+ * Site de l'application : https://www.drupal.org
  * Site web YunoHost: https://yunohost.org/
 
 ---
 
-Informations pour les développeurs
+## Informations pour les développeurs
-----------------
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/drupal7_ynh/tree/testing).
 

check_process

@@ -15,17 +15,19 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
-		# 7
+		# 7.0~ynh1
 		# upgrade=1	from_commit=89bf310b8ac87a61e5974508f2b41fbb32823e95
+		# 7.73~ynh1
+		# upgrade=1	from_commit=6c565bad2d6083eac25eaee126d9eb32595d94b4
 		backup_restore=1
 		multi_instance=1
-		# This test is no longer necessary since the version 2.7 (PR: https://github.com/YunoHost/yunohost/pull/304), you can still do it if your app could be installed with this version.
-		# incorrect_path=1
 		port_already_use=0
 		change_url=1
-;;; Levels
-	# If the level 5 (Package linter) is forced to 1. Please add justifications here.
-	Level 5=auto
 ;;; Options
 Email=yalh@yahoo.com
 Notification=all
+;;; Upgrade options
+	; commit=89bf310b8ac87a61e5974508f2b41fbb32823e95
+		name=7.0~ynh1
+	; commit=6c565bad2d6083eac25eaee126d9eb32595d94b4
+		name=7.73~ynh1

issue_template.md

@@ -1,32 +1,34 @@
 ---
 name: Bug report
-about: Create a report to help us debug, it would be nice to fill the template as much as you can to help us, help you and help us all.
+about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently.
 
 ---
 
 **How to post a meaningful bug report**
 1. *Read this whole template first.*
 2. *Determine if you are on the right place:*
-   - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!*
+   - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
    - *Otherwise, the issue may be due to Drupal 7 itself. Refer to its documentation or repository for help.*
-   - *If you have a doubt, post here, we will figure it out together.*
+   - *When in doubt, post here and we will figure it out together.*
 3. *Delete the italic comments as you write over them below, and remove this guide.*
 --- 
 
-**Describe the bug**
+### Describe the bug
+
 *A clear and concise description of what the bug is.*
 
-**Versions**
+### Context
+
 - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
 - YunoHost version: x.x.x
 - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
-- Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes*
+- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes*
   - If yes, please explain:
 - Using, or trying to install package version/branch:
 - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
 
-**To Reproduce**
+### Steps to reproduce
-*Steps to reproduce the behavior.*
+
 - *If you performed a command from the CLI, the command itself is enough. For example:*
     ```sh
     sudo yunohost app install drupal7
@@ -34,13 +36,20 @@ about: Create a report to help us debug, it would be nice to fill the template a
 - *If you used the webadmin, please perform the equivalent command from the CLI first.*
 - *If the error occurs in your browser, explain what you did:*
    1. *Go to '...'*
-   2. *Click on '....'*
+   2. *Click on '...'*
-   3. *Scroll down to '....'*
+   3. *Scroll down to '...'*
    4. *See error*
 
-**Expected behavior**
+### Expected behavior
+
 *A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
 
-**Logs**
+### Logs
-*After a failed command, YunoHost makes the log available to you, but also to others, thanks to `yunohost log display [log name] --share`. The actual command, with the correct log name, is displayed at the end of the failed attempt in the CLI. Execute it and copy here the share link it outputs.*
+
+*When an operation fails, YunoHost provides a simple way to share the logs.*
+- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.*
+- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.*
+
+*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)*
+
 *If applicable and useful, add screenshots to help explain your problem.*

manifest.json

@@ -6,18 +6,19 @@
         "en": "Old version of a content management framework written in PHP",
         "fr": "Ancienne version d'un système de gestion de contenu écrit en PHP"
     },
-    "version": "7.73~ynh1",
+    "version": "7.78~ynh1",
     "url": "https://www.drupal.org",
     "license": "GPL-2.0-or-later",
     "maintainer": {
         "name": "yalh76"
     },
     "requirements": {
-        "yunohost": ">= 3.5"
+        "yunohost": ">= 4.1.7.3"
     },
     "multi_instance": true,
     "services": [
         "nginx",
+        "php7.3-fpm",
         "mysql"
     ],
     "arguments": {
@@ -46,7 +47,7 @@
                 "type": "user",
                 "ask": {
                     "en": "Choose an admin user",
-                    "fr": "Choisissez l’administrateur"
+                    "fr": "Choisissez l'administrateur"
                 },
                 "example": "johndoe"
             },

pull_request_template.md

@@ -13,6 +13,4 @@
 
 ## Package_check results
 ---
-*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
+* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"*
-
-[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/drupal7_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/drupal7_ynh%20PR-NUM-%20(USERNAME)/)  

scripts/change_url

@@ -96,6 +96,8 @@ then
 	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"
+	domain="$new_domain"
+	path_url="$new_path"
 fi
 
 #=================================================
@@ -105,13 +107,7 @@ fi
 #=================================================
 ynh_script_progression --message="Updating Drush alias..."
 
-drush_aliasconfig="$final_path/.drush/$app.aliases.drushrc.php"
+ynh_add_config --template="../conf/yoursite.aliases.drushrc.php" --destination="$final_path/.drush/$app.aliases.drushrc.php"
-cp -f "../conf/yoursite.aliases.drushrc.php" "$drush_aliasconfig"
-
-ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$drush_aliasconfig"
-ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$drush_aliasconfig"
-ynh_replace_string --match_string="__DOMAIN__" --replace_string="$new_domain" --target_file="$drush_aliasconfig"
-ynh_replace_string --match_string="__PATH_URL__" --replace_string="$new_path" --target_file="$drush_aliasconfig"
 
 #=================================================
 # GENERIC FINALISATION

scripts/install

@@ -77,6 +77,14 @@ db_user=$db_name
 ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 
+#=================================================
+# CREATE FINAL PATH
+#=================================================
+ynh_script_progression --message="Creating final path..."
+
+ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+mkdir -p "$final_path/$app"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -93,14 +101,6 @@ ynh_script_progression --message="Configuring system user..."
 # Create a system user
 ynh_system_user_create --username=$app --home_dir="$final_path"
 
-#=================================================
-# CREATE FINAL PATH
-#=================================================
-ynh_script_progression --message="Creating final path..."
-
-ynh_app_setting_set --app=$app --key=final_path --value=$final_path
-mkdir -p "$final_path/$app"
-
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
@@ -118,13 +118,8 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 ynh_script_progression --message="Creating Drush alias..."
 
 mkdir -p "$final_path/.drush"
-drush_aliasconfig="$final_path/.drush/$app.aliases.drushrc.php"
-cp -f "../conf/yoursite.aliases.drushrc.php" "$drush_aliasconfig"
 
-ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$drush_aliasconfig"
+ynh_add_config --template="../conf/yoursite.aliases.drushrc.php" --destination="$final_path/.drush/$app.aliases.drushrc.php"
-ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$drush_aliasconfig"
-ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$drush_aliasconfig"
-ynh_replace_string --match_string="__PATH_URL__" --replace_string="$path_url" --target_file="$drush_aliasconfig"
 
 #=================================================
 # INSTALL COMPOSER
@@ -133,7 +128,7 @@ ynh_script_progression --message="Installing Composer..."
 
 mkdir -p "$final_path/.composer"
 
-cp -f "../conf/composer.json" "$final_path/.composer/composer.json"
+ynh_add_config --template="../conf/composer.json" --destination="$final_path/.composer/composer.json"
 
 ynh_install_composer --phpversion="$phpversion" --workdir="$final_path/.composer"
 
@@ -173,10 +168,7 @@ update-alternatives --set php /usr/bin/php${YNH_DEFAULT_PHP_VERSION}
 #=================================================
 ynh_script_progression --message="Setuping the cron file..."
 
-cp ../conf/cron /etc/cron.d/$app
+ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app"
-
-ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="/etc/cron.d/$app"
-ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="/etc/cron.d/$app"
 
 #=================================================
 # STORE THE CONFIG FILE CHECKSUM
@@ -199,13 +191,14 @@ chown -R $app: $final_path
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring SSOwat..."
+ynh_script_progression --message="Configuring permissions..."
 
 # Make app public if necessary
 if [ $is_public -eq 1 ]
 then
-	# unprotected_uris allows SSO credentials to be passed anyway.
+	# Everyone can access the app.
-	ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
+	# The "main" permission is automatically created before the install script.
+	ynh_permission_update --permission="main" --add="visitors"
 fi
 
 #=================================================

scripts/restore

@@ -86,6 +86,7 @@ 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 --package="$extra_php_dependencies"
+phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # SPECIFIC RESTORATION

scripts/upgrade

@@ -20,11 +20,9 @@ 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)
-is_public=$(ynh_app_setting_get --app=$app --key=is_public)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 language=$(ynh_app_setting_get --app=$app --key=language)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # CHECK VERSION
@@ -38,25 +36,11 @@ upgrade_type=$(ynh_check_app_version_changed)
 #=================================================
 ynh_script_progression --message="Ensuring downward compatibility..."
 
-# Fix is_public as a boolean value
+# Cleaning legacy permissions
-if [ "$is_public" = "Yes" ]; then
+if ynh_legacy_permissions_exists; then
-	ynh_app_setting_set --app=$app --key=is_public --value=1
+	ynh_legacy_permissions_delete_all
-	is_public=1
-elif [ "$is_public" = "No" ]; then
-	ynh_app_setting_set --app=$app --key=is_public --value=0
-	is_public=0
-fi
 
-# If db_name doesn't exist, create it
+	ynh_app_setting_delete --app=$app --key=is_public
-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
 fi
 
 #=================================================
@@ -105,6 +89,7 @@ ynh_script_progression --message="Upgrading php-fpm configuration..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config --package="$extra_php_dependencies"
+phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # SPECIFIC UPGRADE
@@ -148,12 +133,7 @@ ynh_store_file_checksum --file="$final_path/$app/sites/default/settings.php"
 #=================================================
 ynh_script_progression --message="Setuping the cron file"
 
-cp -f ../conf/cron /etc/cron.d/$app
+ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app"
-
-ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="/etc/cron.d/$app"
-ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="/etc/cron.d/$app"
-
-ynh_systemd_action --service_name=cron --action=reload
 
 #=================================================
 # GENERIC FINALIZATION
@@ -165,18 +145,6 @@ ynh_script_progression --message="Securing files and directories..."
 # Set permissions on app files
 chown -R $app: $final_path
 
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Upgrading SSOwat configuration..."
-
-# Make app public if necessary
-if [ $is_public -eq 1 ]
-then
-	# unprotected_uris allows SSO credentials to be passed anyway
-	ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
-fi
-
 #=================================================
 # RELOAD NGINX
 #=================================================