#!/bin/sh
#
# $Id: WAS.in,v 1.5 2002/03/23 23:39:42 alan Exp $
# 
# WAS
#
# Description:	Manages a Websphere Application Server as an HA resource
#
#
# Author:	Alan Robertson
# Support:	linux-ha-dev@lists.tummy.com
# License:	GNU Lesser General Public License (LGPL)
# Copyright:	(C) 2002 International Business Machines, Inc.
#
#
# An example usage in /etc/ha.d/haresources: 
#       node1  10.0.0.170 WAS::/opt/WebSphere/ApplicationServer/config/server-cfg.xml
#
# See usage() function below for more details...
#

prefix=/usr
exec_prefix=/usr
#. /etc/ha.d/shellfuncs
. /etc/ha.d/shellfuncs

#
WASDIR=/opt/WebSphere/AppServer
if
  [ ! -d $WASDIR ]
then
  WASDIR=/usr/WebSphere/AppServer
fi
STARTTIME=300	#	5 minutes
WGET=/usr/bin/wget
DEFAULT_WASPORTS="9080"
#
#
WASBIN=$WASDIR/bin
DEFAULT=$WASDIR/config/server-cfg.xml
unset LC_ALL; export LC_ALL
unset LANGUAGE; export LANGUAGE

#
#	Print usage message
#
usage() {
  methods=`WAS_methods | grep -v methods`
  methods=`echo $methods | tr ' ' '|'`
  cat <<-! >&1
	For the single server edition of WAS:
	usage: $0 <WAS-configuration file> ($methods)
	usage: $0 methods

	For the advanced edition of WAS:
	usage: $0 <WAS-(snoop)-port-number> ($methods)
	usage: $0 methods

	$0 manages a Websphere Application Server (WAS) as an HA resource

	The 'start' operation starts WAS.
	The 'stop' operation stops WAS.
	The 'status' operation reports whether WAS is running
	The 'monitor' operation reports whether the WAS seems to be working
		(httpd also needs to be working for this case)
	The 'methods' operation reports on the methods $0 supports

	This is known to work with the Single Server edition of Websphere,
	and is believed to work with the Advanced edition too.
	Since the Advanced Edition has no configuration file (it's in a the
	database) you need to give a port number instead of a
	configuration file for this config parameter.

	The default configuration file for the single server edition is:
	$DEFAULT

	The default snoop-port for the advanced edition is: $DEFAULT_WASPORTS

	The start and stop operations must be run as root.

	The status operation will report a pid of "-" for the
	WAS root process using unless it is run as root.

	If you don't have xmllint on your system, parsing of WAS
	configuration files is very primitive.
	In this case, the port specification we need from the XML
	config file has to be on the same line as the
	first part of the <transports/> tag.

	We run servlet/snoop on the first transport port listed in
	the config file for the "monitor" operation.

	$Id: WAS.in,v 1.5 2002/03/23 23:39:42 alan Exp $
	!
  exit 1

}

#
#	Run:  Run a script, and log its output.
#
run() {
  output=`"$@" 2>&1`
  rc=$?
  output=`echo $output`
  if
    [ $rc -eq 0 ]
  then 
    if
      [ ! -z "$output" ]
    then
      ha_log "info: $output"
    fi
    return 0
  else
    if
      [ ! -z "$output" ]
    then
      ha_log "ERROR: $output"
    else
      ha_log "ERROR: command failed: $*"
    fi
    return $rc
  fi
}

#
#	Reformat the XML document in a sort of canonical form
#	if we can.  If we don't have xmllint, we just cat it out
#	and hope for the best ;-)
#
xmlcat() {
  if
    [ "X$XMLcat" == X ]
  then
    XMLcat=`which xmllint 2>/dev/null`
    if
      [ "X${XMLcat}" == X  -o ! -x "${XMLcat}" ]
    then
      XMLcat=cat
    else
      XMLcat="$XMLcat --recover --format"
    fi
  fi
  for j in "$@"
  do
    ${XMLcat} "$j"
  done
}

