Merge pull request #42 from YunoHost-Apps/testing

Scripts cleanup

check_process

@@ -1,8 +1,3 @@
-# See here for more information
-# https://github.com/YunoHost/package_check#syntax-check_process-file
-
-# Move this file from check_process.default to check_process when you have filled it.
-
 ;; Test complet
 	; Manifest
 		domain="domain.tld"	(DOMAIN)
@@ -18,7 +13,7 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
-		#upgrade=1	from_commit=CommitHash
+		upgrade=1	from_commit=093ec18f9f5282e1a137c0ac5444a414ee2b83bc
 		backup_restore=1
 		multi_instance=1
 		incorrect_path=1

scripts/backup

@@ -16,7 +16,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
 	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
@@ -49,13 +48,6 @@ ynh_print_info "Backing up nginx web server configuration..."
 
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 
-#=================================================
-# BACKUP THE PHP-FPM CONFIGURATION
-#=================================================
-ynh_print_info "Backing up php-fpm configuration..."
-
-#ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
-
 #=================================================
 # BACKUP THE MYSQL DATABASE
 #=================================================
@@ -65,13 +57,6 @@ ynh_mysql_dump_db "$db_name" > db.sql
 
 #=================================================
 # SPECIFIC BACKUP
-#=================================================
-# BACKUP LOGROTATE
-#=================================================
-ynh_print_info "Backing up logrotate configuration..."
-
-#ynh_backup "/etc/logrotate.d/$app"
-
 #=================================================
 # BACKUP SYSTEMD
 #=================================================
@@ -79,12 +64,6 @@ ynh_print_info "Backing up systemd configuration..."
 
 ynh_backup "/etc/systemd/system/$app.service"
 
-#=================================================
-# BACKUP A CRON FILE
-#=================================================
-
-#ynh_backup "/etc/cron.d/$app"
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/change_url

@@ -34,15 +34,6 @@ final_path=$(ynh_app_setting_get $app final_path)
 #db_name=$(ynh_app_setting_get "$app" db_name)
 #db_pwd=$(ynh_app_setting_get $app db_pwd)
 
-#=================================================
-# CHECK THE SYNTAX OF THE PATHS
-#=================================================
-
-test -n "$old_path" || old_path="/"
-test -n "$new_path" || new_path="/"
-new_path=$(ynh_normalize_url_path $new_path)
-old_path=$(ynh_normalize_url_path $old_path)
-
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
 #=================================================
@@ -114,8 +105,6 @@ ynh_systemd_action --action=start --service_name=$app
 # STORE THE CONFIG FILE CHECKSUM
 #=================================================
 
-### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
-### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
 ynh_backup_if_checksum_is_different "$final_path/config.ini"
 # Recalculate and store the checksum of the file for the next upgrade.
 ynh_store_file_checksum "$final_path/config.ini"

scripts/install

@@ -17,7 +17,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
 	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
@@ -29,30 +28,19 @@ ynh_abort_if_errors
 ynh_print_info "Retrieve arguments from the manifest ..."
 
 domain=$YNH_APP_ARG_DOMAIN
-#path_url=$YNH_APP_ARG_PATH
 path_url="/"
 admin=$YNH_APP_ARG_ADMIN
 is_public=$YNH_APP_ARG_IS_PUBLIC
-#language=$YNH_APP_ARG_LANGUAGE
+
 password=$YNH_APP_ARG_PASSWORD
 single_user=$YNH_APP_ARG_SINGLE_USER
 
-## Bypass package_checker name not compatible with writefreely
+# Bypass package_checker name not compatible with writefreely
 if [ "$admin" = "package_checker" ]
 then
 	admin="test"
 fi
 
-### If it's a multi-instance app, meaning it can be installed several times independently
-### The id of the app as stated in the manifest is available as $YNH_APP_ID
-### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-### The app instance name is available as $YNH_APP_INSTANCE_NAME
-###    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-###    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-###    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-### The app instance name is probably what interests you most, since this is
-### guaranteed to be unique. This is a good unique identifier to define installation path,
-### db names, ...
 app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
@@ -60,14 +48,9 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 ynh_print_info "Validating installation parameters..."
 
-### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
-### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
-
 # Register (book) web path
 ynh_webpath_register $app $domain $path_url
 
@@ -80,7 +63,7 @@ ynh_app_setting_set $app domain $domain
 ynh_app_setting_set $app path $path_url
 ynh_app_setting_set $app admin $admin
 ynh_app_setting_set $app is_public $is_public
-#ynh_app_setting_set $app language $language
+
 ynh_app_setting_set $app single_user $single_user
 
 #=================================================
@@ -90,15 +73,8 @@ ynh_app_setting_set $app single_user $single_user
 #=================================================
 ynh_print_info "Configuring firewall ..."
 
-### Use these lines if you have to open a port for the application
-### `ynh_find_port` will find the first available port starting from the given port.
-### If you're not using these lines:
-###		- Remove the section "CLOSE A PORT" in the remove script
-
 # Find a free port
 port=$(ynh_find_port 8095)
-# Open this port
-#ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
 ynh_app_setting_set $app port $port
 
 #=================================================
@@ -106,13 +82,6 @@ ynh_app_setting_set $app port $port
 #=================================================
 ynh_print_info "Installing dependencies ..."
 
-### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
-### Those deb packages will be installed as dependencies of this package.
-### If you're not using this helper:
-###		- Remove the section "REMOVE DEPENDENCIES" in the remove script
-###		- As well as the section "REINSTALL DEPENDENCIES" in the restore script
-###		- And the section "UPGRADE DEPENDENCIES" in the upgrade script
-
 #ynh_install_app_dependencies deb1 deb2
 
 #=================================================
@@ -120,15 +89,6 @@ ynh_print_info "Installing dependencies ..."
 #=================================================
 ynh_print_info "Creating a mysql database ..."
 
-### Use these lines if you need a database for the application.
-### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
-### The password will be stored as 'mysqlpwd' into the app settings,
-### and will be available as $db_pwd
-### If you're not using these lines:
-###		- Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
-###		- Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
-###		- As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
-
 db_name=$(ynh_sanitize_dbid $app)
 ynh_app_setting_set $app db_name $db_name
 ynh_mysql_setup_db $db_name $db_name
@@ -138,10 +98,6 @@ ynh_mysql_setup_db $db_name $db_name
 #=================================================
 ynh_print_info "Setting up source files ..."
 
-### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
-### downloaded from an upstream source, like a git repository.
-### `ynh_setup_source` use the file conf/app.src
-
 ynh_app_setting_set $app final_path $final_path
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source "$final_path" $architecture
@@ -151,8 +107,6 @@ ynh_setup_source "$final_path" $architecture
 #=================================================
 ynh_print_info "Configuring nginx web server..."
 
-### `ynh_add_nginx_config` will use the file conf/nginx.conf
-
 # Create a dedicated nginx config
 ynh_add_nginx_config
 
@@ -164,88 +118,20 @@ ynh_print_info "Configuring system user ..."
 # Create a system user
 ynh_system_user_create "$app" "$final_path"
 
-#=================================================
-# PHP-FPM CONFIGURATION
-#=================================================
-ynh_print_info "Configuring php-fpm ..."
-
-### `ynh_add_fpm_config` is used to set up a PHP config.
-### You can remove it if your app doesn't use PHP.
-### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini
-### If you're not using these lines:
-###		- You can remove these files in conf/.
-###		- Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
-###		- Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
-###		- As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
-###		With the reload at the end of the script.
-###		- And the section "PHP-FPM CONFIGURATION" in the upgrade script
-
-# Create a dedicated php-fpm config
-#ynh_add_fpm_config
-
 #=================================================
 # SPECIFIC SETUP
-#=================================================
-# ...
-#=================================================
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
 ynh_print_info "Configuring a systemd service ..."
 
