path: root/remote/modules/vmchooser/data/opt/openslx/scripts/vmchooser-run_virt

#!/bin/bash
# -----------------------------------------------------------------------------
# Copyright (c) 2007..2010 - RZ Uni FR
# Copyright (c) 2007..2011 - OpenSLX GmbH
#
# This program is free software distributed under the GPL version 2.
# See http://openslx.org/COPYING
#
# If you have any feedback please consult http://openslx.org/feedback and
# send your suggestions, praise, or complaints to feedback@openslx.org
#
# General information about OpenSLX can be found at http://openslx.org/
# -----------------------------------------------------------------------------
# run-virt.sh
#    - This is the generic wrapper for the several virtualization solutions.
#      The idea is to setup a set of variables used by at least two different
#      tools and then include the specific plugin which configures the speci-
#      fied virtualization tool.
################################################################################

################################################################################
### Define default dirs / get configs
################################################################################

# include general configuration from vmchooser
[ -f /opt/openslx/etc/vmchooser/vmchooser.conf ] && . /opt/openslx/etc/vmchooser/vmchooser.conf
# load general virtualization information
[ -f /opt/openslx/etc/vmchooser/virtualization.conf ] && . /opt/openslx/etc/vmchooser/virtualization.conf
# Load general openslx config
[ -f /opt/openslx/config ] && . /opt/openslx/config

################################################################################
### Functions used throughout the script
################################################################################

# function to write to stdout and logfile
LOGFILE=/var/log/openslx/run-virt.${USER}.$$.log
writelog () {
	# write to stdout
	echo -e "$1"
	# log into file
	echo -e "$1" >> ${LOGFILE}
}

# remove config dirs when exit
cleanexit () {
	if echo "${RMDIRS}" 2>/dev/null | grep -q ${xmlvirt}; then
		writelog "${xmlvirt} exited. Cleanning up... \c"
		rm -rf ${RMDIRS} >/dev/null 2>&1
		writelog "done"
	fi
	
	exit "$1"
}

# check for important files used
filecheck ()
{
	filecheck=$(LANG=us ls -lh ${diskfile} 2>&1)
	writelog "Filecheck:\n${filecheck}\n"
	noimage=$(echo ${filecheck} | grep -i "no such file or directory" | wc -l)
	rightsfile=${diskfile}
	
	# check if link
	if [ -L "${diskfile}" ]; then
		# take link target
		rightsfile=$(ls -lh ${diskfile} 2>&1 | awk -F '-> *' '{print $2}')
		rightsfile=${vmdir}/${rightsfile}
		filecheck=$(LANG=us ls -lh ${rightsfile} 2>&1)
	fi
	
	# does file exist
	if [ "${noimage}" -ge "1" ]; then
		writelog "Virtual Machine Image Problem:\c "
		writelog "\tThe image you've specified doesn't exist."
		writelog "Filecheck says:\c "
		writelog "\t\t${diskfile}:\n\t\t\tNo such file or directory"
		writelog "Hint:\c "
		writelog "\t\t\tCompare spelling of the image with your options.\n"
		exit 1
	fi
	
	# readable by calling user
	if ! [ -r "${diskfile}" >/dev/null 2>&1 \
		-o -r "${diskfile}" >/dev/null 2>&1 ]; then
		writelog "Vmware Image Problem:\c "
		writelog "\tThe image you've specified has wrong rights."
		writelog "Filecheck says:\t\t$(echo ${filecheck} \
		| awk '{print $1" "$3" "$4}') ${rightsfile}"
		writelog "Hint:\t\t\tChange rights with: chmod a+r ${rightsfile}\n"
		exit 1
	fi
	
	# writable (for persistent-mode)?
	if ! [ -w "${diskfile}" >/dev/null 2>&1 \
	-o -w "${diskfile}" >/dev/null 2>&1 ] \
	&& [ "${np}" = "independent-persistent" ]; then
		writelog "Vmware Image Problem:\c "
		writelog "\tThe image you have specified has wrong rights."
		writelog "Filecheck says:\t\t$(echo ${filecheck} \
		| awk '{print $1" "$3" "$4}') ${rightsfile}"
		writelog "Hint:\t\t\tUse nonpersistent-mode or change rights to rw\n"
		exit 1
	fi
}

################################################################################
### Get XML file and dir
################################################################################

## Added for persistent support.
diskmode='nonpersistent' && \
if [[ "$(grep --extended-regexp \
      '< *short_description *param=".+ --persistent--"' "$1")" ]]; then
    diskmode='persistent' && \
    imageFilePath="$(grep -io '<image_name param=.*"' "$1" \
        | sed -e "s/&.*;/; /g" | awk -F '"' '{ print $2 }')" && \
    originalXMLFilePath="$(grep -io '<original_xml_file_path param=.*"' "$1" \
        | sed -e "s/&.*;/; /g" | awk -F '"' '{ print $2 }')" && \
    originalImageFileName="$(grep -io '<image_name param=.*"' \
        "$originalXMLFilePath" | sed -e "s/&.*;/; /g" | awk -F '"' \
        '{ print $2 }')" && \
    originalVMDKFilePath="$(dirname \
        "$originalXMLFilePath")/${originalImageFileName}" && \
    # Added to workaround path prefix coming from temporary generated xml file
    # by vmchooser.
    if [[ "$(grep --extended-regexp '^/tmp/tmp\.[^\/]+/' <<< \
          "$imageFilePath")" ]]; then
        imageFilePath=$(sed -r 's/^\/?tmp\/[^\/]+\///g' \
            <<< "$imageFilePath") && \
        sed -ir \
            "s/(<image_name param=\")[^\"]*(\")/\\1$(sed -e \
            's/\\/\\\\/g' -e 's/\//\\\//g' -e \
            's/&/\\\&/g' <<< "$imageFilePath")\\2/g" "$1"
    fi
    # Create linked clone if not exists.
    if [ ! -f "$imageFilePath" ]; then
        mkdir -p "$(dirname "$imageFilePath")" && \
        bash "$(dirname "$0")/vmchooser-clc" "$originalXMLFilePath" \
            "$imageFilePath" --debug --verbose &>"${LOGFILE}"
    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=${vmchooser_xmlpath}
fi
# full path
xmlfile="${xmlpath}/${xmlfile%.xml}.xml"

DO_PROFILE="$(grep -c -E -i '<\s*profile\s*param="?(true|yes)"?' "$xmlfile")"

################################################################################
### Sanity checks
################################################################################

# test if the xml file is valid
if ! [ -r "${xmlfile}" ]; then
	writelog "${xmlfile} not a readable XML file!"
	exit 1
fi

# test if XML file
if ! grep '<?xml' "${xmlfile}" >/dev/null 2>&1; then
	writelog "Submitted configuration file ${xmlfile} seems to have wrong XML format"
	exit 1
fi

# check for running in graphical environment otherwise no much use here
[ -z "$DISPLAY" ] && echo -e "\n\tStart only within a graphical desktop!\n" \
&& exit 1

################################################################################
###  Logo for console
################################################################################

cat <<EOL
                                             __        __   
                .----.--.--.-----.___.--.--.|__|.----.|  |_ 
                |   _|  |  |     |___|  |  ||  ||   _||   _|
                |__| |_____|__|__|    \___/ |__||__|  |____|
          OpenSLX virtual machine environment preparation script ...

EOL

################################################################################
### Read needed variables from XML file
################################################################################

writelog "Starting configuration..."
writelog "\tLogfile:\t\t${LOGFILE}"
writelog "\t/tmp info:\t\t$(df -h | grep " /tmp$" | awk '{print $2}') \c"
writelog "$(grep "/tmp " /proc/mounts | awk '{print $1" "$2" "$3" "$4}')"
writelog "\tVM XML dir:\t\t$(dirname "${xmlfile}")"
writelog "\tXML file:\t\t${xmlfile}"
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
	imgpath="$(dirname "${imgname}")"
	imgname="$(basename "${imgname}")"
	vmpath="${imgpath}/${imgname}"
	# If old vmchooser binary stuff
	# We do not need folder name as it is already included by vmchooser
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}"
	vmpath="${imgpath}/${imgname}"
fi

