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