使用 backupninja 為 Debian 定制備份計劃

backupninja是Debian系統（以及基於Debian的發行版）中一個強大的、高度可配置的備份軟件。在前一篇文章中，我們探討了如何安裝backupninja以及如何設置兩個備份操作並執行。然而，那些只是冰山一角。這一次，我們要討論如何定制 Handler 和 Helper ，使用這些功能定制策略以完成任何備份需要。

回顧 backupninja

backupninja的一個獨特的地方是它可以完全拋棄/etc/backup.d中的純文本配置文件和操作文件，軟件自己會搞定。另外，我們可以編寫自定義腳本（又叫 “handler”）放在/usr/share/backupninja 目錄下來完成不同類型的備份操作。此外，可以通過ninjahelper的基於ncurses的交互式菜單（又叫“helper”）來指導我們創建一些配置文件，使得人工錯誤降到最低。

創建定制的Handler與Helper

這一節的目標是創建一個腳本，將home目錄以gzip或bzip2壓縮包的形式備份起來，不包括音樂與視頻文件。我們將這個文件命名為home，將它放在/usr/backup/ninja目錄下。

盡管你可以使用默認的tar handler（參考 /usr/share/backupninja/tar 與 /usr/share/backupninja/tar.helper）來達到這個效果，但是我們使用這種方法來展示如何創建實用的 handler 腳本與基於 ncurses 的 helper。你可以根據你的需求來決定如何運用這裡的方法。

由於 handlers 來源於主腳本，所以無需以#!/bin/bash開始的釋伴行（shebang line）。

我們編寫的 handler （/usr/share/backupninja/home）如下所示。已經詳細注釋了。getconf 函數用來讀取備份操作的配置文件。如果你指定了一個變量的值，那麼它會覆蓋配置文件中對應變量的值：

1. #/home 目錄 handler 腳本
2. # 每個備份文件會通過 FQDN 來鑒別主機
3. getconf backupname
4. # 備份文件的保存目錄
5. getconf backupdir
6. # 默認壓縮
7. getconf compress
8. # 包含 /home 目錄
9. getconf includes
10. #不包含 *.mp3 與 *.mp4 文件
11. getconf excludes
12. # 要打包備份文件的默認擴展名
13. getconf EXTENSION
14. # tar 程序的絕對路徑
15. getconf TAR `which tar`
16. # date 程序的絕對路徑
17. getconf DATE `which date`
18. # 日期格式
19. DATEFORMAT="%Y-%m-%d"
20. # 如果備份目錄不存在，以致命錯誤退出
21. if[!-d "$backupdir"]
22. then
23. mkdir -p "$backupdir"|| fatal "Can not make directory $backupdir"
24. fi
25. # 如果備份目錄不可寫，同樣以致命錯誤退出
26. if[!-w "$backupdir"]
27. then
28. fatal "Directory $backupdir is not writable"
29. fi
30. # 根據壓縮格式選擇對應的tar選項
31. case $compress in
32. "gzip")
33. compress_option="-z"
34. EXTENSION="tar.gz"
35. ;;
36. "bzip")
37. compress_option="-j"
38. EXTENSION="tar.bz2"
39. ;;
40. "none")
41. compress_option=""
42. ;;
43. *)
44. warning "Unknown compress filter ($tar_compress)"
45. compress_option=""
46. EXTENSION="tar.gz"
47. ;;
48. esac
49. # 不包含一些文件類型/目錄
50. exclude_options=""
51. for i in $excludes
52. do
53. exclude_options="$exclude_options --exclude $i"
54. done
55. # 調試信息，執行備份操作
56. debug "Running backup: " $TAR -c -p -v $compress_option $exclude_options \
57. -f "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`".$EXTENSION" \
58. $includes
59. # 將標准輸出重定向到以.list為擴展的文件
60. # 將標准錯誤輸出重定向到以.err為擴展的文件
61. $TAR -c -p -v $compress_option $exclude_options \
62. -f "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`".$EXTENSION" \
63. $includes \
64. >"$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`.list \
65. 2>"$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`.err
66. [ $?-ne 0]&& fatal "Tar backup failed"

接下來我們將要創建helper文件（/usr/share/backupninja/home.helper）。這樣，hendlers將會以菜單的形式在ninjahelper中顯示：

