Fix

conf/systemd.service

@@ -3,14 +3,14 @@ Description=Multi-protocols bridge for online communications
 After=network.target
 
 [Service]
-WorkingDirectory=__PATH__
-User=matterbridge
-Group=users
 Type=simple
+User=__APP__
+Group=__APP__
+WorkingDirectory=__FINALPATH__/
 UMask=000
-ExecStart=/opt/matterbridge/matterbridge -conf /opt/matterbridge/matterbridge.toml
+ExecStart=__FINALPATH__/matterbridge -conf __FINALPATH__/matterbridge.toml
 RestartSec=30
 Restart=always
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=multi-user.target

scripts/_common.sh

@@ -4,9 +4,6 @@
 # COMMON VARIABLES
 #=================================================
 
-# dependencies used by the app
-pkg_dependencies="coturn acl"
-
 #=================================================
 # PERSONAL HELPERS
 #=================================================

scripts/install

@@ -38,13 +38,6 @@ test ! -e "$final_path" || ynh_die --message="This path already contains a folde
 # Register (book) web path
 ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-#ynh_script_progression --message="Installing dependencies..." --time --weight=1
-
-#ynh_install_app_dependencies $pkg_dependencies
-
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -54,13 +47,6 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$final_path" --source_id="$architecture"
 
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-
-# Create a dedicated nginx config
-#ynh_add_nginx_config
-
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
@@ -73,7 +59,8 @@ ynh_system_user_create --username=$app
 # MODIFY A CONFIG FILE
 #=================================================
 
-ynh_replace_string "__PATH__" "$final_path" "../conf/systemd.service"
+cp -a ../conf/matterbridge.toml $final_path/matterbridge.toml
+
 #ynh_replace_string "__RAM__" "$ram" "../conf/conf/matterbridge.toml"
 #ynh_replace_string "__PORT__" "$port" "../conf/matterbridge.toml"
 #ynh_replace_string "__OP__" "$op" "../conf/matterbridge.toml"
@@ -81,8 +68,6 @@ ynh_replace_string "__PATH__" "$final_path" "../conf/systemd.service"
 #ynh_replace_string "__PASSWD__" "$passwd" "../conf/matterbridge.toml"
 #ynh_replace_string "__EULA__" "$eula" "../conf/matterbridge.toml"
 
-cp -a ../conf/matterbridge.toml $final_path/matterbridge.toml
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -98,18 +83,6 @@ ynh_script_progression --message="Integrating service in YunoHost..." --time --w
 
 yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
 
-#=================================================
-# 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 "/etc/onlyoffice/documentserver/nginx/onlyoffice-documentserver.conf"
-
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
@@ -126,7 +99,7 @@ chown -R $app: $final_path
 ynh_script_progression --message="Starting a systemd service..." --time --weight=1
 
 # Reload services
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action=start --log_path="/var/log/$app/$app.log"
 
 #=================================================
 # END OF SCRIPT

scripts/remove

@@ -41,14 +41,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
 
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --time --weight=1
-
-# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
-
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================

scripts/restore

@@ -1,52 +1,93 @@
 #!/bin/bash
 
-# Note: each files and directories you've saved using the ynh_backup helper
+#=================================================
-# will be located in the current directory, regarding the last argument.
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Exit on command errors and treat unset variables as an error
+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
-set -eu
+source ../settings/scripts/_common.sh
-
-# See comments in install script
-app=$YNH_APP_INSTANCE_NAME
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Retrieve old app settings
+#=================================================
-domain=$(ynh_app_setting_get "$app" domain)
+# MANAGE SCRIPT FAILURE
-path_url=$(ynh_app_setting_get "$app" path_url)
+#=================================================
 
