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