#!/bin/sh
#
#
#	Ping OCF RA that utilizes fping
#
# Copyright (c) 2011 Dan Urist <durist@ucar.edu>
# Derived from the ping RA by Andrew Beekhof
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it would be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# Further, this software is distributed without any warranty that it is
# free of the rightful claim of any third person regarding infringement
# or the like.  Any license provided herein, whether implied or
# otherwise, applies only to this software file.  Patent licenses, if
# any, provided herein do not apply to combinations of this program with
# other software, or any other product whatsoever.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write the Free Software Foundation,
# Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
#

#######################################################################
# Initialization:

. ${OCF_ROOT}/resource.d/heartbeat/.ocf-shellfuncs

#######################################################################

meta_data() {
	cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="fping">
<version>1.0</version>

<longdesc lang="en">
Every time the monitor action is run, this resource agent records (in the CIB) the current number of ping nodes the host can connect to; uses fping.
</longdesc>
<shortdesc lang="en">node connectivity</shortdesc>

<parameters>

<parameter name="pidfile" unique="0">
<longdesc lang="en">PID file</longdesc>
<shortdesc lang="en">PID file</shortdesc>
<content type="string" default="$HA_VARRUN/fping-${OCF_RESOURCE_INSTANCE}" />
</parameter>

<parameter name="dampen" unique="0">
<longdesc lang="en">
The time to wait (dampening) further changes occur
</longdesc>
<shortdesc lang="en">Dampening interval</shortdesc>
<content type="integer" default="5s"/>
</parameter>

<parameter name="name" unique="0">
<longdesc lang="en">
The name of the attributes to set.  This is the name to be used in the constraints.
</longdesc>
<shortdesc lang="en">Attribute name</shortdesc>
<content type="string" default="${OCF_RESOURCE_INSTANCE}"/>
</parameter>

<parameter name="multiplier" unique="0">
<longdesc lang="en">
The number by which to multiply the number of connected ping nodes by
</longdesc>
<shortdesc lang="en">Value multiplier</shortdesc>
<content type="integer" default="1"/>
</parameter>

<parameter name="host_list" unique="0">
<longdesc lang="en">
The list of ping nodes to count.  Defaults to all configured ping nodes.  Rarely needs to be specified.
</longdesc>
<shortdesc lang="en">Host list</shortdesc>
<content type="string" default=""/>
</parameter>

<parameter name="attempts" unique="0">
<longdesc lang="en">
Number of ping attempts, per host, before declaring it dead
</longdesc>
<shortdesc lang="en">no. of ping attempts</shortdesc>
<content type="integer" default="3"/>
</parameter>

<parameter name="itimeout" unique="0">
<longdesc lang="en">
Initial target timeout in seconds. Successive timeouts are multiplied by the backoff factor.
</longdesc>
<shortdesc lang="en">initial ping timeout in seconds</shortdesc>
<content type="integer" default="1"/>
</parameter>

<parameter name="backoff" unique="0">
<longdesc lang="en">
Value by which the timeout is multiplied on each successive request. Should be specified as a floating point number (x.y).
</longdesc>
<shortdesc lang="en">backoff factor</shortdesc>
<content type="string" default="1.0"/>
</parameter>

<parameter name="options" unique="0">
<longdesc lang="en">
A catch all for any other options that need to be passed to fping.
</longdesc>
<shortdesc lang="en">Extra Options</shortdesc>
<content type="string" default=""/>
</parameter>

<parameter name="debug" unique="0">
<longdesc lang="en">
Enables to use default attrd_updater verbose logging on every call.
</longdesc>
<shortdesc lang="en">Verbose logging</shortdesc>
<content type="string" default="false"/>
</parameter>

</parameters>

<actions>
<action name="start"   timeout="60" />
<action name="stop"    timeout="20" />
<action name="reload"  timeout="100" />
<action name="monitor" depth="0"  timeout="60" interval="10"/>
<action name="meta-data"  timeout="5" />
<action name="validate-all"  timeout="30" />
</actions>
</resource-agent>
END
}

#######################################################################

ping_conditional_log() {
    level=$1; shift 
    if [ ${OCF_RESKEY_debug} = "true" ]; then
	ocf_log $level "$*"
    fi
}

ping_usage() {
	cat <<END
usage: $0 {start|stop|monitor|migrate_to|migrate_from|validate-all|meta-data}

Expects to have a fully populated OCF RA-compliant environment set.
END
}

ping_start() {
    ping_monitor
    if [ $? =  $OCF_SUCCESS ]; then
	return $OCF_SUCCESS
    fi
    touch ${OCF_RESKEY_pidfile}
    ping_update
}

ping_stop() {
    rm -f ${OCF_RESKEY_pidfile}
    attrd_updater -D -n $OCF_RESKEY_name -d $OCF_RESKEY_dampen $attrd_options
    return $OCF_SUCCESS
}

