mirror of
https://github.com/YunoHost-Apps/flarum_ynh.git
synced 2024-09-03 18:36:24 +02:00
315 lines
12 KiB
Bash
315 lines
12 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source experimental_helpers/ynh_add_extra_apt_repos__3
|
|
source experimental_helpers/ynh_install_php__3
|
|
source experimental_helpers/ynh_exec_as
|
|
source experimental_helpers/ynh_composer__2
|
|
source experimental_helpers/ynh_send_readme_to_admin__2
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# 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)
|
|
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
|
|
#=================================================
|
|
|
|
### This helper will compare the version of the currently installed app and the version of the upstream package.
|
|
### $upgrade_type can have 2 different values
|
|
### - UPGRADE_APP if the upstream app version has changed
|
|
### - UPGRADE_PACKAGE if only the YunoHost package has changed
|
|
### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
|
|
### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
|
|
upgrade_type=$(ynh_check_app_version_changed)
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..." --time --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
|
|
|
|
# If some settings are missing, assume older package version
|
|
[ -z "$old_project_version" ] && old_project_version="0.1.0-beta.7"
|
|
[ -z "$old_ssowat_version" ] && old_ssowat_version="0.6"
|
|
|
|
# Remove the v before version number
|
|
if [[ $old_project_version == "v*" ]]; then $old_project_version = ${old_project_version:1}; 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
|
|
|
|
#=================================================
|
|
# CHECK THE PATH
|
|
#=================================================
|
|
|
|
# Normalize the URL path syntax
|
|
# N.B. : this is for app installations before YunoHost 2.7
|
|
# where this value might be something like /foo/ or foo/
|
|
# instead of /foo ....
|
|
# If nobody installed your app before 2.7, then you may
|
|
# safely remove this line
|
|
path_url=$(ynh_normalize_url_path --path_url=$path_url)
|
|
|
|
#=================================================
|
|
# STANDARD UPGRADE STEPS
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading nginx web server configuration..." --time --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..." --time --weight=1
|
|
|
|
ynh_install_php --phpversion=${php_version} --package="$pkg_dependencies"
|
|
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
|
|
|
|
# Create a dedicated user (if not existing)
|
|
ynh_system_user_create --username=$app
|
|
|
|
#=================================================
|
|
# PHP-FPM CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading php-fpm configuration..." --time --weight=1
|
|
|
|
# Create a dedicated php-fpm config
|
|
ynh_add_fpm_config $php_version
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# COMPOSER UPGRADE
|
|
#=================================================
|
|
|
|
if ! type "$final_path/composer.phar" > /dev/null; then
|
|
ynh_install_composer $php_version $final_path
|
|
fi
|
|
|
|
#=================================================
|
|
# FLARUM UPGRADE
|
|
#=================================================
|
|
|
|
if [[ $(dpkg --compare-versions $old_project_version lt $project_version && echo true) ]]; then
|
|
|
|
# Backing up the app directory
|
|
tmpbak="/tmp/${app}backup"
|
|
ynh_secure_remove --file="$tmpbak"
|
|
mkdir -p $tmpbak
|
|
cp -R $final_path/* $tmpbak
|
|
|
|
# Deleting current app directory
|
|
ynh_secure_remove --file="$final_path"
|
|
|
|
# Create working directory
|
|
mkdir -p "$final_path/.composer"
|
|
chown -R $app:www-data $final_path
|
|
chmod -R 0775 $final_path
|
|
|
|
#=================================================
|
|
# COMPOSER INSTALLATION
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Installing Composer..." --time --weight=1
|
|
ynh_install_composer $php_version $final_path
|
|
|
|
#=================================================
|
|
# FLARUM INSTALLATION
|
|
#=================================================
|
|
|
|
# Prepare Flarum temp directory
|
|
tmp=/tmp/$app
|
|
mkdir -p $tmp
|
|
chown -R $app:www-data $tmp
|
|
chmod -R 0775 $tmp
|
|
|
|
# Install Flarum
|
|
ynh_script_progression --message="Composer is installing Flarum and its dependencies (may take a while)..." --time --weight=3
|
|
|
|
# First, create the project with core and all basic extensions
|
|
ynh_composer_exec $app $php_version $final_path "create-project flarum/flarum=$project_version $tmp --stability=beta --ansi -d $tmp"
|
|
|
|
# Copy Flarum to working directory
|
|
cp -Rf $tmp/* $final_path
|
|
# Copy config.php from old app version
|
|
cp -Rf $tmpbak/config.php $final_path
|
|
# Copy assets from old app version. Can be either in root folder or in "public" folder
|
|
if [ -d $tmpbak/assets ]; then
|
|
cp -Rf $tmpbak/assets $final_path/public
|
|
fi
|
|
if [ -d $tmpbak/public/assets ]; then
|
|
cp -Rf $tmpbak/public/assets $final_path/public
|
|
fi
|
|
# Clean temp directory
|
|
ynh_secure_remove $tmp
|
|
ynh_secure_remove $tmpbak
|
|
|
|
# Set right permissions for the post-installation
|
|
chown -R $app: $final_path
|
|
chown -R $app:www-data $final_path/storage
|
|
chmod -R 0775 $final_path
|
|
fi
|
|
|
|
# Perform migrations and clear cache
|
|
pushd $final_path
|
|
ynh_composer_exec $app $php_version $final_path "update --prefer-dist --no-dev -o --with-all-dependencies"
|
|
exec_as $app php$php_version flarum migrate
|
|
exec_as $app php$php_version flarum cache:clear
|
|
popd
|
|
|
|
# Database password has to be input on admin page after upgrade to 0.1.0-beta.7.2
|
|
if [[ $project_version == "0.1.0-beta.7.2" ]]; then
|
|
curl "https://$domain$path_url/admin" -H "Accept: */*" --compressed -H "Content-Type: application/x-www-form-urlencoded; charset=UTF-8" --data "databasePassword=$db_pwd" -k
|
|
fi
|
|
|
|
# Install and activate the SSOwat auth extension
|
|
install_and_activate_extension $app $php_version $final_path $db_name "tituspijean/flarum-ext-auth-ssowat:$ssowat_version" "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
|
|
|
|
# Install, activate and set language extensions
|
|
case $language in
|
|
en)
|
|
ynh_script_progression --message="Installing French extension..." --time --weight=2
|
|
install_and_activate_extension $app $php_version $final_path $db_name "flarum/lang-english" "flarum-lang-english"
|
|
sql_command="UPDATE \`settings\` SET \`value\` = 'en' WHERE \`settings\`.\`key\` = 'default_locale'"
|
|
ynh_mysql_execute_as_root "$sql_command" $db_name
|
|
;;
|
|
fr)
|
|
ynh_script_progression --message="Installing French extension..." --time --weight=2
|
|
install_and_activate_extension $app $php_version $final_path $db_name "milescellar/flarum-ext-french" "milescellar-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..." --time --weight=2
|
|
install_and_activate_extension $app $php_version $final_path $db_name "cbmainz/flarum-de" "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."
|
|
|
|
if [ $bazaar_extension -eq 1 ]; then
|
|
install_and_activate_extension $app $php_version $final_path $db_name "flagrow/bazaar" "flagrow-bazaar"
|
|
fi
|
|
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..." --time --weight=1
|
|
|
|
# Use logrotate to manage app-specific logfile(s)
|
|
ynh_use_logrotate --non-append
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SECURE FILES AND DIRECTORIES
|
|
#=================================================
|
|
|
|
# Set permissions on app files
|
|
chown -R $app: $final_path
|
|
chown -R $app:www-data $final_path/storage
|
|
chmod -R 0775 $final_path
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading SSOwat configuration..." --time --weight=1
|
|
|
|
# Make app public if necessary
|
|
if [ $is_public -eq 1 ]
|
|
then
|
|
# unprotected_uris allows SSO credentials to be passed anyway
|
|
ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
|
|
fi
|
|
|
|
#=================================================
|
|
# 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_app_setting_set $app php_version $php_version
|
|
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
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --time --last
|