-### `ynh_systemd_config` is used to configure a systemd script for an app.
-### It can be used for apps that use sysvinit (with adaptation) or systemd.
-### Have a look at the app to be sure this app needs a systemd script.
-### `ynh_systemd_config` will use the file conf/systemd.service
-### If you're not using these lines:
-###		- You can remove those files in conf/.
-###		- Remove the section "BACKUP SYSTEMD" in the backup script
-###		- Remove also the section "STOP AND REMOVE SERVICE" in the remove script
-###		- As well as the section "RESTORE SYSTEMD" in the restore script
-###		- And the section "SETUP SYSTEMD" in the upgrade script
-
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
-#=================================================
-# SETUP APPLICATION WITH CURL
-#=================================================
-
-### Use these lines only if the app installation needs to be finalized through
-### web forms. We generally don't want to ask the final user,
-### so we're going to use curl to automatically fill the fields and submit the
-### forms.
-
-# Set right permissions for curl install
-#chown -R $app: $final_path
-
-# Set the app as temporarily public for curl call
-#ynh_print_info "Configuring ssowat ..."
-#ynh_app_setting_set $app skipped_uris "/"
-# Reload SSOwat config
-#yunohost app ssowatconf
-
-# Reload Nginx
-#systemctl reload nginx
-
-# Installation with curl
-#ynh_print_info "Finalizing install ..."
-#ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
-
-# Remove the public access
-#if [ $is_public -eq 0 ]
-#then
-#	ynh_app_setting_delete $app skipped_uris
-#fi
-
 #=================================================
 # MODIFY A CONFIG FILE
 #=================================================
 
-### `ynh_replace_string` is used to replace a string in a file.
-### (It's compatible with sed regular expressions syntax)
-
 # setup application config
 cp "../conf/config.ini" "$final_path/config.ini"
 
@@ -260,10 +146,6 @@ ynh_replace_string "__SINGLEUSER__" "$single_user" "$final_path/config.ini"
 # STORE THE CONFIG FILE CHECKSUM
 #=================================================
 
-### `ynh_store_file_checksum` is used to store the checksum of a file.
-### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`,
-### you can make a backup of this file before modifying it again if the admin had modified it.
-
 # Calculate and store the config file checksum into the app settings
 ynh_store_file_checksum "$final_path/config.ini"
 
@@ -287,43 +169,13 @@ popd
 # SECURE FILES AND DIRECTORIES
 #=================================================
 
-### For security reason, any app should set the permissions to root: before anything else.
-### Then, if write authorization is needed, any access should be given only to directories
-### that really need such authorization.
-
 # Set permissions to app files
 chown -R "$app":"$app" "$final_path"
 
-#=================================================
-# SETUP LOGROTATE
-#=================================================
-ynh_print_info "Configuring log rotation ..."
-
-### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
-### Use this helper only if there is effectively a log file for this app.
-### If you're not using this helper:
-###		- Remove the section "BACKUP LOGROTATE" in the backup script
-###		- Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
-###		- As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
-###		- And the section "SETUP LOGROTATE" in the upgrade script
-
-# Use logrotate to manage application logfile(s)
-#ynh_use_logrotate
-
 #=================================================
 # ADVERTISE SERVICE IN ADMIN PANEL
 #=================================================
 
-### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
-### You'll find the service in the 'services' section of YunoHost admin panel.
-### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
-### If you're not using these lines:
-###		- You can remove these files in conf/.
-###		- Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
-###		- As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
-
-#yunohost service add $app --log "/var/log/$app/APP.log"
-
 # if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
 yunohost service add $app --description "$app daemon for WriteFreely" --log_type systemd
 

scripts/remove

@@ -75,22 +75,6 @@ ynh_print_info "Removing nginx web server configuration"
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
 
-#=================================================
-# REMOVE PHP-FPM CONFIGURATION
-#=================================================
-ynh_print_info "Removing php-fpm configuration"
-
-# Remove the dedicated php-fpm config
-#ynh_remove_fpm_config
-
-#=================================================
-# REMOVE LOGROTATE CONFIGURATION
-#=================================================
-ynh_print_info "Removing logrotate configuration"
-
-# Remove the app-specific logrotate config
-#ynh_remove_logrotate
-
 #=================================================
 # CLOSE A PORT
 #=================================================
@@ -107,14 +91,11 @@ fi
 # REMOVE THE CRON FILE
 #=================================================
 
-# Remove a cron file
-#ynh_secure_remove "/etc/cron.d/$app"
-
 # Remove a directory securely
 ynh_secure_remove "/etc/$app/"
 
 # Remove the log files
