vcs-backup.sh
author František Kučera <franta-hg@frantovo.cz>
Fri, 19 Apr 2019 23:26:08 +0200
branchv_0
changeset 6 308978165cc3
parent 5 5e5d4c937739
child 7 ca71e981bdb4
permissions -rwxr-xr-x
cron taks function skeletons
franta-hg@0
     1
#!/bin/bash
franta-hg@0
     2
franta-hg@0
     3
# VCS Backup
franta-hg@0
     4
# Copyright © 2019 František Kučera (Frantovo.cz, GlobalCode.info)
franta-hg@0
     5
#
franta-hg@0
     6
# This program is free software: you can redistribute it and/or modify
franta-hg@0
     7
# it under the terms of the GNU General Public License as published by
franta-hg@0
     8
# the Free Software Foundation, either version 3 of the License, or
franta-hg@0
     9
# (at your option) any later version.
franta-hg@0
    10
#
franta-hg@0
    11
# This program is distributed in the hope that it will be useful,
franta-hg@0
    12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@0
    13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@0
    14
# GNU General Public License for more details.
franta-hg@0
    15
#
franta-hg@0
    16
# You should have received a copy of the GNU General Public License
franta-hg@0
    17
# along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@0
    18
franta-hg@0
    19
franta-hg@0
    20
# Server-side configuration:
franta-hg@0
    21
VCS_BACKUP_DATA_DIR="/mnt/data";
franta-hg@0
    22
VCS_BACKUP_CURRENT_DIR="$VCS_BACKUP_DATA_DIR/current";
franta-hg@2
    23
VCS_BACKUP_PUBLIC_DIR="$VCS_BACKUP_DATA_DIR/public";
franta-hg@0
    24
VCS_BACKUP_CONFIG_DIR="$VCS_BACKUP_DATA_DIR/config";
franta-hg@0
    25
VCS_BACKUP_SNAPSHOT_DIR="$VCS_BACKUP_DATA_DIR/snapshot";
franta-hg@0
    26
VCS_BACKUP_SUBVOLUME_SOCKET="/run/vcs-backup-subvolume";
franta-hg@5
    27
VCS_BACKUP_CLONE_SOCKET="/run/vcs-backup-clone/socket";
franta-hg@3
    28
VCS_BACKUP_CLONE_CALLBACK_SOCKET="clone-callback";
franta-hg@0
    29
VCS_BACKUP_USER="vcs-backup";
franta-hg@0
    30
VCS_BACKUP_MANAGER="vcs-backup-manager";
franta-hg@0
    31
franta-hg@0
    32
# Installation – check and do it by hand:
franta-hg@0
    33
# There should be already mounted Btrfs at $VCS_BACKUP_DATA_DIR
franta-hg@0
    34
installInstructions() {
franta-hg@0
    35
cp vcs-backup.sh /usr/local/bin/
franta-hg@0
    36
adduser --disabled-password "$VCS_BACKUP"
franta-hg@0
    37
adduser --disabled-password "$VCS_BACKUP_MANAGER"
franta-hg@0
    38
franta-hg@0
    39
mkdir "$VCS_BACKUP_CURRENT_DIR";
franta-hg@0
    40
mkdir "$VCS_BACKUP_CONFIG_DIR";
franta-hg@0
    41
mkdir "$VCS_BACKUP_SNAPSHOT_DIR";
franta-hg@5
    42
mkdir "$(dirname VCS_BACKUP_CLONE_SOCKET)"
franta-hg@0
    43
franta-hg@5
    44
chown "${VCS_BACKUP_USER}:${VCS_BACKUP_USER}" "$(dirname VCS_BACKUP_CLONE_SOCKET)"
franta-hg@0
    45
chown "${VCS_BACKUP_USER}:${VCS_BACKUP_USER}" "$VCS_BACKUP_CURRENT_DIR"
franta-hg@0
    46
chown "${VCS_BACKUP_MANAGER}:${VCS_BACKUP_MANAGER}" "$VCS_BACKUP_CONFIG_DIR"
franta-hg@0
    47
}
franta-hg@0
    48
