1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/firefly-iii_ynh.git synced 2024-09-03 18:36:13 +02:00
firefly-iii_ynh/scripts/upgrade

259 lines
10 KiB
Text
Raw Normal View History

2018-06-17 00:50:26 +02:00
#!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
2020-06-11 00:45:03 +02:00
source ynh_composer__2
2018-06-17 00:50:26 +02:00
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..."
2018-06-17 00:50:26 +02:00
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)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
random_key=$(ynh_app_setting_get --app=$app --key=random_key)
2021-02-08 08:58:17 +01:00
email=$(ynh_user_get_info --username=$admin --key=mail)
#=================================================
# CHECK VERSION
#=================================================
2020-06-11 00:45:03 +02:00
ynh_script_progression --message="Checking version..."
upgrade_type=$(ynh_check_app_version_changed)
2018-06-17 00:50:26 +02:00
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..."
2018-06-17 00:50:26 +02:00
# Fix is_public as a boolean value
if [ "$is_public" = "Yes" ]; then
ynh_app_setting_set --app=$app --key=is_public --value=1
2020-06-11 00:45:03 +02:00
is_public=1
elif [ "$is_public" = "No" ]; then
ynh_app_setting_set --app=$app --key=is_public --value=0
is_public=0
2018-06-17 00:50:26 +02:00
fi
# If db_name doesn't exist, create it
2020-06-11 00:45:03 +02:00
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
2020-06-11 00:45:03 +02:00
final_path=/var/www/$app
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
2018-06-17 00:50:26 +02:00
fi
2021-02-08 07:48:49 +01:00
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
2018-06-17 00:50:26 +02:00
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..."
2018-06-17 00:50:26 +02:00
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# restore it if the upgrade fails
ynh_restore_upgradebackup
2018-06-17 00:50:26 +02:00
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
2020-06-11 00:45:03 +02:00
# STANDARD UPGRADE STEPS
2018-06-17 00:50:26 +02:00
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
2018-06-17 00:50:26 +02:00
#=================================================
2020-06-11 00:45:03 +02:00
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
2021-05-25 17:42:51 +02:00
if [ `cd $final_path && git rev-parse --is-inside-work-tree` ];
then
pushd "$final_path"
git pull
ynh_secure_remove bootstrap/cache/*
ynh_secure_remove vendor/
popd
else
ynh_script_progression --message="Upgrading source files..."
# Create a temporary directory
tmpdir="$(mktemp -d)"
# Backup the config file in the temp dir
2020-06-11 00:45:03 +02:00
mkdir -p "$tmpdir/storage/upload"
mkdir -p "$tmpdir/storage/export"
mkdir -p "$final_path/storage/upload/"
mkdir -p "$final_path/storage/export/"
2021-05-25 17:42:51 +02:00
cp -a "$final_path/storage/upload/*" "$tmpdir/storage/upload/"
2020-10-31 20:25:24 +01:00
cp -a "$final_path/.env" "$tmpdir/.env"
2021-05-25 17:42:51 +02:00
cp -a "$final_path/storage/export/*" "$tmpdir/storage/export/"
2020-11-16 23:54:25 +01:00
ynh_secure_remove --file="$final_path"
2020-06-11 00:45:03 +02:00
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
2021-05-25 17:42:51 +02:00
ynh_secure_remove bootstrap/cache/*
# Restore the config file and data
mkdir -p "$final_path/storage/upload/"
mkdir -p "$final_path/storage/export/"
2021-05-25 17:42:51 +02:00
cp -a "$tmpdir/storage/upload/*" "$final_path/storage/upload/."
cp -a "$tmpdir/storage/export/*" "$final_path/storage/export/."
2021-02-08 08:58:17 +01:00
cp -a "$tmpdir/.env" "$final_path/.env"
2020-06-11 00:45:03 +02:00
# Remove temporary directory
2020-11-16 23:54:25 +01:00
ynh_secure_remove --file="$tmpdir"
2021-05-25 17:42:51 +02:00
fi
2020-06-11 00:45:03 +02:00
fi
#=================================================
2020-06-11 00:45:03 +02:00
# NGINX CONFIGURATION
#=================================================
2020-11-29 09:59:46 +01:00
ynh_script_progression --message="Upgrading NGINX web server configuration..."
2020-11-29 09:59:46 +01:00
# Create a dedicated NGINX config
2020-06-11 00:45:03 +02:00
ynh_add_nginx_config
#=================================================
2020-06-11 00:45:03 +02:00
# UPGRADE DEPENDENCIES
#=================================================
2020-06-11 00:45:03 +02:00
ynh_script_progression --message="Upgrading dependencies..."
2020-06-11 00:45:03 +02:00
ynh_install_app_dependencies "$pkg_dependencies"
2020-06-11 00:45:03 +02:00
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..."
2020-02-22 21:29:53 +01:00
2020-06-11 00:45:03 +02:00
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app
2020-06-11 00:45:03 +02:00
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
2020-11-29 09:59:46 +01:00
ynh_script_progression --message="Upgrading PHP-FPM configuration..."
2020-02-22 21:29:53 +01:00
2020-06-11 00:45:03 +02:00
# 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)
2018-06-17 00:50:26 +02:00
#=================================================
2020-06-11 00:45:03 +02:00
# SPECIFIC UPGRADE
#=================================================
2020-06-11 00:45:03 +02:00
# UPDATE PHP DEPENDENCIES
#=================================================
2020-11-29 09:59:46 +01:00
ynh_script_progression --message="Updating PHP dependencies..."
2021-02-08 08:58:17 +01:00
chown -R $app: $final_path
2020-02-22 21:29:53 +01:00
2020-06-13 00:40:47 +02:00
ynh_exec_warn_less ynh_install_composer --phpversion="$phpversion" --workdir="$final_path"
2018-06-17 00:50:26 +02:00
#=================================================
2020-06-11 00:45:03 +02:00
# MODIFY A CONFIG FILE
2018-06-17 00:50:26 +02:00
#=================================================
2020-11-19 10:11:49 +01:00
ynh_script_progression --message="Modifying a config file..."
2018-06-17 00:50:26 +02:00
2020-11-16 23:36:00 +01:00
config="$final_path/.env"
ynh_backup_if_checksum_is_different --file="$config"
cp ../conf/.env "$config"
ynh_replace_string --match_string="SomeRandomStringOf32CharsExactly" --replace_string="$random_key" --target_file="$config"
ynh_replace_string --match_string="fireflyiiidb" --replace_string="127.0.0.1" --target_file="$config"
ynh_replace_string --match_string="DB_DATABASE=firefly" --replace_string="DB_DATABASE=$db_name" --target_file="$config"
ynh_replace_string --match_string="DB_USERNAME=firefly" --replace_string="DB_USERNAME=$db_name" --target_file="$config"
ynh_replace_string --match_string="secret_firefly_password" --replace_string="$db_pwd" --target_file="$config"
ynh_replace_string --match_string="MAIL_MAILER=log" --replace_string="MAIL_MAILER=smtp" --target_file="$config"
ynh_replace_string --match_string="MAIL_HOST=null" --replace_string="MAIL_HOST=127.0.0.1" --target_file="$config"
ynh_replace_string --match_string="MAIL_PORT=2525" --replace_string="MAIL_PORT=25" --target_file="$config"
ynh_replace_string --match_string="mail@example.com" --replace_string="$email" --target_file="$config"
ynh_replace_string --match_string="changeme@example.com" --replace_string="$app@$domain" --target_file="$config"
2020-11-19 10:11:49 +01:00
# These helpers are for reference.Remove them once app gets support for LDAP. Put them directly in .env
2020-11-16 23:36:00 +01:00
# ynh_replace_string --match_string="ADLDAP_CONTROLLERS=" --replace_string="ADLDAP_CONTROLLERS=127.0.0.1" --target_file="$config"
# ynh_replace_string --match_string='ADLDAP_BASEDN=""' --replace_string='ADLDAP_BASEDN="dc=yunohost,dc=org"' --target_file="$config"
# ynh_replace_string --match_string="ADLDAP_ACCOUNT_PREFIX=" --replace_string='ADLDAP_ACCOUNT_PREFIX="uid="' --target_file="$config"
# ynh_replace_string --match_string="ADLDAP_ACCOUNT_SUFFIX=" --replace_string='ADLDAP_ACCOUNT_SUFFIX=",dc=yunohost,dc=org"' --target_file="$config"
# ynh_replace_string --match_string="distinguishedname" --replace_string="uid" --target_file="$config"
# ynh_replace_string --match_string="userprincipalname" --replace_string="uid" --target_file="$config"
ynh_replace_string --match_string="localhost" --replace_string="$domain$path_url" --target_file="$config"
2020-06-11 00:45:03 +02:00
# Recalculate and store the checksum of the file for the next upgrade.
2020-11-16 23:36:00 +01:00
ynh_store_file_checksum --file="$config"
2018-06-17 00:50:26 +02:00
#=================================================
2020-06-11 00:45:03 +02:00
# DEPLOYMENT
2018-06-17 00:50:26 +02:00
#=================================================
2020-06-11 00:45:03 +02:00
ynh_script_progression --message="Deploying..."
2018-06-17 00:50:26 +02:00
2020-06-11 00:45:03 +02:00
pushd "$final_path"
2021-02-08 08:58:17 +01:00
ynh_secure_remove --file="bootstrap/cache/*"
php$phpversion artisan cache:clear
php$phpversion artisan migrate --seed
2020-06-11 00:45:03 +02:00
php$phpversion artisan firefly-iii:upgrade-database
php$phpversion artisan passport:install
2020-11-19 10:11:49 +01:00
php$phpversion artisan cache:clear
2020-06-11 00:45:03 +02:00
popd
#=================================================
# SETUP LOGROTATE
#=================================================
ynh_script_progression --message="Upgrading logrotate configuration..."
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
2020-06-11 00:45:03 +02:00
#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
ynh_script_progression --message="Securing files and directories..."
# Set permissions on app files
chown -R $app: $final_path
2021-02-08 08:58:17 +01:00
chmod -R 775 $final_path/storage
2020-06-11 00:45:03 +02:00
2021-02-08 07:50:55 +01:00
#=================================================
# SETUP A CRON
#=================================================
ynh_script_progression --message="Setuping a cron..."
cp ../conf/cron /etc/cron.d/$app
ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="/etc/cron.d/$app"
ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="/etc/cron.d/$app"
ynh_replace_string --match_string="__PHPVERSION__" --replace_string="$phpversion" --target_file="/etc/cron.d/$app"
2018-06-17 00:50:26 +02:00
#=================================================
# RELOAD NGINX
#=================================================
2020-11-29 09:59:46 +01:00
ynh_script_progression --message="Reloading NGINX web server..."
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
2020-06-11 00:45:03 +02:00
ynh_script_progression --message="Upgrade of $app completed" --last