roundcube_ynh/scripts/upgrade

#!/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=2

app=$YNH_APP_INSTANCE_NAME

domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
with_carddav=$(ynh_app_setting_get --app=$app --key=with_carddav)
with_enigma=$(ynh_app_setting_get --app=$app --key=with_enigma)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
language=$(ynh_app_setting_get --app=$app --key=language)
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)

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

# 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=$app --key=with_carddav --value=$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=$app --key=with_enigma --value=$with_enigma
fi

 # If language doesn't exist, create it 
 if [ -z "$language" ]; then 
    language="en_GB"
    ynh_app_setting_set --app=$app --key=language --value=$language
fi 

# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
    ynh_legacy_permissions_delete_all

    ynh_app_setting_delete --app=$app --key=is_public
fi

#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=30

# 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

#=================================================
# 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 --home_dir="$final_path"

#=================================================
# STANDARD UPGRADE STEPS
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================

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

if [ "$upgrade_type" == "UPGRADE_APP" ]
then
	ynh_script_progression --message="Upgrading source files..." --weight=3

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

chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..."

# Create a dedicated NGINX config
ynh_add_nginx_config

#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=5

# Create a dedicated PHP-FPM config
ynh_add_fpm_config --package="$extra_php_dependencies"

#=================================================
# SPECIFIC UPGRADE
#=================================================
# CONFIGURE ROUNDCUBE
#=================================================

if [ "$upgrade_type" == "UPGRADE_APP" ]
then
    ynh_script_progression --message="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 --match_string="__DESKEY__" --replace_string="$(ynh_string_random --length=24)" --target_file="$rc_conf"
    ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$rc_conf"
    ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$rc_conf"
    ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$rc_conf"

    #=================================================
    # UPDATE DEPENDENCIES WITH COMPOSER
    #=================================================
    ynh_script_progression --message="Updating dependencies with Composer..." --weight=30

    # Upgrade composer itself
    ynh_install_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"
    fi

    #=================================================
    # UPGRADE ADDITIONAL PLUGINS
    #=================================================
    ynh_script_progression --message="Upgrading additional plugins..." --weight=30

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

    # Install net_LDAP
    ynh_composer_exec --commands="require kolab/net_ldap3"

    # 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"
        carddav_server=0

        # Copy the plugin configuration file
        cp $final_path/plugins/carddav/config.inc.php{.dist,}

        # Look for installed and supported CardDAV servers
        for carddav_app in "nextcloud" "baikal"
        do
            carddav_app_ids=$(yunohost app list | grep "id: $carddav_app" | grep -Po 'id: \K(.*)' || echo "")
            for carddav_app_id in $carddav_app_ids
            do
                carddav_server=1
                # Append preset configuration to the config file
                cat "../conf/${carddav_app}.inc.php" >> $final_path/plugins/carddav/config.inc.php
                # Retrieve app settings and enable relevant preset
                carddav_domain=$(ynh_app_setting_get --app=$carddav_app_id --key=domain)
                carddav_path=$(ynh_app_setting_get --app=$carddav_app_id --key=path)
                carddav_url="https://${carddav_domain}${carddav_path%/}"
                ynh_replace_string --match_string="{${carddav_app}_id}" --replace_string="$carddav_app_id" --target_file="$final_path/plugins/carddav/config.inc.php"
                ynh_replace_string --match_string="{${carddav_app}_url}" --replace_string="$carddav_url" --target_file="$final_path/plugins/carddav/config.inc.php"
            done
        done

        # Do not actually add the carddav plugin if there's no carddav server available...
        if [ $carddav_server -eq 1 ]
        then
            installed_plugins+=" 'carddav',"
        fi
    fi

    # Install Enigma plugin
    if [ $with_enigma -eq 1 ]
    then
        enigma_tmp_config="../conf/enigma.config.inc.php"

        ynh_replace_string --match_string="__DIR__" --replace_string="$final_path/plugins/enigma/home" --target_file="$enigma_tmp_config"

        cp "$enigma_tmp_config" "$final_path/plugins/enigma/config.inc.php" \
            && installed_plugins+=" 'enigma'," \
            || ynh_print_warn --message="Unable to install Enigma plugin"
    fi

    #=================================================
    # UPDATE ROUNDCUBE CONFIGURATION
    #=================================================
    ynh_script_progression --message="Updating $app configuration..." --weight=4

    ynh_replace_string --match_string="^\s*// installed plugins" --replace_string="&\n $installed_plugins" --target_file="$final_path/config/config.inc.php"

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

    # Store the config file checksum into the app settings
    ynh_store_file_checksum --file="$final_path/config/config.inc.php"

    chmod 400 "$final_path/config/config.inc.php"
    chown $app:$app "$final_path/config/config.inc.php"

    #=================================================
    # UPDATE ROUNDCUBE CORE
    #=================================================
    ynh_script_progression --message="Updating $app core..." --weight=4

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

#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..."

ynh_systemd_action --service_name=nginx --action=reload

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

ynh_script_progression --message="Installation of $app completed" --last