dup.helper: updated to support the new duplicity handlers features.
[matthijs/upstream/backupninja-vserver.git] / lib / vserver.in
1 #####################################################
2 ## VSERVERS RELATED FUNCTIONS FOR NINJAHELPER
3 ##
4 ## Depends on:
5 ##    - easydialog library
6 ##    - $conffile
7 ##
8 ## Global variables used and modified here:
9 ##    - $vservers_are_available (yes/no)
10 ##    - $found_vservers (list)
11 ##    - $selected_vservers (list)
12 ##    - $host_or_vservers (host/vservers/both)
13 ##
14
15 ##
16 ## Get vservers-related variables.
17 ## Then, if Vservers are enabled, check that:
18 ##   - VROOTDIR is valid;
19 ##   - at least one vserver can be found.
20 ## If, and only if, the above conditions are all true:
21 ##   - set $vservers_are_available to 'yes';
22 ##   - set $found_vservers to the list of all vservers found on the system.
23 ## This function has to be run once before a new helper is run.
24 ##
25 init_vservers() {
26    # get global variables from the conffile
27    setfile $conffile
28    getconf vservers no
29    getconf VSERVERINFO /usr/sbin/vserver-info
30    getconf VSERVER /usr/sbin/vserver
31    getconf VROOTDIR `if [ -f "$VSERVERINFO" ]; then $VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'; fi`
32    # init this library's global variables
33    vservers_are_available=no
34    found_vservers=
35    selected_vservers=
36    host_or_vservers=host
37    # check vservers real availability
38    if [ $vservers == yes ]; then
39       [ -n "$VROOTDIR" ] || (msgBox "warning" "VROOTDIR is not set in $conffile and could not be guessed."; return)
40       [ -d "$VROOTDIR" ] || (msgBox "warning" "VROOTDIR ($VROOTDIR) does not exist."; return)
41       found_vservers=`ls $VROOTDIR | grep -E -v "lost+found|ARCHIVES" | tr "\n" " "`
42       [ -n "$found_vservers" ] || return
43       vservers_are_available=yes
44    fi
45 }
46
47 ##
48 ## If the argument is the name of a vserver selected use by the current helper,
49 ## echoes 'on' and returns 0.
50 ## Else, echoes 'off' and returns 1.
51 ##
52 vserver_is_selected() {
53    local vserver=$1
54    local vserver_is_selected=1
55    local i
56    for i in $selected_vservers ; do
57       [ "$vserver" == "$i" ] && vserver_is_selected=0
58    done
59    if [ $vserver_is_selected = 0 ]; then
60       echo on
61    else
62       echo off
63    fi
64    return $vserver_is_selected
65 }
66
67 ##
68 ## Have the user choose one Vserver among the existing ones.
69 ## Set $selected_vservers to the chosen one's name.
70 ## Returns 1 if cancelled or if Vservers are not available.
71 ##
72 choose_one_vserver() {
73    [ "$vservers_are_available" == "yes" ] || return 1
74    local title=$1
75    local i=
76    local vserver=
77    REPLY=
78    while [ -z "$REPLY" ]; do
79       [ -n "$selected_vservers" ] && setDefault $selected_vservers
80       listBegin "$title" "Choose at least one Linux-Vserver to backup:"
81             for vserver in $found_vservers; do
82                listItem "$vserver" "Backup $vserver vserver"
83             done
84       listDisplay menu
85       [ $? = 0 ] || return 1
86    done
87    selected_vservers=$REPLY
88 }
89
90 ##
91 ## If Vservers are not enabled, set host_or_vservers='host' and then return 
92 ## Else, have the user choose if he/she wants to perform the backup on the host
93 ## system or on one Vserver.
94 ## Set, respectively, $host_or_vservers to 'host' or 'vservers'.
95 ## Returns 1 if cancelled.
96 ##
97 choose_host_or_one_vserver() {
98    if [ "$vservers_are_available" != "yes" ] 
99    then
100        host_or_vservers='host'
101        return
102    fi
103    local title=$1
104    # if there is one, set the previously chosen item as the default
105    [ -n "$host_or_vservers" ] && setDefault $host_or_vservers
106    menuBox "$title - src" "Do you want to operate on the host system and/or on vservers?" \
107       "host" "Host system" \
108       "vserver" "One Vserver"
109    [ $? = 0 ] || return 1
110    case $REPLY in
111       "host")
112          host_or_vservers='host'
113          ;;
114       "vserver")
115          host_or_vservers='vservers'
116          ;;
117    esac
118 }
119
120 ##
121 ## If Vservers are not enabled, set host_or_vservers='host' and then return
122 ## Else, have the user choose the target he/she wants to perform the backup on:
123 ##   - host system only;
124 ##   - some vservers only;
125 ##   - both the host system and some vservers.
126 ## Set, respectively, $host_or_vservers to 'host', 'vservers', or 'both'
127 ## Returns 1 if cancelled.
128 ##
129 choose_host_or_vservers_or_both() {
130    if [ "$vservers_are_available" != "yes" ] 
131    then
132        host_or_vservers='host'
133        return
134    fi
135    local title=$1
136    # if there is one, set the previously chosen item as the default
137    [ -n "$host_or_vservers" ] && setDefault $host_or_vservers
138    menuBox "$title - src" "Do you want to operate on the host system and/or on vservers?" \
139       "host" "Host system only" \
140       "vservers" "Vservers only" \
141       "both" "Host system and Vservers"
142    [ $? = 0 ] || return 1
143    case $REPLY in
144       "host")
145          host_or_vservers='host'
146          ;;
147       "vservers")
148          host_or_vservers='vservers'
149          ;;
150       "both")
151          host_or_vservers='both'
152          ;;
153    esac
154 }
155
156 ##
157 ## Have the user choose among "all vservers" and a not-empty subset of these.
158 ## Set $selected_vservers to 'all' or to a space-separated name list.
159 ## Returns 1 if cancelled or if Vservers are not available.
160 ##
161 choose_one_or_more_vservers() {
162    [ "$vservers_are_available" == "yes" ] || return 1
163    local title=$1
164    local i=
165    # UI
166    booleanBox "$title" "Do you want to backup all vservers?" ` [ -z "$selected_vservers" -o "$selected_vservers" == "all" ] || echo no`
167    if [ $? = 0 ]; then
168       selected_vservers="all"
169    else
170       # choose among the existing vservers
171       local vserver=
172       local vserver_was_selected=
173       REPLY=
174       while [ -z "$REPLY" ]; do
175          listBegin "$title" "Choose at least one Linux-Vserver to backup:"
176             # list existing vservers, preselecting the previously selected ones
177             for vserver in $found_vservers; do
178                listItem "$vserver" "Backup $vserver vserver" `vserver_is_selected $vserver`
179             done
180          listDisplay checklist
181          [ $? = 0 ] || return 1
182       done
183       # remove quotes around each vserver name
184       selected_vservers=`echo $REPLY | tr -d '"'`
185    fi
186 }