Merge pull request #143 from YunoHost-Apps/plugins-upgrades

Upgrade to 1.8.14

CHANGELOG.md

@@ -1,12 +1,18 @@
 Changelog
 =========
 
+## [1.8.14~ynh1]() - 2021-06-04
+
+#### Changed
+* [Upgrade to 1.8.14](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/commit/452b42c106f9e67f84165e1f62ba7cc516240351)
+* [Update to MyPads 1.7.21](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/commit/678da97ecac67491028cdeba1493ba11650b992b)
+* [Update helpers](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/commit/3873098c04a798684c1eddd0c86465bec7b28237)
+
 ## [1.8.13~ynh2]() - 2021-05-14
 
 #### Disabled
 * [ep_automatic_logut plugin](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/140/files)
 
-
 ## [1.8.13~ynh1]() - 2021-03-23
 
 #### Changed
@@ -42,7 +48,7 @@ Changelog
 * [Add changelog](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/76)
 
 #### Fixed
-- [Show a link to mypads only if installed](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/74/commits/46b50b32e58edfb74c143fe5a50362629294f50b)
+* [Show a link to mypads only if installed](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/74/commits/46b50b32e58edfb74c143fe5a50362629294f50b)
 
 #### Changed
 * [Upgrade to 1.8.0](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/78)
@@ -61,19 +67,19 @@ Changelog
 - [Progress bar](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/4489e07a059477802cfeb402e1980b79e1ddce97)
 
 #### Fixed
-- [Fix regression on ynh_system_user_create](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/c0de9b2ee3ebc5ecb11e02655984e1fe793dd9d5)
+* [Fix regression on ynh_system_user_create](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/c0de9b2ee3ebc5ecb11e02655984e1fe793dd9d5)
 
 #### Changed
-- [Update to last standart](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/c663ec74c1d97cccbc1291a9d3e74cdf3b7586e9)
+* [Update to last standart](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/c663ec74c1d97cccbc1291a9d3e74cdf3b7586e9)
 * [Update to mypads 1.7.6](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/c87caaad6507a52a71572ef21529cc4f1022b53b)
-- [Update helpers](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/bab779a39f3f6f45c0fcc6bdf640baa47a5e6821)
+* [Update helpers](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/bab779a39f3f6f45c0fcc6bdf640baa47a5e6821)
-- [Allow to include a pad in an other page](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/f27cca79957f88fd9972452db146fe6867ba3f79)
+* [Allow to include a pad in an other page](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/63/commits/f27cca79957f88fd9972452db146fe6867ba3f79)
 
 
 ## [1.7.0~ynh1](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/55) - 2018-12-08
 
 #### Fixed
-- [Set permissions during the restore script](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/55/commits/85be69b5ce15db0d9df0f0ca191be43c2ea6bc31)
+* [Set permissions during the restore script](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/55/commits/85be69b5ce15db0d9df0f0ca191be43c2ea6bc31)
 
 #### Changed
 * [Update mypads to 1.6.8](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/pull/55/commits/8c73fd242286029991b774d02ce9209c88793c21)

README.md

@@ -1,7 +1,3 @@
-
-
----
-
 <!--
 N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
 It shall NOT be edited by hand.
@@ -10,23 +6,24 @@ It shall NOT be edited by hand.
 # Etherpad MyPads for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)  
