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