Skip to content

Fix upgrade script #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
HugoPoi wants to merge 9 commits into
base: testing
Choose a base branch
from
Draft

Fix upgrade script #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
00c04a0
fix: upgrade issue from 1.5.3 and 1.6.0
HugoPoi Feb 4, 2024
9239647
refactor: remove upgrade_type checking
HugoPoi Feb 4, 2024
0382965
fix: add composer update after good setup
HugoPoi Feb 4, 2024
a2bc97b
refactor: common install functions
HugoPoi Feb 5, 2024
1ff2ece
style: linter no quote warn
HugoPoi Feb 5, 2024
4266a05
fix: only composer update during upgrade
HugoPoi Feb 5, 2024
dfe6ee5
fix: move composer update after require plugins
HugoPoi Feb 5, 2024
c913078
fix: try to manage composer update correctly
HugoPoi Feb 5, 2024
c4751b5
Merge branch 'testing' into pr/195
ericgaspar May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 84 additions & 1 deletion scripts/_common.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,88 @@ automatic_addressbook_version=v0.4.3
carddav_version=5.0.1

#=================================================
# EXPERIMENTAL HELPERS
# DEFINE ALL COMMON FONCTIONS
#=================================================

setup_composer_deps() {
cp "$install_dir/composer.json-dist" "$install_dir/composer.json"
}

configure_roundcube() {
deskey=$(ynh_string_random --length=24)
ynh_add_config --template="../conf/config.inc.php" --destination="$install_dir/config/config.inc.php"
}

install_ldap_addressbook_contextmenu_plugins() {
# Create logs and temp directories
mkdir -p "$install_dir/"{logs,temp}

# Install net_LDAP
export COMPOSER_ALLOW_SUPERUSER=1
ynh_composer_exec --commands="require kolab/net_ldap3 --update-with-all-dependencies"

# 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 \
--update-with-all-dependencies"

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

ynh_add_config --template="../conf/enigma.config.inc.php" --destination="$install_dir/plugins/enigma/config.inc.php"
mkdir -p "$install_dir/plugins/enigma/home"
chown -R $app:www-data "$install_dir/plugins/enigma/home"
}

install_carddav_plugin(){
ynh_composer_exec --commands="require roundcube/carddav $carddav_version --update-with-all-dependencies"

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

# Copy the plugin configuration file
cp $install_dir/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" >> $install_dir/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="$install_dir/plugins/carddav/config.inc.php"
ynh_replace_string --match_string="{${carddav_app}_url}" --replace_string="$carddav_url" --target_file="$install_dir/plugins/carddav/config.inc.php"
done
done

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

}

