scripts/get-fastladder-db.sh at master · id774/scripts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#!/bin/sh

########################################################################
# get-fastladder-db.sh: Retrieve Fastladder Database from Remote Server
#
#  Description:
#  This script retrieves the Fastladder database from a remote server
#  using `rsync`. It allows specifying a user and host as arguments.
#  - Ensures required commands are available before execution.
#  - Creates a backup of the existing database before overwriting.
#
#  Author: id774 (More info: http://id774.net)
#  Source Code: https://github.com/id774/scripts
#  License: The GPL version 3, or LGPL version 3 (Dual License).
#  Contact: idnanashi@gmail.com
#
#  Usage:
#  Retrieve the Fastladder database with default user and host:
#      ./get-fastladder-db.sh
#
#  Specify a user and host:
#      ./get-fastladder-db.sh <user> <host>
#
#  Requirements:
#  - Must be executed on Linux or macOS.
#  - Requires `rsync` installed.
#  - SSH access to the specified host is required.
#
#  Version History:
#  v1.3 2025-06-23
#       Unified usage output to display full script header and support common help/version options.
#  v1.2 2025-04-13
#       Unify log level formatting using [INFO], [WARN], and [ERROR] tags.
#  v1.1 2025-03-22
#       Unify usage information by extracting help text from header comments.
#  v1.0 2025-03-16
#       Added system validation, command checks, and backup handling.
#  v0.1 2016-04-09
#       Initial version.
#
########################################################################

# Display full script header information extracted from the top comment block
usage() {
    awk '
        BEGIN { in_header = 0 }
        /^#{10,}$/ { if (!in_header) { in_header = 1; next } else exit }
        in_header && /^# ?/ { print substr($0, 3) }
    ' "$0"
    exit 0
}

# Check if required commands are available and executable
check_commands() {
    for cmd in "$@"; do
        cmd_path=$(command -v "$cmd" 2>/dev/null)
        if [ -z "$cmd_path" ]; then
            echo "[ERROR] Command '$cmd' is not installed. Please install $cmd and try again." >&2
            exit 127
        elif [ ! -x "$cmd_path" ]; then
            echo "[ERROR] Command '$cmd' is not executable. Please check the permissions." >&2
            exit 126
        fi
    done
}

# Process arguments
check_arguments() {
    USER="${1:-debian}"
    HOST="${2:-harpuia}"
}

# Sync Fastladder database
sync_database() {
    SOURCE_DB_PATH="fastladder/db/new.db"
    TARGET_DB_PATH="$HOME/fastladder/db/fastladder.db"

    # Ensure target directory exists
    mkdir -p "$(dirname "$TARGET_DB_PATH")"

    # Backup existing database if it exists
    if [ -f "$TARGET_DB_PATH" ]; then
        BACKUP_DB_PATH="${TARGET_DB_PATH}.bak.$(date +%Y%m%d%H%M%S)"
        echo "[INFO] Backing up existing database to $BACKUP_DB_PATH."
        mv "$TARGET_DB_PATH" "$BACKUP_DB_PATH"
    fi

    echo "[INFO] Syncing Fastladder database from $USER@$HOST..."
    rsync -auvz "$USER@$HOST:~/$SOURCE_DB_PATH" "$TARGET_DB_PATH"

    if [ $? -eq 0 ]; then
        echo "[INFO] Fastladder database successfully retrieved."
    else
        echo "[ERROR] Failed to retrieve the database from $USER@$HOST." >&2
        exit 1
    fi
}

# Main entry point of the script
main() {
    case "$1" in
        -h|--help|-v|--version) usage ;;
    esac

    check_commands rsync mkdir mv
    check_arguments "$@"
    sync_database
    return 0
}

# Execute main function
main "$@"