Skip to content

improved restore mode, abie to restore to new location #42

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

Closed
wants to merge 7 commits into from
Closed

improved restore mode, abie to restore to new location #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4890e02
improve restore mode
buildplan Aug 14, 2025
764b176
update sha256 v0.33
Aug 14, 2025
5d2e447
version bump
buildplan Aug 14, 2025
1916c63
added v0.33
buildplan Aug 14, 2025
868597f
improve run restore
buildplan Aug 14, 2025
7f011e5
improved restore function
buildplan Aug 14, 2025
aa55173
Merge pull request #44 from buildplan/buildplan-patch-1
buildplan Aug 14, 2025
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
178 changes: 105 additions & 73 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ To run the backup automatically, edit the root crontab.

```ini
# =================================================================
# Configuration for rsync Backup Script v0.32
# Configuration for rsync Backup Script v0.33
# =================================================================
# !! IMPORTANT !! Set file permissions to 600 (chmod 600 backup.conf)

Expand Down Expand Up @@ -310,7 +310,7 @@ END_EXCLUDES

```bash
#!/bin/bash
# ===================== v0.32 - 2025.08.13 ========================
# ===================== v0.33 - 2025.08.14 ========================
#
# =================================================================
# SCRIPT INITIALIZATION & SETUP
Expand Down Expand Up @@ -617,6 +617,7 @@ run_preflight_checks() {
fi
}
run_restore_mode() {
local RSYNC_CMD="rsync"
printf "${C_BOLD}${C_CYAN}--- RESTORE MODE ACTIVATED ---${C_RESET}\n"
run_preflight_checks "restore"
local DIRS_ARRAY; read -ra DIRS_ARRAY <<< "$BACKUP_DIRS"
Expand All @@ -639,11 +640,9 @@ run_restore_mode() {
if [[ "$dir_choice" == "$RECYCLE_OPTION" ]]; then
printf "${C_BOLD}${C_CYAN}--- Browse Recycle Bin ---${C_RESET}\n"
local remote_recycle_path="${BOX_DIR%/}/${RECYCLE_BIN_DIR%/}"
local date_folders
date_folders=$(ssh "${SSH_OPTS_ARRAY[@]}" "${SSH_DIRECT_OPTS[@]}" "$BOX_ADDR" "ls -1 \"$remote_recycle_path\"" 2>/dev/null) || true
local date_folders; date_folders=$(ssh "${SSH_OPTS_ARRAY[@]}" "${SSH_DIRECT_OPTS[@]}" "$BOX_ADDR" "ls -1 \"$remote_recycle_path\"" 2>/dev/null) || true
if [[ -z "$date_folders" ]]; then
echo "❌ No dated folders found in the recycle bin. Nothing to restore." >&2
return 1
echo "❌ No dated folders found in the recycle bin. Nothing to restore." >&2; return 1
fi
printf "${C_YELLOW}Select a backup run (date_time) to browse:${C_RESET}\n"
select date_choice in $date_folders "Cancel"; do
Expand All @@ -654,122 +653,155 @@ run_restore_mode() {
local remote_date_path="${remote_recycle_path}/${date_choice}"
printf "${C_BOLD}--- Files available from ${date_choice} (showing first 20) ---${C_RESET}\n"
local remote_listing_source="${BOX_ADDR}:${remote_date_path}/"
rsync -r -n --out-format='%n' -e "$SSH_CMD" "$remote_listing_source" . 2>/dev/null | head -n 20 || echo "No files found for this date."
"$RSYNC_CMD" -r -n --out-format='%n' -e "$SSH_CMD" "$remote_listing_source" . 2>/dev/null | head -n 20 || echo "No files found for this date."
printf "${C_BOLD}--------------------------------------------------------${C_RESET}\n"
printf "${C_YELLOW}Enter the full original path of the item to restore (e.g., home/user/file.txt): ${C_RESET}"
read -r specific_path
printf "${C_YELLOW}Enter the full original path of the item to restore (e.g., home/user/file.txt): ${C_RESET}"; read -r specific_path
specific_path=$(echo "$specific_path" | sed 's#^/##')
if [[ -z "$specific_path" ]]; then echo "❌ Path cannot be empty. Aborting."; return 1; fi
full_remote_source="${BOX_ADDR}:${remote_date_path}/${specific_path}"
if ! rsync -r -n -e "$SSH_CMD" "$full_remote_source" . >/dev/null 2>&1; then
echo "❌ ERROR: The path '${specific_path}' was not found in the recycle bin for ${date_choice}. Aborting." >&2
return 1
if ! "$RSYNC_CMD" -r -n -e "$SSH_CMD" "$full_remote_source" . >/dev/null 2>&1; then
echo "❌ ERROR: The path '${specific_path}' was not found in the recycle bin for ${date_choice}. Aborting." >&2; return 1
fi
default_local_dest="/${specific_path}"
item_for_display="(from Recycle Bin) '${specific_path}'"
default_local_dest="/${specific_path}"; item_for_display="(from Recycle Bin) '${specific_path}'"
elif [[ "$dir_choice" == "Cancel" ]]; then
echo "Restore cancelled."
return 0
echo "Restore cancelled."; return 0
else
item_for_display="the entire directory '${dir_choice}'"
while true; do
printf "\n${C_YELLOW}Restore the entire directory or a specific file/subfolder? [entire/specific]: ${C_RESET}"
read -r choice
printf "\n${C_YELLOW}Restore the entire directory or a specific file/subfolder? [entire/specific]: ${C_RESET}"; read -r choice
case "$choice" in
entire)
is_full_directory_restore=true
break
;;
entire) is_full_directory_restore=true; break ;;
specific)
local specific_path_prompt
printf -v specific_path_prompt "Enter the path relative to '%s' to restore: " "$dir_choice"
printf "${C_YELLOW}%s${C_RESET}" "$specific_path_prompt"
read -er specific_path
printf -v specific_path_prompt "Enter the path relative to '%s' to restore: " "$dir_choice"; printf "${C_YELLOW}%s${C_RESET}" "$specific_path_prompt"; read -er specific_path
specific_path=$(echo "$specific_path" | sed 's#^/##')
if [[ -n "$specific_path" ]]; then
restore_path="$specific_path"
item_for_display="'$restore_path' from '${dir_choice}'"
break
restore_path="$specific_path"; item_for_display="'$restore_path' from '${dir_choice}'"; break
else
echo "Path cannot be empty. Please try again or choose 'entire'."
fi
;;
fi ;;
*) echo "Invalid choice. Please answer 'entire' or 'specific'." ;;
esac
done
local relative_path="${dir_choice#*./}"
full_remote_source="${REMOTE_TARGET}${relative_path}${restore_path}"
local remote_base="${REMOTE_TARGET%/}"
full_remote_source="${remote_base}/${relative_path#/}"
if [[ -n "$restore_path" ]]; then
full_remote_source="${full_remote_source%/}/${restore_path#/}"
fi
if [[ -n "$restore_path" ]]; then
default_local_dest=$(echo "${dir_choice}${restore_path}" | sed 's#/\./#/#')
else
default_local_dest=$(echo "$dir_choice" | sed 's#/\./#/#')
fi
fi
local final_dest
printf "\n${C_YELLOW}Enter the destination path.\n${C_DIM}Press [Enter] to use the original location (%s):${C_RESET} " "$default_local_dest"
read -r final_dest
local final_dest
printf "\n%s\n" "${C_BOLD}--------------------------------------------------------"
printf "%s\n" " Restore Destination"
printf "%s\n" "--------------------------------------------------------${C_RESET}"
printf "%s\n\n" "Enter the absolute destination path for the restore."
printf "%s\n" "${C_YELLOW}Default (original location):${C_RESET}"
printf "${C_CYAN}%s${C_RESET}\n\n" "$default_local_dest"
printf "%s\n" "Press [Enter] to use the default path, or enter a new one."
read -rp "> " final_dest
: "${final_dest:=$default_local_dest}"
local path_validation_attempts=0
local max_attempts=5
while true; do
((path_validation_attempts++))
if (( path_validation_attempts > max_attempts )); then
printf "\n${C_RED}❌ Too many invalid attempts. Exiting restore mode.${C_RESET}\n"; return 1
fi
if [[ "$final_dest" != "/" ]]; then final_dest="${final_dest%/}"; fi
local parent_dir; parent_dir=$(dirname -- "$final_dest")
if [[ "$final_dest" != /* ]]; then
printf "\n${C_RED}❌ Error: Please provide an absolute path (starting with '/').${C_RESET}\n"
elif [[ -e "$final_dest" && ! -d "$final_dest" ]]; then
printf "\n${C_RED}❌ Error: The destination '%s' exists but is a file. Please choose a different path.${C_RESET}\n" "$final_dest"
elif [[ -e "$parent_dir" && ! -w "$parent_dir" ]]; then
printf "\n${C_RED}❌ Error: The parent directory '%s' exists but is not writable.${C_RESET}\n" "$parent_dir"
elif [[ -d "$final_dest" ]]; then
printf "${C_GREEN}✅ Destination '%s' exists and is accessible.${C_RESET}\n" "$final_dest"
if [[ "$final_dest" != "$default_local_dest" && -z "$restore_path" ]]; then
local warning_msg="⚠️ WARNING: Custom destination directory already exists. Files may be overwritten."
printf "${C_YELLOW}%s${C_RESET}\n" "$warning_msg"; log_message "$warning_msg"
fi
break
else
printf "\n${C_YELLOW}⚠️ The destination '%s' does not exist.${C_RESET}\n" "$final_dest"
printf "${C_YELLOW}Choose an action:${C_RESET}\n"
PS3="Your choice: "
select action in "Create the destination path" "Enter a different path" "Cancel"; do
case "$action" in
"Create the destination path")
if mkdir -p "$final_dest"; then
printf "${C_GREEN}✅ Successfully created directory '%s'.${C_RESET}\n" "$final_dest"
if [[ "${is_full_directory_restore:-false}" == "true" ]]; then
chmod 700 "$final_dest"; log_message "Set permissions to 700 on newly created restore directory: $final_dest"
else
chmod 755 "$final_dest"
fi
break 2
else
printf "\n${C_RED}❌ Failed to create directory '%s'. Check permissions.${C_RESET}\n" "$final_dest"; break
fi ;;
"Enter a different path")
break ;;
"Cancel")
echo "Restore cancelled by user."; return 0 ;;
*) echo "Invalid option. Please try again." ;;
esac
done
PS3="#? "
fi
if (( path_validation_attempts < max_attempts )); then
printf "\n${C_YELLOW}Please enter a new destination path: ${C_RESET}"; read -r final_dest
if [[ -z "$final_dest" ]]; then
final_dest="$default_local_dest"; printf "${C_DIM}Empty input, using default location: %s${C_RESET}\n" "$final_dest"
fi
fi
done
local extra_rsync_opts=()
local dest_user=""
if [[ "$final_dest" == /home/* ]]; then
dest_user=$(echo "$final_dest" | cut -d/ -f3)
if [[ -n "$dest_user" ]] && id -u "$dest_user" &>/dev/null; then
printf "${C_CYAN}ℹ️ Home directory detected. Restored files will be owned by '${dest_user}'.${C_RESET}\n"
extra_rsync_opts+=("--chown=${dest_user}:${dest_user}")
chown "${dest_user}:${dest_user}" "$final_dest" 2>/dev/null || true
else
dest_user=""
fi
fi
local dest_created=false
if [[ ! -e "$final_dest" ]]; then
dest_created=true
fi
local dest_parent
dest_parent=$(dirname "$final_dest")
if ! mkdir -p "$dest_parent"; then
echo "❌ FATAL: Could not create parent destination directory '$dest_parent'. Aborting." >&2
return 1
fi
if [[ -n "$dest_user" ]]; then
chown "${dest_user}:${dest_user}" "$dest_parent"
fi
if [[ "$final_dest" != "$default_local_dest" && -d "$final_dest" && -z "$restore_path" ]]; then
local warning_msg="⚠️ WARNING: The custom destination directory '$final_dest' already exists. Files may be overwritten."
echo "$warning_msg"; log_message "$warning_msg"
fi
if [[ "$dest_created" == "true" && "${is_full_directory_restore:-false}" == "true" ]]; then
chmod 700 "$final_dest"; log_message "Set permissions to 700 on newly created restore directory: $final_dest"
fi
printf "Restore destination is set to: ${C_BOLD}%s${C_RESET}\n" "$final_dest"
printf "\n${C_BOLD}${C_YELLOW}--- PERFORMING DRY RUN. NO FILES WILL BE CHANGED. ---${C_RESET}\n"
printf "\n${C_BOLD}Restore Summary:${C_RESET}\n"
printf " Source: %s\n" "$item_for_display"
printf " Destination: ${C_BOLD}%s${C_RESET}\n" "$final_dest"
printf "\n${C_BOLD}${C_YELLOW}--- PERFORMING DRY RUN (NO CHANGES MADE) ---${C_RESET}\n"
log_message "Starting restore dry-run of ${item_for_display} from ${full_remote_source} to ${final_dest}"
local rsync_restore_opts=(-avhi --progress --exclude-from="$EXCLUDE_FILE_TMP" -e "$SSH_CMD")
if ! rsync "${rsync_restore_opts[@]}" "${extra_rsync_opts[@]}" --dry-run "$full_remote_source" "$final_dest"; then
echo "❌ DRY RUN FAILED. Rsync reported an error. Aborting." >&2; return 1
if ! "$RSYNC_CMD" "${rsync_restore_opts[@]}" "${extra_rsync_opts[@]}" --dry-run "$full_remote_source" "$final_dest"; then
printf "${C_RED}❌ DRY RUN FAILED. Rsync reported an error. Check connectivity and permissions.${C_RESET}\n" >&2
log_message "Restore dry-run failed for ${item_for_display}"; return 1
fi
printf "${C_BOLD}${C_GREEN}--- DRY RUN COMPLETE ---${C_RESET}\n"
local confirmation
while true; do
printf "\n${C_YELLOW}Are you sure you want to proceed with restoring %s to '%s'? [yes/no]: ${C_RESET}" "$item_for_display" "$final_dest"
read -r confirmation

case "$confirmation" in
yes) break ;;
no) echo "Restore aborted by user." ; return 0 ;;
*) echo "Please answer yes or no." ;;
printf "\n${C_YELLOW}Proceed with restoring %s to '%s'? [yes/no]: ${C_RESET}" "$item_for_display" "$final_dest"; read -r confirmation
case "${confirmation,,}" in
yes|y) break ;;
no|n) echo "Restore cancelled by user."; return 0 ;;
*) echo "Please answer 'yes' or 'no'." ;;
esac
done
printf "\n${C_BOLD}--- PROCEEDING WITH RESTORE... ---${C_RESET}\n"
log_message "Starting REAL restore of ${item_for_display} from ${full_remote_source} to ${final_dest}"
if rsync "${rsync_restore_opts[@]}" "${extra_rsync_opts[@]}" "$full_remote_source" "$final_dest"; then
printf "\n${C_BOLD}--- EXECUTING RESTORE ---${C_RESET}\n"
log_message "Starting actual restore of ${item_for_display} from ${full_remote_source} to ${final_dest}"
if "$RSYNC_CMD" "${rsync_restore_opts[@]}" "${extra_rsync_opts[@]}" "$full_remote_source" "$final_dest"; then
log_message "Restore completed successfully."
printf "${C_GREEN}✅ Restore of %s to '%s' completed successfully.${C_RESET}\n" "$item_for_display" "$final_dest"
send_notification "Restore SUCCESS: ${HOSTNAME}" "white_check_mark" "${NTFY_PRIORITY_SUCCESS}" "success" "Successfully restored ${item_for_display} to ${final_dest}"
else
log_message "Restore FAILED with rsync exit code $?."
local rsync_exit_code=$?
log_message "Restore FAILED with rsync exit code ${rsync_exit_code}."
printf "${C_RED}❌ Restore FAILED. Check the rsync output and log for details.${C_RESET}\n"
send_notification "Restore FAILED: ${HOSTNAME}" "x" "${NTFY_PRIORITY_FAILURE}" "failure" "Restore of ${item_for_display} to ${final_dest} failed."
return 1
send_notification "Restore FAILED: ${HOSTNAME}" "x" "${NTFY_PRIORITY_FAILURE}" "failure" "Restore of ${item_for_display} to ${final_dest} failed (exit code: ${rsync_exit_code})"; return 1
fi
}
run_recycle_bin_cleanup() {
Expand Down
2 changes: 1 addition & 1 deletion backup.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# =================================================================
# Configuration for rsync Backup Script v0.32
# Configuration for rsync Backup Script v0.33
# =================================================================
# !! IMPORTANT !! Set file permissions to 600 (chmod 600 backup.conf)

Expand Down
Loading