mirror of
https://github.com/YunoHost-Apps/flarum_ynh.git
synced 2024-09-03 18:36:24 +02:00
317 lines
11 KiB
Bash
317 lines
11 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source experimental_helpers/ynh_exec_as
|
|
source experimental_helpers/ynh_composer__2
|
|
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)
|
|
is_public=$(ynh_app_setting_get --app=$app --key=is_public)
|
|
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)
|
|
old_ssowat_version=$(ynh_app_setting_get --app=$app --key=ssowat_version)
|
|
bazaar_extension=$(ynh_app_setting_get --app=$app --key=bazaar_extension)
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
ynh_script_progression --message="Checking version..."
|
|
|
|
upgrade_type=$(ynh_check_app_version_changed)
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
|
|
|
|
# Fix is_public as a boolean value
|
|
if [ "$is_public" = "Yes" ]; then
|
|
ynh_app_setting_set --app=$app --key=is_public --value=1
|
|
is_public=1
|
|
elif [ "$is_public" = "No" ]; then
|
|
ynh_app_setting_set --app=$app --key=is_public --value=0
|
|
is_public=0
|
|
fi
|
|
|
|
# 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
|
|
is_public=$(ynh_app_setting_get --app=$app --key=is_public)
|
|
skipped_uris=$(ynh_app_setting_get --app=$app --key=skipped_uris)
|
|
unprotected_uris=$(ynh_app_setting_get --app=$app --key=unprotected_uris)
|
|
protected_uris=$(ynh_app_setting_get --app=$app --key=protected_uris)
|
|
|
|
# Remove is_public if exists
|
|
if [ ! -z "$is_public" ]; then
|
|
ynh_app_setting_delete --app=$app --key=is_public
|
|
fi
|
|
|
|
# Remove skipped_uris if exists
|
|
if [ ! -z "$skipped_uris" ]; then
|
|
ynh_app_setting_delete --app=$app --key=skipped_uris
|
|
fi
|
|
|
|
# Remove unprotected_uris if exists
|
|
if [ ! -z "$unprotected_uris" ]; then
|
|
ynh_app_setting_delete --app=$app --key=unprotected_uris
|
|
fi
|
|
|
|
# Remove protected_uris if exists
|
|
if [ ! -z "$protected_uris" ]; then
|
|
ynh_app_setting_delete --app=$app --key=protected_uris
|
|
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 exists
|
|
if [ ! -z "$bazaar_extension" ]; then
|
|
ynh_app_setting_delete --app=$app --key=bazaar_extension
|
|
fi
|
|
|
|
#=================================================
|
|
# 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
|
|
|
|
#=================================================
|
|
# CHECK THE PATH
|
|
#=================================================
|
|
|
|
# Normalize the URL path syntax
|
|
path_url=$(ynh_normalize_url_path --path_url=$path_url)
|
|
|
|
#=================================================
|
|
# STANDARD UPGRADE STEPS
|
|
#=================================================
|
|
# 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
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading nginx web server configuration..." --weight=1
|
|
|
|
# Bug in Nginx with locations and aliases (see http://stackoverflow.com/a/35102259 )
|
|
if [ $path_url = "/" ]; then
|
|
ynh_replace_string "__PATH_HACK__" "" "../conf/nginx.conf"
|
|
else
|
|
ynh_replace_string "__PATH_HACK__" "$path_url" "../conf/nginx.conf"
|
|
fi
|
|
|
|
# Create a dedicated nginx config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..." --weight=1
|
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
|
|
#=================================================
|
|
# 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
|
|
# Adding it to www-data group
|
|
usermod -a -G www-data $app
|
|
|
|
#=================================================
|
|
# 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 --package="$extra_php_dependencies"
|
|
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# ADD SWAP
|
|
#=================================================
|
|
ynh_script_progression --message="Adding swap..."
|
|
|
|
ynh_add_swap --size=$swap_needed
|
|
|
|
#=================================================
|
|
# COMPOSER AND FLARUM UPGRADE
|
|
#=================================================
|
|
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
ynh_script_progression --message="Installing composer dependencies..."
|
|
|
|
# Set right permissions
|
|
chown -R $app:www-data $final_path
|
|
|
|
# Install Composer and Flarum
|
|
ynh_install_composer --phpversion=$phpversion --workdir=$final_path
|
|
|
|
# Perform migrations and clear cache
|
|
pushd $final_path
|
|
ynh_script_progression --message="Upgrading Flarum and its extensions..." --weight=1
|
|
ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require tituspijean/flarum-ext-auth-ssowat:$ssowat_version --no-update"
|
|
ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require flarum/core:$core_version --prefer-dist --update-no-dev -a --update-with-all-dependencies"
|
|
exec_as $app php$phpversion flarum migrate
|
|
exec_as $app php$phpversion flarum cache:clear
|
|
popd
|
|
fi
|
|
|
|
#=================================================
|
|
# FLARUM EXTENSIONS
|
|
#=================================================
|
|
|
|
if ! exec_as $app php$phpversion flarum info | grep -q "tituspijean-auth-ssowat" | grep -q $ssowat_version;
|
|
then
|
|
# Install and activate the SSOwat auth extension
|
|
activate_flarum_extension $db_name "tituspijean-auth-ssowat"
|
|
# Configure SSOwat auth extension
|
|
ssowatdomain=$(</etc/yunohost/current_host)
|
|
sql_command="INSERT IGNORE INTO \`settings\` (\`key\`, \`value\`) VALUES ('tituspijean-auth-ssowat.domain', '$ssowatdomain'), ('tituspijean-auth-ssowat.onlyUse', '0');"
|
|
ynh_mysql_execute_as_root "$sql_command" $db_name
|
|
fi
|
|
|
|
# Install, activate and set language extensions
|
|
case $language in
|
|
fr)
|
|
ynh_script_progression --message="Installing French extension..." --weight=2
|
|
ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require milescellar/lang-french"
|
|
activate_flarum_extension $db_name "milescellar-lang-french"
|
|
sql_command="UPDATE \`settings\` SET \`value\` = 'fr' WHERE \`settings\`.\`key\` = 'default_locale'"
|
|
ynh_mysql_execute_as_root "$sql_command" $db_name
|
|
;;
|
|
de)
|
|
ynh_script_progression --message="Installing German extension..." --weight=2
|
|
ynh_composer_exec --phpversion=$phpversion --workdir=$final_path --commands="require cbmainz/flarum-de"
|
|
activate_flarum_extension $db_name "cbmainz-de"
|
|
sql_command="UPDATE \`settings\` SET \`value\` = 'de' WHERE \`settings\`.\`key\` = 'default_locale'"
|
|
ynh_mysql_execute_as_root "$sql_command" $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
|
|
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 ssowat_version $ssowat_version
|
|
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
|
|
|
|
# Use logrotate to manage app-specific logfile(s)
|
|
ynh_use_logrotate --non-append
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SECURE FILES AND DIRECTORIES
|
|
#=================================================
|
|
ynh_script_progression --message="Securing files and directories..."
|
|
|
|
# Set permissions on app files
|
|
chown -R $app:www-data $final_path
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading SSOwat configuration..." --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
|
|
|
|
#=================================================
|
|
# 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
|