Merge ffc92b03e3 into 5e30a37743

.github/workflows/updater.sh

@@ -9,9 +9,6 @@
 # Since each app is different, maintainers can adapt its contents so as to perform
 # automatic actions when a new upstream release is detected.
 
-# Remove this exit command when you are ready to run this Action
-#exit 1
-
 #=================================================
 # FETCHING LATEST RELEASE AND ITS ASSETS
 #=================================================
@@ -66,12 +63,9 @@ echo "Handling asset at $asset_url"
 # Here we base the source file name upon a unique keyword in the assets url (admin vs. update)
 # Leave $src empty to ignore the asset
 case $asset_url in
-  *"admin"*)
+  *"prestashop_"*)
     src="app"
     ;;
-  *"update"*)
-    src="app-upgrade"
-    ;;
   *)
     src=""
     ;;

.github/workflows/updater.yml

@@ -0,0 +1,49 @@
+# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected.
+# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization.
+# This file should be enough by itself, but feel free to tune it to your needs.
+# It calls updater.sh, which is where you should put the app-specific update steps.
+name: Check for new upstream releases
+on:
+  # Allow to manually trigger the workflow
+  workflow_dispatch:
+  # Run it every day at 6:00 UTC
+  schedule:
+    - cron:  '0 6 * * *'
+jobs:
+  updater:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch the source code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run the updater script
+        id: run_updater
+        run: |
+          # Setting up Git user
+          git config --global user.name 'yunohost-bot'
+          git config --global user.email 'yunohost-bot@users.noreply.github.com'
+          # Run the updater script
+          /bin/bash .github/workflows/updater.sh
+      - name: Commit changes
+        id: commit
+        if: ${{ env.PROCEED == 'true' }}
+        run: |
+          git commit -am "Upgrade to v$VERSION"
+      - name: Create Pull Request
+        id: cpr
+        if: ${{ env.PROCEED == 'true' }}
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update to version ${{ env.VERSION }}
+          committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          signoff: false
+          base: testing
+          branch: ci-auto-update-v${{ env.VERSION }}
+          delete-branch: true
+          title: 'Upgrade to version ${{ env.VERSION }}'
+          body: |
+            Upgrade to v${{ env.VERSION }}
+          draft: false

check_process

@@ -3,6 +3,10 @@
 		domain="domain.tld"
 		path="/path"
 		is_public=1
+		language=English
+		shopname=Prestashop
+		admin=john
+		password=12345678
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1

conf/nginx.conf

