1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/flarum_ynh.git synced 2024-09-03 18:36:24 +02:00
flarum_ynh/scripts/upgrade
Éric Gaspar 3c05d628ab
1.5.0
2022-09-13 18:08:13 +02:00

275 lines
9.9 KiB
Bash

#!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
source experimental_helpers/ynh_add_swap
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --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)
db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
old_project_version=$(ynh_app_setting_get --app=$app --key=project_version)
old_core_version=$(ynh_app_setting_get --app=$app --key=core_version)
core_version=$(ynh_app_upstream_version)
old_ldap_version=$(ynh_app_setting_get --app=$app --key=ldap_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=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
#=================================================
# 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
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
# Remove the v before version number
if [[ $old_project_version == "v*" ]]; then $old_project_version = ${old_project_version:1}; fi
# Remove bazaar_extension if it exists
bazaar_extension=$(ynh_app_setting_get --app=$app --key=bazaar_extension)
if [ ! -z "$bazaar_extension" ]; then
ynh_app_setting_delete --app=$app --key=bazaar_extension
fi
# Remove SSOwat extension if it exists
ssowat_extension=$(ynh_app_setting_get --app=$app --key=ssowat_extension)
if [ ! -z "$ssowat_extension" ]; then
ynh_exec_warn_less ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="remove tituspijean/flarum-ext-auth-ssowat"
ynh_app_setting_delete --app=$app --key=ssowat_extension
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir=$final_path
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..."
# Create a temporary directory
tmpdir="$(mktemp -d)"
cp -R $final_path/* $tmpdir
# Deleting current app directory
ynh_secure_remove --file="$final_path"
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
# Copy config.php back into Flarum
cp -f $tmpdir/config.php $final_path
# Copy assets from old app version. Can be either in root folder or in "public" folder
if [ -d $tmpdir/assets ]; then
cp -Rf $tmpdir/assets $final_path/public
fi
if [ -d $tmpdir/public/assets ]; then
cp -Rf $tmpdir/public/assets $final_path/public
fi
# Clean temp directory
ynh_secure_remove --file="$tmpdir"
fi
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=2
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading php-fpm configuration..." --weight=1
# Create a dedicated php-fpm config
ynh_add_fpm_config --usage=low --footprint=low
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
# Create a dedicated NGINX config
ynh_add_nginx_config
#=================================================
# SPECIFIC UPGRADE
#=================================================
# ADD SWAP
#=================================================
ynh_script_progression --message="Adding swap..."
if [ ${PACKAGE_CHECK_EXEC:-0} -eq 0 ]; then
ynh_add_swap --size=$swap_needed
fi
#=================================================
# COMPOSER AND FLARUM UPGRADE
#=================================================
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Installing composer dependencies..." --weight=5
# Set right permissions
chown -R $app:www-data $final_path
# Install Composer and Flarum
ynh_exec_warn_less ynh_install_composer --phpversion=$phpversion --workdir=$final_path
if ynh_compare_current_package_version --comparison lt --version 1.1.0~ynh1
then
# Starting 1.0 (implemented for 1.1 in the package), version requirement is "*" for extensions
# ... except for flarum/core, but that's handled in the next block.
jq '.require | .[] = "*"' $final_path/composer.json
fi
# Perform migrations and clear cache
pushd $final_path
ynh_script_progression --message="Upgrading Flarum and its extensions..." --weight=1
ynh_exec_warn_less ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require tituspijean/flarum-ext-auth-ldap:$ldap_version --no-update"
ynh_exec_warn_less ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require flarum/core:$core_version --prefer-dist --update-no-dev -a --update-with-all-dependencies"
ynh_exec_as $app php$phpversion flarum migrate
ynh_exec_as $app php$phpversion flarum cache:clear
popd
fi
#=================================================
# FLARUM EXTENSIONS
#=================================================
if ! ynh_exec_as $app php$phpversion flarum info | grep -q "tituspijean-auth-ldap" | grep -q $ldap_version;
then
# Install and activate the LDAP auth extension
activate_flarum_extension $db_name "tituspijean-auth-ldap"
# Configure LDAP auth extension
ynh_add_config --template="../conf/ldap.sql.template" --destination="../conf/ldap.sql"
ynh_mysql_connect_as --user=$app --password="$db_pwd" --database=$db_name < ../conf/ldap.sql
fi
# Install, activate and set language extensions
case $language in
fr)
ynh_script_progression --message="Installing French extension..." --weight=2
ynh_exec_warn_less ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require qiaeru/lang-french:*"
activate_flarum_extension $db_name "qiaeru-lang-french"
sql_command="UPDATE \`settings\` SET \`value\` = 'fr' WHERE \`settings\`.\`key\` = 'default_locale'"
ynh_mysql_execute_as_root --sql="$sql_command" --database=$db_name
;;
de)
ynh_script_progression --message="Installing German extension..." --weight=2
ynh_exec_warn_less ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require kakifrucht/flarum-de:*"
activate_flarum_extension $db_name "kakifrucht-de"
sql_command="UPDATE \`settings\` SET \`value\` = 'de' WHERE \`settings\`.\`key\` = 'default_locale'"
ynh_mysql_execute_as_root --sql="$sql_command" --database=$db_name
;;
esac
ynh_print_info "You may need to manually enable your language extension in Flarum's admin panel."
# Clear cache
pushd $final_path
ynh_exec_as $app php$phpversion flarum cache:clear
popd
# Save version settings
ynh_app_setting_set $app project_version "$project_version"
ynh_app_setting_set $app core_version "$core_version"
ynh_app_setting_set $app ldap_version "$ldap_version"
# Set files and directories permissions
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP LOGROTATE
#=================================================
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Upgrade of $app completed" --last