File systemd-vboxinit of Package systemd-vboxinit

Overview Repositories Revisions Requests Users Attributes Meta

File systemd-vboxinit of Package systemd-vboxinit

#!/usr/bin/env bash
# shellcheck disable=SC2145
# shellcheck disable=SC2053

# ============================================================================================ #
#: Title           : systemd-vboxinit                                                          #
#: Sypnosis        : systemd-vboxinit OPTIONS                                                  #
#: Date Created    : Wed Oct  2 07:57:25 PHT 2013 / Wed Oct  2 03:11:58 UTC 2013               #
#: Last Edit       : Mon 04 Oct 2021 09:29:12 AM PST  /  Mon 04 Oct 2021 01:29:12 AM UTC       #
#: License         : GPLv3                                                                     #
#: Version         : 2.1.7                                                                     #
#: Author          : Jason V. Ferrer '<jetchisel@opensuse.org>'                                #
#: Description     : Auto start sessions when booting and save sessions when host is stopped.  #
#: Options         : [about,stop,start,disable,license,help]                                   #
#: Home Page       : https://github.com/Jetchisel/VBoxAutostart                                #
#: ExtComm         : cat,find,grep,less,pgrep,systemctl,VBoxManage                             #
# ============================================================================================ #

# ******************************************************************************************** #
#              Set shell option so RunningUuids can be tested in one-line.                     #
# ******************************************************************************************** #

shopt -s extglob

# ******************************************************************************************** #
#   Warn and die functions, for exit messages and default status or an optional exit status.   #
# ******************************************************************************************** #

warn() {
  printf '%s\n' "${BASH_SOURCE##*/}: $*" ##: Print message to stdout by default.
}

die() {
  local st=$? ##: Assign the last exit command to the var st.
  case $2 in  ##: Test against a pattern for the value of `$2'
    *[^0-9]*|'') :;; ##: If the value of `$2' is not a digit. `+([!0-9])' or empty.
    *) st=$2;; ##: Save the value of `$2' in st if value is digit.
  esac

case $st in ##: Test against a pattern for the value of `$st'
    0) warn "$1" ;;  ##: If value of `$st' is 0 then print message to stdout.
    *) warn "$1" >&2;; ##: If value of `$st' is not zero then print message to `stderr'.
  esac

exit "$st"  ##: Exit with the status of the recent command or an optional given status.
}

# ******************************************************************************************** #
#       One argument only exit immediately and avoid running the script until the end.         #
# ******************************************************************************************** #