@@ -4,6 +4,7 @@ location __PATH__/ {
   # Path to source
   alias __FINALPATH__/ ;
 
+### Example PHP configuration (remove it if not used)
   index index.php;
 
   # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file
@@ -14,17 +15,13 @@ location __PATH__/ {
     fastcgi_split_path_info ^(.+?\.php)(/.*)$;
     fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
 
-    #fastcgi_index index.php;
+    fastcgi_index index.php;
     include fastcgi_params;
-
-    include /etc/nginx/fastcgi_params;
-    fastcgi_intercept_errors on;
     fastcgi_param REMOTE_USER $remote_user;
     fastcgi_param PATH_INFO $fastcgi_path_info;
     fastcgi_param SCRIPT_FILENAME $request_filename;
-    
-    #fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
   }
+### End of PHP configuration part
 
   # Include SSOWAT user panel.
   include conf.d/yunohost_panel.conf.inc;

config_panel.toml.example

@@ -0,0 +1,295 @@
+
+## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button
+## Those panels let user configure some params on their apps using a friendly interface,
+## and remove the need to manually edit files from the command line.
+ 
+## From a packager perspective, this .toml is coupled to the scripts/config script,
+## which may be used to define custom getters/setters. However, most use cases
+## should be covered automagically by the core, thus it may not be necessary
+## to define a scripts/config at all!
+ 
+## -----------------------------------------------------------------------------
+## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and 
+## do not overwhelm the admin with tons of misunderstandable or advanced settings.
+## -----------------------------------------------------------------------------
+
+## The top level describe the entire config panels screen.
+
+## The version is a required property. 
+## Here a small reminder to associate config panel version with YunoHost version
+## | Config | YNH    | Config panel small change log                           |
+## | ------ | ---    | ------------------------------------------------------- |
+## | 0.1    | 3.x    | 0.1 config script not compatible with YNH >= 4.3        |
+## | 1.0    | 4.3.x  | The new config panel system with 'bind' property        |
+version = "1.0"
+
+## (optional) i18n property let you internationalize questions, however this feature 
+## is only available in core configuration panel (like yunohost domain config).
+## So in app config panel this key is ignored for now, but you can internationalize
+## by using a lang dictionary (see property name bellow)
+# i18n = "prefix_translation_key"
+
+################################################################################
+#### ABOUT PANELS
+################################################################################
+
+## The next level describes web admin panels
+## You have to choose an ID for each panel, in this example the ID is "main"
+## Keep in mind this ID will be used in CLI to refer to your question, so choose
+## something short and meaningfull.
+## In the webadmin, each panel corresponds to a distinct tab / form
+[main]
+
+## Define the label for your panel
+## Internationalization works similarly to the 'description' and 'ask' questions in the manifest
+# name.en = "Main configuration"
+# name.fr = "Configuration principale"
+
+## (optional) If you need to trigger a service reload-or-restart after the user
+## change a question in this panel, you can add your service in the list.
+services = ["__APP__"]
+# or services = ["nginx", "__APP__"] to also reload-or-restart nginx
+
+## (optional) This help properties is a short help displayed on the same line
+## than the panel title but not displayed in the tab.
+# help = ""
+    
+    ############################################################################
+    #### ABOUT SECTIONS
+    ############################################################################
+
+    ## A panel is composed of one or several sections.
+    ##
+    ## Sections are meant to group questions together when they correspond to
+    ## a same subtopic. This impacts the rendering in terms of CLI prompts
+    ## and HTML forms
+    ##
+    ## You should choose an ID for your section, and prefix it with the panel ID
+    ## (Be sure to not make a typo in the panel ID, which would implicitly create
+    ## an other entire panel)
+    ##
+    ## We use the context of pepettes_ynh as an example,
+    ## which is a simple donation form app written in python,
+    ## and for which the admin will want to edit the configuration
+    [main.customization]
+
+    ## (optional) Defining a proper title for sections is not mandatory
+    ## and depends on the exact rendering you're aiming for the CLI / webadmin
+    name = ""
+
+    ## (optional) This help properties is a short help displayed on the same line
+    ## than the section title, meant to provide additional details
+    # help = ""
+    
+    ## (optional) As for panel, you can specify to trigger a service 
+    ## reload-or-restart after the user change a question in this section.
+    ## This property is added to the panel property, it doesn't deactivate it.
+    ## So no need to replicate, the service list from panel services property.
+    # services = []
+    
+    ## (optional) By default all questions are optionals, but you can specify a
+    ## default behaviour for question in the section
+    optional = false
+        
+    ## (optional) It's also possible with the 'visible' property to only
+    ## display the section depending on the user's answers to previous questions.
+    ##
+    ## Be careful that the 'visible' property should only refer to **previous** questions
+    ## Hence, it should not make sense to have a "visible" property on the very first section.
+    ##
+    ## Also, keep in mind that this feature only works in the webadmin and not in CLI
+    ## (therefore a user could be prompted in CLI for a question that may not be relevant)
+    # visible = true
+
+        ########################################################################
+        #### ABOUT QUESTIONS
+        ########################################################################
+
+        ## A section is compound of one or several questions.
+
+        ## ---------------------------------------------------------------------
+        ## IMPORTANT: as for panel and section you have to choose an ID, but this
+        ## one should be unique in all this document, even if the question is in
+        ## an other panel.
+        ## ---------------------------------------------------------------------
+        
+        ## You can use same questions types and properties than in manifest.yml 
+        ## install part. However, in YNH 4.3, a lot of change has been made to
+        ## extend availables questions types list.
+        ## See: TODO DOC LINK
+        
+        [main.customization.project_name]
+        
+        ## (required) The ask property is equivalent to the ask property in 
+        ## the manifest. However, in config panels, questions are displayed on the
+        ## left side and therefore have less space to be rendered. Therefore, 
+        ## it is better to use a short question, and use the "help" property to
+        ## provide additional details if necessary.
+        ask.en = "Name of the project"
+
+        ## (required) The type property indicates how the question should be 
+        ## displayed, validated and managed. Some types have specific properties.
+        ## 
+        ## Types available: string, boolean, number, range, text, password, path
+        ## email, url, date, time, color, select, domain, user, tags, file.
+        ##
+        ## For a complete list with specific properties, see: TODO DOC LINK
+        type = "string"
+        
+        ########################################################################
+        #### ABOUT THE BIND PROPERTY
+        ########################################################################
+
+        ## (recommended) 'bind' property is a powerful feature that let you 
+        ## configure how and where the data will be read, validated and written. 
+
+        ## By default, 'bind property is in "settings" mode, it means it will 
+        ## **only** read and write the value in application settings file.
+        ## bind = "settings"
+
+        ## However, settings usually correspond to key/values in actual app configurations
+        ## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost
+        ## will automagically find a line with "KEY=VALUE" in FILENAME
+        ## (with the adequate separator between KEY and VALUE)
+        ##
+        ## YunoHost will then use this value for the read/get operation.
+        ## During write/set operations, YunoHost will overwrite the value
+        ## in **both** FILENAME and in the app's settings.yml
+
+        ## Configuration file format supported: yaml, toml, json, ini, env, php,
+        ## python. The feature probably works with others formats, but should be tested carefully.
+
+        ## Note that this feature only works with relatively simple cases
+        ## such as `KEY: VALUE`, but won't properly work with
+        ## complex data structures like multilin array/lists or dictionnaries.
+        ## It also doesn't work with XML format, custom config function call, php define(), ...
+
+        ## More info on TODO
+        # bind = ":/var/www/__APP__/settings.py"
+
+
+        ## By default, bind = ":FILENAME" will use the question ID as KEY
+        ## ... but the question ID may sometime not be the exact KEY name in the configuration file.
+        ## 
+        ## In particular, in pepettes, the python variable is 'name' and not 'project_name'
+        ## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 )
+        ##
+        ## In that case, the key name can be specified before the column ':'
+        
+        bind = "name:/var/www/__APP__/settings.py"
+
+        ## ---------------------------------------------------------------------
+        ## IMPORTANT: other 'bind' mode exists:
+        ## 
+        ## bind = "FILENAME" (with no column character before FILENAME)
+        ## may be used to bind to the **entire file content** (instead of a single KEY/VALUE)
+        ## This could be used to expose an entire configuration file, or binary files such as images
+        ## For example:
+        ## bind = "/var/www/__APP__/img/logo.png"
+        ##
+        ## bind = "null" can be used to disable reading / writing in settings.
+        ## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting
+        ## In this mode, you are expected to define custom getter/setters/validators in scripts/config:
+        ##
+        ## getter: get__QUESTIONID()
+        ## setter: set__QUESTIONID()
+        ## validator: validate__QUESTIONID()
+        ##
+        ## You can also specify a common getter / setter / validator, with the 
+        ## function 'bind' mode, for example here it will try to run 
+        ## get__array_settings() first.
+        #  bind = "array_settings()"
+        ## ---------------------------------------------------------------------
+        
+        ## ---------------------------------------------------------------------
+        ## IMPORTANT: with the exception of bind=null questions,
+        ## question IDs should almost **always** correspond to an app setting
+        ## initialized / reused during install/upgrade.
+        ## Not doing so may result in inconsistencies between the config panel mechanism
+        ## and the use of ynh_add_config
+        ## ---------------------------------------------------------------------
+
+        ########################################################################
+        #### OTHER GENERIC PROPERTY FOR QUESTIONS
+        ########################################################################
+        
+        ## (optional) An help text for the question
+        help = "Fill the name of the project which will received donation"
+
+        ## (optional) An example display as placeholder in web form
+        # example = "YunoHost"
+
+        ## (optional) set to true in order to redact the value in operation logs
+        # redact = false
+
+        ## (optional) A validation pattern
+        ## ---------------------------------------------------------------------
+        ## IMPORTANT: your pattern should be between simple quote, not double.
+        ## ---------------------------------------------------------------------
+        pattern.regexp = '^\w{3,30}$'
+        pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted"
+
+        ## Note: visible and optional properties are also available for questions
+
+
+        [main.customization.contact_url]
+        ask = "Contact url"
+        type = "url"
+        example = "mailto: contact@example.org"
+        help = "mailto: accepted"
+        pattern.regexp = '^mailto:[^@]+@[^@]+|https://$'
+        pattern.error = "Should be https or mailto:"
+        bind = ":/var/www/__APP__/settings.py"
+
+        [main.customization.logo]
+        ask = "Logo"
+        type = "file"
+        accept = ".png"
+        help = "Fill with an already resized logo"
+        bind = "__FINALPATH__/img/logo.png"
+        
+        [main.customization.favicon]
+        ask = "Favicon"
+        type = "file"
+        accept = ".png"
+        help = "Fill with an already sized favicon"
+        bind = "__FINALPATH__/img/favicon.png"
+
+        
+    [main.stripe]
+    name = "Stripe general info"
+    optional = false
+
+        # The next alert is overwrited with a getter from the config script
+        [main.stripe.amount]
+        ask = "Donation in the month : XX €
+        type = "alert"
+        style = "success"
+
+        [main.stripe.publishable_key]
+        ask = "Publishable key"
+        type = "string"
+        redact = true
+        help = "Indicate here the stripe publishable key"
+        bind = ":/var/www/__APP__/settings.py"
+
+        [main.stripe.secret_key]
+        ask = "Secret key"
+        type = "string"
+        redact = true
+        help = "Indicate here the stripe secret key"
+        bind = ":/var/www/__APP__/settings.py"
+        
+        [main.stripe.prices]
+        ask = "Prices ID"
+        type = "tags"
+        help = """\
+        Indicates here the prices ID of donation products you created in stripe interfaces. \
+        Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \
+        Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \
+        FREQUENCY: 'one_time' or 'recuring' \
+        CURRENCY: 'EUR' or 'USD' \
+        PRICE_ID: ID from stripe interfaces starting with 'price_' \
+        """
+        pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$'
+        pattern.error = "Please respect the format describe in help text for each price ID"

manifest.json

@@ -56,6 +56,24 @@
                 "name": "is_public",
                 "type": "boolean",
                 "default": true
+            },
+            {
+                "name": "language",
+                "type": "select",
+                "choices": ["English", "Français"],
+                "default": "Français"
+            },
+            {
+                "name": "shopname",
+                "type": "string"
+            },
+            {
+                "name": "admin",
+                "type": "user"
+            },
+            {
+                "name": "password",
+                "type": "password"
             }
         ]
     }

