#!/bin/ksh93
#  ALTRAN_PROLOG_BEGIN_TAG
#  This is an automatically generated prolog.
#
#  Copyright (C) Altran ACT S.A.S. 2019,2021.  All rights reserved.
#
#  ALTRAN_PROLOG_END_TAG
#
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r721 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_methods.sh 1.6 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2010,2016 
# 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 
# @(#)  7d4c34b 43haes/lib/ksh93/hacmp/KLIB_HACMP_list_methods.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM

#============================================================================
#
# Name:        KLIB_HACMP_list_methods
#
# Description: This is the main, FPATH function that is invoked by clmgr
#              to collect method names. It uses the "cllscustom" and "cllspgr"
#              utilities to generate the list of names unless a search is
#              being conducted. In the case of a search, the associated FPATH
#              function, KLIB_HACMP_get_method_attributes is invoked in verbose
#              mode. The resulting data set is then passed through the
#              "search_properties()" function to arrive at a set of outputs
#              that matches the provided search parameters.
#
# Inputs:      See the "devDoc()" function at the bottom of this file.
#
# Outputs:     The list array is populated with one method per entry.
#              The only other outputs are any error messages that might
#              be needed.
#
# Returns:     Zero if no errors are detected. Otherwise, an appropriate
#              non-zero value is returned. Refer to the "RETURN" section
#              of the "devDoc()" function at the bottom of this file for
#              the standard return code values/meanings for clmgr.
#
#============================================================================
function KLIB_HACMP_list_methods {
    . $HALIBROOT/log_entry "$0()" "$CL"
    : version=@(#)  7d4c34b 43haes/lib/ksh93/hacmp/KLIB_HACMP_list_methods.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM
    : INPUTS: $*

    typeset -n list=$1
    shift

    [[ $1 != *=* ]] && typeset -u type=${1//\"/}

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

    #================================================================
    : Check for a defined cluster. No need to continue without one.
    #================================================================
    CL=$LINENO isClusterDefined
    if (( $? != RC_SUCCESS )); then
        log_return_msg "$RC_MISSING_DEPENDENCY" "$0()" "$LINENO"
        return $?
    fi

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -A queries
    typeset -u attr=
    typeset item= OUTPUT= value=
    typeset -i index=0 matches=0 rc=$RC_UNKNOWN

    #=================
    : Validate input
    #=================
    if [[ -n $type && $type != @(NO|SN|VE)* ]]; then
        dspmsg -s $CLMGR_SET $CLMGR_MSGS 110 '\nERROR: invalid value specified for "%1$s":  %2$s\n\n' TYPE "$type" 1>&2
        dspmsg -s $CLMGR_SET $CLMGR_MSGS 3 'Valid values: %1$s\n\n' "notify, snapshot, verify" 1>&2
        rc=$RC_INCORRECT_INPUT

    else
        #===================================================
        : Check for any specified attribute=value pairs.
        : If any are found, use those to query the output.
        #===================================================
        while (( $# > 0 )); do
            value="$1"
            if [[ $value == *=* ]]; then
                attr=${value%%=*}  # "attr" makes this uppercase
                queries[$attr]="${value#*=}"
            fi
            shift
        done

        if (( ${#queries[*]} == 0 )); then  # List all
            case "$type" in
                 NO*) if [[ -s $ODMDIR/HACMPpager ]]
                      then
                          print "$0()[$LINENO]($SECONDS): cllspgr" >>$CLMGR_TMPLOG  # Always log commands
                          cmd="cllspgr"
                          OUTPUT=$(cllspgr)
                      fi
                 ;;
                 SN*) if [[ -s $ODMDIR/HACMPcustom ]]
                      then
                          print "$0()[$LINENO]($SECONDS): cllscustom -t snapshot" >>$CLMGR_TMPLOG  # Always log commands
                          cmd="cllscustom"
                          OUTPUT=$(cllscustom -t snapshot)
                      fi
                 ;;
                 VE*) if [[ -s $ODMDIR/HACMPcustom ]]
                      then
                          print "$0()[$LINENO]($SECONDS): cllscustom -t verify" >>$CLMGR_TMPLOG  # Always log commands
                          cmd="cllscustom"
                          OUTPUT=$(cllscustom -t verify)
                      fi
                 ;;
                 *)   if [[ -s $ODMDIR/HACMPcustom ]]
                      then
                          print "$0()[$LINENO]($SECONDS): cllscustom" >>$CLMGR_TMPLOG  # Always log commands
                          cmd="cllscustom/cllspgr"
                          typeset name= rem=
                          cllscustom -c |\
                          while IFS=: read name type rem; do
                              if [[ $type == @(SN|VE)* ]]; then
                                  [[ -n $OUTPUT ]] && OUTPUT="$OUTPUT$NL"
                                  OUTPUT="$OUTPUT$name"
                              fi
                          done
                      fi

                      if [[ -s $ODMDIR/HACMPpager ]]
                      then
                          print "$0()[$LINENO]($SECONDS): cllspgr" >>$CLMGR_TMPLOG  # Always log commands
                          OUTPUT="$OUTPUT$NL$(cllspgr)"
                      fi
                  ;;
            esac
            rc=$?
            print "$0()[$LINENO]($SECONDS): $cmd RC: $rc; OUTPUT == \"$OUTPUT\"" >>$CLMGR_TMPLOG  # Always log command result

            if (( $rc == RC_SUCCESS )); then
                print -- "$OUTPUT" |\
                while read item; do
                    [[ $item == *([[:space:]])\#* ]] && continue
                    if [[ -n $item ]]; then
                        list[$index]=$item
                        (( index++ ))
                    fi
                done
            else
                rc=$RC_ERROR
            fi

        else  # A search was specified
            typeset -A allProperties
            CL=$LINENO CLMGR_VERBOSE=1 KLIB_HACMP_get_method_attributes "" allProperties
            CL=$LINENO search_properties queries allProperties
            rc=$?
            if (( $rc == RC_SUCCESS )); then
                for key in ${!allProperties[*]}; do
                    [[ $key != NAME@(|+([0-9])) ]] && continue
                    list[$index]=${allProperties[$key]}
                    (( index++ ))
                done
            fi
        fi
    fi

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


#============================================================================
#
# Name:        devDoc
#
# Description: This is a never-to-be-called, wrapper function that all the
#              clmgr FPATH functions implement in order to hide embedded
#              syntax from trace logging. This information is implemented
#              in POD format, and can be viewed in a number of ways using
#              POD tools. Some viewing suggestions for this function's POD-
#              formatted information are:
#
#                  perldoc <FILENAME>
#                  pod2text -c <FILENAME>
#                  pod2text -c --code <FILENAME>
#                  pod2html <FILENAME>
#
#              However, the more important use for this information is that
#              it is parsed by clmgr to display the syntax for this file's
#              operation. The information in the "SYNOPSIS" section is used
#              for this purpose. This feature was originally implemented
#              using the man page information. However, in a code review it
#              was pointed out that this approach had to be changed because
#              customers do not have to install the man pages! Therefore, a
#              built-in dependency on man page information would break the
#              automatic help feature of clmgr. So the SYNPOSIS section must
#              be used instead.
#
#              IMPORTANT: As a result of this, it is imperative that the
#                         information in this SYNOPSIS be kept in sync
#                         with the man page information, which is owned
#                         by the IDD team.
#
# Inputs:      None.
#
# Outputs:     None.
#
# Returns:     n/a (not intended to be invoked)
#
#============================================================================
function devDoc {
    : <<'=cut' >/dev/null 2>&1

=head1 NAME

 KLIB_HACMP_list_methods

=head1 VERSION

 Version Number:  1.6
 Last Extracted:  5/3/16 18:53:58
 Last Changed:    4/6/16 06:32:06

 Path, Component, Release(, Level):
 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_methods.sh, hacmp.assist, 61haes_r721, 1618A_hacmp721

=head1 SYNOPSIS

 clmgr query method \
             [ TYPE={notify|snapshot|verify} ]

 NOTE: the alias for "method" is "me".

=head1 DESCRIPTION

Displays the currently configured set of cluster snspshots.

=head1 ARGUMENTS

 1. list [REQUIRED] [hash ref]
    An associative array within which data about the
    queried objects can be returned to the caller.

 2. type {OPTIONAL] [string]
    The type of method to be queried.
    Valid values: {notify|snapshot|verify}

=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. 2010,2015
All Rights Reserved

=cut
} # End of "devDoc()"


#==============================================================================
# The following, comment block attempts to enforce coding standards when this
# file is edited via emacs or vim. This block _must_ appear at the very end
# of the file, or the editor will not find it, and it will be ignored.
#==============================================================================
# Local Variables:
# indent-tabs-mode: nil
# tab-width: 4
# End:
#==============================================================================
# vim: tabstop=4 shiftwidth=4 expandtab
#==============================================================================