From 53aeda3d749b76e76d8fcebfc72c9e66b7819a2d Mon Sep 17 00:00:00 2001 From: Emmanuel Averty Date: Fri, 6 Jan 2023 16:08:56 +0100 Subject: [PATCH] cleaning --- check_process | 18 ++ conf/gogs_migrations | 5 - conf/gogs_post_migration.sh | 32 --- ...n_source.sql => login_source.sql.template} | 0 scripts/backup | 1 - scripts/change_url | 1 - scripts/experimental_helper.sh | 257 ------------------ scripts/install | 3 +- scripts/remove | 1 - scripts/restore | 1 - scripts/upgrade | 66 +---- 11 files changed, 21 insertions(+), 364 deletions(-) create mode 100644 check_process delete mode 100644 conf/gogs_migrations delete mode 100644 conf/gogs_post_migration.sh rename conf/{login_source.sql => login_source.sql.template} (100%) delete mode 100644 scripts/experimental_helper.sh diff --git a/check_process b/check_process new file mode 100644 index 0000000..8555ae1 --- /dev/null +++ b/check_process @@ -0,0 +1,18 @@ +;; General + ; Manifest + domain="domain.tld" + path="/path" + admin="john" + is_public=1 + ; Checks + pkg_linter=1 + setup_sub_dir=1 + setup_root=1 + setup_nourl=0 + setup_private=1 + setup_public=1 + upgrade=1 + backup_restore=1 + multi_instance=1 + port_already_use=1 (6000) + change_url=1 \ No newline at end of file diff --git a/conf/gogs_migrations b/conf/gogs_migrations deleted file mode 100644 index 5e7a3c4..0000000 --- a/conf/gogs_migrations +++ /dev/null @@ -1,5 +0,0 @@ -/opt/$app -/home/$app -/var/log/$app -/etc/systemd/system/$app.service -/etc/nginx/conf.d/$domain.d/$app.conf diff --git a/conf/gogs_post_migration.sh b/conf/gogs_post_migration.sh deleted file mode 100644 index e4065ff..0000000 --- a/conf/gogs_post_migration.sh +++ /dev/null @@ -1,32 +0,0 @@ -#!/bin/bash - -# Ending the migration process from Gogs to Gitea - -set -u - -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - -source /usr/share/yunohost/helpers - -#================================================= -# SET VARIABLES -#================================================= - -old_app="__OLD_APP__" -new_app="__NEW_APP__" -script_name="$0" - -#================================================= -# DELETE OLD APP'S SETTINGS -#================================================= - -ynh_secure_remove --file="/etc/yunohost/apps/$old_app" -yunohost app ssowatconf - -#================================================= -# DELETE THIS SCRIPT -#================================================= - -echo "rm $script_name" | at now + 1 minutes diff --git a/conf/login_source.sql b/conf/login_source.sql.template similarity index 100% rename from conf/login_source.sql rename to conf/login_source.sql.template diff --git a/scripts/backup b/scripts/backup index a311d22..ac63fe1 100644 --- a/scripts/backup +++ b/scripts/backup @@ -5,7 +5,6 @@ #================================================= # Load common variables and helpers -source ../settings/scripts/experimental_helper.sh source ../settings/scripts/_common.sh # IMPORT GENERIC HELPERS diff --git a/scripts/change_url b/scripts/change_url index db5a59c..60a4f43 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -5,7 +5,6 @@ #================================================= # Import common cmd -source ./experimental_helper.sh source ./_common.sh # IMPORT GENERIC HELPERS diff --git a/scripts/experimental_helper.sh b/scripts/experimental_helper.sh deleted file mode 100644 index 8757149..0000000 --- a/scripts/experimental_helper.sh +++ /dev/null @@ -1,257 +0,0 @@ -# Execute a command as another user -# usage: exec_as USER COMMAND [ARG ...] -exec_as() { - local USER=$1 - shift 1 - - if [[ $USER = $(whoami) ]]; then - eval "$@" - else - sudo -u "$USER" "$@" - fi -} - -# Need also the helper https://github.com/YunoHost-Apps/Experimental_helpers/blob/master/ynh_handle_getopts_args/ynh_handle_getopts_args - -# Make the main steps to migrate an app to its fork. -# -# This helper has to be used for an app which needs to migrate to a new name or a new fork -# (like owncloud to nextcloud or zerobin to privatebin). -# -# This helper will move the files of an app to its new name -# or recreate the things it can't move. -# -# To specify which files it has to move, you have to create a "migration file", stored in ../conf -# This file is a simple list of each file it has to move, -# except that file names must reference the $app variable instead of the real name of the app, -# and every instance-specific variables (like $domain). -# $app is especially important because it's this variable which will be used to identify the old place and the new one for each file. -# -# If a database exists for this app, it will be dumped and then imported in a newly created database, with a new name and new user. -# Don't forget you have to then apply these changes to application-specific settings (depends on the packaged application) -# -# Same things for an existing user, a new one will be created. -# But the old one can't be removed unless it's not used. See below. -# -# If you have some dependencies for your app, it's possible to change the fake debian package which manages them. -# You have to fill the $pkg_dependencies variable, and then a new fake package will be created and installed, -# and the old one will be removed. -# If you don't have a $pkg_dependencies variable, the helper can't know what the app dependencies are. -# -# The app settings.yml will be modified as follows: -# - finalpath will be changed according to the new name (but only if the existing $final_path contains the old app name) -# - The checksums of php-fpm and nginx config files will be updated too. -# - If there is a $db_name value, it will be changed. -# - And, of course, the ID will be changed to the new name too. -# -# Finally, the $app variable will take the value of the new name. -# The helper will set the $migration_process variable to 1 if a migration has been successfully handled. -# -# You have to handle by yourself all the migrations not done by this helper, like configuration or special values in settings.yml -# Also, at the end of the upgrade script, you have to add a post_migration script to handle all the things the helper can't do during YunoHost upgrade (mostly for permission reasons), -# especially remove the old user, move some hooks and remove the old configuration directory -# To launch this script, you have to move it elsewhere and start it after the upgrade script. -# `cp ../conf/$script_post_migration /tmp` -# `(cd /tmp; echo "/tmp/$script_post_migration" | at now + 2 minutes)` -# -# usage: ynh_handle_app_migration migration_id migration_list -# | arg: -i, --migration_id= - ID from which to migrate -# | arg: -l, --migration_list= - File specifying every file to move (one file per line) -ynh_handle_app_migration () { - # Need for end of install - ynh_package_install at - - #================================================= - # LOAD SETTINGS - #================================================= - - old_app=$YNH_APP_INSTANCE_NAME - local old_app_id=$YNH_APP_ID - local old_app_number=$YNH_APP_INSTANCE_NUMBER - - # Declare an array to define the options of this helper. - declare -Ar args_array=( [i]=migration_id= [l]=migration_list= ) - # Get the id from which to migrate - local migration_id - # And the file with the paths to move - local migration_list - # Manage arguments with getopts - ynh_handle_getopts_args "$@" - - # Get the new app id in the manifest - local new_app_id=$(grep \"id\": ../manifest.json | cut -d\" -f4) - if [ $old_app_number -eq 1 ]; then - local new_app=$new_app_id - else - local new_app=${new_app_id}__${old_app_number} - fi - - #================================================= - # CHECK IF IT HAS TO MIGRATE - #================================================= - - migration_process=0 - - if [ "$old_app_id" == "$new_app_id" ] - then - # If the 2 id are the same - # No migration to do. - echo 0 - return 0 - else - if [ "$old_app_id" != "$migration_id" ] - then - # If the new app is not the authorized id, fail. - ynh_die --message "Incompatible application for migration from $old_app_id to $new_app_id" - fi - - echo "Migrate from $old_app_id to $new_app_id" >&2 - - #================================================= - # CHECK IF THE MIGRATION CAN BE DONE - #================================================= - - # TODO Handle multi instance apps... - # Check that there is not already an app installed for this id. - (yunohost app list --installed -f "$new_app" | grep -q id) \ - && ynh_die "$new_app is already installed" - - #================================================= - # CHECK THE LIST OF FILES TO MOVE - #================================================= - - local temp_migration_list="$(tempfile)" - - # Build the list by removing blank lines and comment lines - sed '/^#.*\|^$/d' "../conf/$migration_list" > "$temp_migration_list" - - # Check if there is no file in the destination - local file_to_move="" - while read file_to_move - do - # Replace all occurences of $app by $new_app in each file to move. - local move_to_destination="${file_to_move//\$app/$new_app}" - test -e "$move_to_destination" && ynh_die "A file named $move_to_destination already exists." - done < "$temp_migration_list" - - #================================================= - # COPY YUNOHOST SETTINGS FOR THIS APP - #================================================= - - local settings_dir="/etc/yunohost/apps" - cp -a "$settings_dir/$old_app" "$settings_dir/$new_app" - cp -a ../{scripts,conf} "$settings_dir/$new_app" - - # Replace the old id by the new one - ynh_replace_string "\(^id: .*\)$old_app" "\1$new_app" "$settings_dir/$new_app/settings.yml" - # INFO: There a special behavior with yunohost app setting: - # if the id given in argument does not match with the id - # stored in the config file, the config file will be purged. - # That's why we use sed instead of app setting here. - # https://github.com/YunoHost/yunohost/blob/c6b5284be8da39cf2da4e1036a730eb5e0515096/src/yunohost/app.py#L1316-L1321 - - # Change the label if it's simply the name of the app - old_label=$(ynh_app_setting_get $new_app label) - if [ "${old_label,,}" == "$old_app_id" ] - then - # Build the new label from the id of the app. With the first character as upper case - new_label=$(echo $new_app_id | cut -c1 | tr [:lower:] [:upper:])$(echo $new_app_id | cut -c2-) - ynh_app_setting_set $new_app label $new_label - fi - - yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.main', force=True, sync_perm=False)" - yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='/' , sync_perm=True)" - - #================================================= - # MOVE FILES TO THE NEW DESTINATION - #================================================= - - while read file_to_move - do - # Replace all occurence of $app by $new_app in each file to move. - move_to_destination="$(eval echo "${file_to_move//\$app/$new_app}")" - local real_file_to_move="$(eval echo "${file_to_move//\$app/$old_app}")" - echo "Move file $real_file_to_move to $move_to_destination" >&2 - mv "$real_file_to_move" "$move_to_destination" - done < "$temp_migration_list" - - #================================================= - # UPDATE SETTINGS KNOWN ENTRIES - #================================================= - - # Replace nginx checksum - ynh_replace_string "\(^checksum__etc_nginx.*\)_$old_app" "\1_$new_app/" "$settings_dir/$new_app/settings.yml" - - # Replace php5-fpm checksums - ynh_replace_string "\(^checksum__etc_php5.*[-_]\)$old_app" "\1$new_app/" "$settings_dir/$new_app/settings.yml" - - # Replace final_path - ynh_replace_string "\(^final_path: .*\)$old_app" "\1$new_app" "$settings_dir/$new_app/settings.yml" - - #================================================= - # MOVE THE DATABASE - #================================================= - - db_pwd=$(ynh_app_setting_get $old_app mysqlpwd) - db_name=$dbname - - # Check if a database exists before trying to move it - local mysql_root_password=$(cat $MYSQL_ROOT_PWD_FILE) - if [ -n "$db_name" ] && mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name" - then - new_db_name=$(ynh_sanitize_dbid $new_app) - echo "Rename the database $db_name to $new_db_name" >&2 - - local sql_dump="/tmp/${db_name}-$(date '+%s').sql" - - # Dump the old database - ynh_mysql_dump_db "$db_name" > "$sql_dump" - - # Create a new database - ynh_mysql_setup_db $new_db_name $new_db_name $db_pwd - # Then restore the old one into the new one - ynh_mysql_connect_as $new_db_name $db_pwd $new_db_name < "$sql_dump" - - # Remove the old database - ynh_mysql_remove_db $db_name $db_name - # And the dump - ynh_secure_remove --file="$sql_dump" - - # Update the value of $db_name - db_name=$new_db_name - ynh_app_setting_set $new_app db_name $db_name - fi - - #================================================= - # CHANGE THE FAKE DEPENDENCIES PACKAGE - #================================================= - - # Check if a variable $pkg_dependencies exists - # If this variable doesn't exist, this part shall be managed in the upgrade script. - if [ -n "${pkg_dependencies:-}" ] - then - # Define the name of the package - local old_package_name="${old_app//_/-}-ynh-deps" - local new_package_name="${new_app//_/-}-ynh-deps" - - if ynh_package_is_installed "$old_package_name" - then - # Install a new fake package - app=$new_app - ynh_install_app_dependencies $pkg_dependencies - # Then remove the old one - app=$old_app - ynh_remove_app_dependencies - fi - fi - - #================================================= - # UPDATE THE ID OF THE APP - #================================================= - - app=$new_app - - # Set migration_process to 1 to inform that an upgrade has been made - migration_process=1 - fi -} diff --git a/scripts/install b/scripts/install index b8f17d3..d9d4c58 100644 --- a/scripts/install +++ b/scripts/install @@ -5,7 +5,6 @@ #================================================= # Load common variables and helpers -source ./experimental_helper.sh source ./_common.sh # IMPORT GENERIC HELPERS @@ -106,7 +105,7 @@ do done # Add ldap config -ynh_replace_string --match_string "__APP__" --replace_string "$app" --target_file ../conf/login_source.sql +ynh_add_config --template="login_source.sql.template" --destination="../conf/login_source.sql" ynh_mysql_connect_as "$db_user" "$db_password" "$dbname" < ../conf/login_source.sql # SETUP FAIL2BAN diff --git a/scripts/remove b/scripts/remove index ebfab83..fe4ed1e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -5,7 +5,6 @@ #================================================= # Load common variables and helpers -source ./experimental_helper.sh source ./_common.sh # IMPORT GENERIC HELPERS diff --git a/scripts/restore b/scripts/restore index b6f3459..3cf615a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -5,7 +5,6 @@ #================================================= # Load common variables and helpers -source ../settings/scripts/experimental_helper.sh source ../settings/scripts/_common.sh # IMPORT GENERIC HELPERS diff --git a/scripts/upgrade b/scripts/upgrade index d47cf36..fc28e6f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -5,7 +5,6 @@ #================================================= # Load common variables and helpers -source ./experimental_helper.sh source ./_common.sh # IMPORT GENERIC HELPERS @@ -17,7 +16,7 @@ source /usr/share/yunohost/helpers ynh_script_progression --message="Loading installation settings..." domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_normalize_url_path --path_url $(ynh_app_setting_get --app $app --key path)) +path_url=$(ynh_app_setting_get --app $app --key path) db_password=$(ynh_app_setting_get --app=$app --key=mysqlpwd) admin=$(ynh_app_setting_get --app=$app --key=adminusername) key=$(ynh_app_setting_get --app=$app --key=secret_key) @@ -62,51 +61,6 @@ if [ -z "$lfs_key" ]; then ynh_app_setting_set --app=$app --key=lfs_key --value=$lfs_key fi -#================================================= -# MIGRATION FROM GOGS -#================================================= - -# [[ $YNH_APP_ID == "gogs" ]] \ -# && [[ "$(cat "/opt/$app/templates/.VERSION")" != 0.11.79.1211 ]] \ -# && ynh_die --message "It look like that you have an old Gogs install. You need first upgrade Gogs instance (id: $gogs_migrate_id) and after migrate to Gitea." -# ynh_handle_app_migration --migration_id=gogs --migration_list=gogs_migrations -# -# if [[ $migration_process -eq 1 ]]; then -# # Reload variables -# dbname=$app -# db_user=$app -# final_path="/opt/$app" -# datadir="/home/""$app" -# repos_path="$datadir/repositories" -# data_path="$datadir/data" -# -# # Replace the user -# ynh_system_user_delete $old_app -# test getent passwd "$app" &>/dev/null || \ -# useradd -d "$datadir" --system --user-group "$app" --shell /bin/bash || \ -# ynh_die --message "Unable to create $app system account" -# -# # Clean old binary -# ynh_secure_remove --file=$final_path/gogs -# ynh_secure_remove --file=$final_path/custom/conf/auth.d -# -# # Restore authentication from SQL database -# ynh_replace_string --match_string __APP__ --replace_string "$app" --target_file ../conf/login_source.sql -# ynh_mysql_connect_as "$db_user" "$db_password" "$dbname" < ../conf/login_source.sql -# -# # Fix hooks -# if [[ -e $repos_path ]];then -# ls $repos_path/*/*.git/hooks/pre-receive | while read p; do -# ynh_secure_remove --file=$p -# done -# ls $repos_path/*/*.git/hooks/post-receive | while read p; do -# ynh_secure_remove --file=$p -# done -# fi -# -# upstream_version="0.0.1" -# fi - # Move data directory if [ -e "/home/""$app" ] && [ ! -e $datadir ]; then mv "/home/""$app" "$datadir" @@ -168,7 +122,7 @@ if ! ynh_permission_exists --permission admin; then ynh_app_setting_delete --app $app --key unprotected_uris ynh_permission_create --permission="admin" --allowed="$admin" # Update ldap config - ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="../conf/login_source.sql" + ynh_add_config --template="login_source.sql.template" --destination="../conf/login_source.sql" ynh_mysql_connect_as "$db_user" "$db_password" "$dbname" < ../conf/login_source.sql fi @@ -200,20 +154,4 @@ ynh_store_file_checksum --file="$final_path/custom/conf/app.ini" # FINISH MIGRATION PROCESS #================================================= -# if [[ $migration_process -eq 1 ]]; then -# echo "Gogs has been successfully migrated to Gitea! \ -# A last scheduled operation will run in a couple of minutes to finish the \ -# migration in YunoHost side. Do not proceed any application operation while \ -# you don't see Gogs as installed." >&2 -# -# # Execute a post migration script after the end of this upgrade. -# # Mainly for some cleaning -# script_post_migration=gogs_post_migration.sh -# ynh_replace_string --match_string __OLD_APP__ --replace_string "$old_app" --target_file ../conf/$script_post_migration -# ynh_replace_string --match_string __NEW_APP__ --replace_string "$app" --target_file ../conf/$script_post_migration -# cp ../conf/$script_post_migration /tmp -# chmod +x /tmp/$script_post_migration -# (cd /tmp; echo "/tmp/$script_post_migration > /tmp/$script_post_migration.log 2>&1" | at now + 2 minutes) -# fi - ynh_script_progression --message="Upgrade of $app completed" --last