1. # 備份操作描述，以下劃線分割單詞
2. HELPERS="$HELPERS home:backup_of_home_directories"
3. home_wizard(){
4. home_title="Home action wizard"
5. backupname=`hostname --fqdn`
6. # 指定備份操作的時間
7. inputBox "$home_title""When to run this action?""everyday at 01"
8. [ $?=1]&&return
9. home_when_run="when = $REPLY"
10. # 指定備份文件名
11. inputBox "$home_title""\"Name\" of backups""$backupname"
12. [ $?=1]&&return
13. home_backupname="backupname = $REPLY"
14. backupname="$REPLY"
15. # 指定保存備份文件的默認路徑
16. inputBox "$home_title""Directory where to store the backups""/var/backups/home"
17. [ $?=1]&&return
18. home_backupdir="backupdir = $REPLY"
19. # 指定復選框的默認值
20. radioBox "$home_title""Compression" \
21. "none""No compression" off \
22. "gzip""Compress with gzip" on \
23. "bzip""Compress with bzip" off
24. [ $?=1]&&return;
25. result="$REPLY"
26. home_compress="compress = $REPLY "
27. REPLY=
28. while[-z "$REPLY"];do
29. formBegin "$home_title: Includes"
30. formItem "Include:"/home/gacanepa
31. formDisplay
32. [ $?=0]||return1
33. home_includes="includes = "
34. for i in $REPLY;do
35. [-n "$i"]&& home_includes="$home_includes $i"
36. done
37. done
38. REPLY=
39. while[-z "$REPLY"];do
40. formBegin "$home_title: Excludes"
41. formItem "Exclude:"*.mp3
42. formItem "Exclude:"*.mp4
43. # 按需增加多個“Exclude”文本框指定其他不須包含的內容
44. formItem "Exclude:"
45. formItem "Exclude:"
46. formDisplay
47. [ $?=0]||return1
48. home_excludes="excludes = "
49. for i in $REPLY;do
50. [-n "$i"]&& home_excludes="$home_excludes $i"
51. done
52. done
53. # 保存配置
54. get_next_filename $configdirectory/10.home
55. cat > $next_filename <<EOF
56. $home_when_run
57. $home_backupname
58. $home_backupdir
59. $home_compress
60. $home_includes
61. $home_excludes
62. # tar 程序的路徑，必須為GNU tar
63. TAR `which tar`
64. DATE `which date`
65. DATEFORMAT "%Y-%m-%d"
66. EXTENSION tar
67. EOF
68. # 將配置文件的權限改為600
69. chmod 600 $next_filename
70. }

運行 ninjahelper

當創建了名為home的handler腳本以及對應的home.helper後，運行ninjahelper命令創建一個新的備份操作。

#ninjahelper

選擇 create a new backup action（創建一個新的備份操作）。

接下來將看到可選的操作類型，這裡選擇“backup of home directories"（備份home目錄）：

然後會顯示在helper中設置的默認值（這裡只顯示了3個）。可以編輯文本框中的值。注意，關於“when”變量的語法，參考文檔的日程安排章節。

當完成備份操作的創建後，它會顯示在ninjahelper的初始化菜單中：

按回車鍵顯示這個備份操作的選項。因為它非常簡單，所以我們可以隨便對它進行一些實驗。

注意，“run this action now"（立即運行）選項會不顧日程表安排的時間而立即進行備份操作：

備份操作會發生一些錯誤，debug會提供一些有用的信息以幫助你定位錯誤並糾正。例如，當備份操作有錯誤並且沒有被糾正，那麼當它運行時將會打印出如下所示的錯誤信息。

上面的圖片告訴我們，用於完成備份操作的連接沒有建立，因為它所需要鏈接的遠程主機似乎宕機了。另外，在helper文件中指定的目標目錄不存在。當糾正這些問題後，重新開始備份操作。

需要牢記的事情：

• 當你在/usr/share/backupninja 下新建了一個自定義腳本（如foobar）來處理特殊的備份操作時，那麼你還需要編寫與之對應的helper（foobar.helper）文件，ninjahelper 將通過它生成名為10.foobar（下一個操作為11，以此類推）的文件，保存在/etc/backup.d目錄下，而這個文件才是備份操作的真正的配置文件。
• 可以通過ninjahelper設定好備份操作的執行時間，或按照“when”變量中設置的頻率來執行。

總結

在這篇文章中，我們探討了如何從頭創建我們自己的備份操作，以及如何向ninjahelper添加相關的菜單以生成對應的配置文件。通過上一篇與這一篇文章，我希望我已經給出了足夠好的理由讓你繼續研究，或者至少應該嘗試一下。