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