mirror of
https://github.com/YunoHost-Apps/nextcloud_ynh.git
synced 2024-09-03 19:55:57 +02:00
499 lines
19 KiB
Bash
Executable file
499 lines
19 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# LOAD SETTINGS
|
|
#=================================================
|
|
ynh_script_progression --message="Loading installation settings..." --weight=3
|
|
|
|
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)
|
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
|
user_home=$(ynh_app_setting_get --app=$app --key=user_home)
|
|
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
|
|
|
|
fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
|
|
fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage)
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
|
|
upgrade_type=$(ynh_check_app_version_changed)
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..."
|
|
|
|
# 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
|
|
|
|
# Remove the option backup_core_only if it's in the settings.yml file
|
|
ynh_app_setting_delete --app=$app --key=backup_core_only
|
|
|
|
# If fpm_footprint doesn't exist, create it
|
|
if [ -z "$fpm_footprint" ]; then
|
|
fpm_footprint=high
|
|
ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint
|
|
fi
|
|
|
|
# If fpm_usage doesn't exist, create it
|
|
if [ -z "$fpm_usage" ]; then
|
|
fpm_usage=medium
|
|
ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage
|
|
fi
|
|
|
|
#=================================================
|
|
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
|
#=================================================
|
|
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=30
|
|
|
|
# Made a backup only after the version 11.0.0
|
|
# Before, the datas will be always saved.
|
|
# Get the current version number of nextcloud/owncloud
|
|
current_version=$(grep OC_VersionString "$final_path/version.php" | cut -d\' -f2)
|
|
current_major_version=${current_version%%.*}
|
|
|
|
if [ $current_major_version -gt 11 ]
|
|
then
|
|
# Inform the backup/restore process that it should not save the data directory
|
|
# Use only for the previous backup script that doesn't set 'is_big'
|
|
ynh_app_setting_set --app=$app --key=backup_core_only --value=1
|
|
|
|
# Backup the current version of the app
|
|
ynh_backup_before_upgrade
|
|
|
|
# Remove the option backup_core_only after the backup.
|
|
ynh_app_setting_delete $app backup_core_only
|
|
|
|
ynh_clean_setup () {
|
|
# Remove the post migration script before its execution !
|
|
ynh_exec_warn_less ynh_secure_remove --file="/tmp/owncloud_post_migration.sh"
|
|
|
|
# restore it if the upgrade fails
|
|
ynh_restore_upgradebackup
|
|
}
|
|
fi
|
|
|
|
# Exit if an error occurs during the execution of the script
|
|
ynh_abort_if_errors
|
|
|
|
#=================================================
|
|
# HANDLE MIGRATION FROM OWNCLOUD
|
|
#=================================================
|
|
|
|
ynh_handle_app_migration "owncloud" "owncloud_migration"
|
|
if [ $migration_process -eq 1 ]
|
|
then
|
|
# If a migration has been performed
|
|
# Reload some values changed by the migration process
|
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
|
|
|
# Remove the old fake package for owncloud.
|
|
# Its name is specific, so the migration process can't remove it
|
|
ynh_package_autopurge owncloud-deps
|
|
|
|
# Change the database access in the config
|
|
ynh_replace_string "\('dbname' =>\).*" "\1 '$db_name'," "$final_path/config/config.php"
|
|
ynh_replace_string "\('dbuser' =>\).*" "\1 '$db_name'," "$final_path/config/config.php"
|
|
|
|
# Change the path of the data directory
|
|
ynh_replace_string "\('dbuser' =>\).*" "\1 '$db_name'," "$final_path/config/config.php"
|
|
ynh_replace_string "\('datadirectory' =>.*\)$old_app" "\1$app" "$final_path/config/config.php"
|
|
fi
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..." --weight=7
|
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
|
|
#=================================================
|
|
# STANDARD UPGRADE STEPS
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
ynh_script_progression --message="Making sure dedicated system user exists..."
|
|
|
|
# Create a dedicated user (if not existing)
|
|
ynh_system_user_create --username=$app
|
|
|
|
#=================================================
|
|
# PHP-FPM CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2
|
|
|
|
# Recreate a dedicated PHP-FPM config
|
|
ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint --package="$extra_php_dependencies"
|
|
|
|
# Delete existing ini configuration file (backward compatibility)
|
|
if [ -f /etc/php/$phpversion/fpm/conf.d/20-$app.ini ]; then
|
|
ynh_secure_remove --file=/etc/php/$phpversion/fpm/conf.d/20-$app.ini
|
|
fi
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
|
|
|
|
ynh_backup_if_checksum_is_different --file="/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
|
|
# Delete current NGINX configuration to be able to check if .well-known is already served.
|
|
ynh_remove_nginx_config
|
|
ynh_app_setting_delete --app=$app --key="checksum__etc_nginx_conf.d_$domain.d_$app.conf"
|
|
|
|
# Wait untils NGINX has fully reloaded
|
|
ynh_systemd_action --service_name=nginx --action=reload --line_match="Reloaded" --log_path="systemd"
|
|
|
|
# Check if .well-known is available for this domain
|
|
if is_url_handled --domain="$domain" --path="/.well-known/caldav" || is_url_handled --domain="$domain" --path="/.well-known/carddav"
|
|
then
|
|
ynh_print_warn --message="Another app already uses the domain $domain to serve a caldav/carddav feature. You may encounter issues when dealing with your calendar or address book."
|
|
|
|
# Remove lines about .well-known/carddav and caldav with sed.
|
|
sed --in-place --regexp-extended '/^location = \/\.well\-known\/(caldav|carddav) \{/,/\}/d' "../conf/nginx.conf"
|
|
fi
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# MAKE SEQUENTIAL UPGRADES FROM EACH MAJOR
|
|
# VERSION TO THE NEXT ONE
|
|
#=================================================
|
|
|
|
# Define a function to execute commands with `occ`
|
|
exec_occ() {
|
|
# Backward compatibility to upgrade from NC14 or older version
|
|
if [ $current_major_version = "last" ] || [ $current_major_version -ge 15 ]
|
|
then
|
|
NEXTCLOUD_PHP_VERSION=$phpversion
|
|
else
|
|
NEXTCLOUD_PHP_VERSION="7.0"
|
|
fi
|
|
(cd "$final_path" && exec_as "$app" \
|
|
php$NEXTCLOUD_PHP_VERSION occ --no-interaction --no-ansi "$@")
|
|
}
|
|
|
|
# Define a function to add an external storage
|
|
# Create the external storage for the given folders and enable sharing
|
|
create_external_storage() {
|
|
local datadir="$1"
|
|
local mount_name="$2"
|
|
local mount_id=$(exec_occ files_external:create --output=json \
|
|
"$mount_name" 'local' 'null::null' -c "datadir=$datadir" || true)
|
|
! [[ $mount_id =~ ^[0-9]+$ ]] \
|
|
&& ynh_print_warn --message="Unable to create external storage" \
|
|
|| exec_occ files_external:option "$mount_id" enable_sharing true
|
|
}
|
|
# Define app's data directory
|
|
datadir="/home/yunohost.app/$app/data"
|
|
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
ynh_script_progression --message="Upgrading Nextcloud..." --weight=3
|
|
|
|
# Load the last available version
|
|
source upgrade.d/upgrade.last.sh
|
|
last_version=$next_version
|
|
|
|
last_major_version=${last_version%%.*}
|
|
|
|
# Set write access for the following commands
|
|
chown -R $app: "$final_path" "$datadir"
|
|
|
|
# Print the current version number of Nextcloud
|
|
exec_occ -V
|
|
|
|
# While the current version is not the last version, do an upgrade
|
|
while [ "$last_version" != "$current_version" ]
|
|
do
|
|
|
|
# The major version is the first part of the version number
|
|
current_major_version=${current_version%%.*}
|
|
|
|
if [ ! -f upgrade.d/upgrade.$current_major_version.sh ]; then
|
|
source upgrade.d/upgrade.last.sh
|
|
else
|
|
source upgrade.d/upgrade.$current_major_version.sh
|
|
fi
|
|
|
|
# If the current version has the same major version than the next one,
|
|
# then it's the last upgrade to do
|
|
# We also cover the case where the last version is the first of the current major version series
|
|
# (e.g. 20.0.0 is the latest version)
|
|
if [[ ("$last_major_version" -eq "$current_major_version") || ( ("$last_major_version" -eq "$((current_major_version+1))") && ("$next_version" == "$last_version") ) ]]; then
|
|
current_major_version=last
|
|
# Enable YunoHost patches on Nextcloud sources
|
|
cp -a ../sources/patches_last_version/* ../sources/patches
|
|
fi
|
|
|
|
# Load the value for this version
|
|
source upgrade.d/upgrade.$current_major_version.sh
|
|
|
|
ynh_print_info --message="Upgrade to nextcloud $next_version"
|
|
|
|
# Create an app.src for this version of Nextcloud
|
|
cp ../conf/app.src.default ../conf/app.src
|
|
ynh_replace_string --match_string="__VERSION__" --replace_string="$next_version" --target_file="../conf/app.src"
|
|
ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$nextcloud_source_sha256" --target_file="../conf/app.src"
|
|
|
|
# Create a temporary directory
|
|
tmpdir="$(ynh_smart_mktemp min_size=300)"
|
|
|
|
# Install the next nextcloud version in $tmpdir
|
|
ynh_setup_source --dest_dir="$tmpdir"
|
|
|
|
# Allow Symlinks for multimedia folder
|
|
ynh_replace_string --match_string="protected \$allowSymlinks = false;" --replace_string="protected \$allowSymlinks = true;" --target_file="$tmpdir/lib/private/Files/Storage/Local.php"
|
|
|
|
# Enable maintenance mode
|
|
exec_occ maintenance:mode --on
|
|
|
|
# Backup the config file in the temp dir
|
|
cp -a "$final_path/config/config.php" "$tmpdir/config/config.php"
|
|
|
|
# Backup 3rd party applications from the current Nextcloud
|
|
# But do not overwrite if there is any upgrade
|
|
# (apps directory already exists in Nextcloud archive)
|
|
(
|
|
cd $final_path/apps
|
|
for nc_app_dir in */
|
|
do
|
|
if [ ! -d "$tmpdir/apps/$nc_app_dir" ]
|
|
then
|
|
cp -a "$nc_app_dir" "$tmpdir/apps/$nc_app_dir"
|
|
fi
|
|
done
|
|
)
|
|
|
|
# Replace the old nextcloud by the new one
|
|
ynh_secure_remove --file="$final_path"
|
|
mv "$tmpdir" "$final_path"
|
|
ynh_secure_remove --file="$tmpdir"
|
|
|
|
# Set write access for the following commands
|
|
chown -R $app: "$final_path" "$datadir"
|
|
|
|
# Upgrade Nextcloud (SUCCESS = 0, UP_TO_DATE = 3)
|
|
exec_occ maintenance:mode --off
|
|
exec_occ upgrade \
|
|
|| [ $? -eq 3 ] || ynh_die --message="Unable to upgrade Nextcloud"
|
|
|
|
# Get the new current version number
|
|
current_version=$(grep OC_VersionString "$final_path/version.php" | cut -d\' -f2)
|
|
current_major_version=${current_version%%.*}
|
|
|
|
# Print the current version number of nextcloud
|
|
exec_occ -V
|
|
done
|
|
|
|
exec_occ db:add-missing-indices -n
|
|
exec_occ db:add-missing-columns -n
|
|
exec_occ db:add-missing-primary-keys -n
|
|
exec_occ db:convert-filecache-bigint -n
|
|
|
|
#=================================================
|
|
# CONFIGURE NEXTCLOUD
|
|
#=================================================
|
|
ynh_script_progression --message="Reconfiguring Nextcloud..." --weight=9
|
|
|
|
# Verify the checksum and backup the file if it's different
|
|
ynh_backup_if_checksum_is_different --file="$final_path/config/config.php"
|
|
|
|
nc_conf="${final_path}/config.json"
|
|
cp ../conf/config.json "$nc_conf"
|
|
|
|
ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$nc_conf"
|
|
ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="$nc_conf"
|
|
|
|
# Ensure that UpdateNotification app is disabled
|
|
exec_occ app:disable updatenotification
|
|
|
|
# Enable LDAP plugin
|
|
exec_occ app:enable user_ldap
|
|
|
|
# Load the config file in nextcloud
|
|
exec_occ config:import "$nc_conf"
|
|
|
|
# Then remove the config file
|
|
ynh_secure_remove --file="$nc_conf"
|
|
|
|
#=================================================
|
|
# ALLOW USERS TO DISCONNECT FROM NEXTCLOUD
|
|
#=================================================
|
|
|
|
# Add dynamic logout URL to the config
|
|
exec_occ config:system:get logout_url >/dev/null 2>&1 \
|
|
|| echo "
|
|
//-YunoHost-
|
|
// set logout_url according to main domain
|
|
\$main_domain = exec('cat /etc/yunohost/current_host');
|
|
\$CONFIG['logout_url'] = 'https://'.\$main_domain.'/yunohost/sso/?action=logout';
|
|
//-YunoHost-
|
|
" >> "$final_path/config/config.php"
|
|
|
|
#=================================================
|
|
# CHANGE HOSTNAME FOR ACTIVITY NOTIFICATIONS
|
|
#=================================================
|
|
|
|
ynh_replace_string --match_string="'overwrite.cli.url' => 'http://localhost'," --replace_string="'overwrite.cli.url' => 'https://${domain}'," --target_file="${final_path}/config/config.php"
|
|
|
|
#=================================================
|
|
# MOUNT HOME FOLDERS AS EXTERNAL STORAGE
|
|
#=================================================
|
|
|
|
# Enable External Storage and create local mount to home folder as needed
|
|
if [ $user_home -eq 1 ]; then
|
|
exec_occ app:enable files_external
|
|
exec_occ files_external:list --output=json \
|
|
| grep -q '"storage":"\\\\OC\\\\Files\\\\Storage\\\\Local"' \
|
|
|| create_external_storage "/home/\$user" "Home"
|
|
# Iterate over users to extend their home folder permissions
|
|
for u in $(ynh_user_list); do
|
|
setfacl --modify g:$app:rwx "/home/$u" || true
|
|
done
|
|
fi
|
|
|
|
#=================================================
|
|
# STORE THE CHECKSUM OF THE CONFIG FILE
|
|
#=================================================
|
|
|
|
# Calculate and store the config file checksum into the app settings
|
|
ynh_store_file_checksum --file="${final_path}/config/config.php"
|
|
fi
|
|
|
|
#=================================================
|
|
# UPDATE THE CRON JOB
|
|
#=================================================
|
|
|
|
cron_path="/etc/cron.d/$app"
|
|
cp -a ../conf/nextcloud.cron "$cron_path"
|
|
chown root: "$cron_path"
|
|
chmod 644 "$cron_path"
|
|
|
|
ynh_replace_string --match_string="__USER__" --replace_string="$app" --target_file="$cron_path"
|
|
ynh_replace_string --match_string="__DESTDIR__" --replace_string="$final_path" --target_file="$cron_path"
|
|
ynh_replace_string --match_string="__YNH_PHP_VERSION__" --replace_string="$phpversion" --target_file="$cron_path"
|
|
|
|
exec_occ background:cron
|
|
|
|
#=================================================
|
|
# UPDATE THE HOOK FILE FOR USER CREATE
|
|
#=================================================
|
|
|
|
# Set system group in hooks
|
|
ynh_replace_string --match_string="__GROUP__" --replace_string="$app" --target_file=../hooks/post_user_create
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SECURE FILES AND DIRECTORIES
|
|
#=================================================
|
|
|
|
# Fix app ownerships & permissions
|
|
chown -R $app: "$final_path" "$datadir"
|
|
find $final_path/ -type f -print0 | xargs -0 chmod 0644
|
|
find $final_path/ -type d -print0 | xargs -0 chmod 0755
|
|
find $datadir/ -type f -print0 | xargs -0 chmod 0640
|
|
find $datadir/ -type d -print0 | xargs -0 chmod 0750
|
|
chmod 640 "$final_path/config/config.php"
|
|
chmod 755 /home/yunohost.app
|
|
|
|
#=================================================
|
|
# WARNING ABOUT THIRD-PARTY APPS
|
|
#=================================================
|
|
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
# Warn about possible disabled apps
|
|
ynh_print_warn --message="Note that if you've installed some third-parties Nextcloud applications, \
|
|
they are probably disabled and you'll have to manually enable them again."
|
|
fi
|
|
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..."
|
|
|
|
# Use logrotate to manage app-specific logfile(s)
|
|
ynh_use_logrotate --non-append
|
|
|
|
#=================================================
|
|
# SETUP FAIL2BAN
|
|
#=================================================
|
|
ynh_script_progression --message="Reconfiguring Fail2Ban..." --weight=7
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
ynh_add_fail2ban_config --logpath="/home/yunohost.app/$app/data/nextcloud.log" --failregex="^.*Login failed: '.*' \(Remote IP: '<HOST>'.*$" --max_retry=5
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading SSOwat configuration..." --weight=2
|
|
|
|
ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
|
|
ynh_app_setting_set --app=$app --key=skipped_regex \
|
|
--value="$(sed 's/[\.\-]/\%&/g' <<< $domain)/%.well%-known/.*"
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_script_progression --message="Reloading NGINX web server..."
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# FINISH MIGRATION PROCESS
|
|
#=================================================
|
|
|
|
if [ $migration_process -eq 1 ]
|
|
then
|
|
ynh_print_info --message="ownCloud has been successfully migrated to Nextcloud! \
|
|
A last scheduled operation will run in a couple of minutes to finish the \
|
|
migration in YunoHost side. Do not proceed any application operation while \
|
|
you don't see Nextcloud as installed."
|
|
|
|
# Execute a post migration script after the end of this upgrade.
|
|
# Mainly for some cleaning
|
|
script_post_migration=owncloud_post_migration.sh
|
|
ynh_replace_string --match_string="__OLD_APP__" --replace_string="$old_app" --target_file=../conf/$script_post_migration
|
|
ynh_replace_string --match_string="__NEW_APP__" --replace_string="$app" --target_file=../conf/$script_post_migration
|
|
cp ../conf/$script_post_migration /tmp
|
|
chmod +x /tmp/$script_post_migration
|
|
(cd /tmp; echo "/tmp/$script_post_migration > /tmp/$script_post_migration.log 2>&1" | at now + 2 minutes)
|
|
fi
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --last
|