OSP Toolkit Code

/**************************************************************************
*** COPYRIGHT (c) 2002 by TransNexus, Inc.                              ***
***                                                                     ***
*** This software is property of TransNexus, Inc.                       ***
*** This software is freely available under license from TransNexus.    ***
*** The license terms and conditions for free use of this software by   ***
*** third parties are defined in the OSP Toolkit Software License       ***
*** Agreement (LICENSE.txt).  Any use of this software by third         ***
*** parties, which does not comply with the terms and conditions of the ***
*** OSP Toolkit Software License Agreement is prohibited without        ***
*** the prior, express, written consent of TransNexus, Inc.             ***
***                                                                     ***
*** Thank you for using the OSP ToolKit(TM).  Please report any bugs,   ***
*** suggestions or feedback to support@transnexus.com                   ***
***                                                                     ***
**************************************************************************/








/*
 * ospstatus.c - OSP status functions
 */

#include "osp.h"
#include "osperrno.h"
#include "osplist.h"
#include "ospxmldoc.h"
#include "ospxmlattr.h"
#include "ospxmlelem.h"
#include "ospmsgattr.h"
#include "ospmsgelem.h"
#include "ospmsg.h"
#include "ospstatus.h"


/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusNew() - create a new status object
 *-----------------------------------------------------------------------*/

OSPTSTATUS *                           /* returns ptr to status or null */
    OSPPStatusNew(void)
{
    OSPTSTATUS     *ospvStatus = OSPC_OSNULL;

    /* try to allocate the memory for the entire object */
    OSPM_MALLOC(ospvStatus, OSPTSTATUS,sizeof(*ospvStatus));
    if(ospvStatus!=OSPC_OSNULL)
    {
        /* !!!PS Initialize it */
        OSPM_MEMSET(ospvStatus, 0, sizeof(*ospvStatus));
        ospvStatus->ospmStatusDesc=OSPC_OSNULL;
    }
    return(ospvStatus);
}


/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusDelete() - destroy a status object
 *-----------------------------------------------------------------------*/
void                                  /* no return */
OSPPStatusDelete(
    OSPTSTATUS **ospvStatus            /* Status to destroy */
)
{
    if (*ospvStatus != OSPC_OSNULL)
    {
        if ((*ospvStatus)->ospmStatusDesc != OSPC_OSNULL ) 
        {
            OSPM_FREE((*ospvStatus)->ospmStatusDesc);
            (*ospvStatus)->ospmStatusDesc = OSPC_OSNULL;
        }
        OSPM_FREE(*ospvStatus);
        *ospvStatus = OSPC_OSNULL;
    }
}
/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusSetDesc() - set the status description
 *-----------------------------------------------------------------------*/
void                                  /* no return */
OSPPStatusSetDesc(
    OSPTSTATUS *ospvStatus,            /* Status to set */
    unsigned char *ospvDesc
)
{
    if (ospvStatus != OSPC_OSNULL) 
    {
        if (ospvStatus->ospmStatusDesc != OSPC_OSNULL)
        {
            OSPM_FREE(ospvStatus->ospmStatusDesc);
            ospvStatus->ospmStatusDesc = OSPC_OSNULL;
        }
        OSPM_MALLOC(ospvStatus->ospmStatusDesc, unsigned char, 
            strlen((const char *)ospvDesc)+1);
        if (ospvStatus->ospmStatusDesc != OSPC_OSNULL)
        {

            OSPM_MEMCPY((ospvStatus->ospmStatusDesc), 
                (const char *)(ospvDesc), strlen((const char *)ospvDesc)+1);
            ospvStatus->ospmHasDesc = OSPC_TRUE;
        }
    }
    return; 
}

#ifdef OSPC_DEBUG
/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusHasCode() - is the status code populated
 *-----------------------------------------------------------------------*/
unsigned                              /* return 1 or 0 */
OSPPStatusHasCode(
    OSPTSTATUS *ospvStatus            /* Status to check */
)
{
    unsigned hascode = OSPC_FALSE;

    if (ospvStatus != OSPC_OSNULL) 
    {
        hascode=ospvStatus->ospmHasCode;
    }
    return hascode; 
}

/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusGetCode() - get the status code
 *-----------------------------------------------------------------------*/
unsigned                              /* return code */
OSPPStatusGetCode(
    OSPTSTATUS *ospvStatus            /* Status to get */
)
{
    unsigned statuscode = 0;

    if((ospvStatus != OSPC_OSNULL)&&(ospvStatus->ospmHasCode))
    {
        statuscode = ospvStatus->ospmStatusCode;
    }
    return statuscode; 
}

#endif /* OSPC_DEBUG */

/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusFromElement() - create a status from an XML element
 *-----------------------------------------------------------------------*/
unsigned                          /* returns error code */
OSPPStatusFromElement(
    OSPTXMLELEM *ospvElem,        /* input is XML element */
    OSPTSTATUS  **ospvStatus      /* where to put status pointer */
)
{
    unsigned       ospvErrCode = OSPC_ERR_NO_ERROR;
    OSPTXMLELEM   *elem = OSPC_OSNULL;
    unsigned long temp = 0;

    if (ospvElem  == OSPC_OSNULL) 
    {
        ospvErrCode = OSPC_ERR_XML_NO_ELEMENT;
    }
    if (ospvStatus == OSPC_OSNULL) 
    {
        ospvErrCode = OSPC_ERR_DATA_NO_STATUS;
    }

#if 0
    assert(OSPPMsgGetElemPart(OSPPXMLElemGetName(ospvElem)) ==ospeElemStatus);
#endif

    /* create the Status structure */
    if (ospvErrCode == OSPC_ERR_NO_ERROR)
    {
        *ospvStatus = OSPPStatusNew();
        if (*ospvStatus == OSPC_OSNULL)
        {
            ospvErrCode = OSPC_ERR_DATA_NO_STATUS;
        }
    }

    if (ospvErrCode == OSPC_ERR_NO_ERROR) 
    {
        /*
         * The Status element should consist of several child
         * elements. We'll run through what's there and pick out
         * the information we need. First, though, let's zero out
         * the values that we expect to find.
         */
        for ( elem = (OSPTXMLELEM *)OSPPXMLElemFirstChild(ospvElem);
            (elem != (OSPTXMLELEM *)OSPC_OSNULL) && (ospvErrCode == OSPC_ERR_NO_ERROR);
            elem = (OSPTXMLELEM *)OSPPXMLElemNextChild(ospvElem, elem) )
        {
            switch (OSPPMsgGetElemPart(OSPPXMLElemGetName(elem)))
            {
                case ospeElemCode:
                ospvErrCode = OSPPMsgCodeFromElement(elem, &temp);
                OSPPStatusSetCode(*ospvStatus, temp);
                break;

                case ospeElemDesc:
                OSPPStatusSetDesc(*ospvStatus, (unsigned char *)OSPPXMLElemGetValue(elem));
                break;

                default:
                /*
                 * This is an element we don't understand. If it's
                 * critical, then we have to report an error.
                 * Otherwise we can ignore it.
                 */
                if (OSPPMsgElemIsCritical(elem))
                {
                    ospvErrCode = OSPC_ERR_XML_BAD_ELEMENT;
                }
                break;
            }
        }
    }
    return ospvErrCode;
}

/**/
/*-----------------------------------------------------------------------*
 * OSPPStatusSetCode() - set the status code
 *-----------------------------------------------------------------------*/
void                                  /* no return */
OSPPStatusSetCode(
    OSPTSTATUS *ospvStatus,           /* Status to set */
    unsigned   ospvCode
)
{
    if (ospvStatus != OSPC_OSNULL) 
    {
        ospvStatus->ospmStatusCode = ospvCode;
        ospvStatus->ospmHasCode=1;
    }
    return; 
}