# Check if virtual machine container file exists
if ! [ -e "${vmpath}" ]; then
	writelog "Virtual machine image ${vmpath} not found!"
	exit 1
fi

# Name of the virt machine, sed because of Windows formatting
vm_name=$(grep -o 'short_description param=.*"' "${xmlfile}" \
| sed -e "s/&.*;/; /g" | awk -F '"' '{print $2}')
# If ${vm_name} not defined use ${xmlfile}
vm_name="${vm_name:-${xmlfile%.xml}}"

# Define vm_shortname since vm_name can be very long
vm_shortname="$(basename "${xmlfile%.xml}" | sed -e "s, ,-,g")"

# vm_name = displayname, define for old scripts
displayname="${vm_name}"

# image is for the following virtual machine
xmlvirt=$(grep -o 'virtualmachine param=.*"' "${xmlfile}" \
| sed -e "s/&.*;/; /g" | awk -F '"' '{print $2}')

# choose the proper virtualization/emulator plugin
[ "x${xmlvirt}" != "x" -a "x${xmlvirt}" != "xqemukvm" -a \
"x${xmlvirt}" != "xvirtualbox" -a "x${xmlvirt}" != "xvmware" ] && \
xmlvirt="emufe"

# make a guess from the filename extension if ${xmlvirt} is empty
# (not set within the XML file)
# TODO: implement possibility to submit own configuration files
if [ -z "${xmlvirt}" ] && [ -n "${additional_config}" ]; then
	writelog "No virtual machine parameter defined in ${xmlfile}"
	writelog "Trying to guess VM...\c"
	case "$(cat ${additional_config} | tr \"[A-Z]\" \"[a-z]\")" in
		*config.version*|*virtualhw.version*|*independent-nonpersistent*|*vmdk*)
			xmlvirt="vmware"
		;;
		*innotek*|*virtualbox*)
			xmlvirt="virtualbox"
		;;
		*qemu*|*kvm*)
			xmlvirt="qemukvm"
		;;
		*)
			xmlvirt="none"
		;;
	esac
	elif [ -z "${xmlvirt}" ]; then
	case "$(echo ${imgname##*.} | tr \"[A-Z]\" \"[a-z]\")" in
		vmdk)
			xmlvirt="vmware"
		;;
		vbox|vdi)
			xmlvirt="virtualbox"
		;;
		qcow*)
			xmlvirt="qemukvm"
		;;
		*)
			xmlvirt="emufe"
		;;
	esac
	writelog "result:\t${xmlvirt}"
fi

# Definition of the client system
vmostype=$(grep -io '<os param=.*"' "${xmlfile}" | awk -F '"' '{ print $2 }' |\
tr "[A-Z]" "[a-z]")

# Definition of the networking the client system is connected to
network_kind=$(grep -io '<network param=.*"' "${xmlfile}" \
| awk -F '"' '{ print $2 }' | tr "[A-Z]" "[a-z]")
network_card=$(grep -io '<netcard param=.*"' "${xmlfile}" \
| awk -F '"' '{ print $2 }'| tr "[A-Z]" "[a-z]")

# Set redirects to 0, see vmgrid if you want to define some
redirects=0

# Serial/parallel ports defined (e.g. "ttyS0" or "autodetect")
serial=$(grep -io '<serialport param=.*"' "${xmlfile}" \
| awk -F '"' '{ print $2 }')
parallel=$(grep -io '<parport param=.*"' "${xmlfile}" \
| awk -F '"' '{ print $2 }')

writelog "\tVirtualization:\t\t$xmlvirt"
writelog "\tVM name:\t\t$vm_name"
writelog "\tVM short name:\t\t$vm_shortname"

###############################################################################
### Declaration of default variables
###############################################################################