-[![Install etherpad_mypads with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad_mypads)
+[![Install Etherpad MyPads with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad_mypads)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install etherpad_mypads quickly and simply on a YunoHost server.
+> *This package allows you to install Etherpad MyPads quickly and simply on a YunoHost server.
 If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
 
-Online editor providing collaborative editing in real-time.
+Online editor providing collaborative editing in real-time
 
-**Shipped version:** 1.8.13~ynh2
+**Shipped version:** 1.8.14~ynh1
 
 **Demo:** https://video.etherpad.com
 
+## Screenshots
 
-
+![](./doc/screenshots/etherpad_demo.gif)
 
 ## Disclaimers / important information
 
@@ -62,13 +59,11 @@ You can also find a configuration file for Etherpad at this path `/var/www/ether
   * [ep_subscript_and_superscript](https://www.npmjs.com/package/ep_subscript_and_superscript) - *Add support for Subscript and Superscript*
   * [ep_table_of_contents](https://www.npmjs.com/package/ep_table_of_contents) - *View a table of contents for your pad*
 
-
-
 ## Documentation and resources
 
 * Official app website: http://etherpad.org
 * Official user documentation: https://yunohost.org/en/app_etherpad_mypads
-* Official admin documentation: http://etherpad.org/doc/v1.8.13
+* Official admin documentation: http://etherpad.org/doc/v1.8.14
 * Upstream app code repository: https://github.com/ether/etherpad-lite
 * YunoHost documentation for this app: https://yunohost.org/app_etherpad_mypads
 * Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues

README_fr.md

@@ -1,24 +1,25 @@
 # Etherpad MyPads pour YunoHost
 
 [![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)  
-[![Installer etherpad_mypads avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad_mypads)
+[![Installer Etherpad MyPads avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad_mypads)
 
 *[Read this readme in english.](./README.md)*
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install etherpad_mypads quickly and simply on a YunoHost server.
+> *Ce package vous permet d'installer Etherpad MyPads rapidement et simplement sur un serveur YunoHost.
-If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
 
-Éditeur en ligne fournissant l'édition collaborative en temps réel.
+Éditeur en ligne fournissant l'édition collaborative en temps réel
 
-**Version incluse:** 1.8.13~ynh2
+**Version incluse :** 1.8.14~ynh1
-
-**Démo:** https://video.etherpad.com
 
+**Démo :** https://video.etherpad.com
 
+## Captures d'écran
 
+![](./doc/screenshots/etherpad_demo.gif)
 
 ## Avertissements / informations importantes
 
@@ -55,16 +56,14 @@ Vous pouvez accéder à deux panneaux d'administration différents, pour Etherpa
   * [ep_subscript_and_superscript](https://www.npmjs.com/package/ep_subscript_and_superscript) - *Ajouter la prise en charge de Subscript et Superscript*.
   * [ep_table_of_contents](https://www.npmjs.com/package/ep_table_of_contents) - *Voir une table des matières pour votre pad*
 
-
-
 ## Documentations et ressources
 
-* Site official de l'app : http://etherpad.org
+* Site officiel de l'app : http://etherpad.org
-* Documentation officielle utilisateur: https://yunohost.org/en/app_etherpad_mypads
+* Documentation officielle utilisateur : https://yunohost.org/en/app_etherpad_mypads
-* Documentation officielle de l'admin: http://etherpad.org/doc/v1.8.13
+* Documentation officielle de l'admin : http://etherpad.org/doc/v1.8.14
-* Dépôt de code officiel de l'app:  https://github.com/ether/etherpad-lite
+* Dépôt de code officiel de l'app : https://github.com/ether/etherpad-lite
-* Documentation YunoHost pour cette app: https://yunohost.org/app_etherpad_mypads
+* Documentation YunoHost pour cette app : https://yunohost.org/app_etherpad_mypads
-* Signaler un bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues
+* Signaler un bug : https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues
 
 ## Informations pour les développeurs
 
@@ -73,8 +72,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
 Pour essayer la branche testing, procédez comme suit.
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --debug
-or
+ou
 sudo yunohost app upgrade etherpad_mypads -u https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --debug
 ```
 
-**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

conf/app.src

@@ -1,5 +1,5 @@
-SOURCE_URL=https://github.com/ether/etherpad-lite/archive/1.8.13.tar.gz
+SOURCE_URL=https://github.com/ether/etherpad-lite/archive/1.8.14.tar.gz
-SOURCE_SUM=c83052daf3b0af8aa3c19a8308e21fcbcfecca99aeb3e8047383875f855443f1
+SOURCE_SUM=5404035675fb5ee9349d42927895bb3933590823612ebe31ca4cc523afdac49e
 SOURCE_SUM_PRG=sha256sum
 ARCH_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true

conf/settings.json

@@ -15,6 +15,31 @@
  *
  * This is useful, for example, when running in a Docker container.
  *
+ * DETAILED RULES:
+ *   - If the environment variable is set to the string "true" or "false", the
+ *     value becomes Boolean true or false.
+ *   - If the environment variable is set to the string "null", the value
+ *     becomes null.
+ *   - If the environment variable is set to the string "undefined", the setting
+ *     is removed entirely, except when used as the member of an array in which
+ *     case it becomes null.
+ *   - If the environment variable is set to a string representation of a finite
+ *     number, the string is converted to that number.
+ *   - If the environment variable is set to any other string, including the
+ *     empty string, the value is that string.
+ *   - If the environment variable is unset and a default value is provided, the
+ *     value is as if the environment variable was set to the provided default:
+ *       - "${UNSET_VAR:}" becomes the empty string.
+ *       - "${UNSET_VAR:foo}" becomes the string "foo".
+ *       - "${UNSET_VAR:true}" and "${UNSET_VAR:false}" become true and false.
+ *       - "${UNSET_VAR:null}" becomes null.
+ *       - "${UNSET_VAR:undefined}" causes the setting to be removed (or be set
+ *         to null, if used as a member of an array).
+ *   - If the environment variable is unset and no default value is provided,
+ *     the value becomes null. THIS BEHAVIOR MAY CHANGE IN A FUTURE VERSION OF
+ *     ETHERPAD; if you want the default value to be null, you should explicitly
+ *     specify "null" as the default value.
+ *
  * EXAMPLE:
  *    "port":     "${PORT:9001}"
  *    "minify":   "${MINIFY}"

manifest.json

@@ -3,16 +3,16 @@
 	"id": "etherpad_mypads",
 	"packaging_format": 1,
 	"description": {
-		"en": "Online editor providing collaborative editing in real-time.",
+		"en": "Online editor providing collaborative editing in real-time",
-		"fr": "Éditeur en ligne fournissant l'édition collaborative en temps réel."
+		"fr": "Éditeur en ligne fournissant l'édition collaborative en temps réel"
 	},
-	"version": "1.8.13~ynh2",
+	"version": "1.8.14~ynh1",
-	"url": "https://framapad.org",
+	"url": "http://etherpad.org",
 	"upstream": {
         "license": "Apache-2.0",
         "website": "http://etherpad.org",
         "demo": "https://video.etherpad.com",
-        "admindoc": "http://etherpad.org/doc/v1.8.13",
+        "admindoc": "http://etherpad.org/doc/v1.8.14",
         "userdoc": "https://yunohost.org/en/app_etherpad_mypads",
         "code": "https://github.com/ether/etherpad-lite"
     },
@@ -26,7 +26,7 @@
 		"email": "maniackc_dev@crudelis.fr"
 	}],
 	"requirements": {
-		"yunohost": ">= 4.1.7"
+		"yunohost": ">= 4.2.4"
 	},
 	"multi_instance": true,
 	"services": [

scripts/_common.sh

@@ -1,5 +1,39 @@
 #!/bin/bash
 
+#=================================================
+# COMMON VARIABLES
+#=================================================
+
+#!/bin/bash
+
+# Dependencies for AbiWord
+abiword_app_depencencies="abiword"
+
+# Dependencies for LibreOffice
+libreoffice_app_dependencies="unoconv libreoffice-writer"
+
+# NodeJS version
+nodejs_version=14
+
+# MyPads version
+# This variable is mostly used to force an upgrade of the package in case of new versions of MyPads.
+mypads_version=1.7.21
+
+# Plugin versions
+ep_align_version=0.3.34
+ep_author_hover_version=0.3.19
+ep_comments_page_version=0.1.60
+ep_countable_version=0.0.11
+ep_delete_empty_pads_version=0.0.7
+ep_font_color_version=0.0.43
+ep_headings2_version=0.2.30
+ep_markdown_version=0.1.36
+ep_page_view_version=0.5.24
+ep_spellcheck_version=0.0.28
+ep_subscript_and_superscript_version=0.2.30
+ep_table_of_contents_version=0.3.20
+ep_font_size_version=0.4.23
+
 #=================================================
 # PERSONAL HELPERS
 #=================================================
@@ -369,18 +403,3 @@ ynh_app_changelog () {
         echo "No significative changes from the changelog..." > "${final_changelog}_lite"
     fi
 }
-
-#=================================================
-
-# Execute a command as another user
-# usage: ynh_exec_as USER COMMAND [ARG ...]
-ynh_exec_as() {
-  local USER=$1
-  shift 1
-
-  if [[ $USER = $(whoami) ]]; then
-    eval "$@"
-  else
-    sudo -u "$USER" "$@"
-  fi
-}

scripts/_variables

@@ -1,29 +0,0 @@
-#!/bin/bash
-
-# Dependencies for AbiWord
-abiword_app_depencencies="abiword"
-
-# Dependencies for LibreOffice
-libreoffice_app_dependencies="unoconv libreoffice-writer"
-
-# NodeJS version
-nodejs_version=14
-
-# MyPads version
-# This variable is mostly used to force an upgrade of the package in case of new versions of MyPads.
-mypads_version=1.7.20
-
-# Plugin versions
-ep_align_version=0.3.34
-ep_author_hover_version=0.3.19
-ep_comments_page_version=0.1.60
-ep_countable_version=0.0.11
-ep_delete_empty_pads_version=0.0.7
-ep_font_color_version=0.0.42
-ep_headings2_version=0.2.28
-ep_markdown_version=0.1.32
-ep_page_view_version=0.5.24
-ep_spellcheck_version=0.0.27
-ep_subscript_and_superscript_version=0.2.26
-ep_table_of_contents_version=0.3.20
-ep_font_size_version=0.4.22

scripts/actions/add_remove_abiword

@@ -67,9 +67,6 @@ fi
 
 ynh_script_progression --message="$action2 AbiWord..." --weight=3
 
-# Load common variables, and especially Abiword dependencies.
-source scripts/_variables
-
 dependencies=""
 if [ $abiword -eq 1 ]
 then

scripts/actions/add_remove_libreoffice

@@ -67,9 +67,6 @@ fi
 
 ynh_script_progression --message="$action2 LibreOffice..." --weight=3
 
-# Load common variables, and especially LibreOffice dependencies.
-source scripts/_variables
-
 dependencies=""
 if [ $libreoffice -eq 1 ]
 then

scripts/install

@@ -11,7 +11,6 @@ if [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then
 fi
 
 # Load common variables for all scripts.
-source _variables
 source _common.sh
 source /usr/share/yunohost/helpers
 
@@ -203,16 +202,17 @@ fi
 ynh_store_file_checksum --file="$final_path/settings.json"
 
 ynh_add_config --template="../conf/credentials.json" --destination="$final_path/credentials.json"
+# Restrict access to credentials.json
+chmod 600 $final_path/credentials.json
 
 #=================================================
 # SECURING FILES AND DIRECTORIES
 #=================================================
 
 # Set files ownership to etherpad
-chown -R $app:$app $final_path
+chmod 750 "$final_path"
-chmod o-rwx $final_path
+chmod o-rwx "$final_path"
-# Restrict access to credentials.json
+chown -R $app: "$final_path"
-chmod 600 $final_path/credentials.json
 
 #=================================================
 # SETUP SYSTEMD
@@ -220,7 +220,7 @@ chmod 600 $final_path/credentials.json
 ynh_script_progression --message="Configuring a systemd service..." --weight=4
 
 # Create a dedicated systemd config
-ynh_add_systemd_config --others_var="ynh_node_load_PATH"
+ynh_add_systemd_config
 
 #=================================================
 # ADVERTISE SERVICE IN ADMIN PANEL
@@ -263,6 +263,7 @@ ynh_npm install ep_table_of_contents@${ep_table_of_contents_version} >> $install
 	# Framapad - User Pad Contents font size can be set in settings, this does not effect other peoples views
 	ynh_npm install ep_font_size@${ep_font_size_version} >> $install_log 2>&1
 popd
+
 chown -R $app: $final_path/node_modules
 
 #=================================================

scripts/remove

@@ -17,6 +17,7 @@ ynh_script_progression --message="Loading installation settings..." --weight=3
 app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get --app=$app --key=domain)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 export=$(ynh_app_setting_get --app=$app --key=export)
@@ -74,7 +75,7 @@ ynh_mysql_remove_db --db_user=$db_name --db_name=$db_name
 ynh_script_progression --message="Removing Etherpad main directory..."
 
 # Remove the app directory securely
-ynh_secure_remove --file="/var/www/$app"
+ynh_secure_remove --file="$final_path"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
@@ -89,6 +90,8 @@ ynh_remove_nginx_config
 #=================================================
 ynh_script_progression --message="Removing logrotate configuration..."
 
+ynh_secure_remove --file="/var/log/$app"
+
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
 

scripts/restore

@@ -7,8 +7,6 @@
 #=================================================
 
 # Load common variables for all scripts.
-source ../settings/scripts/_variables
-
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
@@ -135,8 +133,9 @@ ynh_exec_warn_less npm cache clean --force
 #=================================================
 
 # Restore permissions on app files
-chown -R $app: $final_path
+chmod 750 "$final_path"
-chmod o-rwx $final_path
+chmod o-rwx "$final_path"
+chown -R $app: "$final_path"
 
 #=================================================
 # ADVERTISE SERVICE IN ADMIN PANEL

scripts/upgrade

@@ -7,7 +7,6 @@
 #=================================================
 
 # Load common variables for all scripts.
-source _variables
 source _common.sh
 source /usr/share/yunohost/helpers
 
@@ -105,25 +104,25 @@ fi
 # If overwrite_settings doesn't exist, create it
 if [ -z "$overwrite_settings" ]; then
 	overwrite_settings=1
-	ynh_app_setting_set $app overwrite_settings $overwrite_settings
+	ynh_app_setting_set --app=$app --key=overwrite_settings --value=$overwrite_settings
 fi
 
 # If overwrite_credentials doesn't exist, create it
 if [ -z "$overwrite_credentials" ]; then
 	overwrite_credentials=1
-	ynh_app_setting_set $app overwrite_credentials $overwrite_credentials
+	ynh_app_setting_set --app=$app --key=overwrite_credentials --value=$overwrite_credentials
 fi
 
 # If overwrite_nginx doesn't exist, create it
 if [ -z "$overwrite_nginx" ]; then
 	overwrite_nginx=1
-	ynh_app_setting_set $app overwrite_nginx $overwrite_nginx
+	ynh_app_setting_set --app=$app --key=overwrite_nginx --value=$overwrite_nginx
 fi
 
 # If overwrite_systemd doesn't exist, create it
 if [ -z "$overwrite_systemd" ]; then
 	overwrite_systemd=1
-	ynh_app_setting_set $app overwrite_systemd $overwrite_systemd
+	ynh_app_setting_set --app=$app --key=overwrite_systemd --value=$overwrite_systemd
 fi
 
 # Cleaning legacy permissions
@@ -313,6 +312,7 @@ ynh_npm install ep_table_of_contents@${ep_table_of_contents_version} >> $install
     # Framapad - User Pad Contents font size can be set in settings, this does not effect other peoples views
     ynh_npm install ep_font_size@${ep_font_size_version} >> $install_log 2>&1
 popd
+
 chown -R $app: $final_path/node_modules
 
 #=================================================
@@ -393,8 +393,9 @@ fi
 #=================================================
 
 # Set files ownership to Etherpad
-chown -R $app: $final_path
+chmod 750 "$final_path"
-chmod o-rwx $final_path
+chmod o-rwx "$final_path"
+chown -R $app: "$final_path"
 # Restrict access to credentials.json
 chmod 600 "$final_path/credentials.json"
 chown $app -R /var/log/$app/etherpad.log
@@ -429,7 +430,7 @@ ynh_script_progression --message="Upgrading systemd configuration..." --weight=2
 # Overwrite the systemd configuration only if it's allowed
 if [ $overwrite_systemd -eq 1 ]
 then
-	ynh_add_systemd_config --others_var="ynh_node_load_PATH"
+	ynh_add_systemd_config
 fi
 
 #=================================================