#!/bin/ksh93
#  ALTRAN_PROLOG_BEGIN_TAG                                                    
#  This is an automatically generated prolog.                                  
#                                                                              
#  Copyright (C) Altran ACT S.A.S. 2017,2021.  All rights reserved.  
#                                                                              
#  ALTRAN_PROLOG_END_TAG                                                      
#                                                                              
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_verify_methods.sh 1.2 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2010 
# 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 
# @(#)96	1.2  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_verify_methods.sh, hacmp.assist, 61haes_r714 6/11/12 09:50:18

# 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_verify_methods

=head1 VERSION

 Version Number:  1.2
 Last Extracted:  1/31/14 04:41:15
 Last Changed:    6/11/12 09:50:18

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

=head1 SYNOPSIS

 clmgr verify methods <method>

=head1 DESCRIPTION

 Verifies that the specified method will be executed when
 any of its registered events occur.

=head1 ARGUMENTS

 1. method [REQUIRED] [string]
    The method to be tested.

=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_verify_methods {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.2, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_verify_methods.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset method=${1//\"/}
    shift

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

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

    #=====================
    : Validate the input
    #=====================
    if [[ -z $method ]]; then
        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 100 "\nERROR: a name/label must be provided.\n\n" 1>&2
        rc=$RC_MISSING_INPUT
    fi

    if (( $rc == RC_UNKNOWN )); then
        typeset type=
        CL=$LINENO KLIB_HACMP_is_known_method $method type
        if (( $? == RC_SUCCESS )); then
            if [[ $type != *notify* ]]; then
                /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 1170 "\nMethod \"%1\$s\" is not a \"notify\" method.\n\n" "$method" 1>&2
            fi
        else
            rc=$RC_NOT_FOUND

            /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 102 "\nERROR: \"%1\$s\" does not appear to exist!\n\n" "$method" 1>&2
            /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 149 "Available Methods:\n\n" 1>&2

            typeset available
            CL=$LINENO KLIB_HACMP_list_methods available
            for (( i=0; i<${#available[*]}; i++ )); do
                if [[ ${available[$i]} != *([[:space:]]) ]]; then
                    print -u2 "\t${available[$i]}"
                fi
            done
            print -u2 ""
        fi
    fi

    #===========================================================
    : Verify the methods if no input errors have been detected
    #===========================================================
    if (( $rc == RC_UNKNOWN )); then
        typeset -A attrs
        CL=$LINENO KLIB_HACMP_get_method_attributes $method attrs
        typeset EVENTS=
        for key in ${!attrs[*]}; do
            if [[ $key == EVENTS* ]]; then
                for event in ${attrs[$key]}; do
                    if [[ " $EVENTS " != *\ $event\ * ]]; then
                        EVENTS="$EVENTS $event"
                    fi
                done
            fi
        done

        for event in $EVENTS; do
            /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 139 "Verifying with event \"%1\$s\"...\n" "$event"
            print "$0()[$LINENO]($SECONDS): $HAUTILS/clissuepage \"$event\"" >>$CLMGR_TMPLOG  # Always log commands
            $HAUTILS/clissuepage "$event"
            rc=$?
            print "clissuepage RC: $rc" >>$CLMGR_TMPLOG  # Always log command result
            (( $rc != RC_SUCCESS )) && rc=$RC_ERROR
        done
    fi

    (( $rc == RC_UNKNOWN )) && rc=$RC_SUCCESS

    #=======================================================================
    : If a user input error was detected, provide some helpful suggestions
    #=======================================================================
    if (( $rc == RC_MISSING_INPUT || $rc == RC_INCORRECT_INPUT )) && \
       [[ $CLVT_GUI == *([[:space:]]) ]]
    then
        CL=$LINENO cl_dspmsg -s $CLVT_SET $CLVT_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" \
        "verify method -h" "METHOD:" "$CLVT_PROGNAME" 1>&2
    fi

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