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    [ -z "$VROOTDIR" ] || 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 all the arguments are existing vservers names, returns 0.
  78 ## Else, returns 1. Also returns 1 if no argument is given.
  79 ##
  80 vservers_exist() {
  81    [ $# -ge 1 ] || return 1
  82    local args="$1"
  83    local vserver i found
  84    for vserver in $args ; do
  85       found=no
  86       for i in $found_vservers ; do
  87          if [ $vserver = $i ]; then
  88             found=yes
  89             break
  90          fi
  91       done
  92       [ $found = yes ] || return 1
  93    done
  94    return 0
  95 }
  96
  97 ##
  98 ## If all the arguments are running vservers names, returns 0.
  99 ## Else, returns 1. Also returns 1 if no argument is given.
 100 ##
 101 vservers_running() {
 102    [ $# -ge 1 ] || return 1
 103    local args="$1"
 104    local vserver
 105    for vserver in $args ; do
 106       $VSERVERINFO -q $vserver RUNNING || return 1
 107    done
 108    return 0
 109 }
 110
 111 ##
 112 ## If the argument is the name of a vserver selected by the current helper,
 113 ## echoes 'on' and returns 0.
 114 ## Else, echoes 'off' and returns 1.
 115 ##
 116 vserver_is_selected() {
 117    local vserver=$1
 118    local vserver_is_selected=1
 119    local i
 120    for i in $selected_vservers ; do
 121       [ "$vserver" == "$i" ] && vserver_is_selected=0
 122    done
 123    if [ $vserver_is_selected = 0 ]; then
 124       echo on
 125    else
 126       echo off
 127    fi
 128    return $vserver_is_selected
 129 }
 130
 131 ##
 132 ## Have the user choose one Vserver among the existing ones.
 133 ## Set $selected_vservers to the chosen one's name.
 134 ## Returns 1 if cancelled or if Vservers are not available.
 135 ##
 136 choose_one_vserver() {
 137    [ "$vservers_are_available" == "yes" ] || return 1
 138    local title=$1
 139    local i=
 140    local vserver=
 141    REPLY=
 142    while [ -z "$REPLY" ]; do
 143       [ -n "$selected_vservers" ] && setDefault $selected_vservers
 144       listBegin "$title" "Choose at least one Linux-Vserver to backup:"
 145             for vserver in $found_vservers; do
 146                listItem "$vserver" "Backup $vserver vserver"
 147             done
 148       listDisplay menu
 149       [ $? = 0 ] || return 1
 150    done
 151    selected_vservers=$REPLY
 152 }
 153
 154 ##
 155 ## If Vservers are not enabled, set host_or_vservers='host' and then return
 156 ## Else, have the user choose if he/she wants to perform the backup on the host
 157 ## system or on one Vserver.
 158 ## Set, respectively, $host_or_vservers to 'host' or 'vservers'.
 159 ## Returns 1 if cancelled.
 160 ##
 161 choose_host_or_one_vserver() {
 162    if [ "$vservers_are_available" != "yes" ]
 163    then
 164        host_or_vservers='host'
 165        return
 166    fi
 167    local title=$1
 168    # if there is one, set the previously chosen item as the default
 169    [ -n "$host_or_vservers" ] && setDefault $host_or_vservers
 170    menuBox "$title - src" "Do you want to operate on the host system and/or on vservers?" \
 171       "host" "Host system" \
 172       "vserver" "One Vserver"
 173    [ $? = 0 ] || return 1
 174    case $REPLY in
 175       "host")
 176          host_or_vservers='host'
 177          ;;
 178       "vserver")
 179          host_or_vservers='vservers'
 180          ;;
 181    esac
 182 }
 183
 184 ##
 185 ## If Vservers are not enabled, set host_or_vservers='host' and then return
 186 ## Else, have the user choose the target he/she wants to perform the backup on:
 187 ##   - host system only;
 188 ##   - some vservers only;
 189 ##   - both the host system and some vservers.
 190 ## Set, respectively, $host_or_vservers to 'host', 'vservers', or 'both'
 191 ## Returns 1 if cancelled.
 192 ##
 193 choose_host_or_vservers_or_both() {
 194    if [ "$vservers_are_available" != "yes" ]
 195    then
 196        host_or_vservers='host'
 197        return
 198    fi
 199    local title=$1
 200    # if there is one, set the previously chosen item as the default
 201    [ -n "$host_or_vservers" ] && setDefault $host_or_vservers
 202    menuBox "$title - src" "Do you want to operate on the host system and/or on vservers?" \
 203       "host" "Host system only" \
 204       "vservers" "Vservers only" \
 205       "both" "Host system and Vservers"
 206    [ $? = 0 ] || return 1
 207    case $REPLY in
 208       "host")
 209          host_or_vservers='host'
 210          ;;
 211       "vservers")
 212          host_or_vservers='vservers'
 213          ;;
 214       "both")
 215          host_or_vservers='both'
 216          ;;
 217    esac
 218 }
 219
 220 ##
 221 ## Have the user choose among "all vservers" and a not-empty subset of these.
 222 ## Set $selected_vservers to 'all' or to a space-separated name list.
 223 ## Returns 1 if cancelled or if Vservers are not available.
 224 ##
 225 choose_one_or_more_vservers() {
 226    [ "$vservers_are_available" == "yes" ] || return 1
 227    local title=$1
 228    local i=
 229    # UI
 230    booleanBox "$title" "Do you want to backup all vservers?" ` [ -z "$selected_vservers" -o "$selected_vservers" == "all" ] || echo no`
 231    if [ $? = 0 ]; then
 232       selected_vservers="all"
 233    else
 234       # choose among the existing vservers
 235       local vserver=
 236       local vserver_was_selected=
 237       REPLY=
 238       while [ -z "$REPLY" ]; do
 239          listBegin "$title" "Choose at least one Linux-Vserver to backup:"
 240             # list existing vservers, preselecting the previously selected ones
 241             for vserver in $found_vservers; do
 242                listItem "$vserver" "Backup $vserver vserver" `vserver_is_selected $vserver`
 243             done
 244          listDisplay checklist
 245          [ $? = 0 ] || return 1
 246       done
 247       # remove quotes around each vserver name
 248       selected_vservers=`echo $REPLY | tr -d '"'`
 249    fi
 250 }