#
#This is a bit skanky, but it works anyway...
#
#<transports xmi:type="applicationserver:HTTPTransport" xmi:id="HttpTransport_1" hostname="*" port="9080"/>
#<transports xmi:type="applicationserver:HTTPTransport" xmi:id="HttpTransport_2" hostname="*" port="9443" sslEnabled="true"/>
#<transports xmi:type="applicationserver:HTTPTransport" xmi:id="HttpTransport_3" hostname="*" port="9090" external="false"/>
#
# It's not really skanky if we can find xmllint on the system, because it
# reformats tags so they are all on one line, which is all we we need...
#

#
# Get the numbers of the ports WAS should be listening on...
#
# If we don't have xmllint around, then the applicationserver and the
# port= specification have to be on the same line in the XML config file.
#
GetWASPorts() {
  case $1 in
    [0-9]*)	echo "$1" | tr ',' '\012';;
    *)	
	xmlcat $1 | grep -i 'transports.*applicationserver:HTTPTransport' |
	grep port= 				|
	sed -e 's%.*port= *"* *%%'		\
		-e 's%[^0-9][^0-9]*.*$%%'
	# Delete up to port=, throw away optional quote and optional
	#	white space.
	# Throw away everything after the first non-digit.
	# This should leave us the port number all by itself...
  esac
}

#
#	We assume that the first port listed in the <transports/>
#	is the one we should run servlet/snoop on.
#
GetWASSnoopPort() {
	GetWASPorts "$@" | head -n1
}

#
#	Return information on the processname/id for the WAS ports
#
#	pid/java	is the expected output.  Several lines, one per port...
#
#
WASPortInfo() {
  pat=""
  once=yes
  PortCount=0
  for j in $*
  do
    case $pat in
      "")	pat="$j";;
      *)	pat="$pat|$j";;
    esac
    PortCount=`expr $PortCount + 1`
  done
  netstat -ltnp  2>/dev/null| egrep -i "($pat) .*LISTEN" | sed 's%.*LISTEN *%%'
}

#
#	Return the number of WAS ports which are open
#
CheckWASPortsInUse() {
  count=`WASPortInfo "$@" | wc -l`
  echo $count
}

#
#	Return the pid(s) of the processes that have WAS ports open
#
WASPIDs() {
  WASPortInfo "$@" | sort -u | cut -f1 -d/
}

#
#	The version of ps that returns all processes and their (long) args
#	It's only used by WAS_procs, which isn't used for anything ;-)
#
ps_long() {
  ps axww
}


#
#	The total set of WAS processes (single server only)
#
WAS_procs() {
  ps_long | grep -i "config=$1"  | grep -i java | cut -d' ' -f1
}



#
# methods: What methods/operations do we support?
#
WAS_methods() {
  cat <<-!
	start
	stop
	status
	methods
	!
  if
    [ -f $WGET -a -x $WGET ]
  then
    echo monitor
  fi
}

#
#	Return WAS status (silently)
#
WAS_status() {
  WASPorts=`GetWASPorts $1`
  PortsInUse=`CheckWASPortsInUse $WASPorts`
  case $PortsInUse in
    0)	false;;
    *)	true;;
  esac
}

#
#	Report on WAS status to stdout...
#
WAS_report_status() {
  WASPorts=`GetWASPorts $1`
  PortCount=`echo $WASPorts | wc -w`
  PortCount=`echo $PortCount`
  PortsInUse=`CheckWASPortsInUse $WASPorts`
  case $PortsInUse in
    0)	echo "WAS: server $1 is stopped."; false;;
    *)
	pids=`WASPIDs $WASPorts`
	if
	  [ $PortsInUse -ge $PortCount ]
	then
    	  echo "WAS: server $1 is running (pid" $pids "et al)."
	else
    	  echo "WAS: server $1 is running (pid $pids et al) but not listening on all ports."
        fi
	true;;
  esac
}