# VM-ID static (00)
VM_ID="00"
# take last two digits of current pid...
VM_ID=$(expr substr $$ $(expr ${#$} - 1) 2)

# Make sure cpu_cores is not empty
cpu_cores=${cpu_cores:-"1"}

# Amount of memory for the VM. Be generous if diff is written to HDD
if mount | grep -q '^/dev/sd.*on.*/tmp'; then
	reserve=20
	min=768
	max=1536
else
	reserve=65
	min=768
	max=8192
fi

# Calculate absulute amount of RAM that should stay available to the host
reserve="$[ ( $totalmem * $reserve ) / 100 ]"
# Respect some upper and lower bounds for the host amount
[ "$reserve" -lt "$min" ] && reserve="$min"
[ "$reserve" -gt "$max" ] && reserve="$max"

# Get a result which can be divided by 4
mem="$[ ( ( $totalmem - $reserve ) / 4 ) * 4 ]"
if [ -n "$mainvirtmem" ]; then
	forcemem="$[ "$mainvirtmem" / 4 * 4 ]"
	mem="$forcemem"
fi
hostmem="$[ $totalmem - $mem ]"

# Configuring ethernet mac address: first 3 bytes are fixed (00:50:56)
# 4th byte is the VM-ID (0D)
# last two bytes are taken from the bridge of the host
# define one MAC per guest
macguestpart="00:50:56:${VM_ID}"
machostpart=$(echo "${hostmacaddr}" | awk -F ":" '{print $(NF-1)":"$NF}')
macaddr=$(echo "${macguestpart}:${machostpart}" | tr "[a-z]" "[A-Z]")
macaddrsuffix=$(echo "${VM_ID}:${machostpart}" | tr "[a-z]" "[A-Z]")

# Virtual fd/cd/dvd and drive devices, floppy b: for configuration
# if $floppy_0 from run-virt.include set then fdtest="TRUE"
fdtest=
fdtest=${floppy_0:+"TRUE"}
# if $fdtest not set floppy0="FALSE", else "TRUE"
floppy0=${fdtest:-"FALSE"}
floppy1="TRUE"
floppy1name="/opt/openslx/etc/vmchooser/loopimg/fd.img"
# if $cdrom_0 from run-virt.include set then cdtest="TRUE"
cdtest=
cdtest=${cdrom_0:+"TRUE"}
# if $cdtest not set cdrom0="FALSE", else "TRUE"
cdrom0=${cdtest:-"FALSE"}
# if $cdrom_1 from run-virt.include set then cdtest="TRUE"
cdtest=
cdtest=${cdrom_1:+"TRUE"}
# if $cdtest not set cdrom1="FALSE", else "TRUE"
cdrom1=${cdtest:-"FALSE"}
# IDE is expected default, test for the virtual disk image type should
# be done while creating the runscripts ...
# TODO enable SCSI support instead of just disabling it.
ide="TRUE"
scsi="FALSE"
hddrv="ide"
audio="true"
remotedesktopport="590${VM_ID}"


# Enable 3D
enable3d=$(grep -i "<enable3d param=.*" ${xmlfile} 2>/dev/null | \
awk -F '=' {'print $2'} | tr "[A-Z]" "[a-z]")

# Add rw share
sharepath="${HOME}"
sharename="home"

# Set hostname: using original hostname and adding string
hostname="virt-$(hostname)"

writelog "\tVM Hostname:\t\t$hostname"

################################################################################
### Setup the rest of the environment and run the configured vm
################################################################################
# 8086:1e20
if lspci -n | grep -E -i '8086:1e20( |$)'; then
	VOL="100%" # bwPC 4: Speaker too quiet :-(
else
	VOL="80%"
fi
# Adjust sound volume
#writelog "Unmuting sound...\c "
amixer -q sset Master "$VOL" unmute 2>/dev/null
amixer -q sset PCM "$VOL" unmute 2>/dev/null
amixer -q sset CD "$VOL" unmute 2>/dev/null
amixer -q sset Headphone "$VOL" unmute 2>/dev/null
amixer -q sset Front "$VOL" unmute 2>/dev/null      # in SUSE 11.0 it's headphone
amixer -q sset Speaker "$VOL" unmute 2>/dev/null       # annoying built-in speaker
#writelog "finished\n"

# Load kvm modules
if [ "$vtflag" = "1" -a -n "$kvm_module" ]; then
	modprobe "$kvm_module"
fi


# # # # # # Start printer daemon # # # # # # # 
USER="$(whoami)"
SPOOLDIR="/var/spool"
QUEUE="STANDARD"

# Start the lpdaemon listening on the given port
tcpsvd -E 0.0.0.0 5515 \
  lpd "$SPOOLDIR" \
  sh -c "printergui $USER $SPOOLDIR/$QUEUE/\$DATAFILE" &

# PID to kill the process
PID_LPD="$!"


# Copy guest configuration (with added information) config.xml to be accessed
# via virtual floppy
cp "$xmlfile" "/opt/openslx/etc/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 > "/opt/openslx/etc/vmchooser/fd-loop/hostres.txt"
# Add our magic openslx binary that sets the correct guest resolution
cp "/opt/openslx/etc/vmchooser/openslx.exe" "/opt/openslx/etc/vmchooser/fd-loop/"

# Try to use dnbd3 to access the image
unset vm_diskfile
unset vm_revision
unset dnbd3
if [ -n "$SLX_DNBD3_SERVERS" -a "x$SLX_VM_DNBD3" = "xyes" ]; then
	if [ -e "/dev/dnbd0" -a -e "/var/run/dnbd3.socket" ]; then
		# Shuffle server list
		TMP_SERVERS=$(for SRV in $SLX_DNBD3_SERVERS; do echo "$RANDOM $SRV"; done | sort -u | sed -r 's/^[0-9]+ //')
		for SRV in $TMP_SERVERS; do
			dnbd3=$(dnbd3-client -h "$SRV" -i "${vmpath#/mnt/vmstore/}" -r 0)
			RET=$?
			if [ "$RET" = "0" ]; then
				vm_diskfile="$dnbd3"
				vm_revision=$(cat "/sys/block/${dnbd3#/dev/}/net/rid")
				writelog "DNBD3: $vm_diskfile on $dnbd3 with rid $vm_revision"
				break
			fi
		done
		[ -z "$vm_diskfile" ] && writelog "No working dnbd3 server found :-("
	else
		writelog "Won't use dnbd3 as it's not loaded, or the daemon is not running..."
	fi
else
	writelog "Won't use dnbd3 as no servers are given in config"
fi
[ -z "$vm_diskfile" ] && vm_diskfile="$vmpath"
writelog "Used diskfile: $vm_diskfile"

# Get all virtual machine specific stuff from the respective include file
if [ -e /opt/openslx/etc/"${xmlvirt}"/run-virt.include ] ; then
	self="${xmlvirt}"
	. /opt/openslx/etc/"${xmlvirt}"/run-virt.include
	# start a windowmanager for easier handling
	# (expect problems /w windows opening in background /w vmware without wm)
	for dm in twm xfwm4 metacity openbox blackbox kwin fvwm2 ; do
		if which $dm >/dev/null 2>&1 ; then
			if [ "$dm" = "fvwm2" ] ; then
				echo "EdgeScroll 0 0" > ${redodir}/fvwm
				fvwm2 -f ${redodir}/fvwm >/dev/null 2>&1 &
			else
				$dm >/dev/null 2>&1 &
			fi
			break
		fi
	done
	# Start poolvideoswitch if we find the autostarter file
	#if [ -e /etc/xdg/autostart/pvsgui.desktop ]; then
	#  /usr/local/bin/pvsgui -p 2 -b >/dev/null 2>&1 &
	#fi
	if [[ "$DO_PROFILE" -ge "1" ]]; then
		wget "http://132.230.8.113/profile/do.php?action=start"
	fi
	eval ${VIRTCMD} ${VIRTCMDOPTS}
	writelog "Bye."
	
	# Postrun for commands after virtualization finishes
	if [ -n "${POSTRUN}" ]; then
		eval ${POSTRUN}  >/dev/null 2>&1
	fi

	# Disconnect dnbd3 device
	if [ -n "$dnbd3" ]; then
		for timeout in 1 1 2; do
			dnbd3-client -c "$dnbd3" && break
			writelog "dnbd3 still busy...."
			sleep "$timeout"
		done
	fi
	# Postrun for commands after virtualization finishes
    if [ -n "${POSTRUN}" ]; then
	    eval ${POSTRUN} >/dev/null 2>&1
    fi

    # Kill LPD
    kill $PID_LPD

	cleanexit 0
else
	writelog "Failed because of missing ${xmlvirt} plugin."
	cleanexit 1
fi



cleanexit 0
exit 0