#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_log.sh 1.2 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 1990,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 
# @(#)41	1.2  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_log.sh, hacmp.assist, 61haes_r714 6/10/12 15:32:35

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

=head1 VERSION

 Version Number:  1.2
 Last Extracted:  1/31/14 04:41:48
 Last Changed:    6/10/12 15:32:35

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

=head1 SYNOPSIS

KLIB_HACMP_is_known_log

=head1 DESCRIPTION

Determines if the specified log is a recognized/known PowerHA log.

=head1 ARGUMENTS

 1. log [REQUIRED] [string]
    The name of the log to search for on this node.

 2. directory [OPTIONAL] [string]
    A reference to use for returning the current directory of
    the specified log file.

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

    typeset log=${1//\"/}
    [[ -n $2 ]] && typeset -n directory=$2

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

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

    #=================
    : Validate input
    #=================
    if [[ -z $log ]]; 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

    else
        print "$0()[$LINENO]($SECONDS): $HAUTILS/clodmget -q \"name=$log\" -f value HACMPlogs" >>$CLMGR_TMPLOG  # Always log commands
        $HAUTILS/clodmget -q "name=$log" -f value HACMPlogs |\
        while read line; do
            directory=${line//\"/}
            rc=$RC_SUCCESS
            break
        done

        (( $rc != RC_SUCCESS )) && rc=$RC_ERROR
        print "clodmget RC: $rc" >>$CLMGR_TMPLOG  # Always log command result
    fi

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