Repository navigation
Expand file tree
/
Copy pathwp-backup.sh
More file actions
executable file
·710 lines (612 loc) · 24 KB
/
Copy pathwp-backup.sh
File metadata and controls
executable file
·710 lines (612 loc) · 24 KB
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
#!/usr/bin/env bash
# =============================================================================
# wp-backup — WordPress Backup & Restore
# =============================================================================
#
# A site-agnostic interactive backup utility. Drop it into any WordPress site
# user's ~/.local/bin/ directory and run it as: wp-backup
#
# INSTALL (run as wpnadmin or root, replacing <domain> with the site domain)
# -------------------------------------------------------------------------
# SITE_USER=$(getent passwd | awk -F: '$6=="/sites/<domain>" {print $1}')
# sudo mkdir -p /sites/<domain>/.local/bin
# sudo cp wp-backup.sh /sites/<domain>/.local/bin/wp-backup
# sudo chmod +x /sites/<domain>/.local/bin/wp-backup
# sudo chown ${SITE_USER}:${SITE_USER} /sites/<domain>/.local/bin/wp-backup
#
# Then the site user can simply run: wp-backup
#
# AUTO-DETECTED AT RUNTIME (no hardcoded values)
# -----------------------------------------------
# DOMAIN basename of $HOME (e.g. example.co.nz)
# WP_ROOT from $HOME/wp-cli.yml path: (primary)
# or probed via wp-load.php (fallback)
# BACKUP_DIR $HOME/backup (created if missing)
# DB creds read from wp-config.php by wp-cli — never stored in this script
#
# WP_ROOT DETECTION ORDER
# -----------------------
# 1. path: value in $HOME/wp-cli.yml → primary (wp-cli.yml present) ✅
# 2. $HOME/files/public/wp-load.php exists → files/public webroot
# 3. $HOME/files/wp-load.php exists → files webroot
# 4. Abort with error
#
# REQUIREMENTS
# ------------
# wp-cli /usr/local/bin/wp (or wherever wp-cli is installed)
# tar, gzip, ionice, nice (standard on Ubuntu)
#
# =============================================================================
set -euo pipefail
# ── Colours ───────────────────────────────────────────────────────────────────
RED='\033[0;31m'; GREEN='\033[0;32m'; YELLOW='\033[1;33m'
CYAN='\033[0;36m'; BOLD='\033[1m'; RESET='\033[0m'; DIM='\033[2m'
# ── Helpers ───────────────────────────────────────────────────────────────────
separator() { echo -e "${CYAN}──────────────────────────────────────────────────${RESET}"; }
header() {
clear
separator
echo -e " ${BOLD}${CYAN}WordPress Backup & Restore — ${DOMAIN}${RESET}"
separator
echo
}
success() { echo -e " ${GREEN}✔ $*${RESET}"; }
warn() { echo -e " ${YELLOW}⚠ $*${RESET}"; }
error() { echo -e " ${RED}✖ $*${RESET}"; }
info() { echo -e " ${CYAN}ℹ $*${RESET}"; }
confirm() {
local prompt="$1"
local answer
while true; do
read -rp "$(echo -e " ${BOLD}${prompt}${RESET} [y/n] ")" answer
case "${answer,,}" in
y|yes) return 0 ;;
n|no) return 1 ;;
*) warn "Please answer y or n." ;;
esac
done
}
spinner() {
local pid=$1 msg=$2
local frames=('⠋' '⠙' '⠹' '⠸' '⠼' '⠴' '⠦' '⠧' '⠇' '⠏')
local i=0
while kill -0 "$pid" 2>/dev/null; do
printf "\r ${CYAN}%s${RESET} %s " "${frames[$((i % ${#frames[@]}))]}" "$msg"
sleep 0.1
(( i++ )) || true
done
printf "\r%-70s\r" " "
}
elapsed() {
local secs=$1
printf "%dm %02ds" $(( secs / 60 )) $(( secs % 60 ))
}
# ── Auto-detect WP_ROOT ───────────────────────────────────────────────────────
detect_wp_root() {
local yml="${HOME}/wp-cli.yml"
# Primary: read path: from wp-cli.yml
if [[ -f "$yml" ]]; then
local yml_path
yml_path=$(grep -E '^\s*path\s*:' "$yml" 2>/dev/null | head -1 | sed 's/.*path\s*:\s*//' | tr -d '"'"'" | xargs)
if [[ -n "$yml_path" ]]; then
# path may be relative (e.g. "files") or absolute
if [[ "$yml_path" = /* ]]; then
echo "$yml_path"
else
echo "${HOME}/${yml_path}"
fi
return 0
fi
fi
# Fallback: probe for wp-load.php
for candidate in "${HOME}/files/public" "${HOME}/files"; do
if [[ -f "${candidate}/wp-load.php" ]]; then
echo "$candidate"
return 0
fi
done
return 1
}
# ── Runtime config ────────────────────────────────────────────────────────────
DOMAIN=$(basename "$HOME")
BACKUP_DIR="${HOME}/backup"
RAND=$(openssl rand -hex 4)
STAMP=$(date +%Y%m%d_%H%M%S)
WP_BIN=$(command -v wp 2>/dev/null || echo "/usr/local/bin/wp")
WP_ROOT=$(detect_wp_root) || {
echo -e "\n ${RED}${BOLD}ERROR:${RESET} Could not locate WordPress installation."
echo -e " Checked: \$HOME/wp-cli.yml, \$HOME/files/public, \$HOME/files"
echo -e " Ensure wp-cli.yml has a valid 'path:' entry or wp-load.php is present.\n"
exit 1
}
FILES_DIR="${HOME}/files"
DB_OUT="${BACKUP_DIR}/db_${DOMAIN}_${STAMP}_${RAND}.sql.gz"
TAR_OUT="${BACKUP_DIR}/files_${DOMAIN}_${STAMP}_${RAND}.tar.gz"
# Directories to exclude from the files archive (built-in defaults).
# Paths are relative to $HOME (tar runs with -C "$HOME").
FILES_REL=$(basename "$FILES_DIR")
TAR_EXCLUDES=(
"${FILES_REL}/*/wp-content/cache"
"${FILES_REL}/*/wp-content/uploads/cache"
"${FILES_REL}/*/wp-content/upgrade"
"${FILES_REL}/*/wp-content/uploads/wc-logs"
"${FILES_REL}/wp-content/cache"
"${FILES_REL}/wp-content/uploads/cache"
"${FILES_REL}/wp-content/upgrade"
"${FILES_REL}/wp-content/uploads/wc-logs"
"${FILES_REL}/wp-content/debug.log"
)
# ── Load optional local config ────────────────────────────────────────────────
# Create $HOME/wp-backup.conf to add extra excludes, one path per line.
# Paths are relative to $HOME (e.g. files/wp-content/uploads/videos).
# Lines starting with # and blank lines are ignored.
CONF_FILE="${HOME}/wp-backup.conf"
CONF_EXCLUDES=()
if [[ -f "$CONF_FILE" ]]; then
while IFS= read -r line || [[ -n "$line" ]]; do
# Strip leading/trailing whitespace
line="${line#"${line%%[![:space:]]*}"}"
line="${line%"${line##*[![:space:]]}"}"
# Skip blank lines and comments
[[ -z "$line" || "$line" == \#* ]] && continue
# Resolve relative to $HOME; strip any leading slash or $HOME prefix the user may have typed
line="${line#/}"
line="${line#${HOME}/}"
# Strip trailing slash — tar exclude patterns must not have one
line="${line%/}"
CONF_EXCLUDES+=("${line}")
done < "$CONF_FILE"
fi
# Merge conf excludes into main array
TAR_EXCLUDES+=("${CONF_EXCLUDES[@]+"${CONF_EXCLUDES[@]}"}")
# ── Backup: Database ──────────────────────────────────────────────────────────
backup_db() {
separator
echo -e "\n ${BOLD}Database backup${RESET}\n"
info "WP root: ${WP_ROOT}"
info "Output: ${DB_OUT}"
echo
mkdir -p "$BACKUP_DIR"
[[ -f "$DB_OUT" ]] && { warn "Removing existing ${DB_OUT}"; rm -f "$DB_OUT"; }
local T_START
T_START=$(date +%s)
(
nice -n 10 ionice -c 3 \
"$WP_BIN" db export - --path="$WP_ROOT" --quiet \
| gzip > "$DB_OUT"
) &
local BG_PID=$!
spinner "$BG_PID" "Exporting & compressing database …"
if wait "$BG_PID"; then
local T_END SIZE
T_END=$(date +%s)
SIZE=$(du -sh "$DB_OUT" 2>/dev/null | cut -f1)
success "Database backup complete ($(elapsed $(( T_END - T_START ))), ${SIZE})"
info "Saved to: ${DB_OUT}"
else
error "Database backup FAILED"
return 1
fi
echo
}
# ── Backup: Files ─────────────────────────────────────────────────────────────
backup_files() {
separator
echo -e "\n ${BOLD}Files backup${RESET}\n"
info "Source: ${FILES_DIR}"
info "Output: ${TAR_OUT}"
echo -e " ${CYAN}Excluding (built-in):${RESET} wp-content/cache, uploads/cache, upgrade, wc-logs, debug.log"
if [[ ${#CONF_EXCLUDES[@]} -gt 0 ]]; then
echo -e " ${CYAN}Excluding (wp-backup.conf):${RESET}"
for ex in "${CONF_EXCLUDES[@]}"; do
echo -e " • ${ex}"
done
fi
echo
mkdir -p "$BACKUP_DIR"
[[ -f "$TAR_OUT" ]] && { warn "Removing existing ${TAR_OUT}"; rm -f "$TAR_OUT"; }
local EXCLUDE_ARGS=()
for ex in "${TAR_EXCLUDES[@]}"; do
EXCLUDE_ARGS+=("--exclude=${ex}")
done
local T_START
T_START=$(date +%s)
(
nice -n 5 ionice -c 2 -n 5 \
tar -czf "$TAR_OUT" \
-C "$HOME" \
--warning=no-file-changed \
"${EXCLUDE_ARGS[@]}" \
"$FILES_REL"
) &
local BG_PID=$!
spinner "$BG_PID" "Archiving WordPress files …"
local TAR_EXIT=0
wait "$BG_PID" || TAR_EXIT=$?
local T_END SIZE
T_END=$(date +%s)
SIZE=$(du -sh "$TAR_OUT" 2>/dev/null | cut -f1)
if [[ $TAR_EXIT -eq 0 ]]; then
success "Files backup complete ($(elapsed $(( T_END - T_START ))), ${SIZE})"
info "Saved to: ${TAR_OUT}"
elif [[ $TAR_EXIT -eq 1 ]]; then
success "Files backup complete ($(elapsed $(( T_END - T_START ))), ${SIZE})"
info "Saved to: ${TAR_OUT}"
warn "Note: some files changed during backup (normal on a live site). Backup is OK."
warn "To avoid this, add exclusions to ~/wp-backup.conf."
else
error "Files backup FAILED (tar exit code ${TAR_EXIT})"
rm -f "$TAR_OUT"
return 1
fi
echo
}
# ── Restore: Database ─────────────────────────────────────────────────────────
restore_db() {
separator
echo -e "\n ${BOLD}Restore Database${RESET}\n"
# List available DB backups
local -a backups
while IFS= read -r -d '' f; do
backups+=("$f")
done < <(find "$BACKUP_DIR" -maxdepth 1 -name "db_*.sql.gz" -print0 2>/dev/null | sort -z -r)
if [[ ${#backups[@]} -eq 0 ]]; then
warn "No database backups found in ${BACKUP_DIR}"
return 1
fi
echo -e " ${BOLD}Available database backups:${RESET}\n"
local i=1
for f in "${backups[@]}"; do
local size date_str
size=$(du -sh "$f" 2>/dev/null | cut -f1)
date_str=$(stat -c '%y' "$f" 2>/dev/null | cut -d'.' -f1)
printf " %2d) %-55s %6s %s\n" "$i" "$(basename "$f")" "$size" "$date_str"
(( i++ ))
done
echo
local choice
while true; do
read -rp "$(echo -e " ${BOLD}Select backup to restore [1-${#backups[@]}] or 0 to cancel:${RESET} ")" choice
if [[ "$choice" == "0" ]]; then
echo -e "\n Cancelled.\n"; return 0
fi
if [[ "$choice" =~ ^[0-9]+$ ]] && (( choice >= 1 && choice <= ${#backups[@]} )); then
break
fi
warn "Invalid choice — enter a number between 1 and ${#backups[@]}, or 0 to cancel."
done
local selected="${backups[$((choice-1))]}"
echo
warn "This will ${BOLD}overwrite the live database${RESET}${YELLOW} for ${DOMAIN}."
warn "Selected: $(basename "$selected")"
echo
if ! confirm "Are you sure you want to restore this backup?"; then
echo -e "\n Cancelled.\n"; return 0
fi
# ── Step 1: Safety backup of current database ────────────────────────────────
echo
separator
local ROLLBACK_STAMP ROLLBACK_OUT ERR_LOG BG_PID
ROLLBACK_STAMP=$(date +%Y%m%d_%H%M%S)
ROLLBACK_OUT="${BACKUP_DIR}/db_${DOMAIN}_${ROLLBACK_STAMP}_pre-restore.sql.gz"
ERR_LOG=$(mktemp /tmp/wp-backup.XXXXXX)
echo -e "\n ${BOLD}[1/3] Safety backup of current database${RESET}\n"
info "Saving rollback to: $(basename "$ROLLBACK_OUT")"
echo
mkdir -p "$BACKUP_DIR"
(
nice -n 10 ionice -c 3 \
"$WP_BIN" db export - --path="$WP_ROOT" --quiet \
| gzip > "$ROLLBACK_OUT"
) 2>"$ERR_LOG" &
BG_PID=$!
spinner "$BG_PID" "Backing up current database …"
if wait "$BG_PID"; then
local SIZE
SIZE=$(du -sh "$ROLLBACK_OUT" 2>/dev/null | cut -f1)
success "Safety backup created (${SIZE})"
else
error "Safety backup FAILED — aborting restore to protect your data."
[[ -s "$ERR_LOG" ]] && cat "$ERR_LOG" | sed 's/^/ /'
rm -f "$ERR_LOG" "$ROLLBACK_OUT"
return 1
fi
rm -f "$ERR_LOG"
echo
# ── Step 2: Import selected backup ───────────────────────────────────────────
separator
echo -e "\n ${BOLD}[2/3] Importing database …${RESET}\n"
local T_START
T_START=$(date +%s)
ERR_LOG=$(mktemp /tmp/wp-backup.XXXXXX)
(
nice -n 10 ionice -c 3 \
gunzip -c "$selected" | "$WP_BIN" db import - --path="$WP_ROOT" >/dev/null
) 2>"$ERR_LOG" &
BG_PID=$!
spinner "$BG_PID" "Importing database …"
local T_END
T_END=$(date +%s)
if ! wait "$BG_PID"; then
error "Database import FAILED ($(elapsed $(( T_END - T_START ))))"
echo
if [[ -s "$ERR_LOG" ]]; then
echo -e " ${RED}Error output:${RESET}"
cat "$ERR_LOG" | sed 's/^/ /'
echo
fi
rm -f "$ERR_LOG"
echo
warn "Your database may be in an inconsistent state."
echo -e " ${BOLD}Your rollback backup:${RESET}"
info "${ROLLBACK_OUT}"
echo -e " To restore manually:"
echo -e " ${CYAN}gunzip -c $(basename "$ROLLBACK_OUT") | wp db import - --path=${WP_ROOT}${RESET}"
echo
return 1
fi
rm -f "$ERR_LOG"
success "Database import complete ($(elapsed $(( T_END - T_START ))))"
echo
# ── Step 3: Flush cache and verify ───────────────────────────────────────────
separator
echo -e "\n ${BOLD}[3/3] Post-restore checks${RESET}\n"
if "$WP_BIN" cache flush --path="$WP_ROOT" --quiet 2>/dev/null; then
success "Object cache flushed"
else
warn "Cache flush skipped (no persistent object cache active)"
fi
local siteurl
if siteurl=$("$WP_BIN" option get siteurl --path="$WP_ROOT" 2>/dev/null); then
success "WordPress OK — siteurl: ${siteurl}"
else
warn "Could not verify WordPress after restore. Check the site in a browser."
warn "If broken, rollback is at: $(basename "$ROLLBACK_OUT")"
fi
echo
}
# ── Restore: Files ────────────────────────────────────────────────────────────
restore_files() {
separator
echo -e "\n ${BOLD}Restore Files${RESET}\n"
local -a backups
while IFS= read -r -d '' f; do
backups+=("$f")
done < <(find "$BACKUP_DIR" -maxdepth 1 -name "files_*.tar.gz" -print0 2>/dev/null | sort -z -r)
if [[ ${#backups[@]} -eq 0 ]]; then
warn "No file backups found in ${BACKUP_DIR}"
return 1
fi
echo -e " ${BOLD}Available file backups:${RESET}\n"
local i=1
for f in "${backups[@]}"; do
local size date_str
size=$(du -sh "$f" 2>/dev/null | cut -f1)
date_str=$(stat -c '%y' "$f" 2>/dev/null | cut -d'.' -f1)
printf " %2d) %-55s %6s %s\n" "$i" "$(basename "$f")" "$size" "$date_str"
(( i++ ))
done
echo
local choice
while true; do
read -rp "$(echo -e " ${BOLD}Select backup to restore [1-${#backups[@]}] or 0 to cancel:${RESET} ")" choice
if [[ "$choice" == "0" ]]; then
echo -e "\n Cancelled.\n"; return 0
fi
if [[ "$choice" =~ ^[0-9]+$ ]] && (( choice >= 1 && choice <= ${#backups[@]} )); then
break
fi
warn "Invalid choice — enter a number between 1 and ${#backups[@]}, or 0 to cancel."
done
local selected="${backups[$((choice-1))]}"
echo
warn "This will ${BOLD}overwrite files in ${FILES_DIR}${RESET}${YELLOW}."
warn "Selected: $(basename "$selected")"
echo
# ── Offer to safety-backup current files first ────────────────────────────
echo -e " ${BOLD}Recommended:${RESET} Back up current files before overwriting.\n"
if confirm "Create a safety backup of current files first?"; then
echo
# Snapshot filename distinct from the rotating TAR_OUT
local SNAP_STAMP SNAP_OUT
SNAP_STAMP=$(date +%Y%m%d_%H%M%S)
SNAP_OUT="${BACKUP_DIR}/files_${DOMAIN}_${SNAP_STAMP}_pre-restore.tar.gz"
local EXCLUDE_ARGS=()
for ex in "${TAR_EXCLUDES[@]}"; do
EXCLUDE_ARGS+=("--exclude=${ex}")
done
local ERR_LOG BG_PID
ERR_LOG=$(mktemp /tmp/wp-backup.XXXXXX)
mkdir -p "$BACKUP_DIR"
(
nice -n 5 ionice -c 2 -n 5 \
tar -czf "$SNAP_OUT" -C "$HOME" --warning=no-file-changed "${EXCLUDE_ARGS[@]}" "$FILES_REL"
) 2>"$ERR_LOG" &
BG_PID=$!
spinner "$BG_PID" "Archiving current files …"
local SNAP_EXIT=0
wait "$BG_PID" || SNAP_EXIT=$?
if [[ $SNAP_EXIT -le 1 ]]; then
local SIZE
SIZE=$(du -sh "$SNAP_OUT" 2>/dev/null | cut -f1)
success "Safety backup created (${SIZE})"
info "Saved to: $(basename "$SNAP_OUT")"
[[ $SNAP_EXIT -eq 1 ]] && warn "Note: some files changed during backup (normal on a live site). Backup is OK."
else
error "Safety backup FAILED (tar exit code ${SNAP_EXIT}) — aborting restore to protect your files."
[[ -s "$ERR_LOG" ]] && cat "$ERR_LOG" | sed 's/^/ /'
rm -f "$ERR_LOG"
return 1
fi
rm -f "$ERR_LOG"
echo
fi
if ! confirm "Proceed with files restore? This cannot be undone."; then
echo -e "\n Cancelled.\n"; return 0
fi
# ── Extract archive ───────────────────────────────────────────────────────
echo
separator
echo -e "\n ${BOLD}Extracting files …${RESET}\n"
local T_START ERR_LOG BG_PID
T_START=$(date +%s)
ERR_LOG=$(mktemp /tmp/wp-backup.XXXXXX)
(
nice -n 5 ionice -c 2 -n 5 \
tar -xzf "$selected" -C "$HOME"
) 2>"$ERR_LOG" &
BG_PID=$!
spinner "$BG_PID" "Extracting WordPress files …"
local T_END
T_END=$(date +%s)
local TAR_XEXIT=0
wait "$BG_PID" || TAR_XEXIT=$?
if [[ $TAR_XEXIT -gt 1 ]]; then
error "Files restore FAILED (tar exit code ${TAR_XEXIT}) ($(elapsed $(( T_END - T_START ))))"
if [[ -s "$ERR_LOG" ]]; then
echo -e " ${RED}Error output:${RESET}"
cat "$ERR_LOG" | sed 's/^/ /'
fi
rm -f "$ERR_LOG"
return 1
fi
rm -f "$ERR_LOG"
success "Files restore complete ($(elapsed $(( T_END - T_START ))))"
echo
# ── Flush cache ───────────────────────────────────────────────────────────
if "$WP_BIN" cache flush --path="$WP_ROOT" --quiet 2>/dev/null; then
success "Object cache flushed"
else
warn "Cache flush skipped (no persistent object cache active)"
fi
echo
}
# ── Create conf template ──────────────────────────────────────────────────────
create_conf() {
if [[ -f "$CONF_FILE" ]]; then
echo -e "\n ${YELLOW}⚠ ${CONF_FILE} already exists — not overwriting.${RESET}"
echo -e " Edit it directly to add or change exclusions.\n"
exit 0
fi
cat > "$CONF_FILE" << 'EOF'
# wp-backup.conf — Custom exclusions for wp-backup
# =================================================
# Paths to exclude from file backups, one per line.
# Paths are relative to your home directory — no leading or trailing slashes:
#
# files/wp-content/updraft <- correct
# files/wp-content/updraft/ <- trailing slash will be stripped automatically
#
# Lines starting with # and blank lines are ignored.
#
# ── Common exclusions (uncomment to enable) ───────────────────────────────────
# Updraft Plus backup storage (often large — it's already a backup)
# files/wp-content/updraft
# Large upload directories
# files/wp-content/uploads/videos
# files/wp-content/uploads/woocommerce_uploads
# Old yearly upload directories
# files/wp-content/uploads/2020
# files/wp-content/uploads/2021
EOF
echo -e "\n ${GREEN}✔ Created ${CONF_FILE}${RESET}"
echo -e " Edit it to uncomment or add paths to exclude from file backups.\n"
}
show_help() {
echo -e "
${BOLD}${CYAN}wp-backup${RESET} — WordPress Backup & Restore
Run ${CYAN}wp-backup${RESET} to launch the interactive menu.
${BOLD}MENU OPTIONS${RESET}
1 DB backup Exports and compresses the database to ~/backup/
2 Files backup Archives your WordPress files to ~/backup/
3 DB + Files Full backup — both of the above (recommended)
4 Restore DB Choose a DB backup to restore; current DB is automatically
saved as a rollback snapshot first
5 Restore Files Choose a files backup to restore; optionally snapshot
current files before overwriting
6 Exit
${BOLD}BACKUPS ARE SAVED TO${RESET}
~/backup/db_<domain>_<date>.sql.gz
~/backup/files_<domain>_<date>.tar.gz
${BOLD}EXCLUDING PATHS FROM FILE BACKUPS${RESET}
The following are always excluded from file backups:
wp-content/cache, wp-content/uploads/cache,
wp-content/upgrade, wp-content/uploads/wc-logs,
wp-content/debug.log
To exclude additional paths, create ${CYAN}~/wp-backup.conf${RESET}:
${CYAN}wp-backup conf${RESET} Creates a template ~/wp-backup.conf with examples
Then edit the file and uncomment the paths you want to exclude.
Paths are relative to your home directory, no leading or trailing slashes:
files/wp-content/updraft
files/wp-content/uploads/videos
Lines starting with # are treated as comments.
${BOLD}QUITTING${RESET}
Enter ${BOLD}0${RESET} or ${BOLD}q${RESET} at any prompt to cancel and exit.
"
}
# ── Main menu ─────────────────────────────────────────────────────────────────
main() {
header
echo -e " ${BOLD}Site:${RESET} ${DOMAIN}"
echo -e " ${BOLD}WP root:${RESET} ${WP_ROOT}"
echo -e " ${BOLD}Backups:${RESET} ${BACKUP_DIR}"
echo
echo -e " ${BOLD}Files backup will exclude:${RESET}"
echo -e " ${DIM}(built-in)${RESET} wp-content/cache, uploads/cache, upgrade, wc-logs, debug.log"
if [[ ${#CONF_EXCLUDES[@]} -gt 0 ]]; then
for ex in "${CONF_EXCLUDES[@]}"; do
echo -e " ${DIM}(wp-backup.conf)${RESET} ${ex}"
done
fi
echo
separator
echo -e "\n ${BOLD}What would you like to do?${RESET}\n"
echo -e " 1) DB backup only"
echo -e " 2) Files backup only"
echo -e " 3) DB + Files backup ${YELLOW}(recommended)${RESET}"
echo -e " 4) Restore DB"
echo -e " 5) Restore Files"
echo -e " 6) Exit"
echo -e " ${DIM}Tip: enter 0 or q to quit at any prompt${RESET}"
echo
local choice
while true; do
read -rp "$(echo -e " ${BOLD}Enter choice [1-6]:${RESET} ")" choice
case "$choice" in
1|2|3|4|5|6) break ;;
0|q|Q) echo -e "\n Goodbye.\n"; exit 0 ;;
*) warn "Invalid choice — please enter 1-6." ;;
esac
done
echo
local OVERALL_START EXIT_CODE
OVERALL_START=$(date +%s)
EXIT_CODE=0
case "$choice" in
1) backup_db || EXIT_CODE=1 ;;
2) backup_files || EXIT_CODE=1 ;;
3) backup_db || EXIT_CODE=1
backup_files || EXIT_CODE=1 ;;
4) restore_db || EXIT_CODE=1 ;;
5) restore_files || EXIT_CODE=1 ;;
6) echo -e " Goodbye.\n"; exit 0 ;;
esac
separator
local OVERALL_END
OVERALL_END=$(date +%s)
echo
if (( EXIT_CODE == 0 )); then
echo -e " ${GREEN}${BOLD}Done!${RESET} Total time: $(elapsed $(( OVERALL_END - OVERALL_START )))"
else
echo -e " ${RED}${BOLD}One or more operations failed — check output above.${RESET}"
fi
echo
separator
echo
exit "$EXIT_CODE"
}
case "${1:-}" in
-h|--help|help) show_help; exit 0 ;;
conf) create_conf; exit 0 ;;
esac
main