kresus_ynh/scripts/upgrade

#!/bin/bash

#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================

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

#=================================================
# MANAGE SCRIPT FAILURE
#=================================================

# Exit if an error occurs during the execution of the script
ynh_abort_if_errors

#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..."

app=$YNH_APP_INSTANCE_NAME

domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
port=$(ynh_app_setting_get --app=$app --key=port)
salt=$(ynh_app_setting_get --app=$app --key=salt)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)

#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================

# Previous versions did not set the DB name as a setting, so we need to set it now (will be used on
# remove).
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
	db_user=$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" final_path "$final_path"
fi

if [ -d "/home/ynh$app" ]
then
	mv "/home/ynh$app/data" "$final_path/data"
	ynh_secure_remove --file="/home/ynh$app"
fi

if [ -z "$salt" ]
then
	salt=$(ynh_string_random 40)
	ynh_app_setting_set "$app" salt "$salt"
fi

#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app"

# 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
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing app dependencies"

ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies

# Now that postgresql is installed, check the db exists and the user is set up
if [ -z "$db_pwd" ]
then
	ynh_script_progression --message="Setting up database"
	ynh_psql_test_if_first_run
	ynh_psql_setup_db --db_user=$db_user --db_name=$db_name
	db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
fi

#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_script_progression --message="Downloading app from sources"

ynh_setup_source --dest_dir="$final_path"

if [ -z "$final_path/data" ]
then
	mkdir "$final_path/data"
fi

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..."

# Create a dedicated NGINX config
ynh_add_nginx_config

#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Creating system user"

ynh_system_user_create --username=$app

#=================================================
# SPECIFIC UPGRADE
#=================================================
# Install nodesjs
#=================================================
ynh_script_progression --message="Installing nodejs"

ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version

#=================================================
# Install woob with pip
#=================================================
ynh_script_progression --message="Installing woob"

ynh_secure_remove --file="${final_path}/venv"
virtualenv --python=python3 --system-site-packages "${final_path}/venv"
(
	set +o nounset
	source "${final_path}/venv/bin/activate"
	set -o nounset

	pip install --upgrade pip
	pip install woob html2text simplejson BeautifulSoup4 PyExecJS pdfminer.six --ignore-installed
)

#=================================================
# Install Kresus with npm
#=================================================
ynh_script_progression --message="Installing app"

ynh_use_nodejs
(
	cd "$final_path"
	chown -R $app: "$final_path"

	# In case of nodejs upgrade, remove the current node_modules to make sure there are no errors
	# linked to modules compiled for the previous version.
	ynh_secure_remove --file="$final_path/node_modules"

	ynh_exec_warn_less ynh_npm install --production --unsafe-perm
)

#=================================================
# CONFIGURE KRESUS
#=================================================

ynh_backup_if_checksum_is_different "$final_path/config.ini"

cp ../conf/config.ini "$final_path/config.ini"

ynh_replace_string --match_string="__PORT__"        --replace_string="$port"       --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__PATH__"        --replace_string="$path_url"   --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__FINALPATH__"   --replace_string="$final_path" --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__SALT__"        --replace_string="$salt"       --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__APP__"         --replace_string="$app"        --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__DOMAIN__"      --replace_string="$domain"     --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__DB_NAME__"     --replace_string="$db_name"    --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__DB_USER__"     --replace_string="$db_user"    --target_file="$final_path/config.ini"
ynh_replace_string --match_string="__DB_PASSWORD__" --replace_string="$db_pwd"     --target_file="$final_path/config.ini"

# Calculate and store the config file checksum into the app settings
ynh_store_file_checksum "$final_path/config.ini"

#=================================================
# SETUP SYSTEMD
#=================================================

ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH"                     --target_file="../conf/systemd.service"
ynh_replace_string --match_string="__NODEPATH__" --replace_string="$(dirname "$nodejs_path")" --target_file="../conf/systemd.service"

# Create a dedicated systemd config
ynh_script_progression --message="Creating systemd configuration"
ynh_add_systemd_config

#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================

# Reset permissions
chown -R root:root "$final_path"

# Set permissions to app files
chown -R $app:$app "$final_path/data/"
chmod -R 750 "$final_path/data/"

# Set permissions to config files
chown $app "$final_path/config.ini"
chmod 600 "$final_path/config.ini"

if [ -f "$final_path/data/woob-data/backends" ]
then
	chmod 600 "$final_path/data/woob-data/backends"
fi

#=================================================
# RESTART SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Restarting a systemd service..."

# Start a systemd service
ynh_systemd_action --service_name=$app --action="restart"

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

ynh_systemd_action --service_name=nginx --action=reload

#=================================================
# SEND README TO ADMIN
#=================================================

message="
Kresus was successfully updated!

Domain: $domain
Path  : $path_url
Config: $final_path/config.ini

Note about config.ini: this package will regenerate the config file on upgrade.
If you changed it manually and upgrade Kresus, you'll find a backup in $final_path.

Are you facing an issue, want to improve this app or say thank you?
Please open a new issue in this project: https://github.com/YunoHost-Apps/kresus_ynh
"
ynh_send_readme_to_admin "$message"

#=================================================
# END OF SCRIPT
#=================================================

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