#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_event.sh 1.2 
#  
# Licensed Materials - Property of IBM 
#  
# Restricted Materials of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2012,2013 
# All Rights Reserved 
#  
# US Government Users Restricted Rights - Use, duplication or 
# disclosure restricted by GSA ADP Schedule Contract with IBM Corp. 
#  
# IBM_PROLOG_END_TAG 

#================================================
# The following, commented line enforces coding
# standards when this file is edited via vim.
#================================================
# vim:tabstop=4:shiftwidth=4:expandtab:smarttab
#================================================

# Start of POD-formatted documentation. Viewing suggestions:
#      perldoc <FILENAME>
#      pod2text -c <FILENAME>
#      pod2text -c --code <FILENAME>
#      pod2html <FILENAME>
function devDoc {
    : <<'=cut' >/dev/null 2>&1

=head1 NAME

 KLIB_HACMP_add_event

=head1 VERSION

 Version Number:  1.2
 Last Extracted:  1/31/14 04:42:01
 Last Changed:    5/8/13 14:25:05

 Path, Component, Release(, Level):
 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_event.sh, hacmp.assist, 61haes_r714

=head1 SYNOPSIS

 clmgr add event <event> \
             FILE=<EXECUTABLE_FILE> \
             [ DESCRIPTION=<EVENT_DESCRIPTION> ]

 NOTE: an alias for "event" is "ev".

=head1 DESCRIPTION

Attempts to configure a new, custom cluster event in the
cluster configuration.

=head1 ARGUMENTS

 1. properties [REQUIRED] [hash ref]
    An associative array within which data about the
    created object can be returned to the caller.

 2. event [REQUIRED] [string]
    The label that is to be applied to this event.

 3. file [REQUIRED] [string]
    The executable file for this event.

 4. description [OPTIONAL] [string]
    A description of the event. If not description is
    specified, a default will be provided.

=head1 RETURN

 0: no errors were detected; the operation appears to have been successful
 1: a general error has occurred
 2: a specified resource does not exist, or could not be found
 3: some required input was missing
 4: some detected input was incorrect in some way
 5: a required dependency does not exist
 6: a specified search failed to match any data

=head1 COPYRIGHT

COPYRIGHT International Business Machines Corp. 2005,2010
All Rights Reserved

=cut
} # End of POD-formatted documentation.


function KLIB_HACMP_add_event {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.2, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_event.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset -n properties=$1
    typeset event=${2//\"/}
    typeset file=${3//\"/}
    typeset description=${4//\"/}

    [[ $CLMGR_LOGGING == 'med' ]] && set +x  # Only trace param values

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN

    typeset existing
    CL=$LINENO KLIB_HACMP_list_events existing 2>>$CLMGR_TMPLOG

    #=================
    : Validate input
    #=================
    if [[ -z $event ]]; then
        CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 100 '\nERROR: a name/label must be provided.\n\n' 1>&2
        rc=$RC_MISSING_INPUT

    elif [[ " ${existing[*]} " == *\ $event\ * ]]; then
        CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 229 '\nERROR: the specified object already exists: "%1$s"\n\n' "$event" 1>&2
        rc=$RC_INCORRECT_INPUT
    fi

    if [[ -z $file ]]; then
        CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 101 '\nERROR: this operation requires the "%1$s" attribute.\n\n' FILE 1>&2
        rc=$RC_MISSING_INPUT
    else
        if [[ $file != /* ]]; then
            CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 106 '\nERROR: the specified path does not appear to be in absolute format:\n%1$s\n\n' "$file" 1>&2
            rc=$RC_INCORRECT_INPUT
        fi

        if [[ ! -e $file ]]; then
            CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 107 '\nERROR: the specified path/file does not appear to exist on "%2$s": %1$s\n\n' "$file" "$LOCAL_NODE" 1>&2
            rc=$RC_NOT_FOUND
        fi

        if [[ $file == *[[:space:]]* ]]; then
            CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 108 "\nERROR: the \"%1\$s\" attribute's value contains whitespace, which is not allowed: \"%2\$s\"\n\n" FILE "$file" 1>&2
            rc=$RC_INCORRECT_INPUT
        fi
    fi

    #=========================================================
    : Create the event if no input errors have been detected
    #=========================================================
    if (( $rc == RC_UNKNOWN )); then
        [[ -z $description ]] && description="$event, running $file."

        print -- "$0()[$LINENO]($SECONDS): $HAUTILS/claddcustom -t event -n \"$event\" -I \"$description\" -v \"$file\"" >>$CLMGR_TMPLOG  # Always log commands
        $HAUTILS/claddcustom -t event \
                             -n "$event" \
                             -I "$description" \
                             -v "$file"
        rc=$?
        print "claddcustom RC: $rc" >>$CLMGR_TMPLOG  # Always log command result

        if (( $rc != RC_SUCCESS )); then
            CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 201 '\nERROR: failed to create "%1$s".\n\n' "$event" 1>&2
            rc=$RC_ERROR
        fi

        #===========================================================
        : If output from this operation was requested, retrieve it
        #===========================================================
        if (( $rc == RC_SUCCESS )); then
            if (( CLMGR_VERBOSE )) || [[ -n $CLMGR_ATTRS ]]; then
                CL=$LINENO KLIB_HACMP_get_event_attributes "$event" properties
            fi
        fi
    fi

    #=======================================================================
    : If a user input error was detected, provide some helpful suggestions
    #=======================================================================
    if (( $rc == RC_MISSING_INPUT || $rc == RC_INCORRECT_INPUT )) && \
       [[ $CLMGR_GUI == *([[:space:]]) ]]
    then
        CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 104 "For more information about available options and syntax, try\n\"$HAUTILS/clmgr %1\$s\". As an\nalternative, if the PowerHA SystemMirror man pages have been installed, invoke\n\"$HAUTILS/clmgr -hv\" (or \"/usr/bin/man clmgr\"),\nsearching for \"%2\$s\" in the displayed text.\n\n" \
        "add event -h" "EVENT:" "$CLMGR_PROGNAME" 1>&2
    fi

    log_return_msg "$rc" "$0()" "$LINENO"
    return $?
} # End of "KLIB_HACMP_add_event()"