mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
Rename 'filesystem' to 'backup' (backup-related stuff) and migrate some stuff to/from 'utils'
This commit is contained in:
Alexandre Aubin
parent
3c22feb0cb
commit
267c4119a8
2 changed files with 221 additions and 221 deletions
|
|
@ -282,26 +282,6 @@ ynh_bind_or_cp() {
|
||||||
ynh_backup "$1" "$2" 1
|
ynh_backup "$1" "$2" 1
|
||||||
}
|
}
|
||||||
|
|
||||||
# Create a directory under /tmp
|
|
||||||
#
|
|
||||||
# [internal]
|
|
||||||
#
|
|
||||||
# Deprecated helper
|
|
||||||
#
|
|
||||||
# usage: ynh_mkdir_tmp
|
|
||||||
# | ret: the created directory path
|
|
||||||
ynh_mkdir_tmp() {
|
|
||||||
ynh_print_warn --message="The helper ynh_mkdir_tmp is deprecated."
|
|
||||||
ynh_print_warn --message="You should use 'mktemp -d' instead and manage permissions \
|
|
||||||
properly with chmod/chown."
|
|
||||||
local TMP_DIR=$(mktemp -d)
|
|
||||||
|
|
||||||
# Give rights to other users could be a security risk.
|
|
||||||
# But for retrocompatibility we need it. (This helpers is deprecated)
|
|
||||||
chmod 755 $TMP_DIR
|
|
||||||
echo $TMP_DIR
|
|
||||||
}
|
|
||||||
|
|
||||||
# Calculate and store a file checksum into the app settings
|
# Calculate and store a file checksum into the app settings
|
||||||
#
|
#
|
||||||
# $app should be defined when calling this helper
|
# $app should be defined when calling this helper
|
||||||
|
|
@ -388,43 +368,83 @@ ynh_delete_file_checksum () {
|
||||||
ynh_app_setting_delete --app=$app --key=$checksum_setting_name
|
ynh_app_setting_delete --app=$app --key=$checksum_setting_name
|
||||||
}
|
}
|
||||||
|
|
||||||
# Remove a file or a directory securely
|
# Make a backup in case of failed upgrade
|
||||||
#
|
#
|
||||||
# usage: ynh_secure_remove --file=path_to_remove
|
# usage:
|
||||||
# | arg: -f, --file - File or directory to remove
|
# ynh_backup_before_upgrade
|
||||||
|
# ynh_clean_setup () {
|
||||||
|
# ynh_restore_upgradebackup
|
||||||
|
# }
|
||||||
|
# ynh_abort_if_errors
|
||||||
#
|
#
|
||||||
# Requires YunoHost version 2.6.4 or higher.
|
# Requires YunoHost version 2.7.2 or higher.
|
||||||
ynh_secure_remove () {
|
ynh_backup_before_upgrade () {
|
||||||
# Declare an array to define the options of this helper.
|
if [ ! -e "/etc/yunohost/apps/$app/scripts/backup" ]
|
||||||
local legacy_args=f
|
|
||||||
declare -Ar args_array=( [f]=file= )
|
|
||||||
local file
|
|
||||||
# Manage arguments with getopts
|
|
||||||
ynh_handle_getopts_args "$@"
|
|
||||||
|
|
||||||
local forbidden_path=" \
|
|
||||||
/var/www \
|
|
||||||
/home/yunohost.app"
|
|
||||||
|
|
||||||
if [ $# -ge 2 ]
|
|
||||||
then
|
then
|
||||||
ynh_print_warn --message="/!\ Packager ! You provided more than one argument to ynh_secure_remove but it will be ignored... Use this helper with one argument at time."
|
ynh_print_warn --message="This app doesn't have any backup script."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
backup_number=1
|
||||||
|
local old_backup_number=2
|
||||||
|
local app_bck=${app//_/-} # Replace all '_' by '-'
|
||||||
|
NO_BACKUP_UPGRADE=${NO_BACKUP_UPGRADE:-0}
|
||||||
|
|
||||||
|
if [ "$NO_BACKUP_UPGRADE" -eq 0 ]
|
||||||
|
then
|
||||||
|
# Check if a backup already exists with the prefix 1
|
||||||
|
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1
|
||||||
|
then
|
||||||
|
# Prefix becomes 2 to preserve the previous backup
|
||||||
|
backup_number=2
|
||||||
|
old_backup_number=1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "$forbidden_path" =~ "$file" \
|
# Create backup
|
||||||
# Match all paths or subpaths in $forbidden_path
|
sudo BACKUP_CORE_ONLY=1 yunohost backup create --apps $app --name $app_bck-pre-upgrade$backup_number --debug
|
||||||
|| "$file" =~ ^/[[:alnum:]]+$ \
|
if [ "$?" -eq 0 ]
|
||||||
# Match all first level paths from / (Like /var, /root, etc...)
|
|
||||||
|| "${file:${#file}-1}" = "/" ]]
|
|
||||||
# Match if the path finishes by /. Because it seems there is an empty variable
|
|
||||||
then
|
then
|
||||||
ynh_print_warn --message="Avoid deleting $file."
|
# If the backup succeeded, remove the previous backup
|
||||||
else
|
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number
|
||||||
if [ -e "$file" ]
|
|
||||||
then
|
then
|
||||||
sudo rm -R "$file"
|
# Remove the previous backup only if it exists
|
||||||
else
|
sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number > /dev/null
|
||||||
ynh_print_info --message="$file wasn't deleted because it doesn't exist."
|
|
||||||
fi
|
fi
|
||||||
|
else
|
||||||
|
ynh_die --message="Backup failed, the upgrade process was aborted."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
ynh_print_warn --message="\$NO_BACKUP_UPGRADE is set, backup will be avoided. Be careful, this upgrade is going to be operated without a security backup"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Restore a previous backup if the upgrade process failed
|
||||||
|
#
|
||||||
|
# usage:
|
||||||
|
# ynh_backup_before_upgrade
|
||||||
|
# ynh_clean_setup () {
|
||||||
|
# ynh_restore_upgradebackup
|
||||||
|
# }
|
||||||
|
# ynh_abort_if_errors
|
||||||
|
#
|
||||||
|
# Requires YunoHost version 2.7.2 or higher.
|
||||||
|
ynh_restore_upgradebackup () {
|
||||||
|
ynh_print_err --message="Upgrade failed."
|
||||||
|
local app_bck=${app//_/-} # Replace all '_' by '-'
|
||||||
|
|
||||||
|
NO_BACKUP_UPGRADE=${NO_BACKUP_UPGRADE:-0}
|
||||||
|
|
||||||
|
if [ "$NO_BACKUP_UPGRADE" -eq 0 ]
|
||||||
|
then
|
||||||
|
# Check if an existing backup can be found before removing and restoring the application.
|
||||||
|
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number
|
||||||
|
then
|
||||||
|
# Remove the application then restore it
|
||||||
|
sudo yunohost app remove $app
|
||||||
|
# Restore the backup
|
||||||
|
sudo yunohost backup restore $app_bck-pre-upgrade$backup_number --apps $app --force --debug
|
||||||
|
ynh_die --message="The app was restored to the way it was before the failed upgrade."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
ynh_print_warn --message="\$NO_BACKUP_UPGRADE is set, that means there's no backup to restore. You have to fix this upgrade by yourself !"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
@ -29,87 +29,6 @@ ynh_get_plain_key() {
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# Restore a previous backup if the upgrade process failed
|
|
||||||
#
|
|
||||||
# usage:
|
|
||||||
# ynh_backup_before_upgrade
|
|
||||||
# ynh_clean_setup () {
|
|
||||||
# ynh_restore_upgradebackup
|
|
||||||
# }
|
|
||||||
# ynh_abort_if_errors
|
|
||||||
#
|
|
||||||
# Requires YunoHost version 2.7.2 or higher.
|
|
||||||
ynh_restore_upgradebackup () {
|
|
||||||
ynh_print_err --message="Upgrade failed."
|
|
||||||
local app_bck=${app//_/-} # Replace all '_' by '-'
|
|
||||||
|
|
||||||
NO_BACKUP_UPGRADE=${NO_BACKUP_UPGRADE:-0}
|
|
||||||
|
|
||||||
if [ "$NO_BACKUP_UPGRADE" -eq 0 ]
|
|
||||||
then
|
|
||||||
# Check if an existing backup can be found before removing and restoring the application.
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number
|
|
||||||
then
|
|
||||||
# Remove the application then restore it
|
|
||||||
sudo yunohost app remove $app
|
|
||||||
# Restore the backup
|
|
||||||
sudo yunohost backup restore $app_bck-pre-upgrade$backup_number --apps $app --force --debug
|
|
||||||
ynh_die --message="The app was restored to the way it was before the failed upgrade."
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
ynh_print_warn --message="\$NO_BACKUP_UPGRADE is set, that means there's no backup to restore. You have to fix this upgrade by yourself !"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Make a backup in case of failed upgrade
|
|
||||||
#
|
|
||||||
# usage:
|
|
||||||
# ynh_backup_before_upgrade
|
|
||||||
# ynh_clean_setup () {
|
|
||||||
# ynh_restore_upgradebackup
|
|
||||||
# }
|
|
||||||
# ynh_abort_if_errors
|
|
||||||
#
|
|
||||||
# Requires YunoHost version 2.7.2 or higher.
|
|
||||||
ynh_backup_before_upgrade () {
|
|
||||||
if [ ! -e "/etc/yunohost/apps/$app/scripts/backup" ]
|
|
||||||
then
|
|
||||||
ynh_print_warn --message="This app doesn't have any backup script."
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
backup_number=1
|
|
||||||
local old_backup_number=2
|
|
||||||
local app_bck=${app//_/-} # Replace all '_' by '-'
|
|
||||||
NO_BACKUP_UPGRADE=${NO_BACKUP_UPGRADE:-0}
|
|
||||||
|
|
||||||
if [ "$NO_BACKUP_UPGRADE" -eq 0 ]
|
|
||||||
then
|
|
||||||
# Check if a backup already exists with the prefix 1
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1
|
|
||||||
then
|
|
||||||
# Prefix becomes 2 to preserve the previous backup
|
|
||||||
backup_number=2
|
|
||||||
old_backup_number=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Create backup
|
|
||||||
sudo BACKUP_CORE_ONLY=1 yunohost backup create --apps $app --name $app_bck-pre-upgrade$backup_number --debug
|
|
||||||
if [ "$?" -eq 0 ]
|
|
||||||
then
|
|
||||||
# If the backup succeeded, remove the previous backup
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number
|
|
||||||
then
|
|
||||||
# Remove the previous backup only if it exists
|
|
||||||
sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number > /dev/null
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
ynh_die --message="Backup failed, the upgrade process was aborted."
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
ynh_print_warn --message="\$NO_BACKUP_UPGRADE is set, backup will be avoided. Be careful, this upgrade is going to be operated without a security backup"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Download, check integrity, uncompress and patch the source from app.src
|
# Download, check integrity, uncompress and patch the source from app.src
|
||||||
#
|
#
|
||||||
# The file conf/app.src need to contains:
|
# The file conf/app.src need to contains:
|
||||||
|
|
@ -318,3 +237,64 @@ ynh_render_template() {
|
||||||
jinja2.Template(sys.stdin.read()
|
jinja2.Template(sys.stdin.read()
|
||||||
).render(os.environ));' < $template_path > $output_path
|
).render(os.environ));' < $template_path > $output_path
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Create a directory under /tmp
|
||||||
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
|
# Deprecated helper
|
||||||
|
#
|
||||||
|
# usage: ynh_mkdir_tmp
|
||||||
|
# | ret: the created directory path
|
||||||
|
ynh_mkdir_tmp() {
|
||||||
|
ynh_print_warn --message="The helper ynh_mkdir_tmp is deprecated."
|
||||||
|
ynh_print_warn --message="You should use 'mktemp -d' instead and manage permissions \
|
||||||
|
properly with chmod/chown."
|
||||||
|
local TMP_DIR=$(mktemp -d)
|
||||||
|
|
||||||
|
# Give rights to other users could be a security risk.
|
||||||
|
# But for retrocompatibility we need it. (This helpers is deprecated)
|
||||||
|
chmod 755 $TMP_DIR
|
||||||
|
echo $TMP_DIR
|
||||||
|
}
|
||||||
|
|
||||||
|
# Remove a file or a directory securely
|
||||||
|
#
|
||||||
|
# usage: ynh_secure_remove --file=path_to_remove
|
||||||
|
# | arg: -f, --file - File or directory to remove
|
||||||
|
#
|
||||||
|
# Requires YunoHost version 2.6.4 or higher.
|
||||||
|
ynh_secure_remove () {
|
||||||
|
# Declare an array to define the options of this helper.
|
||||||
|
local legacy_args=f
|
||||||
|
declare -Ar args_array=( [f]=file= )
|
||||||
|
local file
|
||||||
|
# Manage arguments with getopts
|
||||||
|
ynh_handle_getopts_args "$@"
|
||||||
|
|
||||||
|
local forbidden_path=" \
|
||||||
|
/var/www \
|
||||||
|
/home/yunohost.app"
|
||||||
|
|
||||||
|
if [ $# -ge 2 ]
|
||||||
|
then
|
||||||
|
ynh_print_warn --message="/!\ Packager ! You provided more than one argument to ynh_secure_remove but it will be ignored... Use this helper with one argument at time."
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$forbidden_path" =~ "$file" \
|
||||||
|
# Match all paths or subpaths in $forbidden_path
|
||||||
|
|| "$file" =~ ^/[[:alnum:]]+$ \
|
||||||
|
# Match all first level paths from / (Like /var, /root, etc...)
|
||||||
|
|| "${file:${#file}-1}" = "/" ]]
|
||||||
|
# Match if the path finishes by /. Because it seems there is an empty variable
|
||||||
|
then
|
||||||
|
ynh_print_warn --message="Avoid deleting $file."
|
||||||
|
else
|
||||||
|
if [ -e "$file" ]
|
||||||
|
then
|
||||||
|
sudo rm -R "$file"
|
||||||
|
else
|
||||||
|
ynh_print_info --message="$file wasn't deleted because it doesn't exist."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue