Merge branch 'master' of git.openslx.org:openslx-ng/tm-scripts

3 files changed, 361 insertions, 36 deletions

diff --git a/remote/modules/vmchooser/data/opt/openslx/bin/clc.bash b/remote/modules/vmchooser/data/opt/openslx/bin/clc.bash
new file mode 100755
index 00000000..f5c989f4
--- /dev/null
+++ b/remote/modules/vmchooser/data/opt/openslx/bin/clc.bash
@@ -0,0 +1,306 @@
+#!/bin/bash
+
+# region header
+
+# Copyright Torben Sickert 16.12.2012
+
+# License
+#    This library written by Torben Sickert stand under a creative commons
+#    naming 3.0 unported license.
+#    see http://creativecommons.org/licenses/by/3.0/deed.de
+
+# vim: set tabstop=4 shiftwidth=4 expandtab:
+# vim: foldmethod=marker foldmarker=region,endregion:
+
+# Dependencies:
+
+# vmware or virtualbox
+
+# Notes:
+
+# USE "sudo bin/vmware-vmx --new-sn JJ237-G52E2-08X0C-C3306-0WCQ1"
+# To activate wmware workstation!
+
+# Abbreviation for "createLinkedClone".
+__NAME__='clc'
+
+# endregion
+
+# Provides the main module scope.
+function clc() {
+
+# region configuration 
+
+    # region private properties
+
+        # region command line arguments
+
+        local _VERBOSE='no'
+        local _SUPPORTED_HYPERVISOR=('VMware' 'virtualBox')
+        # NOTE: This value will be determined automatically. If no hypervisor
+        # could be detected this value will be used as default.
+        # The first value from supported Machines is taken as default.
+        local _HYPERVISOR="$_SUPPORTED_HYPERVISOR"
+        local _PERSISTENT_SHORT_DESCRIPTION_SUFFIX=' --persistent--'
+
+        # endregion
+
+        local _STANDARD_OUTPUT=/dev/null
+        local _ERROR_OUTPUT=/dev/null
+        local _BASIC_IMAGE_CONFIGURATION_FILE_PATH=''
+        local _TARGET_PATH=''
+        local _CREATE_PERSISTENT_CONFIG='no'
+
+    # endregion
+
+# endregion
+
+# region functions
+
+    # region command line interface
+
+    # Prints a description about how to use this program.
+    function clcPrintUsageMessage() {
+        cat << EOF
+    $__NAME__ Generates a linked clone from given machine description file in
+    given target location.
+EOF
+        return $?
+    }
+
+    # Prints a description about how to use this program by providing examples.
+    function clcPrintUsageExamples() {
+        cat << EOF
+    # Getting a help message.
+    >>> $0 --help
+
+    # Creating a linked clone.
+    >>> $0 /path/to/config.xml ~/.persistentLinkedClones/
+
+    # Creating a linked clone in verbose mode.
+    >>> $0 /path/to/config.xml ~/.persistentLinkedClones/ --verbose
+
+    # Creating a linked clone in verbose mode with debugging output.
+    >>> $0 /path/to/config.xml ~/.persistentLinkedClones/ --verbose --debug
+
+    # Creating a linked clone in verbose mode with debugging output.
+    >>> $0 /path/to/config.xml ~/.persistentLinkedClones/ -v -d
+EOF
+        return $?
+    }
+
+    # Prints descriptions about each available command line option.
+    function clcPrintCommandLineOptionDescriptions() {
+        # NOTE; All letters are used for short options.
+        cat << EOF
+    -h --help Shows this help message.
+
+    -v --verbose Tells you what is going on (default: "$_VERBOSE").
+
+    -d --debug Gives you any output from all tools which are used
+        (default: "$_DEBUG").
+
+    -c --create-persistent-config If set an xml file for persistent openslx
+        boot will be created (default: "$_CREATE_PERSISTENT_CONFIG").
+EOF
+        return $?
+    }
+
+    # Provides a help message for this module.
+    function clcPrintHelpMessage() {
+        echo -e \
+            "\nUsage: $0 BASIC_IMAGE_CONFIGURATION_FILE_PATH TARGET_PATH [options]\n" && \
+        clcPrintUsageMessage "$@" && \
+        echo -e '\nExamples:\n' && \
+        clcPrintUsageExamples "$@" && \
+        echo -e '\nOption descriptions:\n' && \
+        clcPrintCommandLineOptionDescriptions "$@" && \
+        echo && \
+        return $?
+    }
+
+    # Provides the command line interface and interactive questions.
+    function clcCommandLineInterface() {
+        while true; do
+            case "$1" in
+                -h|--help)
+                    shift
+                    clcPrintHelpMessage "$0"
+                    exit 0
+                    ;;
+                -v|--verbose)
+                    shift
+                    _VERBOSE='yes'
+                    ;;
+                -d|--debug)
+                    shift
+                    _DEBUG='yes'
+                    _STANDARD_OUTPUT=/dev/stdout
+                    _ERROR_OUTPUT=/dev/stderr
+                    ;;
+                -c|--create-persistent-config)
+                    shift
+                    _CREATE_PERSISTENT_CONFIG='yes'
+                    ;;
+
+                '')
+                    shift
+                    break 2
+                    ;;
+                *)
+                    if [[ ! "$_BASIC_IMAGE_CONFIGURATION_FILE_PATH" ]]; then
+                        _BASIC_IMAGE_CONFIGURATION_FILE_PATH="$1"
+                    elif [[ ! "$_TARGET_PATH" ]]; then
+                        _TARGET_PATH="$1"
+                    else
+                        clcLog 'critical' \
+                            "Given argument: \"$1\" is not available." '\n'
+                        clcPrintHelpMessage "$0"
+                        return 1
+                    fi
+                    shift
+                    ;;
+            esac
+        done
+        if [[ ! "$_BASIC_IMAGE_CONFIGURATION_FILE_PATH" ]] || \
+           [[ ! "$_TARGET_PATH" ]]; then
+            clcLog 'critical' \
+                "You have to provide a basic image configuration file and a destination path."
+            clcPrintHelpMessage "$0"
+            return 1
+        fi
+        local supportedVirtualMachine
+        for supportedVirtualMachine in ${_SUPPORTED_HYPERVISOR[*]}; do
+            if [[ "$(clcGetXMLValue 'virtualMachine' | \
+                  grep --ignore-case "$supportedVirtualMachine")" ]]; then
+                _HYPERVISOR="$supportedVirtualMachine"
+                clcLog 'debug' "Detected \"$_HYPERVISOR\" as hypervisor."
+                break
+            fi
+        done
+        clcLog 'info' "Using \"$_HYPERVISOR\" as hypervisor." && \
+        return $?
+    }
+
+    # Grabs a value from currently loaded xml file.
+    function clcGetXMLValue() {
+        grep --ignore-case --only-matching "<$1 param=.*" \
+            "$_BASIC_IMAGE_CONFIGURATION_FILE_PATH" | awk -F '"' '{ print $2 }'
+        return $?
+    }
+
+    # Handles logging messages. Returns non zero and exit on log level error to
+    # support chaining the message into toolchain.
+    function clcLog() {
+        local loggingType='info'
+        local message="$1"
+        if [ "$2" ]; then
+            loggingType="$1"
+            message="$2"
+        fi
+        if [ "$_VERBOSE" == 'yes' ] || [ "$loggingType" == 'error' ] || \
+           [ "$loggingType" == 'critical' ]; then
+            if [ "$3" ]; then
+                echo -e -n "$3"
+            fi
+            echo -e "${loggingType}: $message"
+        fi
+        if [ "$loggingType" == 'error' ]; then
+            exit 1
+        fi
+    }
+
+    # endregion
+
+    # region tools
+
+    # Returns the minimal vmx vmware configuration file content to create a
+    # snapshot.
+    function clcGetTemporaryVMXContent() {
+        cat << EOF
+.encoding = "UTF-8"
+config.version = "8"
+virtualHW.version = "7"
+ide0:0.present = "TRUE"
+ide0:0.fileName = "$1"
+displayName = ""
+EOF
+        return $?
+    }
+
+    # Creates a snapshot from VMware generated virtual machine.
+    function clcCreateVMwareSnapshot() {
+        local temporaryConfigurationPath="$(mktemp --directory)/" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        local temporaryConfigurationFilePath="$(mktemp --suffix '.vmx')" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        clcGetTemporaryVMXContent "/var/lib/virt/vmware/$(clcGetXMLValue 'image_name')" \
+            1>"$temporaryConfigurationFilePath" 2>"$_ERROR_OUTPUT" && \
+        mv "$temporaryConfigurationFilePath" "$temporaryConfigurationPath" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        clcLog "Needed files generated in \"$temporaryConfigurationPath\" generated." && \
+        vmrun snapshot "$temporaryConfigurationPath"*.vmx \
+            persistentUserSnapshot 1>"$_STANDARD_OUTPUT" \
+            2>"$_ERROR_OUTPUT" && \
+        mv "$temporaryConfigurationPath"*.vmdk "$_TARGET_PATH" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT"
+        local result=$?
+        if [[ "$_DEBUG" == 'no' ]]; then
+            rm --recursive "$temporaryConfigurationPath" 1>"$_STANDARD_OUTPUT" \
+                2>"$_ERROR_OUTPUT"
+        fi
+        return $result
+    }
+
+    # Creates a snapshot from virtualBox generated virtual machine.
+    function clcCreateVirtualBoxSnapshot() {
+        local temporaryConfigurationPath="$(mktemp --directory)" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        VBoxManage clonevm TODO ->(VMNAME) --snapshot base --options link \\
+            --basefolder "$temporaryConfigurationPath" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        mv "${temporaryConfigurationPath}/Snapshots/"*.vmdk "$_TARGET_PATH" \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        rm --recursive "$temporaryConfigurationPath" 1>"$_STANDARD_OUTPUT" \
+            2>"$_ERROR_OUTPUT" && \
+        return $?
+    }
+
+    # Creates a persistent version of given config file.
+    function clcCreatePersistentConfig() {
+        cp "$_BASIC_IMAGE_CONFIGURATION_FILE_PATH" "$_TARGET_PATH" && \
+            1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT" && \
+        sed --in-place --regexp-extended \
+            "s/(< *short_description[^>]*param=\"[^\"]*)(\")/\\1$_PERSISTENT_SHORT_DESCRIPTION_SUFFIX\\2/g" \
+            "$_TARGET_PATH" 1>"$_STANDARD_OUTPUT" 2>"$_ERROR_OUTPUT"
+        return $?
+    }
+
+    # endregion
+
+# endregion
+
+# region controller
+
+    clcCommandLineInterface "$@" || return $?
+    if [[ "$_CREATE_PERSISTENT_CONFIG" == 'yes' ]]; then
+        clcCreatePersistentConfig || \
+            clcLog 'error' 'Creating persitent config failed.'
+    else
+        "clcCreate${_HYPERVISOR}Snapshot" || \
+            clcLog 'error' 'Creating Linked Clone failed.'
+    fi
+    clcLog 'Program has successfully finished.' && \
+    return $?
+
+# endregion
+
+}
+
+# region footer
+
+if [[ "$0" == *"${__NAME__}.bash" ]]; then
+    "$__NAME__" "$@"
+fi
+
+# endregion
diff --git a/remote/modules/vmchooser/data/opt/openslx/bin/run-virt.sh b/remote/modules/vmchooser/data/opt/openslx/bin/run-virt.sh
index f338cd37..bf642ed0 100755
--- a/remote/modules/vmchooser/data/opt/openslx/bin/run-virt.sh
+++ b/remote/modules/vmchooser/data/opt/openslx/bin/run-virt.sh
@@ -110,13 +110,34 @@ filecheck ()
 ### Get XML file and dir
 ################################################################################
 
+## Added for persistent support.
+diskmode='nonpersistent'
+xmlfile="$1"
+if [[ "$(grep --extended-regexp '< *persistent *param=".+"' "$1")" ]]; then
+    imageFilePath=$(grep -io '<image_name param=.*"' "$1" \
+        | sed -e "s/&.*;/; /g" | awk -F '"' '{ print $2 }')
+    diskmode='persistent' && \
+    # TODO path shouldn't be hardcoded.
+    xmlfile="/var/lib/virt/vmware/$(sed 's/-persistent$//g' <<< "$(sed 's/vmdk$/xml/g' <<< "$(basename "$imageFilePath")")")" && \
+    # NOTE: We have to make sure that this folder is present to prevent
+    # getting an empty string by "readlink".
+    mkdir --parents ~/.persistentVirtualMachines/ && \
+    userBranchFilePath="$(readlink --canonicalize ~/.persistentVirtualMachines/$(basename "$imageFilePath"))"
+    # Create linked clone if not exists.
+    if [ ! -f "$userBranchFilePath" ]; then
+        # TODO path shouldn't be hardcoded.
+        /opt/openslx/plugin-repo/vmchooser/clc.bash "$xmlfile" \
+            "$userBranchFilePath" --debug --verbose
+    fi
+fi
+##
+
 # absolute or relative path?
-xmlfile=$1
 if ls ${xmlfile} 2>/dev/null | grep '/' >/dev/null 2>&1; then
   xmlpath=$(dirname ${xmlfile})
   xmlfile=$(basename ${xmlfile})
 else
-  xmlpath=${path}
+  xmlpath=${vmchooser_xmlpath}
 fi
 # full path
 xmlfile="${xmlpath}/${xmlfile%.xml}.xml"
@@ -170,6 +191,11 @@ writelog "VM config:"
 # Name of the virt image
 imgname=$(grep -io '<image_name param=.*"' ${xmlfile} \
           | sed -e "s/&.*;/; /g" | awk -F '"' '{ print $2 }')
+## Added for persistent support.
+if [[ "$userBranchFilePath" ]]; then
+    imgname="$userBranchFilePath"
+fi
+##
 
 # Imagename /w full path
 if echo ${imgname} 2>/dev/null | grep -q '^/' >/dev/null 2>&1; then
@@ -181,6 +207,10 @@ if echo ${imgname} 2>/dev/null | grep -q '^/' >/dev/null 2>&1; then
 elif echo ${xmlfile} 2>/dev/null | grep -q '^/tmp/' >/dev/null 2>&1; then
   vmpath=$imgname
   imgname=$(basename ${imgname})
+## Added for persistent support.
+elif [[ "$userBranchFilePath" ]]; then
+  vmpath="$userBranchFilePath"
+##
 # Else use same path as xml
 else
   imgpath=${xmlpath}
@@ -335,30 +365,6 @@ hddrv="ide"
 audio="true"
 remotedesktopport="590${VM_ID}"
 
-# Display resolution within the host system
-hostres=$(xvidtune -show 2>/dev/null| grep -ve "^$")
-xres=$(echo "${hostres}" | awk '{print $3}')
-yres=$(echo "${hostres}" | awk '{print $7}')
-
-# Resolution defined via xml parameter: fullscreen, full/X*Y/depth; windowed, 
-# win/X*Y/depth
-userres=$(grep -io '<screen param=.*"' ${xmlfile} | awk -F '"' '{ print $2 }' | \
-  tr "A-Z" "a-z")
-case "${userres}" in
-  full*)
-    res=$(echo "${hostres}" | awk -F "/" '{print $2}')
-    uxres=${res%\**}
-    uyres=${#*\*}
-    userres="full"
-  ;;
-  win*)
-    res=$(echo "${hostres}" | awk -F "/" '{print $2}')
-    uxres=${res%\**}
-    uyres=${#*\*}
-    userres="win"
-  ;;
-esac
-
 
 # Enable 3D
 enable3d=$(grep -i "<enable3d param=.*" ${xmlfile} 2>/dev/null | \
@@ -399,10 +405,9 @@ fi
 
 # Copy guest configuration (with added information) config.xml to be accessed
 # via virtual floppy
-# fixme -> to be changed (vmchooser adapts the file content!?)
-#TODO: wozu echo?
-#echo "Please fix the config.xml generation"
-cp ${xmlfile} /etc/openslx/vmchooser/fd-loop/config.xml
+cp "$xmlfile" "/etc/openslx/vmchooser/fd-loop/config.xml"
+# Add another file with resolution information
+xrandr | grep -o -E 'current\s*[0-9]+\s*x\s*[0-9]+' | cut -c 8- | sed -r 's/(\s|\t|\n)//g' | head -n 1 > "/etc/openslx/vmchooser/fd-loop/hostres.txt"
 
 # Get all virtual machine specific stuff from the respective include file
 if [ -e /etc/openslx/${xmlvirt}/run-virt.include ] ; then
diff --git a/remote/modules/vmchooser/data/opt/openslx/bin/xmlfilter.sh b/remote/modules/vmchooser/data/opt/openslx/bin/xmlfilter.sh
index ded5d114..67e49d3e 100755
--- a/remote/modules/vmchooser/data/opt/openslx/bin/xmlfilter.sh
+++ b/remote/modules/vmchooser/data/opt/openslx/bin/xmlfilter.sh
@@ -33,18 +33,32 @@ if [ -f ${OPENSLX_DEFAULT_CONFDIR}/plugins/vmchooser/vmchooser.conf ]; then
   . ${OPENSLX_DEFAULT_CONFDIR}/plugins/vmchooser/vmchooser.conf
 fi
 
-for FILE in $(find $1 -iname "*.xml"); do
+function handlePersistentVM() {
+  if [[ "$(grep --extended-regexp \
+        "<persistent param=\"(|.+:)$USER(|:.+)\"" "$1")" ]]; then
+    # If this virtual machine is useable as persistent version for current
+    # user we provide an additional persistent version.
+    local persistentConfigVersionFilePath="$(mktemp --directory)/$(basename "${1}-persistent")"
+    /opt/openslx/plugin-repo/vmchooser/clc.bash "$1" \
+      "$persistentConfigVersionFilePath" --create-persistent-config && \
+    echo "$persistentConfigVersionFilePath"
+  fi
+}
+
+for FILE in $(find -L "$1" -iname "*.xml"); do
   # filter all xmls which aren't set active
-  if [ $(grep "<active param=.*true.*" ${FILE} | wc -l) -eq 1 ]; then
-    if [ -n ${vmchooser_env} ]; then
+  if [ $(grep "<active param=.*true.*" "$FILE" | wc -l) -eq 1 ]; then
+    if [ -n "${vmchooser_env}" ]; then
       # filter all xmls with pool-param not equal to vmchooser::env
-      if [ $(grep "<pools param=\"${vmchooser_env}\"" ${FILE} | wc -l) -eq 1 ];\
+      if [ $(grep "<pools param=\"${vmchooser_env}\"" "$FILE" | wc -l) -eq 1 ]
       then
-        echo ${FILE};
+        handlePersistentVM "$FILE"
+        echo "$FILE"
       fi
     else
+      handlePersistentVM "$FILE"
       # if there is no pool set, just take all available xmls
-      echo -e ${active}
+      echo "$FILE"
     fi
   fi
 done