-# Check domain/path availability
+ynh_clean_setup () {
-yunohost app checkurl "${domain}${path_url}" -a "$app" \
+	#### Remove this function if there's nothing to clean before calling the remove script.
-    || ynh_die "Path not available: ${domain}${path_url}"
+	true
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
-# Restore sources & data
+#=================================================
-src_path="/opt/${app}"
+# LOAD SETTINGS
-cp -a ./sources "$src_path"
+#=================================================
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
 
-# Restore permissions to app files
+app=$YNH_APP_INSTANCE_NAME
-# you may need to make some file and/or directory writeable by www-data (nginx user)
-chown -R root: "$src_path"
 
-### MySQL (remove if not used) ###
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-# If a MySQL database is used:
+path_url=$(ynh_app_setting_get --app=$app --key=path)
-# # Create and restore the database
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-# dbname=$app
-# dbuser=$app
-# dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
-# ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
-# ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./dump.sql
-### MySQL end ###
 
-# Restore NGINX configuration
+#=================================================
-cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf"
+# CHECK IF THE APP CAN BE RESTORED
+#=================================================
+ynh_script_progression --message="Validating restoration parameters..." --time --weight=1
 
-### PHP (remove if not used) ###
+ynh_webpath_available --domain=$domain --path_url=$path_url \
-# If a dedicated php-fpm process is used:
+	|| ynh_die --message="Path not available: ${domain}${path_url}"
-# # Copy PHP-FPM pool configuration and reload the service
+test ! -d $final_path \
-# sudo cp -a ./php-fpm.conf "/etc/php5/fpm/pool.d/${app}.conf"
+	|| ynh_die --message="There is already a directory: $final_path "
-# sudo service php5-fpm reload
-### PHP end ###
 
-# Restart webserver
+#=================================================
-service nginx reload
+# RESTORE THE APP MAIN DIR
+#=================================================
+ynh_script_progression --message="Restoring the app main directory..." --time --weight=1
+
+ynh_restore_file --origin_path="$final_path"
+
+#=================================================
+# RECREATE THE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Recreating the dedicated system user..." --time --weight=1
+
+# Create the dedicated user (if not existing)
+ynh_system_user_create --username=$app
+
+#=================================================
+# RESTORE USER RIGHTS
+#=================================================
+
+# Restore permissions on app files
+chown -R $app: $final_path
+
+#=================================================
+# RESTORE SYSTEMD
+#=================================================
+ynh_script_progression --message="Restoring the systemd configuration..." --time --weight=1
+
+ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
+systemctl enable $app.service --quiet
+
+#=================================================
+# INTEGRATE SERVICE IN YUNOHOST
+#=================================================
+ynh_script_progression --message="Integrating service in YunoHost..." --time --weight=1
+
+yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Restoration completed for $app" --time --last

scripts/upgrade

@@ -1,48 +1,117 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# See comments in install script
+source _common.sh
-app=$YNH_APP_INSTANCE_NAME
-final_path=/opt/yunohost/$app
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Stop emby-server service
+#=================================================
-systemctl stop matterbridge
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
+
+app=$YNH_APP_INSTANCE_NAME
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+admin=$(ynh_app_setting_get --app=$app --key=admin)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+language=$(ynh_app_setting_get --app=$app --key=language)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+
+upgrade_type=$(ynh_check_app_version_changed)
+
+#=================================================
+# ENSURE DOWNWARD COMPATIBILITY
+#=================================================
+ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
+
+# Cleaning legacy permissions
+if ynh_legacy_permissions_exists; then
+	ynh_legacy_permissions_delete_all
+
+	ynh_app_setting_delete --app=$app --key=is_public
+fi
+
+if ! ynh_permission_exists --permission="admin"; then
+	# Create the required permissions
+	ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
+fi
+
+# Create a permission if needed
+if ! ynh_permission_exists --permission="api"; then
+	ynh_permission_create --permission="api" --url "/api" --allowed="visitors" --show_tile="false" --protected="true"
+fi
+
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --time --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
+
+#=================================================
+# STANDARD UPGRADE STEPS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 
-ynh_app_setting_set $app final_path $final_path
+if [ "$upgrade_type" == "UPGRADE_APP" ]
-# Download, check integrity, uncompress and patch the source from app.src
+then
-ynh_setup_source "$final_path"
+	ynh_script_progression --message="Upgrading source files..." --time --weight=1
+
+	# Download, check integrity, uncompress and patch the source from app.src
+	ynh_setup_source --dest_dir="$final_path"
+fi
 
 #=================================================
-# NGINX CONFIGURATION
+# CREATE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
 
-# Create a dedicated nginx config
+# Create a dedicated user (if not existing)
-#ynh_add_nginx_config
+ynh_system_user_create --username=$app
 
 #=================================================
-# UPGRADE CONFIG
+# SETUP SYSTEMD
 #=================================================
-#cp -a ../conf/loolwsd.xml /etc/loolwsd
+ynh_script_progression --message="Upgrading systemd configuration..." --time --weight=1
-#ynh_replace_string "__NEXTCLOUDDOMAIN__" "$nextcloud_domain" "/etc/loolwsd/loolwsd.xml"
-#ynh_replace_string "__PASSWORD__" "$password" "/etc/loolwsd/loolwsd.xml"
-#systemctl restart loolwsd
 
+# Create a dedicated systemd config
+ynh_add_systemd_config
 
+#=================================================
+# MODIFY A CONFIG FILE
+#=================================================
 
-# If app is public, add url to SSOWat conf as skipped_uris
+ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE"
-#if [[ $is_public -eq 1 ]]; then
+
-  # See install script
+ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$final_path/CONFIG_FILE"
-#  ynh_app_setting_set "$app" unprotected_uris "/"
+
-#fi
+# Recalculate and store the checksum of the file for the next upgrade.
+ynh_store_file_checksum --file="$final_path/CONFIG_FILE"
 
 #=================================================
 # GENERIC FINALIZATION
@@ -50,14 +119,32 @@ ynh_setup_source "$final_path"
 # SECURE FILES AND DIRECTORIES
 #=================================================
 
-### For security reason, any app should set the permissions to root: before anything else.
+# Set permissions on app files
-### Then, if write authorization is needed, any access should be given only to directories
-### that really need such authorization.
-
-# Set permissions to app files
-chmod +x $final_path/matterbridge
 chown -R $app: $final_path
 
-# Start emby-server service
+#=================================================
-systemctl start matterbridge
+# INTEGRATE SERVICE IN YUNOHOST
+#=================================================
+ynh_script_progression --message="Integrating service in YunoHost..." --time --weight=1
 
+yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Upgrade of $app completed" --time --last