-#ynh_secure_remove "/var/log/$app/"
+ynh_secure_remove "/var/log/$app/"
 
 #=================================================
 # GENERIC FINALIZATION

scripts/restore

@@ -16,7 +16,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	#### Remove this function if there's nothing to clean before calling the remove script.
 	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
@@ -74,12 +73,6 @@ ynh_system_user_create "$app" "$final_path"
 # Restore permissions on app files
 chown -R "$app":"$app" "$final_path"
 
-#=================================================
-# RESTORE THE PHP-FPM CONFIGURATION
-#=================================================
-
-#ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
-
 #=================================================
 # SPECIFIC RESTORATION
 #=================================================
@@ -114,26 +107,13 @@ systemctl daemon-reload
 
 yunohost service add $app --description "$app daemon for WriteFreely" --log_type systemd
 
-#=================================================
-# RESTORE THE CRON FILE
-#=================================================
-
-#ynh_restore_file "/etc/cron.d/$app"
-
-#=================================================
-# RESTORE THE LOGROTATE CONFIGURATION
-#=================================================
-
-#ynh_restore_file "/etc/logrotate.d/$app"
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
-# RELOAD NGINX AND PHP-FPM
+# RELOAD NGINX
 #=================================================
-ynh_print_info "Reloading nginx web server and php-fpm..."
+ynh_print_info "Reloading nginx web server..."
 
-#systemctl reload php7.0-fpm
 systemctl reload nginx
 
 #=================================================

scripts/upgrade

@@ -25,19 +25,10 @@ path_url=$(ynh_app_setting_get $app path)
 admin=$(ynh_app_setting_get $app admin)
 is_public=$(ynh_app_setting_get $app is_public)
 final_path=$(ynh_app_setting_get $app final_path)
-#language=$(ynh_app_setting_get $app language)
+
 db_name=$(ynh_app_setting_get $app db_name)
 port=$(ynh_app_setting_get $app port)
 
-ynh_app_setting_delete $app site_name
-ynh_app_setting_delete $app site_description
-ynh_app_setting_delete $app open_registration
-ynh_app_setting_delete $app max_blogs
-ynh_app_setting_delete $app federation
-ynh_app_setting_delete $app public_stats
-ynh_app_setting_delete $app private
-ynh_app_setting_delete $app local_timeline
-
 #=================================================
 # CHECK VERSION
 #=================================================
@@ -70,6 +61,17 @@ if [ -z $final_path ]; then
 	ynh_app_setting_set $app final_path $final_path
 fi
 
+# remove old variables
+ynh_app_setting_delete $app site_name
+ynh_app_setting_delete $app site_description
+ynh_app_setting_delete $app open_registration
+ynh_app_setting_delete $app max_blogs
+ynh_app_setting_delete $app federation
+ynh_app_setting_delete $app public_stats
+ynh_app_setting_delete $app private
+ynh_app_setting_delete $app local_timeline
+
+
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
@@ -134,14 +136,6 @@ ynh_print_info "Making sure dedicated system user exists..."
 # Create a dedicated user (if not existing)
 ynh_system_user_create "$app" "$final_path"
 
-#=================================================
-# PHP-FPM CONFIGURATION
-#=================================================
-ynh_print_info "Upgrading php-fpm configuration..."
-
-# Create a dedicated php-fpm config
-#ynh_add_fpm_config
-
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
@@ -154,8 +148,6 @@ pushd $final_path
 	sudo -u $app ./writefreely --migrate
 popd
 
-### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
-### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
 ynh_backup_if_checksum_is_different "$final_path/config.ini"
 # Recalculate and store the checksum of the file for the next upgrade.
 ynh_store_file_checksum "$final_path/config.ini"
@@ -170,14 +162,6 @@ then
 	yunohost firewall disallow TCP $port 2>&1
 fi
 
-#=================================================
-# SETUP LOGROTATE
-#=================================================
-ynh_print_info "Upgrading logrotate configuration..."
-
-# Use logrotate to manage app-specific logfile(s)
-#ynh_use_logrotate --non-append
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================