franta-hg@0
    49
franta-hg@0
    50
# --- Private functions: ---------------------------------------------------------------------------
franta-hg@0
    51
franta-hg@0
    52
# Environment: all
franta-hg@0
    53
# $1 = VCS type: hg, git
franta-hg@0
    54
# $2 = URL
franta-hg@0
    55
isValidTypeAndURL() { ([[ "$1" == "hg" || "$1" == "git" ]]) && [[ $(echo "$2" | wc -l) == 1 ]] && [[ $(echo "$2" | grep -E '^(http|https|ssh)://([a-zA-Z0-9_-][a-zA-Z0-9_-.]*/?)+$' | wc -l) == 1 ]]; }
franta-hg@0
    56
franta-hg@0
    57
# Environment: all
franta-hg@0
    58
# $1 = path to the config file
franta-hg@5
    59
loadConfigFile() { if [ -f "$1" ]; then . "$1"; fi }
franta-hg@0
    60
franta-hg@0
    61
# Environment: server
franta-hg@0
    62
# $1 = URL
franta-hg@0
    63
urlToRelativeDirectoryPath() {
franta-hg@0
    64
	echo "$1" | sed -E 's@^[^:]+://@@g';
franta-hg@0
    65
}
franta-hg@0
    66
franta-hg@0
    67
# --- Public interface functions: ------------------------------------------------------------------
franta-hg@0
    68
franta-hg@0
    69
# Environment: client
franta-hg@0
    70
# $1 = VCS type: hg, git
franta-hg@0
    71
# $2 = URL
franta-hg@2
    72
# $3 = "public" or "private" (default), whether the repository should be available through the public web interface
franta-hg@0
    73
vcs_backup_public_clientSubmitBackupRequest() {
franta-hg@0
    74
	if isValidTypeAndURL "$1" "$2"; then
franta-hg@0
    75
		loadConfigFile ~/.config/vcs-backup/client.cfg
franta-hg@3
    76
		${VCS_BACKUP_SSH_COMMAND[@]} vcs-backup.sh serverSubmitBackupRequest "$1" "$2" "$3" "$4"
franta-hg@3
    77
		if [[ "$4" == "clone" ]]; then
franta-hg@3
    78
			if   [[ "$1" == "hg"  ]]; then  hg clone "ssh://${VCS_BACKUP_SERVER}//mnt/data/current/$1/$(urlToRelativeDirectoryPath $2)";
franta-hg@3
    79
			elif [[ "$1" == "git" ]]; then git clone "ssh://${VCS_BACKUP_SERVER}//mnt/data/current/$1/$(urlToRelativeDirectoryPath $2)";
franta-hg@3
    80
			fi
franta-hg@3
    81
		fi
franta-hg@0
    82
	else
franta-hg@0
    83
		echo "Unsupported VCS type: '$1' or URL: '$2'" >&2;
franta-hg@0
    84
	fi
franta-hg@0
    85
}
franta-hg@0
    86
franta-hg@0
    87
# Environment: server
franta-hg@5
    88
# User: $VCS_BACKUP_MANAGER
franta-hg@2
    89
# has same parameters as clientSubmitBackupRequest (see above)
franta-hg@0
    90