scripts/_common.sh

@@ -4,7 +4,7 @@
 # COMMON VARIABLES
 #=================================================
 
-YNH_PHP_VERSION="8.0"
+phpversion=$YNH_PHP_VERSION
 
 pkg_dependencies="php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-fpm php${YNH_PHP_VERSION}-common php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-xmlrpc php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-zip"
 
@@ -19,131 +19,3 @@ pkg_dependencies="php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-fpm php${
 #=================================================
 # FUTURE OFFICIAL HELPERS
 #=================================================
-
-
-# Send an email to inform the administrator
-#
-# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
-# | arg: -m --app_message= - The file with the content to send to the administrator.
-# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
-#	example: "root admin@domain"
-#	If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
-#	example: "root admin@domain user1 user2"
-# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
-#
-# Requires YunoHost version 4.1.0 or higher.
-ynh_send_readme_to_admin() {
-	# Declare an array to define the options of this helper.
-	declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
-	local app_message
-	local recipients
-	local type
-	# Manage arguments with getopts
-
-	ynh_handle_getopts_args "$@"
-	app_message="${app_message:-}"
-	recipients="${recipients:-root}"
-	type="${type:-install}"
-
-	# Get the value of admin_mail_html
-	admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
-	admin_mail_html="${admin_mail_html:-0}"
-
-	# Retrieve the email of users
-	find_mails () {
-		local list_mails="$1"
-		local mail
-		local recipients=" "
-		# Read each mail in argument
-		for mail in $list_mails
-		do
-			# Keep root or a real email address as it is
-			if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
-			then
-				recipients="$recipients $mail"
-			else
-				# But replace an user name without a domain after by its email
-				if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
-				then
-					recipients="$recipients $mail"
-				fi
-			fi
-		done
-		echo "$recipients"
-	}
-	recipients=$(find_mails "$recipients")
-
-	# Subject base
-	local mail_subject="☁️🆈🅽🅷☁️: \`$app\`"
-
-	# Adapt the subject according to the type of mail required.
-	if [ "$type" = "backup" ]; then
-		mail_subject="$mail_subject has just been backup."
-	elif [ "$type" = "change_url" ]; then
-		mail_subject="$mail_subject has just been moved to a new URL!"
-	elif [ "$type" = "remove" ]; then
-		mail_subject="$mail_subject has just been removed!"
-	elif [ "$type" = "restore" ]; then
-		mail_subject="$mail_subject has just been restored!"
-	elif [ "$type" = "upgrade" ]; then
-		mail_subject="$mail_subject has just been upgraded!"
-	else	# install
-		mail_subject="$mail_subject has just been installed!"
-	fi
-
-	ynh_add_config --template="$app_message" --destination="../conf/msg_to_send"
-
-	ynh_delete_file_checksum --file="../conf/msg_to_send"
-	local mail_message="This is an automated message from your beloved YunoHost server.
-
-Specific information for the application $app.
-
-$(cat "../conf/msg_to_send")"
-
-	# Store the message into a file for further modifications.
-	echo "$mail_message" > mail_to_send
-
-	# If a html email is required. Apply html tags to the message.
- 	if [ "$admin_mail_html" -eq 1 ]
- 	then
-		# Insert 'br' tags at each ending of lines.
-		ynh_replace_string "$" "<br>" mail_to_send
-
-		# Insert starting HTML tags
-		sed --in-place '1s@^@<!DOCTYPE html>\n<html>\n<head></head>\n<body>\n@' mail_to_send
-
-		# Keep tabulations
-		ynh_replace_string "  " "\&#160;\&#160;" mail_to_send
-		ynh_replace_string "\t" "\&#160;\&#160;" mail_to_send
-
-		# Insert url links tags
-		ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
-
-		# Insert finishing HTML tags
-		echo -e "\n</body>\n</html>" >> mail_to_send
-
-	# Otherwise, remove tags to keep a plain text.
-	else
-		# Remove URL tags
-		ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
-		ynh_replace_string "__URL_TAG2__" ": " mail_to_send
-	fi
-
-	# Define binary to use for mail command
-	if [ -e /usr/bin/bsd-mailx ]
-	then
-		local mail_bin=/usr/bin/bsd-mailx
-	else
-		local mail_bin=/usr/bin/mail.mailutils
-	fi
-
-	if [ "$admin_mail_html" -eq 1 ]
-	then
-		content_type="text/html"
-	else
-		content_type="text/plain"
-	fi
-
-	# Send the email to the recipients
-	cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
-}

