phpmyadmin_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)
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)
db_admin_user=$(ynh_app_setting_get --app=$app --key=db_admin_user)
db_admin_pwd=$(ynh_app_setting_get --app=$app --key=db_admin_pwd)

#=================================================
# 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
	# In older version, db_name was always phpmyadmin
	db_name=phpmyadmin
	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

# In older version, the admin setting was admin_user
if [ -z "$admin" ]; then
	admin=$(ynh_app_setting_get --app=$app --key=admin_user)
	ynh_app_setting_set --app=$app --key=admin --value=$admin
	ynh_app_setting_delete --app=$app --key=admin_user
fi

# If db_admin_user doesn't exist, create it
if [ -z "$db_admin_user" ]; then
	# Setup a privileged user for phpmyadmin (to prevent using MySQL root user)
	db_admin_user="${app}_root"
	ynh_app_setting_set --app=$app --key=db_admin_user --value=$db_admin_user
	db_admin_pwd="$(ynh_string_random)"
	ynh_app_setting_set --app=$app --key=db_admin_pwd --value=$db_admin_pwd

	if ! ynh_mysql_user_exists --user=$db_admin_user
	then
	  ynh_mysql_create_user $db_admin_user "$db_admin_pwd"
	  ynh_mysql_execute_as_root --sql="GRANT ALL PRIVILEGES ON *.* TO '$db_admin_user'@'localhost' IDENTIFIED BY '$db_admin_pwd' WITH GRANT OPTION;
	  FLUSH PRIVILEGES;" --database=mysql
	fi
fi

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

# 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=$path_url)

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

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

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

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

# Create a dedicated NGINX config
ynh_add_nginx_config

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

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

#=================================================
# SPECIFIC UPGRADE
#=================================================
# UPGRADE THE DATABASE
#=================================================

db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)

if [ "$upgrade_type" == "UPGRADE_APP" ]
then
	ynh_script_progression --message="Upgrading database..." --weight=2

	# Handle upgrade from a version before latest version
	# Ignore warnings and failures that will occur if already on latest version
	ynh_replace_string --match_string="phpmyadmin" --replace_string="$db_name" --target_file=$final_path/sql/upgrade_column_info_4_3_0+.sql
	ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" \
		< $final_path/sql/upgrade_column_info_4_3_0+.sql > /dev/null 2>&1 || true

	# Upgrade from last version (don't ignore failures)
	ynh_replace_string --match_string="phpmyadmin" --replace_string="$db_name" --target_file=$final_path/sql/upgrade_tables_4_7_0+.sql
	ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" \
		< $final_path/sql/upgrade_tables_4_7_0+.sql

	ynh_replace_string --match_string="phpmyadmin" --replace_string="$db_name" --target_file=$final_path/sql/create_tables.sql
	ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" \
		< $final_path/sql/create_tables.sql
fi

#=================================================
# CONFIGURE PHPMYADMIN
#=================================================
ynh_script_progression --message="Reconfiguring phpMyAdmin..."

# Verify the checksum and backup the file if it's different
ynh_backup_if_checksum_is_different --file="$final_path/config.inc.php"

ynh_replace_string --match_string="__YNH_PMA_ADMIN_USER__" --replace_string="$db_admin_user" --target_file=../conf/config.inc.php
ynh_replace_string --match_string="__YNH_PMA_ADMIN_PASSWORD__" --replace_string="$db_admin_pwd" --target_file=../conf/config.inc.php
ynh_replace_string --match_string="__YNH_PMA_USER__" --replace_string="$db_name" --target_file=../conf/config.inc.php
ynh_replace_string --match_string="__YNH_PMA_PASSWORD__" --replace_string="$db_pwd" --target_file=../conf/config.inc.php

cp ../conf/config.inc.php $final_path

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

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

# Set permissions to app files
chown -R root: $final_path
# config.inc.php contains sensitive data, restrict its access
chown root:$app $final_path/config.inc.php
chmod 640 $final_path/config.inc.php
# Setup phpMyAdmin temporary folder
mkdir -p $final_path/tmp
chown -R $app: $final_path/tmp

#=================================================
# INSTALL DEPENDENCIES
#=================================================

if [ "$upgrade_type" == "UPGRADE_APP" ]
then
	
	ynh_script_progression --message="Upgrading dependencies with Composer..." --weight=19

	# Force dependency to the used PHP version
	ynh_exec_warn_less ynh_composer_exec --commands=\"config -g platform.php $YNH_PHP_VERSION\"
	# Install dependencies
	ynh_exec_warn_less ynh_composer_exec --commands=\"update --no-dev\"
fi

#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Upgrading SSOwat configuration..."

# Restrict access to admin only
yunohost app addaccess --users=$admin $app

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

ynh_systemd_action --service_name=nginx --action=reload

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

ynh_script_progression --message="Upgrade of phpMyAdmin completed" --last