(( $# > 1 )) && die "Too many arguments, try --help" 1

# ******************************************************************************************** #
#              Check if VirtualBox is installed if not exit with an error.                     #
# ******************************************************************************************** #

NotInstalledMessage="VBoxManage is either not installed or it's not in your PATH!"

if ! type -P VBoxManage >/dev/null; then
  if ! type -P vboxmanage >/dev/null; then
    [[ -f /usr/lib/virtualbox/VBoxManage ]] || die "$NotInstalledMessage" 127
  fi
fi

# ******************************************************************************************** #
#        Check for the required app/executable is with in your PATH, exit otherwise.           #
# ******************************************************************************************** #

Missing=()
ExtComm=(cat find grep less pgrep systemctl VBoxManage)
MissingMessage="is either not installed or it is not in your PATH!"
ExitMessage="Please install the following: "

for apps in "${ExtComm[@]}"; do
  if ! type -P "$apps" >/dev/null; then
    printf '%s %s\n' "$apps" "$MissingMessage" >&2
    Missing+=("$apps")
  fi
done

(( ${#Missing[@]} )) && die "$ExitMessage[${Missing[*]}] exiting now!" 127

# ******************************************************************************************** #
#           Check if vboxdrv kernel module is loaded if not exit with an error.                #
# ******************************************************************************************** #

grep -q "^vboxdrv" /proc/modules || die "vboxdrv is not loaded!"

# ******************************************************************************************** #
#          Assign VirtualBox directory /usr/lib/virtualbox to the variable VBoxDir.            #
# ******************************************************************************************** #

VBoxDir=/usr/lib/virtualbox

# ******************************************************************************************** #
#  Use the VBoxManage in /usr/lib/virtualbox if it exist, else use whatever is in your PATH.   #
# ******************************************************************************************** #

VBoxManage() {
  if [[ -f $VBoxDir/VBoxManage && -x $VBoxDir/VBoxManage ]]; then
    "${VBoxDir}"/VBoxManage "$@"
  else
    if type -P VBoxManage >/dev/null; then
      command -p VBoxManage "$@"
    else
      command -p vboxmanage "$@"
    fi
  fi
}

# ******************************************************************************************** #
#                                  VBoxManage Functions.                                       #
# ******************************************************************************************** #

ExtraData() {
  VBoxManage getextradata "$AllUuid" 'pvbx/startupMode'
}

ListRunningVms() {
  VBoxManage list runningvms
}

ListVms() {
  VBoxManage list vms
}

StartVms() {
  VBoxManage startvm "$AllUuid" --type headless
}

SaveVms() {
  VBoxManage controlvm "$AllUuid" savestate
}

# ******************************************************************************************** #
#           Function to check for vms. If there is none found exit without an error.           #
# ******************************************************************************************** #

NoVmExit() {
  mapfile -u5 -t AllVms 5< <(ListVms)
  (( ${#AllVms[@]} )) || die "No virtual machine found!"
}

# ******************************************************************************************** #
#  Put the running/sanitized vms uuids in an array and format it in the variable RunningUuids. #
# ******************************************************************************************** #

uuids=()
while read -u6 -r vm; do
  running_uuid=${vm##*"{"}
  uuids+=("${running_uuid%"}"*}")
done 6< <(ListRunningVms)
##: This is not an error, printf -v save the array in the variable RunningUuids formatted!
printf -v RunningUuids "%s|" "@(${uuids[@]})"
RunningUuids=${RunningUuids%|}

# ******************************************************************************************** #
#  Function to sanitize/extract the vmname and uuid using P.E. inside the start,stop function. #
# ******************************************************************************************** #

ExtractVmNameUuid() {
  AllUuid=${line##*"{"}
  AllUuid=${AllUuid%"}"*}
  VmName=${line#*'"'}
  VmName=${VmName%'"'*}
}

# ******************************************************************************************** #
#          Function to print the vms status when started, e.g. running,auto,noauto.            #
# ******************************************************************************************** #

VmStatus() {
  local i j k
  if (( ${#RunningVms[@]} )); then
    for i in "${!RunningVms[@]}"; do
      printf '%s\n' "Machine '${RunningVms[i]}' is already running..."
    done
  fi

if (( ${#NoAutoRunning} )); then
    for j in "${!NoAutoRunning[@]}"; do
      printf '%s\n' "Machine '${NoAutoRunning[j]}' is already running but not on auto..."
    done
  fi

if (( ${#NoAutoVms[@]} )); then
    for k in "${!NoAutoVms[@]}"; do
      printf '%s\n' "Machine '${NoAutoVms[k]}' is not set to auto..."
    done
  fi
}

# ******************************************************************************************** #
#                             Function to start the vms Headless.                              #
# ******************************************************************************************** #

start() {
  local line
  NoVmExit
  #NoAutoVms=() RunningVms=() NoAutoRunning=()
  declare -a NoAutoVms
  declare -a RunningVms
  declare -a NoAutoRunning

while read -u7 -r line; do
    ExtractVmNameUuid
    if [[ $(ExtraData) = *auto* && $AllUuid != $RunningUuids ]]; then
      printf '\n%s\n' "Starting Machine '$VmName'..."
      StartVms
    elif [[ $(ExtraData) != *auto* && $AllUuid = $RunningUuids ]]; then
      NoAutoRunning+=("$VmName")
    elif [[ $(ExtraData) = *auto* && $AllUuid = $RunningUuids ]]; then
      RunningVms+=("$VmName")
    elif [[ $(ExtraData) != *auto* ]]; then
      NoAutoVms+=("$VmName")
    fi
  done 7< <(ListVms)

VmStatus
}

# ******************************************************************************************** #
#  Function to print/list files/executables (without extension) inside /usr/lib/virtualbox.    #
# ******************************************************************************************** #

VBoxDaemons() {
  find "$VBoxDir" -type f -iname '*v*box*' \! -name '*.*' -print
}

# ******************************************************************************************** #
#                      Function to stop/kill all running vbox processes.                       #
# ******************************************************************************************** #

KillAllVBoxProcess() {
  local pid
  local pids
  local daemon
  while read -u9 -r daemon; do
    daemon=${daemon##*/}
    daemonpid=$(pgrep -u "$LOGNAME" -x -- "$daemon")
    (( daemonpid )) && pids+=("$daemonpid")
  done 9< <(VBoxDaemons)

for pid in "${pids[@]}"; do
    kill -15 "$pid"
  done
}

# ******************************************************************************************** #
#               Function to save vms state instead of shutting down completely.                #
# ******************************************************************************************** #

stop() {
  local line
  (( ${#uuids[@]} )) || die "No virtual machine runnning!"
  while read -u8 -r line; do
    ExtractVmNameUuid
    printf '%s\n' "Saving machine '$VmName' state..."
    SaveVms
  done 8< <(ListRunningVms)

if ! systemctl is-active vboxdrv.service >/dev/null; then
    KillAllVBoxProcess
  fi
}

# ******************************************************************************************** #
#                             Assign UpdateMessage in an array.                                #
# ******************************************************************************************** #

InstallMessage=(
"All VirtualBox process that is owned by $LOGNAME has been stopped."
"You can now do the following: "
"   Install/reinstall VirtualBox (Update to the latest or install an old_version.)"
"   Rebuild the VirtualBox kernel modules."
)

# ******************************************************************************************** #
# Function to save-state of the runningvms and stop vbox daemons in preparation for an update. #
# ******************************************************************************************** #

disable() {
  local line
  local daemon
  local daemonpid
  local line

(( ${#uuids[@]} )) || die "No virtual machine runnning!"
  while read -u8 -r line; do
    ExtractVmNameUuid
    printf '%s\n' "Saving machine '$VmName' state..."
    SaveVms
  done 8< <(ListRunningVms)

KillAllVBoxProcess && printf '\n%s\n' "${InstallMessage[@]}"
}

# ******************************************************************************************** #
#                                       Usage Function.                                        #
# ******************************************************************************************** #

help() {
  cat <<EOF

Usage: ${BASH_SOURCE##*/} OPTION

Options:
  -s, --start    Start enabled virtual machines otherwise show the state.
  -x, --stop     Save the state of all running virtual machines enabled or not.
  -d, --disable  Like stop but also stops the vbox daemons, useful before a vbox update.
  -h, --help     Show this help.
  -a, --about    A brief info.
  -l, --license  Show license.

EOF
return
}

# ******************************************************************************************** #
#                                      About function.                                         #
# ******************************************************************************************** #

about() {
  cat <<EOF

Systemd-vboxinit

Auto start  sessions when  booting and save sessions  when host is
  stopped using systemd as its start up daemon.

This  program is  free software;  you can  redistribute  it and/or
  modify  it  under the  terms  of  the  GNU  General Public License
  version 3 as published by the Free Software Foundation.

This  program  is distributed  in the hope that it will be useful,
  but  WITHOUT ANY WARRANTY;  without even  the  implied warranty of
  MERCHANTABILITY or FITNESS FOR  A  PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

You should  have received a copy of the GNU General Public License
  (see The LICENSE file.) along  with this program; if not, write to
  the Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor
  Boston, MA  02110-1301, USA.

EOF
return
}

# ******************************************************************************************** #
#                  License function.  (required by GPL, see the LICENSE file)                  #
# ******************************************************************************************** #

license() {
  lisensya=/usr/share/doc/packages/systemd-vboxinit/LICENSE
  [[ -f $lisensya ]] || die "Can't find license file: $lisensya"
  less /usr/share/doc/packages/systemd-vboxinit/LICENSE
  return
}

# ******************************************************************************************** #
#                             Check for a command line option.                                 #
# ******************************************************************************************** #

# ============================================================================================ #
#                                   >>> END OF SCRIPT <<<                                      #
# ============================================================================================ #

Places

File systemd-vboxinit of Package systemd-vboxinit

Places