scripts/backup

@@ -14,6 +14,10 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+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
 ynh_abort_if_errors
 
@@ -28,12 +32,18 @@ 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
 #=================================================
 ynh_print_info --message="Declaring files to be backed up..."
 
+### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
+### to be backuped and not an actual copy of any file. The actual backup that
+### creates and fill the archive with the files happens in the core after this
+### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
+
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
@@ -57,6 +67,9 @@ ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 #=================================================
 ynh_print_info --message="Backing up the MySQL database..."
 
+### (However, things like MySQL dumps *do* take some time to run, though the
+### copy of the generated dump to the archive still happens later)
+
 ynh_mysql_dump_db --database="$db_name" > db.sql
 
 #=================================================

scripts/change_url

@@ -91,6 +91,14 @@ then
 	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 
+#=================================================
+# SPECIFIC MODIFICATIONS
+#=================================================
+# ...
+#=================================================
+
+#=================================================
+# GENERIC FINALISATION
 #=================================================
 # RELOAD NGINX
 #=================================================

scripts/config

@@ -0,0 +1,102 @@
+#!/bin/bash
+# In simple cases, you don't need a config script. 
+
+# With a simple config_panel.toml, you can write in the app settings, in the 
+# upstream config file or replace complete files (logo ...) and restart services.
+
+# The config scripts allows you to go further, to handle specific cases 
+# (validation of several interdependent fields, specific getter/setter for a value,
+# display dynamic informations or choices, pre-loading of config type .cube... ).
+
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+source /usr/share/yunohost/helpers
+
+ynh_abort_if_errors
+
+#=================================================
+# RETRIEVE ARGUMENTS
+#=================================================
+
+final_path=$(ynh_app_setting_get $app final_path)
+
+#=================================================
+# SPECIFIC GETTERS FOR TOML SHORT KEY
+#=================================================
+
+get__amount() {
+    # Here we can imagine to have an API call to stripe to know the amount of donation during a month
+    local amount = 200
+
+    # It's possible to change some properties of the question by overriding it:
+    if [ $amount -gt 100 ]
+    then
+    cat << EOF
+style: success
+value: $amount
+ask:
+  en: A lot of donation this month: **$amount €**
+EOF
+    else
+    cat << EOF
+style: danger
+value: $amount
+ask:
+  en: Not so much donation this month: $amount €
+EOF
+    fi
+}
+
+get__prices() {
+    local prices = "$(grep "DONATION\['" "$final_path/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
+    if [ "$prices" == "," ];
+    then
+        # Return YNH_NULL if you prefer to not return a value at all.
+        echo YNH_NULL
+    else
+        echo $prices
+    fi
+}
+
+
+#=================================================
+# SPECIFIC VALIDATORS FOR TOML SHORT KEYS
+#=================================================
+validate__publishable_key() {
+
+    # We can imagine here we test if the key is really a publisheable key
+    (is_secret_key $publishable_key) &&
+        echo 'This key seems to be a secret key'
+}
+
+#=================================================
+# SPECIFIC SETTERS FOR TOML SHORT KEYS
+#=================================================
+set__prices() {
+
+    #---------------------------------------------
+    # IMPORTANT: setter are trigger only if a change is detected
+    #---------------------------------------------
+    for price in $(echo $prices | sed "s/,/ /"); do
+        frequency=$(echo $price | cut -d/ -f1)
+        currency=$(echo $price | cut -d/ -f2)
+        price_id=$(echo $price | cut -d/ -f3)
+        sed "d/DONATION\['$frequency'\]\['$currency'\]" "$final_path/settings.py"
+
+        echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py"
+    done
+    
+    #---------------------------------------------
+    # IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too
+    #---------------------------------------------
+    ynh_app_setting_set $app prices $prices
+}
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+ynh_app_config_run $1

scripts/install

@@ -13,6 +13,10 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+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
 ynh_abort_if_errors
 
@@ -23,7 +27,10 @@ ynh_abort_if_errors
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
+language=$YNH_APP_ARG_LANGUAGE
+shopname=$YNH_APP_ARG_SHOPNAME
 admin=$YNH_APP_ARG_ADMIN
+password=$YNH_APP_ARG_PASSWORD
 phpversion=$YNH_PHP_VERSION
 
 app=$YNH_APP_INSTANCE_NAME
@@ -47,6 +54,8 @@ 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
 
+#=================================================
+# STANDARD MODIFICATIONS
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
@@ -96,11 +105,34 @@ ynh_add_nginx_config
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring PHP-FPM..." --weight=3
+ynh_script_progression --message="Configuring PHP-FPM..." --weight=1
 
 # Create a dedicated PHP-FPM config
 ynh_add_fpm_config
 
+#=================================================
+# SPECIFIC SETUP
+#=================================================
+# SETUP APPLICATION
+#=================================================
+ynh_script_progression --message="Installing Prestashop..." --weight=1
+
+admin_email=$(ynh_user_get_info $admin 'mail')
+admin_firstname=$(ynh_user_get_info $admin 'firstname')
+admin_lastname=$(ynh_user_get_info $admin 'lastname')
+
+# Installing Prestashop
+# https://docs.prestashop-project.org/1.7-documentation/getting-started/installing-prestashop-using-command-line-script
+pushd $final_path
+	ynh_exec_as $app php index_cli.php --domain=$domain --db_server=127.0.0.1 --db_name=$db_name --db_user=$db_user --db_password=$db_pwd --name=$shopname --firstname=$admin_firstname --lastname=$admin_lastname --email=$admin_email --password=$password
+popd
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# ...
+#=================================================
+
 #=================================================
 # SETUP SSOWAT
 #=================================================
@@ -109,6 +141,8 @@ 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
 
@@ -119,26 +153,6 @@ ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
 ynh_systemd_action --service_name=nginx --action=reload
 
-#=================================================
-# SEND A README FOR THE ADMIN
-#=================================================
-ynh_script_progression --message="Sending a readme for the admin..." --weight=1
-
-echo "Prestashop was successfully installed :)
-
-Please open your $app domain: https://$domain$path_url
-
-Complete the registration process from the setup page displayed.
-Details for MySQL database to be enterted while registration process:
-
-Database login:    $db_user
-Database name:     $db_name
-Database password: $db_pwd
-
-If you are facing any problem or want to improve this app, please open a new issue here: https://github.com/YunoHost-Apps/prestashop_ynh/issues" > mail_to_send
-
-ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type=install
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -22,6 +22,8 @@ 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)
 