ping_monitor() {
    if [ -f ${OCF_RESKEY_pidfile} ]; then
	ping_update
	return $OCF_SUCCESS
    fi
    return $OCF_NOT_RUNNING
}

ping_validate() {
    
    # Is the state directory writable? 
    state_dir=`dirname "$OCF_RESKEY_pidfile"`
    touch "$state_dir/$$"
    if [ $? != 0 ]; then
	ocf_log err "Invalid location for 'state': $state_dir is not writable"
	return $OCF_ERR_ARGS
    fi
    rm "$state_dir/$$"

    # Pidfile better be an absolute path
    case $OCF_RESKEY_pidfile in
	/*) ;;
	*) ocf_log warn "You should use an absolute path for pidfile, not: '$OCF_RESKEY_pidfile'" ;;
    esac

    # Check the monitor interval
    if ocf_is_decimal "$OCF_RESKEY_CRM_meta_interval" && [ $OCF_RESKEY_CRM_meta_interval -gt 0 ]; then
    	:
    else
    	ocf_log err "Invalid monitor interval: '$OCF_RESKEY_CRM_meta_interval'. It should be a positive integer!"
    	exit $OCF_ERR_CONFIGURED
    fi

    # Check the host list
    if [ "x" = "x$OCF_RESKEY_host_list" ]; then 
	ocf_log err "Empty host_list.  Please specify some nodes to ping"
	exit $OCF_ERR_CONFIGURED
    fi

    check_binary fping

    return $OCF_SUCCESS
}

ping_update() {
    active=0
    f_out=$(tempfile)
    f_err=$(tempfile)

    itimeout=`expr $OCF_RESKEY_itimeout \* 1000`
    cmd="fping -r $OCF_RESKEY_attempts -t $itimeout -B $OCF_RESKEY_backoff $OCF_RESKEY_host_list"
    $cmd>$f_out 2>$f_err; rc=$?
    active=`grep alive $f_out|wc -l`

    case $rc in
 	0) 
	    ;;
 	1) 
	    for h in `grep unreachable $f_out | awk '{print $1}'`; do
		ping_conditional_log warn "$h is inactive"
	    done
	    ;;
 	*) 
	    ocf_log err "Unexpected result for '$cmd' $rc: `tr '\n' ';' < $f_err`"
	    ;;
    esac
    rm $f_out $f_err

    score=`expr $active \* $OCF_RESKEY_multiplier`
    attrd_updater -n $OCF_RESKEY_name -v $score -d $OCF_RESKEY_dampen $attrd_options
    rc=$?
    case $rc in 
	0) ping_conditional_log debug "Updated $OCF_RESKEY_name = $score" ;;
	*) ocf_log warn "Could not update $OCF_RESKEY_name = $score: rc=$rc";;
    esac
    return $rc
}

: ${OCF_RESKEY_name:="fping"}
: ${OCF_RESKEY_dampen:="5s"}
: ${OCF_RESKEY_attempts:="3"}
: ${OCF_RESKEY_multiplier:="1"}
: ${OCF_RESKEY_itimeout:="1"}
: ${OCF_RESKEY_backoff:="1.0"}
: ${OCF_RESKEY_debug:="false"}
: ${OCF_RESKEY_CRM_meta_timeout:="60"}
: ${OCF_RESKEY_CRM_meta_interval="10"}
: ${OCF_RESKEY_CRM_meta_globally_unique:="true"}

if [ ${OCF_RESKEY_CRM_meta_globally_unique} = "false" ]; then
    : ${OCF_RESKEY_pidfile:="$HA_VARRUN/fping-${OCF_RESKEY_name}"}
else 
    : ${OCF_RESKEY_pidfile:="$HA_VARRUN/fping-${OCF_RESOURCE_INSTANCE}"}
fi

attrd_options='-q'
if ocf_is_true ${OCF_RESKEY_debug} ; then
    attrd_options=''
fi

# Check the debug option    
case "${OCF_RESKEY_debug}" in
    true|True|TRUE|1)    
	OCF_RESKEY_debug=true
	;;
    false|False|FALSE|0) 
	OCF_RESKEY_debug=false
	;;
    *)
        ocf_log warn "Value for 'debug' is incorrect. Please specify 'true' or 'false' not: ${OCF_RESKEY_debug}"
	OCF_RESKEY_debug=false
	;;
esac

case $__OCF_ACTION in
    meta-data)	
	meta_data
	exit $OCF_SUCCESS
	;;
    start)		
	ping_start
	;;
    stop)		
	ping_stop
	;;
    monitor)	
	ping_monitor
	;;
    reload)		
	ping_start
	;;
    validate-all)	
	ping_validate
	;;
    usage|help)	
	ping_usage
	exit $OCF_SUCCESS
	;;
    *)		
	ping_usage
	exit $OCF_ERR_UNIMPLEMENTED
	;;
esac
exit $?