roundcube_ynh/scripts/install

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

#=================================================
# MANAGE SCRIPT FAILURE
#=================================================

# Exit if an error occurs during the execution of the script
ynh_abort_if_errors

#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================

domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
with_carddav=$YNH_APP_ARG_WITH_CARDDAV
with_enigma=$YNH_APP_ARG_WITH_ENIGMA

app=$YNH_APP_INSTANCE_NAME

#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_print_info "Validating installation parameters..."

final_path=/var/www/$app
test ! -e "$final_path" || ynh_die "This path already contains a folder"

# Normalize the url path syntax
path_url=$(ynh_normalize_url_path $path_url)

# Register (book) web path
ynh_webpath_register $app $domain $path_url

#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_print_info "Storing installation settings..."

ynh_app_setting_set $app domain $domain
ynh_app_setting_set $app path $path_url
ynh_app_setting_set $app with_carddav $with_carddav
ynh_app_setting_set $app with_enigma $with_enigma

#=================================================
# STANDARD MODIFICATIONS
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_print_info "Installing dependencies..."

ynh_install_app_dependencies "$pkg_dependencies"

#=================================================
# CREATE A MYSQL DATABASE
#=================================================
ynh_print_info "Creating a MySQL database..."

db_name=$(ynh_sanitize_dbid $app)
ynh_app_setting_set $app db_name $db_name
ynh_mysql_setup_db $db_name $db_name

#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_print_info "Setting up source files..."

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

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Configuring nginx web server..."

# Create a dedicated nginx config
ynh_add_nginx_config

#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_print_info "Configuring system user..."

# Create a system user
ynh_system_user_create $app

#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Configuring php-fpm..."

# Create a dedicated php-fpm config
ynh_add_fpm_config

#=================================================
# SPECIFIC SETUP
#=================================================
# INSTALL AND INITIALIZE COMPOSER
#=================================================
ynh_print_info "Installing roundcube with composer..."

# Install composer.json
cp "$final_path/composer.json-dist" "$final_path/composer.json"

# Install composer
ynh_install_composer

#=================================================
# INITIALIZE DATABASE
#=================================================
ynh_print_info "Initializing database..."

ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
    < "$final_path/SQL/mysql.initial.sql"

#=================================================
# CONFIGURE ROUNDCUBE
#=================================================
ynh_print_info "Configuring roundcube..."

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

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"
ynh_replace_string "__DBPASS__" "$db_pwd" "$rc_conf"
ynh_replace_string "__DBNAME__" $db_name "$rc_conf"

#=================================================
# INSTALL ADDITIONAL PLUGINS
#=================================================
ynh_print_info "Installing additional plugins..."

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

# 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="require \
    johndoh/contextmenu $contextmenu_version \
    sblaisot/automatic_addressbook $automatic_addressbook_version"

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

# 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" "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"
            sed -i "/\/\/\/\/ PRESET FOR: $carddav_app/,/\/\/\/\/ END: $carddav_app/s/^\/\///" "$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"

#=================================================
# 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 "Installation of $app completed"