+#=================================================
+# STANDARD REMOVE
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
@@ -62,6 +64,12 @@ ynh_script_progression --message="Removing dependencies..." --weight=1
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
 
+#=================================================
+# SPECIFIC REMOVE
+#=================================================
+# ...
+#=================================================
+
 #=================================================
 # GENERIC FINALIZATION
 #=================================================

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,6 +14,9 @@ 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
 
@@ -35,7 +39,8 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=1
 
-test ! -d $final_path || ynh_die --message="There is already a directory: $final_path "
+test ! -d $final_path \
+	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -50,7 +55,7 @@ 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=3
+ynh_script_progression --message="Restoring the app main directory..." --weight=1
 
 ynh_restore_file --origin_path="$final_path"
 
@@ -58,6 +63,8 @@ chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
 
+#=================================================
+# SPECIFIC RESTORATION
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
@@ -76,7 +83,7 @@ ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1
+ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 

scripts/upgrade

@@ -26,13 +26,14 @@ phpversion=$YNH_PHP_VERSION
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."
 
 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=6
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -43,26 +44,13 @@ ynh_clean_setup () {
 # 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
 
-#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
-fi
-
-### If nobody installed your app before 4.1,
-### then you may safely remove these lines
-
 # Cleaning legacy permissions
 if ynh_legacy_permissions_exists; then
 	ynh_legacy_permissions_delete_all
@@ -110,22 +98,13 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1
 ynh_add_fpm_config
 
 #=================================================
-# NGINX CONFIGURATION
+# SPECIFIC UPGRADE
+#=================================================
+# ...
 #=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
-
-# Create a dedicated NGINX config
-ynh_add_nginx_config
 
 #=================================================
-# PHP-FPM CONFIGURATION
+# GENERIC FINALIZATION
-#=================================================
-# ynh_script_progression --message="Upgrading database..." --weight=1
-
-# pushd $final_path
-# 	php$phpversion ./install/upgrade/upgrade.php
-# popd
-
 #=================================================
 # RELOAD NGINX
 #=================================================