vcs_backup_public_serverSubmitBackupRequest() {
franta-hg@0
    91
	if isValidTypeAndURL "$1" "$2"; then
franta-hg@0
    92
		loadConfigFile "/etc/vcs-backup/server.cfg";
franta-hg@0
    93
		relativePath=$1/$(urlToRelativeDirectoryPath "$2");
franta-hg@0
    94
		absolutePath="$VCS_BACKUP_CONFIG_DIR/$relativePath";
franta-hg@0
    95
		mkdir -p "$absolutePath";
franta-hg@0
    96
		echo "$2" > "$absolutePath/url.txt"
franta-hg@0
    97
		echo "submited" > "$absolutePath/state.txt"
franta-hg@0
    98
		setfacl -m u:${VCS_BACKUP_USER}:r  "$absolutePath/url.txt"
franta-hg@0
    99
		setfacl -m u:${VCS_BACKUP_USER}:rw "$absolutePath/state.txt"
franta-hg@0
   100
		echo "$relativePath" | socat -u - unix-send:${VCS_BACKUP_SUBVOLUME_SOCKET};
franta-hg@3
   101
franta-hg@2
   102
		if [[ "$3" == "public" ]]; then
franta-hg@2
   103
			cd "$VCS_BACKUP_PUBLIC_DIR";
franta-hg@2
   104
			mkdir -p "$(dirname $relativePath)";
franta-hg@2
   105
			ln -rs "../current/$relativePath" "$(dirname $relativePath)";
franta-hg@2
   106
		fi
franta-hg@3
   107
franta-hg@3
   108
		if [[ "$4" == "clone" ]]; then
franta-hg@3
   109
			socat -u "unix-recvfrom:$absolutePath/${VCS_BACKUP_CLONE_CALLBACK_SOCKET},mode=777" - | while read m; do # TODO: ,group=${VCS_BACKUP_USER} and no 777
franta-hg@3
   110
				echo "Message from the clone service: $m";
franta-hg@3
   111
			done;
franta-hg@3
   112
		fi
franta-hg@0
   113
	else
franta-hg@0
   114
		echo "Unsupported VCS type: '$1' or URL: '$2'" >&2;
franta-hg@0
   115
	fi
franta-hg@0
   116
}
franta-hg@0
   117
franta-hg@0
   118
# Environment: server
franta-hg@5
   119
# User: root
franta-hg@0
   120
# Should be started as a systemd/init service.
franta-hg@0
   121
# - reads messages from from the subvolume socket – message contains the relative directory path
franta-hg@0
   122
# - creates a subvolume for given repository + necesary parent directories
franta-hg@0
   123
# - sends a message to the clone service → start cloning into the created subvolume
franta-hg@0
   124
vcs_backup_public_serverStartSubvolumeService() {
franta-hg@0
   125
	socat -u "unix-recv:${VCS_BACKUP_SUBVOLUME_SOCKET},group=${VCS_BACKUP_MANAGER},mode=770" - | while read d; do
franta-hg@0
   126
		mkdir -p $(dirname "$VCS_BACKUP_CURRENT_DIR/$d");
franta-hg@0
   127
		btrfs subvolume create "$VCS_BACKUP_CURRENT_DIR/$d" && \
franta-hg@0
   128
		echo "subvolumeCreated" > "$VCS_BACKUP_CONFIG_DIR/$d/state.txt" && \
franta-hg@0
   129
		chown "${VCS_BACKUP_USER}:${VCS_BACKUP_USER}" "$VCS_BACKUP_CURRENT_DIR/$d" && \
franta-hg@0
   130
		echo "$d" | socat -u - unix-send:${VCS_BACKUP_CLONE_SOCKET};
franta-hg@0
   131
	done
franta-hg@0
   132
}
franta-hg@0
   133
franta-hg@0
   134
# Environment: server
franta-hg@5
   135
# User: $VCS_BACKUP_USER
franta-hg@0
   136
# should be started as a systemd/init service
franta-hg@0
   137