#
#	Monitor WAS - does it really seem to be working?
#
#	For this we invoke the snoop applet via wget.
#
#	This is actually faster than WAS_status above...
#
WAS_monitor() {
  tmpfile=/tmp/$$.was-mon
  SnoopPort=`GetWASSnoopPort $1`
  output=`$WGET -nv -O$tmpfile  http://localhost:$SnoopPort/servlet/snoop 2>&1`
  rc=$?
  if
    [ $rc -eq 0 ]
  then
    if
      grep -i 'user-agent.*Wget' $tmpfile >/dev/null
    then
      : OK
    else
      ha_log "ERROR: WAS: $1: no user-agent from snoop application"
      rc=1
    fi
  else
    ha_log "ERROR: WAS: $1: wget failure: $output"
    rc=1
  fi
  rm -fr $tmpfile
  return $rc
}

#
#	Start WAS instance
#
WAS_start() {
# Launch Arguments:
#
#      -configFile      <configFile>
#      -nodeName        <nodeName>
#      -serverName      <serverName>
#      -oltEnabled
#      -oltHost         <hostname>
#      -oltPort         <port>
#      -debugEnabled
#      -jdwpPort        <port>
#      -debugSource     <sourcePath>
#      -serverTrace     <traceString>
#      -serverTraceFile <traceFile>
#      -script          [<scriptFile>]
#      -platform        <platformName>
#      -noExecute
#      -help
  if
    [ -x $WASBIN/startServer.sh ]
  then
    cmd="$WASBIN/startServer.sh -configFile $1"
  else
    cmd="$WASBIN/startupServer.sh"
  fi
    
  if
    run $cmd
  then
    if
      WAS_wait_4_start $STARTTIME "$@"
    then
      true
    else
      ha_log "ERROR: WAS server $1 did not start correctly"
    fi
  else
    false
  fi
}

#
#	Wait for WAS to actually start up.
#
#	It seems to take between 30 and 60 seconds for it to
#	start up on a trivial WAS instance.
#
WAS_wait_4_start() {
  max=$1
  retries=0
  shift
  while
    [ $retries -lt $max ]
  do
    if
      WAS_status "$@"
    then
      return 0
    else
      sleep 1
    fi
    retries=`expr $retries + 1`
  done
  WAS_status "$@"
}
  

#
#	Shut down WAS
#
WAS_stop() {
  # They don't return good return codes...
  # And, they seem to allow anyone to stop WAS (!)
  if
    [ -x $WASBIN/stopServer.sh ]
  then
    run $WASBIN/stopServer.sh -configFile $1
  else
    WASPorts=`GetWASPorts $1`
    kill `WASPIDs $WASPorts`
  fi
  if
    WAS_status $1
  then
    ha_log "ERROR: WAS: $1 did not stop correctly"
    false
  else
    true
  fi
}


#
#	'main' starts here...
#

if
  [ $# -eq 1 -a "methods" = "$1" ]
then
  WAS_methods
  exit $?
fi

#
#	Supply default configuration parameter(s)
#

if
  [ $# -eq 1 ]
then
  if
    [ -f $DEFAULT ]
  then
    set -- "$DEFAULT" "$@"
  else
    set -- "$DEFAULT_WASPORTS" "$@"
  fi
fi


if
  [ ! -f $1 ]
then
  case $1 in
    [0-9]*)	;;	# ignore port numbers...
    *)		ha_log "ERROR: WAS configuration file $1 does not exist!"
  		usage
  		exit 1;;
  esac
fi
  

# What kind of method was invoked?
case "$2" in

  start)	WAS_start $1
		exit $?;;

  stop)		WAS_stop $1
		exit $?;;

  status)	WAS_report_status $1
		exit $?;;

  monitor)	WAS_monitor $1
		exit $?;;

  methods)	WAS_methods
		exit $?;;
esac

usage