roundcube_ynh/scripts/upgrade

#!/bin/bash

#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================

source _common.sh
source /usr/share/yunohost/helpers
# Overload the helper ynh_handle_getopts_args to have fixes from unstable.
# Needed for composer helpers
source _getopts_fix.sh

#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Loading installation settings..."

app=$YNH_APP_INSTANCE_NAME

domain=$(ynh_app_setting_get $app domain)
path_url=$(ynh_app_setting_get $app path)
final_path=$(ynh_app_setting_get $app final_path)
db_name=$(ynh_app_setting_get $app db_name)
with_carddav=$(ynh_app_setting_get $app with_carddav)
with_enigma=$(ynh_app_setting_get $app with_enigma)

#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_print_info "Ensuring downward compatibility..."

# If db_name doesn't exist, create it
if [ -z "$db_name" ]; then
	db_name=$(ynh_sanitize_dbid $app)
	ynh_app_setting_set $app db_name $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 final_path $final_path
fi

# If with_carddav doesn't exist, create it
if [ -z "$with_carddav" ]; then
	if [ -f "$final_path/plugins/carddav/config.inc.php" ]
	then
		with_carddav=1
	else
		with_carddav=0
	fi
	ynh_app_setting_set $app with_carddav $with_carddav
fi

# If with_enigma doesn't exist, create it
if [ -z "$with_enigma" ]; then
	if [ -f "${final_path}/plugins/enigma/config.inc.php" ]
	then
		with_enigma=1
	else
		with_enigma=0
	fi
	ynh_app_setting_set $app with_enigma $with_enigma
fi

#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_print_info "Backing up the app before upgrading (may take a while)..."

# 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)

#=================================================
# STANDARD UPGRADE STEPS
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_print_info "Upgrading source files..."

# Get the current version of roundcube
oldversion=$(grep RCMAIL_VERSION "$final_path/program/include/iniset.php" | cut -d\' -f4)

# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path"

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Upgrading nginx web server configuration..."

# Create a dedicated nginx config
ynh_add_nginx_config

#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_print_info "Upgrading dependencies..."

ynh_install_app_dependencies "$pkg_dependencies"

#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_print_info "Making sure dedicated system user exists..."

# Create a dedicated user (if not existing)
ynh_system_user_create $app

#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Upgrading php-fpm configuration..."

# Create a dedicated php-fpm config
ynh_add_fpm_config

#=================================================
# SPECIFIC UPGRADE
#=================================================
# CONFIGURE ROUNDCUBE
#=================================================
ynh_print_info "Reconfiguring roundcube..."

rc_conf="$final_path/config/config.inc.php"

# Verify the checksum and backup the file if it's different
ynh_backup_if_checksum_is_different "$rc_conf"

cp ../conf/config.inc.php "$rc_conf"

ynh_replace_string "__DESKEY__" "$(ynh_string_random 24)" "$rc_conf"
ynh_replace_string "__DBUSER__" $db_name "$rc_conf"
db_pwd=$(ynh_app_setting_get $app mysqlpwd)
ynh_replace_string "__DBPASS__" "$db_pwd" "$rc_conf"
ynh_replace_string "__DBNAME__" $db_name "$rc_conf"

#=================================================
# UPDATE DEPENDENCIES WITH COMPOSER
#=================================================
ynh_print_info "Updating dependencies with composer..."

# Check if dependencies need to be updated with composer
if [ -f "$final_path/composer.json" ]
then
    ynh_exec_warn_less ynh_composer_exec --commands=\"update --no-dev --prefer-dist\"
else
    # Install composer.json
    cp "$final_path/composer.json-dist" "$final_path/composer.json"

    # Install composer
    ynh_install_composer
fi
#=================================================
# UPGRADE ADDITIONAL PLUGINS
#=================================================
ynh_print_info "Upgrading additional plugins..."

# Create logs and temp directories
mkdir -p "$final_path/"{logs,temp}

# Update or install contextmenu and automatic_addressbook plugins
# https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook
# https://plugins.roundcube.net/packages/johndoh/contextmenu
ynh_composer_exec --commands="update --no-dev --prefer-dist \
    johndoh/contextmenu $contextmenu_version \
    sblaisot/automatic_addressbook $automatic_addressbook_version"

installed_plugins+=" 'contextmenu', 'automatic_addressbook',"

# Update or install CardDAV plugin
if [ $with_carddav -eq 1 ]
then
    ynh_composer_exec --commands="require roundcube/carddav $carddav_version"

    carddav_tmp_config="../conf/carddav.config.inc.php"

    # Look for installed and supported CardDAV servers
    for carddav_app in "owncloud" "nextcloud" "baikal"
    do
        carddav_app_id=$(yunohost app list --installed -f $carddav_app \
            --output-as json | grep -Po '"id":[ ]?"\K.*?(?=")' | head -1)
        if [ -n "$carddav_app_id" ]
        then
            # Retrieve app settings and enable relevant preset
            carddav_domain=$(ynh_app_setting_get $carddav_app_id domain)
            carddav_path=$(ynh_app_setting_get $carddav_app_id path)
            carddav_url="https://${carddav_domain}${carddav_path%/}"
            ynh_replace_string "{${carddav_app}_url}" "$carddav_url" "$carddav_tmp_config"
            ynh_replace_string "\/\* PRESET FOR: $carddav_app" "" "$carddav_tmp_config"
            ynh_replace_string "END: $carddav_app \*\/" "" "$carddav_tmp_config"
        fi
    done

    # Copy the plugin configuration file
    cp "$carddav_tmp_config" ""$final_path/plugins/carddav/config.inc.php""

    installed_plugins+=" 'carddav',"
fi

# Install Enigma plugin
if [ $with_enigma -eq 1 ]
then
    cp -a "$final_path/plugins/enigma/config.inc.php.dist" "$final_path/plugins/enigma/config.inc.php" \
        && installed_plugins+=" 'enigma'," \
        || ynh_print_warn "Unable to install Enigma plugin"
fi

#=================================================
# UPDATE ROUNDCUBE CONFIGURATION
#=================================================
ynh_print_info "Updating roundcube configuration..."

ynh_replace_string "^\s*// installed plugins" "&\n $installed_plugins" "$rc_conf"

# Update javascript dependencies
(cd "$final_path"
/usr/bin/php -q ./bin/install-jsdeps.sh)

# Store the config file checksum into the app settings
ynh_store_file_checksum "$rc_conf"

#=================================================
# UPDATE ROUNDCUBE CORE
#=================================================
ynh_print_info "Updating roundcube core..."

( cd "$final_path"
ynh_exec_warn ./bin/update.sh --version=$oldversion -y)

#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================

# Set permissions to app files
chown -R root: "$final_path"
chown -R $app: "$final_path/"{temp,logs,plugins/enigma/home}

#=================================================
# RELOAD NGINX
#=================================================
ynh_print_info "Reloading nginx web server..."

systemctl reload nginx

#=================================================
# END OF SCRIPT
#=================================================

ynh_print_info "Upgrade of $app completed"