vcs_backup_public_serverStartCloneService() {
franta-hg@0
   138
	socat -u "unix-recv:${VCS_BACKUP_CLONE_SOCKET},mode=700" - | while read d; do
franta-hg@2
   139
		vcsType=$(echo "$d" | sed 's@/.*@@g');
franta-hg@0
   140
		url=$(cat "$VCS_BACKUP_CONFIG_DIR/$d/url.txt");
franta-hg@3
   141
franta-hg@0
   142
		if isValidTypeAndURL "$vcsType" "$url"; then
franta-hg@0
   143
			if   [[ "$vcsType" == "hg"  ]]; then  hg clone -U     "$url" "$VCS_BACKUP_CURRENT_DIR/$d";
franta-hg@0
   144
			elif [[ "$vcsType" == "git" ]]; then git clone --bare "$url" "$VCS_BACKUP_CURRENT_DIR/$d";
franta-hg@0
   145
			fi && echo "cloned" > "$VCS_BACKUP_CONFIG_DIR/$d/state.txt";
franta-hg@0
   146
		else
franta-hg@0
   147
			echo "Unsupported VCS type: '$vcsType' or URL: '$url'" >&2;
franta-hg@0
   148
		fi
franta-hg@3
   149
franta-hg@3
   150
		callBackSocket="$VCS_BACKUP_CONFIG_DIR/$d/$VCS_BACKUP_CLONE_CALLBACK_SOCKET";
franta-hg@3
   151
		if [[ -e "$callBackSocket" ]]; then
franta-hg@3
   152
			echo "done" | socat -u - unix-send:"$callBackSocket";
franta-hg@3
   153
		fi
franta-hg@0
   154
	done
franta-hg@0
   155
}
franta-hg@0
   156
franta-hg@6
   157
# Environment: server
franta-hg@6
   158
# User: $VCS_BACKUP_USER
franta-hg@6
   159
# should be called from cron (usually every day)
franta-hg@6
   160
vcs_backup_public_serverPullCronTask() {
franta-hg@6
   161
	return;
franta-hg@6
   162
}
franta-hg@6
   163
franta-hg@6
   164
# Environment: server
franta-hg@6
   165
# User: $VCS_BACKUP_USER
franta-hg@6
   166
# should be called from cron (usually every day) after Pull (see above)
franta-hg@6
   167
vcs_backup_public_serverSnapshotCronTask() {
franta-hg@6
   168
	return;
franta-hg@6
   169
}
franta-hg@6
   170
franta-hg@0
   171
# --- Single entry-point: --------------------------------------------------------------------------
franta-hg@0
   172
franta-hg@0
   173
PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin";
franta-hg@0
   174
PUBLIC_FUNCTION_PREFIX="vcs_backup_public_";
franta-hg@0
   175
if type -t "$PUBLIC_FUNCTION_PREFIX$1" > /dev/null; then
franta-hg@0
   176
	"$PUBLIC_FUNCTION_PREFIX${@:1}";
franta-hg@4
   177
elif [[ $(basename $0) == "vcs-backup-clone-private-hg"  ]]; then "${PUBLIC_FUNCTION_PREFIX}clientSubmitBackupRequest" hg  "$1" private clone;
franta-hg@4
   178
elif [[ $(basename $0) == "vcs-backup-clone-private-git" ]]; then "${PUBLIC_FUNCTION_PREFIX}clientSubmitBackupRequest" git "$1" private clone;
franta-hg@4
   179
elif [[ $(basename $0) == "vcs-backup-clone-public-hg"   ]]; then "${PUBLIC_FUNCTION_PREFIX}clientSubmitBackupRequest" hg  "$1" public  clone;
franta-hg@4
   180
elif [[ $(basename $0) == "vcs-backup-clone-public-git"  ]]; then "${PUBLIC_FUNCTION_PREFIX}clientSubmitBackupRequest" git "$1" public  clone;
franta-hg@0
   181
else
franta-hg@0
   182
	echo "Unsupported sub-command: $1" >&2
franta-hg@0
   183
	echo "Available sub-commands:" >&2
franta-hg@0
   184
	declare -F | grep "$PUBLIC_FUNCTION_PREFIX" | sed "s/.*$PUBLIC_FUNCTION_PREFIX/  /g" >&2
franta-hg@0
   185
	exit 1;
franta-hg@0
   186
fi