mirror of
https://github.com/YunoHost-Apps/archivist_ynh.git
synced 2024-09-03 18:15:55 +02:00
Panel-config + actions fully tested
This commit is contained in:
Maniack Crudelis
parent
ee8fd67827
commit
a878cd3515
9 changed files with 236 additions and 54 deletions
11
actions.json
11
actions.json
|
|
@ -19,4 +19,15 @@
|
|||
"en": "Remove all previous backup files made by Archivist.",
|
||||
"fr": "Supprime tout les précédents backups créés par Archivist."
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "reset_default_config",
|
||||
"name": "Reset the config file and restore a default one.",
|
||||
"command": "/bin/bash scripts/actions/reset_default_config \"Backup_list.conf\"",
|
||||
"user": "root",
|
||||
"accepted_return_codes": [0],
|
||||
"description": {
|
||||
"en": "Reset the config file Backup_list.conf.",
|
||||
"fr": "Réinitialise le fichier de configuration Backup_list.conf."
|
||||
}
|
||||
}]
|
||||
|
|
|
|||
|
|
@ -53,6 +53,17 @@
|
|||
"type": "number",
|
||||
"default": 500
|
||||
}]
|
||||
},
|
||||
{
|
||||
"name": "Overwriting config files",
|
||||
"id": "overwrite_files",
|
||||
"options": [{
|
||||
"name": "Overwrite the cron file during the upgrade ?",
|
||||
"help": "If the file is overwritten, a backup will be created.",
|
||||
"id": "overwrite_cron",
|
||||
"type": "bool",
|
||||
"default": true
|
||||
}]
|
||||
}]
|
||||
}
|
||||
]
|
||||
|
|
|
|||
|
|
@ -30,6 +30,24 @@ IS_PACKAGE_CHECK () {
|
|||
return $(env | grep -c container=lxc)
|
||||
}
|
||||
|
||||
#=================================================
|
||||
# BOOLEAN CONVERTER
|
||||
#=================================================
|
||||
|
||||
bool_to_01 () {
|
||||
local var="$1"
|
||||
[ "$var" = "true" ] && var=1
|
||||
[ "$var" = "false" ] && var=0
|
||||
echo "$var"
|
||||
}
|
||||
|
||||
bool_to_true_false () {
|
||||
local var="$1"
|
||||
[ "$var" = "1" ] && var=true
|
||||
[ "$var" = "0" ] && var=false
|
||||
echo "$var"
|
||||
}
|
||||
|
||||
#=================================================
|
||||
# EXPERIMENTAL HELPERS
|
||||
#=================================================
|
||||
|
|
@ -517,7 +535,7 @@ EOF
|
|||
ynh_store_file_checksum "$finalfail2banjailconf"
|
||||
ynh_store_file_checksum "$finalfail2banfilterconf"
|
||||
|
||||
systemctl reload fail2ban
|
||||
systemctl restart fail2ban
|
||||
local fail2ban_error="$(journalctl -u fail2ban | tail -n50 | grep "WARNING.*$app.*")"
|
||||
if [ -n "$fail2ban_error" ]
|
||||
then
|
||||
|
|
@ -532,7 +550,7 @@ EOF
|
|||
ynh_remove_fail2ban_config () {
|
||||
ynh_secure_remove "/etc/fail2ban/jail.d/$app.conf"
|
||||
ynh_secure_remove "/etc/fail2ban/filter.d/$app.conf"
|
||||
systemctl reload fail2ban
|
||||
systemctl restart fail2ban
|
||||
}
|
||||
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers
|
|||
# RETRIEVE ARGUMENTS
|
||||
#=================================================
|
||||
|
||||
app=$YNH_APP_ID
|
||||
app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
|
||||
|
||||
final_path=$(ynh_app_setting_get $app final_path)
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers
|
|||
# RETRIEVE ARGUMENTS
|
||||
#=================================================
|
||||
|
||||
app=$YNH_APP_ID
|
||||
app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
|
||||
|
||||
final_path=$(ynh_app_setting_get $app final_path)
|
||||
|
||||
|
|
|
|||
82
scripts/actions/reset_default_config
Executable file
82
scripts/actions/reset_default_config
Executable file
|
|
@ -0,0 +1,82 @@
|
|||
#!/bin/bash
|
||||
|
||||
#=================================================
|
||||
# GENERIC STARTING
|
||||
#=================================================
|
||||
# IMPORT GENERIC HELPERS
|
||||
#=================================================
|
||||
|
||||
source scripts/_common.sh
|
||||
source /usr/share/yunohost/helpers
|
||||
|
||||
#=================================================
|
||||
# RETRIEVE ARGUMENTS
|
||||
#=================================================
|
||||
|
||||
app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
|
||||
final_path=$(ynh_app_setting_get $app final_path)
|
||||
encrypt=$(ynh_app_setting_get $app encrypt)
|
||||
core_backup=$(ynh_app_setting_get $app core_backup)
|
||||
apps_backup=$(ynh_app_setting_get $app apps_backup)
|
||||
|
||||
#=================================================
|
||||
# SORT OUT THE CONFIG FILE TO HANDLE
|
||||
#=================================================
|
||||
|
||||
file="$1"
|
||||
|
||||
if [ "$file" = "Backup_list.conf" ]; then
|
||||
config_file="$final_path/Backup_list.conf"
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
# SPECIFIC ACTION
|
||||
#=================================================
|
||||
# RESET THE CONFIG FILE
|
||||
#=================================================
|
||||
|
||||
# Verify the checksum and backup the file if it's different
|
||||
ynh_backup_if_checksum_is_different "$config_file"
|
||||
|
||||
if [ "$file" = "Backup_list.conf" ]
|
||||
then
|
||||
# Get the default file and overwrite the current config
|
||||
cp "$final_path/Backup_list.conf.default" "$config_file"
|
||||
|
||||
# Recreate the default config
|
||||
backup_dir="/home/yunohost.app/${app}/backup"
|
||||
enc_backup_dir="/home/yunohost.app/${app}/encrypted_backup"
|
||||
ynh_replace_string "^backup_dir=.*" "backup_dir=$backup_dir" "$config_file"
|
||||
ynh_replace_string "^enc_backup_dir=.*" "enc_backup_dir=$enc_backup_dir" "$config_file"
|
||||
|
||||
if [ $encrypt -eq 1 ]
|
||||
then
|
||||
encrypt=true
|
||||
passkey="$final_path/passkey"
|
||||
else
|
||||
encrypt=false
|
||||
passkey=na
|
||||
fi
|
||||
ynh_replace_string "^encrypt=.*" "encrypt=$encrypt" "$config_file"
|
||||
ynh_replace_string "^cryptpass=.*" "cryptpass=$passkey" "$config_file"
|
||||
|
||||
if [ $core_backup -eq 1 ]
|
||||
then
|
||||
core_backup=true
|
||||
else
|
||||
core_backup=false
|
||||
fi
|
||||
ynh_replace_string "^ynh_core_backup=.*" "ynh_core_backup=$core_backup" "$config_file"
|
||||
|
||||
if [ $apps_backup -eq 1 ]
|
||||
then
|
||||
# Add all current applications to the backup
|
||||
while read backup_app
|
||||
do
|
||||
ynh_replace_string "^ynh_app_backup=$" "ynh_app_backup=$backup_app\n&" "$config_file"
|
||||
done <<< "$(yunohost app list -i | grep id: | sed 's/.*id: //')"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Calculate and store the config file checksum into the app settings
|
||||
ynh_store_file_checksum "$config_file"
|
||||
|
|
@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers
|
|||
# RETRIEVE ARGUMENTS
|
||||
#=================================================
|
||||
|
||||
app=$YNH_APP_ID
|
||||
app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID}
|
||||
|
||||
final_path=$(ynh_app_setting_get $app final_path)
|
||||
|
||||
|
|
@ -67,6 +67,11 @@ get_config_value() {
|
|||
old_max_size="$(get_config_value max_size)"
|
||||
max_size="${YNH_CONFIG_MAIN_BACKUP_OPTIONS_MAX_SIZE:-$old_max_size}"
|
||||
|
||||
# Overwrite cron file
|
||||
old_overwrite_cron="$(ynh_app_setting_get $app overwrite_cron)"
|
||||
old_overwrite_cron=$(bool_to_true_false $old_overwrite_cron)
|
||||
overwrite_cron="${YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_CRON:-$old_overwrite_cron}"
|
||||
|
||||
#=================================================
|
||||
# SHOW_CONFIG FUNCTION FOR 'SHOW' COMMAND
|
||||
#=================================================
|
||||
|
|
@ -82,6 +87,8 @@ show_config() {
|
|||
|
||||
echo "YNH_CONFIG_MAIN_BACKUP_OPTIONS_FREQUENCY=$frequency"
|
||||
echo "YNH_CONFIG_MAIN_BACKUP_OPTIONS_MAX_SIZE=$max_size"
|
||||
|
||||
echo "YNH_CONFIG_MAIN_OVERWRITE_FILES_OVERWRITE_CRON=$overwrite_cron"
|
||||
}
|
||||
|
||||
#=================================================
|
||||
|
|
@ -117,7 +124,8 @@ apply_config() {
|
|||
ynh_print_info "Add a backup for the app $backup_app." >&2
|
||||
ynh_replace_string "^ynh_app_backup=$" "ynh_app_backup=$backup_app\n&" "$config_file"
|
||||
done <<< "$(yunohost app list -i | grep id: | sed 's/.*id: //')"
|
||||
else
|
||||
elif [ "$ynh_app_backup" = "false" ] && [ "$old_ynh_app_backup" = "true" ]
|
||||
then
|
||||
# Remove all app currently backup
|
||||
# By deleting all line starting by 'ynh_app_backup=' and having something after '='
|
||||
sed -i "/^ynh_app_backup=.\+$/d" "$config_file"
|
||||
|
|
@ -145,6 +153,10 @@ apply_config() {
|
|||
|
||||
# Change max_size in the config file
|
||||
ynh_replace_string "^max_size=.*" "max_size=$max_size" "$config_file"
|
||||
|
||||
# Set overwrite_cron
|
||||
overwrite_cron=$(bool_to_01 $overwrite_cron)
|
||||
ynh_app_setting_set $app overwrite_cron "$overwrite_cron"
|
||||
}
|
||||
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ fi
|
|||
#=================================================
|
||||
|
||||
ynh_app_setting_set $app frequency "$frequency"
|
||||
ynh_app_setting_set $app encrypt "$encrypt"
|
||||
ynh_app_setting_set $app core_backup "$core_backup"
|
||||
ynh_app_setting_set $app apps_backup "$apps_backup"
|
||||
ynh_app_setting_set $app overwrite_cron "1"
|
||||
|
||||
#=================================================
|
||||
# STANDARD MODIFICATIONS
|
||||
|
|
@ -118,6 +122,9 @@ then
|
|||
done <<< "$(yunohost app list -i | grep id: | sed 's/.*id: //')"
|
||||
fi
|
||||
|
||||
# Calculate and store the config file checksum into the app settings
|
||||
ynh_store_file_checksum "$config_file"
|
||||
|
||||
#=================================================
|
||||
# STRETCH COMPATIBILITY
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -24,6 +24,10 @@ app=$YNH_APP_INSTANCE_NAME
|
|||
|
||||
final_path=$(ynh_app_setting_get $app final_path)
|
||||
frequency="$(ynh_app_setting_get $app frequency)"
|
||||
encrypt=$(ynh_app_setting_get $app encrypt)
|
||||
core_backup=$(ynh_app_setting_get $app core_backup)
|
||||
apps_backup=$(ynh_app_setting_get $app apps_backup)
|
||||
overwrite_cron=$(ynh_app_setting_get $app overwrite_cron)
|
||||
|
||||
#=================================================
|
||||
# CHECK VERSION
|
||||
|
|
@ -31,6 +35,39 @@ frequency="$(ynh_app_setting_get $app frequency)"
|
|||
|
||||
upgrade_type=$(ynh_check_app_version_changed)
|
||||
|
||||
#=================================================
|
||||
# ENSURE DOWNWARD COMPATIBILITY
|
||||
#=================================================
|
||||
|
||||
# If encrypt doesn't exist, create it
|
||||
if [ -z "$encrypt" ]; then
|
||||
encrypt="$(grep "^encrypt=" "$final_path/Backup_list.conf" | cut -d= -f2)"
|
||||
if [ "$encrypt" = true ]; then
|
||||
encrypt=1
|
||||
else
|
||||
encrypt=0
|
||||
fi
|
||||
ynh_app_setting_set $app encrypt $encrypt
|
||||
fi
|
||||
|
||||
# If core_backup doesn't exist, create it
|
||||
if [ -z "$core_backup" ]; then
|
||||
core_backup="$(grep "^ynh_core_backup=" "$final_path/Backup_list.conf" | cut -d= -f2)"
|
||||
ynh_app_setting_set $app core_backup $core_backup
|
||||
fi
|
||||
|
||||
# If apps_backup doesn't exist, create it
|
||||
if [ -z "$apps_backup" ]; then
|
||||
apps_backup="$(grep --count --max-count=1 "^ynh_app_backup=" "$final_path/Backup_list.conf")"
|
||||
ynh_app_setting_set $app apps_backup $apps_backup
|
||||
fi
|
||||
|
||||
# If overwrite_cron doesn't exist, create it
|
||||
if [ -z "$overwrite_cron" ]; then
|
||||
overwrite_cron=1
|
||||
ynh_app_setting_set $app overwrite_cron $overwrite_cron
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
||||
#=================================================
|
||||
|
|
@ -72,6 +109,9 @@ fi
|
|||
# UPDATE THE CRON FILE
|
||||
#=================================================
|
||||
|
||||
# Overwrite the cron file only if it's allowed
|
||||
if [ $overwrite_cron -eq 1 ]
|
||||
then
|
||||
# Verify the checksum and backup the file if it's different
|
||||
ynh_backup_if_checksum_is_different "/etc/cron.d/$app"
|
||||
|
||||
|
|
@ -93,6 +133,7 @@ ynh_replace_string "__FREQUENCY__" "$cron_freq" /etc/cron.d/$app
|
|||
|
||||
# Recalculate and store the config file checksum into the app settings
|
||||
ynh_store_file_checksum "/etc/cron.d/$app"
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
# SETUP LOGROTATE
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue