xml-client.sh

#!/bin/bash
# 
VERSION="0.1.3"
#

#
# Help screen
#
function help_screen () {
    echo 
    echo "Usage: $(basename $0) [-hvd] --tpath /path/to/tmplates/ --request NAME --list VARIABLES"
    echo "  -h  --help              print this usage and exit"
    echo "  -v  --version           print version information and exit"
    echo "  -d                      Enable the debug output"
    echo "  -t  --tpath DIR         Directory containing the request templates "
    echo "                          default is the script path subdirectory xml_tmpl"
    echo "  -r  --request NAME      The name or the request to perform"
    echo "      --list              List the templates request variables and response variables"
    echo "                          When given without a request name, the available requests are listed"
    echo ""
    echo "VARIABLES can be set as environment variables or as arguments in the followiug format"
    echo "      NAME value          The variables can be passed to the script as arguments "
}



function errorout () {
    echo -e "$@" >&2
}

function echoout () {
    echo -e "$@"
}

function formatout () {
    FORMATOUT_FORMAT=$1
    shift
    printf "${FORMATOUT_FORMAT}" $@
}

function debugout () {
    # Send debug output when debug mode is enabled
    if [[ ${DEBUG} != 0 ]]; then
        echo -e "$@" >&2
    fi
}

OSTYPE=$(uname -s)

if [[ "${OSTYPE}" == "Darwin" ]]; then
    TEMPLATE_PATH="$(dirname $0)/xml_tmpl"
else
    TEMPLATE_PATH="$(dirname $(readlink -f $0))/xml_tmpl"
fi

DEBUG=0
while [ $# -gt 0 ]; do
    case $1 in
        # General parameter
        -h|--help)
            help_screen
            exit 0
            ;;

        -v|--version)
            echo 
            echo "`basename $0` version ${VERSION}"
            echo
            exit 0
            ;;

        -d)
            DEBUG=1
            shift 1
            ;;

        -t|--tpath)
            if [[ ! -z "$2" ]] && [[ -d "$2" ]]; then
                TEMPLATE_PATH=$2
            else
                echo "ERROR: Specified template directory '${TEMPLATE_PATH}' does not exist or is not a directory."
                help_screen
                exit 1
            fi
            shift 2
            ;;

        -r|--request)
            if [[ ! -z "$2" ]] && [[ -f "${TEMPLATE_PATH}/$2.xml" ]]; then
                REQUEST_NAME=$2
            else
                echo "ERROR: Specified template '${TEMPLATE_PATH}/$2.xml' or directory does not exist or is not a directory."
                help_screen
                exit 1
            fi
            shift 2
            ;;

        -l|--list)
            COMMAND="LIST"
            shift 1
            ;;

        # VARIABLES        
        *)
            if [[ "${1}" == "$(echo ${1} | egrep '^[A-Z_]+$')" ]] && [[ ! -z "$2" ]]; then
                export XMLSV_${1}=${2}
                shift 2
            else
                echo "ERROR: Unknown option '$1'"
                help_screen
                exit 1
                break
            fi
            ;;
    esac
done


# load the PAI configuration
. ${TEMPLATE_PATH}/_api.conf


#
# List available requests
#
if [[ "${COMMAND}" == "LIST" ]] && [[ -z "${REQUEST_NAME}" ]]; then
    find xml_tmpl/ -name *.xml | sed -Ee 's|^.*/([a-z_]+)\.xml|\1|'
    exit 0
fi


#
# List Request variables and response variables
#
if [[ "${COMMAND}" == "LIST" ]]; then
    if [[ -f "${TEMPLATE_PATH}/${REQUEST_NAME}.xml" ]]; then
        FIELDS=$(egrep '#[A-Z_]+#' ${TEMPLATE_PATH}/${REQUEST_NAME}.xml | sed -Ee 's/^.*#([A-Z_]+)#.*$/\1/')
        . ${TEMPLATE_PATH}/${REQUEST_NAME}.cfg

        echoout ""
        echoout "# ${REQUEST_NAME}"
        echoout ""
        echoout "## Request Variables"
        for F in ${FIELDS}; do
            echoout "* ${F}"
        done
        echoout ""
        echoout "## Response Variables"
        for F in ${RESULT_FIELDS}; do
            echoout "* $(echo ${F} | tr '[:lower:]' '[:upper:]') "
        done
        echoout ""
    else 
        errorout "Unknown request '${REQUEST_NAME}'."
        exit 1
    fi
    exit 0
fi

# Reading files
if [[ -f "${TEMPLATE_PATH}/${REQUEST_NAME}.xml" ]]; then
    FIELDS=$(egrep '#[A-Z_]+#' ${TEMPLATE_PATH}/${REQUEST_NAME}.xml | sed -Ee 's/^.*#([A-Z_]+)#.*$/\1/')
    . ${TEMPLATE_PATH}/${REQUEST_NAME}.cfg
    TMP_FILE=$(umask 077 && mktemp /tmp/xml.XXXXXXXXXX)
else 
    errorout "Request template could not be found."
    exit 1
fi

# Reading VARIABLES from the request file
FIELD_REPLACE=""
for F in ${FIELDS}; do
    SF="XMLSV_${F}"
    if [[ ! -z "${!SF}" ]]; then
        FIELD_REPLACE="${FIELD_REPLACE} -e s|#${F}#|${!SF}| "
    fi
done

# Replacing the variables with content ; Removing elements with NO variables value
sed ${FIELD_REPLACE} ${TEMPLATE_PATH}/${REQUEST_NAME}.xml | egrep -v "#[A-Z_]+#" >${TMP_FILE}


if [[ "${DEBUG}" == "1" ]]; then
    debugout "## REQUEST XML"
    cat ${TMP_FILE} >&2
    debugout -e "\n"
    DEBUG_OPTIONS=" -v "
else
    DEBUG_OPTIONS=""
fi

# Send XML request
RESPONSE_RAW=$(curl -sS -k ${DEBUG_OPTIONS} --header "Content-Type: text/xml;charset=UTF-8" --data @${TMP_FILE} ${XML_URL} | xmllint --format -)
if [[ "${DEBUG}" == "1" ]]; then
    debugout "## RESPONSE_RAW"
    debugout "${RESPONSE_RAW}"
    debugout -e "\n"
fi



# Check the response
OK_CHECK=$(echo ${RESPONSE_RAW} | grep "<\/${OK_FIELD_CHECK}>")
if [[ -z "${OK_CHECK}" ]]; then
    debugout "*** ERROR ***"
    for EF in ${ERROR_FIELDS}; do
        EF_VALUE=$(echo ${RESPONSE_RAW} | grep "<\/${EF}>" | sed -E "s/^.*<${EF}.*>(.*)<\/${EF}>.*$/\1/")
        echoout "$(echo ${EF} | tr '[:lower:]' '[:upper:]') ${EF_VALUE}"
    done
else
    debugout "*** SUCCESS ***"
    for RF in ${RESULT_FIELDS}; do
        RF_VALUE=$(echo ${RESPONSE_RAW} | grep "<\/${RF}>" | sed -E "s/^.*<${RF}.*>(.*)<\/${RF}>.*$/\1/")
        echoout "$(echo ${RF} | tr '[:lower:]' '[:upper:]') ${RF_VALUE}"
    done
fi
echo ""


rm ${TMP_FILE}