enable_plugins_in_config() {
ynh_replace_string --match_string="^\s*// installed plugins" --replace_string="&\n $installed_plugins" --target_file="$install_dir/config/config.inc.php"

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

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

update_javascript_deps() {
(cd "$install_dir"
/usr/bin/php$phpversion -q ./bin/install-jsdeps.sh -v ?)
}

108 changes: 15 additions & 93 deletions scripts/install
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,6 @@ ynh_add_nginx_config
# Create a dedicated php-fpm config
ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint

#=================================================
# SPECIFIC SETUP
#=================================================
# INSTALL AND INITIALIZE COMPOSER
#=================================================
ynh_script_progression --message="Installing Roundcube with Composer..." --weight=30

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

# Install composer
ynh_install_composer

#=================================================
# INITIALIZE DATABASE
#=================================================
Expand All @@ -69,93 +56,28 @@ ynh_script_progression --message="Initializing database..." --weight=3
ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < "$install_dir/SQL/mysql.initial.sql"

#=================================================
# CONFIGURE ROUNDCUBE
# INSTALL DEPENDENCIES AND PLUGINS
#=================================================
ynh_script_progression --message="Configuring Roundcube..." --weight=2

deskey=$(ynh_string_random --length=24)
ynh_add_config --template="../conf/config.inc.php" --destination="$install_dir/config/config.inc.php"

#=================================================
# INSTALL ADDITIONAL PLUGINS
#=================================================
ynh_script_progression --message="Installing additional plugins..." --weight=60

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

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

# 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',"
ynh_script_progression --message="Installing Roundcube with Composer..." --weight=30
setup_composer_deps
ynh_install_composer

ynh_add_config --template="../conf/enigma.config.inc.php" --destination="$install_dir/plugins/enigma/config.inc.php"
mkdir -p "$install_dir/plugins/enigma/home"
chown -R $app:www-data "$install_dir/plugins/enigma/home"
ynh_script_progression --message="Configuring Roundcube..." --weight=2
configure_roundcube

# Install CardDAV plugin
ynh_script_progression --message="Installing ldap, automatic addressbook and contextmenu plugins..." --weight=60
install_ldap_addressbook_contextmenu_plugins

if [ $with_carddav -eq 1 ]
then
ynh_composer_exec --commands="require roundcube/carddav $carddav_version --with-all-dependencies"

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

# Copy the plugin configuration file
cp $install_dir/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" >> $install_dir/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="$install_dir/plugins/carddav/config.inc.php"
ynh_replace_string --match_string="{${carddav_app}_url}" --replace_string="$carddav_url" --target_file="$install_dir/plugins/carddav/config.inc.php"
done
done

# Do not actualy add the cardDAV plugin if there's no cardDAV server available...
if [ $carddav_server -eq 1 ]
then
installed_plugins+=" 'carddav',"
fi
ynh_script_progression --message="Installing carddav plugin..." --weight=30
install_carddav_plugin
fi

#=================================================
# UPDATE ROUNDCUBE CONFIGURATION
#=================================================
ynh_script_progression --message="Updating Roundcube configuration..." --weight=3
ynh_script_progression --message="Install javascript dependencies..." --weight=10
update_javascript_deps

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

# Update javascript dependencies
(cd "$install_dir"
/usr/bin/php$phpversion -q ./bin/install-jsdeps.sh -v ?)

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

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

#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Updating Roundcube configuration..." --weight=3
enable_plugins_in_config

ynh_script_progression --message="Installation of $app completed" --last
147 changes: 26 additions & 121 deletions scripts/upgrade
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@
source _common.sh
source /usr/share/yunohost/helpers

#=================================================
# CHECK VERSION
#=================================================

upgrade_type=$(ynh_check_app_version_changed)

#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
Expand Down Expand Up @@ -64,13 +58,10 @@ fi
# Get the current version of roundcube
oldversion=$(grep RCMAIL_VERSION "$install_dir/program/include/iniset.php" | cut -d\' -f4)

if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..." --weight=3
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="$install_dir"
fi
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir"

chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
Expand All @@ -91,119 +82,33 @@ ynh_add_nginx_config
#=================================================
# CONFIGURE ROUNDCUBE
#=================================================
ynh_script_progression --message="Updating Roundcube dependencies with Composer..." --weight=30
setup_composer_deps
ynh_composer_exec --commands="update --no-dev"

ynh_script_progression --message="Configuring Roundcube..." --weight=2
configure_roundcube

if [ "$upgrade_type" == "UPGRADE_APP" ]
ynh_script_progression --message="Installing ldap, automatic addressbook and contextmenu plugins..." --weight=60
install_ldap_addressbook_contextmenu_plugins

if [ $with_carddav -eq 1 ]
then
ynh_script_progression --message="Reconfiguring Roundcube..." --weight=1

deskey=$(ynh_string_random --length=24)
ynh_add_config --template="../conf/config.inc.php" --destination="$install_dir/config/config.inc.php"

#=================================================
# 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 "$install_dir/composer.json" ]
then
ynh_exec_warn_less ynh_composer_exec --commands="update"
# Update plugin-installer for Composer version 2.0
ynh_exec_warn_less ynh_composer_exec --commands="require roundcube/plugin-installer:>=0.2.0"
else
# Install composer.json
cp "$install_dir/composer.json-dist" "$install_dir/composer.json"
fi

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

# Create logs and temp directories
mkdir -p "$install_dir/"{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',"

ynh_add_config --template="../conf/enigma.config.inc.php" --destination="$install_dir/plugins/enigma/config.inc.php"
mkdir -p "$install_dir/plugins/enigma/home"
chown -R $app:$app "$install_dir/plugins/enigma/home"

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

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

# Copy the plugin configuration file
cp $install_dir/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" >> $install_dir/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="$install_dir/plugins/carddav/config.inc.php"
ynh_replace_string --match_string="{${carddav_app}_url}" --replace_string="$carddav_url" --target_file="$install_dir/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

#=================================================
# 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="$install_dir/config/config.inc.php"

# Update JavaScript dependencies
pushd "$install_dir"
COMPOSER_ALLOW_SUPERUSER=1 "php$phpversion" ./bin/update.sh --version="?" -y <<< ""

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

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

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

COMPOSER_ALLOW_SUPERUSER=1 ynh_exec_warn "php$phpversion" ./bin/update.sh --version=$oldversion -y
popd
ynh_script_progression --message="Installing carddav plugin..." --weight=30
install_carddav_plugin
fi

ynh_script_progression --message="Install javascript dependencies..." --weight=10
update_javascript_deps

ynh_script_progression --message="Updating Roundcube configuration..." --weight=3
enable_plugins_in_config

# Migrate roundcube database
pushd "$install_dir"
COMPOSER_ALLOW_SUPERUSER=1 ynh_exec_warn php$phpversion ./bin/update.sh --version=$oldversion -y
popd

#=================================================
# END OF SCRIPT
#=================================================
Expand Down