Apply last example_ynh (#21)

* Testing (#18) * Update install * Apply last example_ynh Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
2024-09-03 18:15:57 +02:00 · 2022-06-03 21:36:50 +02:00 · 2022-06-03 21:36:50 +02:00 · 371f3d48e1
commit 371f3d48e1
parent ded1da93f0
19 changed files with 138 additions and 169 deletions
--- a/.gitattributes
+++ b/.gitattributes
@ -1,17 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
--- a/.gitignore
+++ b/.gitignore
@ -1,43 +0,0 @@
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-# =========================
-# Operating System Files
-# =========================
-
-# OSX
-# =========================
-
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Thumbnails
-._*
-
-# Files that might appear on external disk
-.Spotlight-V100
-.Trashes
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
--- a/6
+++ b/6
@ -11,13 +11,11 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# 1.0~ynh3
+		upgrade=1	from_commit=5ea5611d28a8330a7d9127371d60f28083b0a0fb
 		backup_restore=1
 		multi_instance=0
 		change_url=1
 ;;; Options
 Email=
 Notification=none
-;;; Upgrade options
-	; commit=CommitHash
-		name=Name and date of the commit.
-		manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1&
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@ -4,11 +4,6 @@ location __PATH__/ {
  # Path to source
  alias __FINALPATH__/ ;

-  # Force usage of https
-  if ($scheme = http) {
-    rewrite ^ https://$server_name$request_uri? permanent;
-  }
-
  index index.html index.php;

  try_files $uri $uri/ index.php;
--- a/doc/.gitkeep
+++ b/doc/.gitkeep
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@ -0,0 +1,9 @@
+## Overview
+ChtickyNotes core is based on [Post It All!](https://github.com/txusko/PostItAll).
+ChtickyNotes is a "simple post-it" application. Its main features are:
+- notes movable and resizable
+- edit note by just typing on it (or CTRL-V to paste chunks of HTML)
+- menu on each note to change its color, and so on
+- global menu to change board, and so on
+- autosave every 10 seconds
+- storage on the server (not on the browser local storage)
--- a/doc/DESCRIPTION_fr.md
+++ b/doc/DESCRIPTION_fr.md
@ -0,0 +1,9 @@
+## Overview
+Le noyau de ChtickyNotes est basé sur [Post It All!](Https://github.com/txusko/PostItAll).
+ChtickyNotes est une application "post-it". Ses principales caractéristiques sont :
+- notes mobiles et redimensionnables
+- éditer la note en tapant simplement dessus (ou CTRL-V pour coller du code HTML)
+- menu sur chaque note pour changer sa couleur...
+- menu global pour changer de tableau...
+- sauvegarde automatique toutes les 10 secondes
+- stockage sur le serveur (pas de stockage local dans le navigateur)
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
--- a/doc/DISCLAIMER_fr.md
+++ b/doc/DISCLAIMER_fr.md
--- a/doc/screenshots/.gitkeep
+++ b/doc/screenshots/.gitkeep
--- a/doc/screenshots/chtickynotes.gif
+++ b/doc/screenshots/chtickynotes.gif
--- a/manifest.json
+++ b/manifest.json
@ -6,28 +6,35 @@
        "en": "Generic sticky notes for all purpose",
        "fr": "Post-its génériques à tout faire"
    },
-    "version": "1.0~ynh3",
+    "version": "1.0~ynh4",
    "url": "https://github.com/YunoHost-Apps/chtickynotes_ynh/",
+    "upstream": {
        "license": "MIT",
+        "website": "https://example.com",
+        "code": "https://github.com/YunoHost-Apps/chtickynotes_ynh/"
+    },
    "developer": {
        "name": "chtixof"
    },
+    "license": "MIT",
    "maintainer": {
        "name": "",
        "email": ""
    },
    "requirements": {
-        "yunohost": ">= 4.2.4"
+        "yunohost": ">= 4.3.0"
    },
    "multi_instance": false,
    "services": [
        "nginx"
    ],
    "arguments": {
-        "install" : [            {
+        "install": [
+            {
                "name": "domain",
                "type": "domain"
-            },{
+            },
+            {
                "name": "path",
                "type": "path",
                "example": "/chtickynotes",
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@ -3,7 +3,7 @@
 #=================================================
 # COMMON VARIABLES
 #=================================================
-YNH_PHP_VERSION="7.3"
+
 #=================================================
 # PERSONAL HELPERS
 #=================================================
--- a/scripts/backup
+++ b/scripts/backup
@ -6,6 +6,7 @@
 # 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

@ -13,6 +14,10 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================

+ynh_clean_setup () {
+	true
+}
+# Exit if an error occurs during the execution of the script
 ynh_abort_if_errors

 #=================================================
@ -53,4 +58,4 @@ ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 # END OF SCRIPT
 #=================================================

-ynh_print_info --message="Backup script completed for ChtickyNotes. (YunoHost will then actually copy those files to the archive)."
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
--- a/scripts/change_url
+++ b/scripts/change_url
@ -6,11 +6,9 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+source _common.sh
 source /usr/share/yunohost/helpers

-# Stop script if errors
-ynh_abort_if_errors
-
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
@ -26,23 +24,24 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+ynh_script_progression --message="Loading installation settings..."

 # Needed for helper "ynh_add_nginx_config"
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)

 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up ChtickyNotes before changing its URL (may take a while)..." --weight=2
+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 () {
+	ynh_clean_check_starting
 	# 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
+	# Restore it if the upgrade fails
 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
@ -64,6 +63,8 @@ then
 	change_path=1
 fi

+#=================================================
+# STANDARD MODIFICATIONS
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
@ -104,4 +105,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Change of URL completed for ChtickyNotes" --last
+ynh_script_progression --message="Change of URL completed for $app" --last
--- a/scripts/install
+++ b/scripts/install
@ -14,7 +14,6 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
 	true
 }
 # Exit if an error occurs during the execution of the script
@ -33,7 +32,7 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_script_progression --message="Validating installation parameters..." --weight=1
+ynh_script_progression --message="Validating installation parameters..."

 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
@ -44,11 +43,19 @@ 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_script_progression --message="Storing installation settings..."

 ynh_app_setting_set --app=$app --key=domain --value=$domain
 ynh_app_setting_set --app=$app --key=path --value=$path_url

+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..."
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@ -59,6 +66,10 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 mkdir -p $final_path
 cp -a ../sources/* $final_path

+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@ -67,45 +78,31 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 # Create a dedicated NGINX config
 ynh_add_nginx_config

-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..."  --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Upgrading PHP-FPM configuration..."
+ynh_script_progression --message="Configuring PHP-FPM..."

-# Create a dedicated php-fpm config
+# Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low

-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
-
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..." --weight=1
+ynh_script_progression --message="Configuring permissions..."

 # 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

 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..."

 ynh_systemd_action --service_name=nginx --action=reload

@ -113,4 +110,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Installation of ChtickyNotes completed" --last
+ynh_script_progression --message="Installation of $app completed" --last
--- a/scripts/remove
+++ b/scripts/remove
@ -12,44 +12,46 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+ynh_script_progression --message="Loading installation settings..."

 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)

+#=================================================
+# STANDARD REMOVE
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing ChtickyNotes main directory..." --weight=2
+ynh_script_progression --message="Removing app main directory..." --weight=2

 # Remove the app directory securely
 ynh_secure_remove --file="$final_path"

-#=================================================
-# 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 NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
+ynh_script_progression --message="Removing NGINX web server configuration..."

 # Remove the dedicated NGINX config
 ynh_remove_nginx_config

+#=================================================
+# REMOVE PHP-FPM CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing PHP-FPM configuration..."
+
+# Remove the dedicated PHP-FPM config
+ynh_remove_fpm_config
+
+
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user..."  --weight=1
+ynh_script_progression --message="Removing the dedicated system user..."

 # Delete a system user
 ynh_system_user_delete --username=$app
@ -58,4 +60,4 @@ ynh_system_user_delete --username=$app
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Removal of ChtickyNotes completed" --last
+ynh_script_progression --message="Removal of $app completed" --last
--- a/scripts/restore
+++ b/scripts/restore
@ -6,6 +6,7 @@
 # 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

@ -13,12 +14,16 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================

+ynh_clean_setup () {
+	true
+}
+# 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
+ynh_script_progression --message="Loading installation settings..."

 app=$YNH_APP_INSTANCE_NAME

@ -40,29 +45,25 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Restoring the NGINX web server configuration..."

 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

+#=================================================
+# RECREATE THE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Recreating the dedicated system user..."
+
+# 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 ChtickyNotes main directory..." --weight=2
+ynh_script_progression --message="Restoring the app main directory..." --weight=2

 ynh_restore_file --origin_path="$final_path"

-#=================================================
-# 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
-
-#=================================================
-# RESTORE USER RIGHTS
-#=================================================
-
-# Restore permissions on app files
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
@ -70,6 +71,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
+ynh_script_progression --message="Restoring the PHP-FPM configuration..."

 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"

@ -78,7 +80,7 @@ ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..."

 ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
 ynh_systemd_action --service_name=nginx --action=reload
@ -87,4 +89,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Restoration completed for ChtickyNotes" --last
+ynh_script_progression --message="Restoration completed for $app" --last
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -12,7 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+ynh_script_progression --message="Loading installation settings..."

 app=$YNH_APP_INSTANCE_NAME

@ -26,6 +26,23 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)

 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)..."
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	ynh_clean_check_starting
+	# 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
 #=================================================
@ -44,39 +61,18 @@ if ynh_legacy_permissions_exists; then
 	ynh_app_setting_delete --app=$app --key=is_public
 fi

-#=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up ChtickyNotes before upgrading (may take a while)..." --weight=1
-
-# 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
-
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+ynh_script_progression --message="Making sure dedicated system user exists..."

 # Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
-# PHP-FPM CONFIGURATION
-#=================================================
-ynh_script_progression --message="Configuring PHP-FPM..."
-
-# Create a dedicated PHP-FPM config
-ynh_add_fpm_config --usage=low --footprint=low
-
-#=================================================
-# SECURE FILES AND DIRECTORIES
+# DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_script_progression --message="Upgrading source files..."

 cp -a ../sources/* $final_path

@ -89,13 +85,21 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

+#=================================================
+# PHP-FPM CONFIGURATION
+#=================================================
+ynh_script_progression --message="Upgrading PHP-FPM configuration..."
+
+# Create a dedicated PHP-FPM config
+ynh_add_fpm_config --usage=low --footprint=low
+
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..."

 ynh_systemd_action --service_name=nginx --action=reload

@ -103,4 +107,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Upgrade of ChtickyNotes completed" --last
+ynh_script_progression --message="Upgrade of $app completed" --last