trac/doxygen/response__print_8h_source.html

 /*

  * Author : GÃ©rald FENOY

  *

  * Copyright (c) 2009-2013 GeoLabs SARL

  *

  * Permission is hereby granted, free of charge, to any person obtaining a copy

  * of this software and associated documentation files (the "Software"), to deal

  * in the Software without restriction, including without limitation the rights

  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  * copies of the Software, and to permit persons to whom the Software is

  * furnished to do so, subject to the following conditions:

  *

  * The above copyright notice and this permission notice shall be included in

  * all copies or substantial portions of the Software.

  *

  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

  * THE SOFTWARE.

  */


 #ifndef ZOO_RESPONSE_PRINT_H

 #define ZOO_RESPONSE_PRINT_H 1


 #pragma once


 #define DEFAULT_SERVICE_URL "http://www.zoo-project.org/"


 #define TIME_SIZE 40


 #include <libintl.h>

 #include <locale.h>


 #define _(String) dgettext ("zoo-kernel",String)


 #define _ss(String) dgettext ("zoo-services",String)


 #define ZOO_LOCK_CREATE_FAILED -4


 #define ZOO_LOCK_ACQUIRE_FAILED -5


 #define ZOO_LOCK_RELEASE_FAILED -6


 #include <sys/stat.h>

 #include <sys/types.h>

 #ifndef WIN32

 #include <sys/ipc.h>

 #include <sys/shm.h>

 #include <sys/sem.h>

 #else

 #include <direct.h>

 #endif

 #include <stdio.h>

 #include <time.h>

 #include <ctype.h>

 #ifdef WIN32

 #ifndef USE_RUBY

 #include <unistd.h>

 #endif

 #endif

 #ifndef WIN32

 //#include <locale.h>

 #include <locale.h> // knut: this appears to be a non-standard header file that has been removed in newer versions of glibc; it may be sufficient to include <locale.h> (see above)

 #endif


 #include "service.h"

 #include <openssl/sha.h>

 #include <openssl/md5.h>

 #include <openssl/hmac.h>

 #include <openssl/evp.h>

 #include <openssl/bio.h>

 #include <openssl/buffer.h>


 #include <libxml/parser.h>

 #include <libxml/xpath.h>

 #include "cgic.h"


 #ifdef __cplusplus

 extern "C" {

 #endif


 #define ZOO_NS_MAX 10


 #define ZOO_DOC_MAX 20


   static char* SERVICE_URL;


   static xmlNsPtr usedNs[ZOO_NS_MAX];

   static char* nsName[ZOO_NS_MAX];

   static int nbNs=0;

   static xmlDocPtr iDocs[ZOO_DOC_MAX];

   static int nbDocs=0;


   static char wpsStatus[3][11]={

     "Succeeded",

     "Failed",

     "Running"

   };

   static const char* schemas[2][8]={

     {"1.0.0","http://www.opengis.net/ows/1.1","http://www.opengis.net/wps/1.0.0","http://schemas.opengis.net/wps/1.0.0","%s %s/wps%s_response.xsd","http://schemas.opengis.net/ows/1.1.0/owsExceptionReport.xsd","1.1.0"},

     {"2.0.0","http://www.opengis.net/ows/2.0","http://www.opengis.net/wps/2.0","http://schemas.opengis.net/wps/2.0","http://www.opengis.net/wps/2.0 http://schemas.opengis.net/wps/2.0/wps.xsd","http://schemas.opengis.net/ows/2.0/owsExceptionReport.xsd","2.0.2","http://www.opengis.net/spec/wps/2.0/def/process-profile/"},

   };

   static int nbSupportedRequests=7;

   static const char* requests[2][7]={

     {"GetCapabilities","DescribeProcess","Execute",NULL},

     {"GetCapabilities","DescribeProcess","Execute","GetStatus","GetResult","Dismiss",NULL},

   };

   static int nbReqIdentifier=2;

   static int nbReqJob=3;

   static const char* root_nodes[2][4]={

     {"ProcessOfferings","ProcessDescriptions","ExecuteResponse",NULL},

     {"Contents","ProcessOfferings","Result",NULL}

   };


   static const char* capabilities[2][7]={

     {

       "Process",

       "processVersion","1",

       "storeSupported","true",

       "statusSupported","true"

     },

     {

       "ProcessSummary",

       "processVersion","1.0.0",

       "jobControlOptions","sync-execute async-execute dismiss",

       "outputTransmission","value reference"

     }

   };


   static const char* const aapccStatusCodes[][8] = {

     {

       "500 Not Implemented",

       "OperationNotSupported",

       "NoApplicableCode",

       NULL

     },

     {

       "400 Bad request",

       "MissingParameterValue"

       "InvalidParameterValue",

       "InvalidUpdateSequence",

       "OptionNotSupported",

       "VersionNegotiationFailed",

       "NoSuchMode",

       NULL

     },

     {

       "404 Not Found",

       "NotFound",

       "NoSuchProcess",

       "NoSuchJob",

       "ResultNotReady",

       NULL

     },

     {

       "500 Not Implemented",

       NULL

     }

   };


   void addLangAttr(xmlNodePtr,maps*);


   void printHeaders(maps*);

   void printSessionHeaders(maps*);


   int zooXmlSearchForNs(const char*);

   int zooXmlAddNs(xmlNodePtr,const char*,const char*);

   void zooXmlCleanupNs();


   int zooXmlAddDoc(xmlNodePtr,const char*,const char*);

   void zooXmlCleanupDocs();


   const char* produceStatusString(maps*,map*);

   void printExceptionReportResponse(maps*,map*);

   xmlNodePtr createExceptionReportNode(maps*,map*,int);

   void printProcessResponse(maps*,map*,int,service*,const char*,int,maps*,maps*);

   xmlNodePtr printWPSHeader(xmlDocPtr,maps*,const char*,const char*,const char*,int);

   xmlNodePtr printGetCapabilitiesHeader(xmlDocPtr,maps*,const char*);

   void printGetCapabilitiesForProcess(registry*,maps*,void*,void*,service*);

   void printDescribeProcessForProcess(registry*,maps*,void*,void*,service*);

   void printFullDescription(xmlDocPtr,int,elements*,const char*,xmlNsPtr,xmlNsPtr,xmlNodePtr,int,int,const map*);

   void printDocument(maps*,xmlDocPtr,int);

   void printDescription(xmlNodePtr,xmlNsPtr,const char*,map*,int);

   void printIOType(xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,xmlNsPtr,elements*,maps*,const char*,int);

   void* printRawdataOutput(maps*,maps*);

   map* parseBoundingBox(const char*);

   void printBoundingBox(xmlNsPtr,xmlNodePtr,map*);

   void printBoundingBoxDocument(maps*,maps*,FILE*);

   void printOutputDefinitions(xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,elements*,maps*,const char*);

   void printStatusInfo(maps*,map*,char*);

   void addAdditionalParameters(map*,xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,int);

   void addMetadata(map*,xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,int);


   char* produceFileUrl(service*,maps*,maps*,const char*, int);

   void outputResponse(service*,maps*,maps*,map*,int,maps*,int);


   int errorException(maps *, const char *, const char *, const char*);


   xmlNodePtr soapEnvelope(maps*,xmlNodePtr);

   int checkForSoapEnvelope(xmlDocPtr);


 #ifdef __cplusplus

 }

 #endif


 #endif

ZOO_NS_MAX
#define ZOO_NS_MAX
Maximum number of XML namespaces.
Definition: response_print.h:104

printWPSHeader
xmlNodePtr printWPSHeader(xmlDocPtr, maps *, const char *, const char *, const char *, int)
Generate a WPS header.
Definition: response_print.c:343

zooXmlCleanupDocs
void zooXmlCleanupDocs()
Free allocated memort to store XML documents.
Definition: response_print.c:292

schemas
static const char * schemas[2][8]
Definitions of schemas depending on the WPS version.
Definition: response_print.h:147

zooXmlSearchForNs
int zooXmlSearchForNs(const char *)
Search for an existing XML namespace in usedNS.
Definition: response_print.c:214

iDocs
static xmlDocPtr iDocs[ZOO_DOC_MAX]
Array of xmlDocPtr storing XML docs.
Definition: response_print.h:130

printIOType
void printIOType(xmlDocPtr, xmlNodePtr, xmlNsPtr, xmlNsPtr, xmlNsPtr, elements *, maps *, const char *, int)
Generate XML nodes describing inputs or outputs metadata.
Definition: response_print.c:2262

parseBoundingBox
map * parseBoundingBox(const char *)
Parse a BoundingBox string.
Definition: response_print.c:3134

outputResponse
void outputResponse(service *, maps *, maps *, map *, int, maps *, int)
Generate the output response (RawDataOutput or ResponseDocument)
Definition: response_print.c:2850

errorException
int errorException(maps *, const char *, const char *, const char *)
Print an OWS ExceptionReport.
Definition: response_print.c:2720

printDescribeProcessForProcess
void printDescribeProcessForProcess(registry *, maps *, void *, void *, service *)
Generate a ProcessDescription node for a servie and add it to a given node.
Definition: response_print.c:1069

nbNs
static int nbNs
Number of XML namespaces.
Definition: response_print.h:126

produceStatusString
const char * produceStatusString(maps *, map *)
Produce the status string used in HTTP headers.
Definition: response_print.c:2542

usedNs
static xmlNsPtr usedNs[ZOO_NS_MAX]
Array of xmlNsPtr storing all used XML namespace.
Definition: response_print.h:118

zooXmlCleanupNs
void zooXmlCleanupNs()
Free allocated memory to store used XML namespace.
Definition: response_print.c:258

nbSupportedRequests
static int nbSupportedRequests
Definitions of support requests (depending on the WPS version)
Definition: response_print.h:154

printGetCapabilitiesForProcess
void printGetCapabilitiesForProcess(registry *, maps *, void *, void *, service *)
Generate a wps:Process node for a servie and add it to a given node.
Definition: response_print.c:706

addLangAttr
void addLangAttr(xmlNodePtr, maps *)
Add a land attribute to a XML node.
Definition: response_print.c:170

nbDocs
static int nbDocs
Number of XML docs.
Definition: response_print.h:134

addAdditionalParameters
void addAdditionalParameters(map *, xmlDocPtr, xmlNodePtr, xmlNsPtr, xmlNsPtr, int)
Add AdditionalParameters nodes to any existing node.
Definition: response_print.c:911

printFullDescription
void printFullDescription(xmlDocPtr, int, elements *, const char *, xmlNsPtr, xmlNsPtr, xmlNodePtr, int, int, const map *)
Generate the required XML tree for the detailled metadata information of inputs or outputs...
Definition: response_print.c:1188

checkForSoapEnvelope
int checkForSoapEnvelope(xmlDocPtr)

zooXmlAddNs
int zooXmlAddNs(xmlNodePtr, const char *, const char *)
Add an XML namespace to the usedNS if it was not already used.
Definition: response_print.c:233

requests
static const char * requests[2][7]
Definitions of requests depending on the WPS version.
Definition: response_print.h:158

printBoundingBoxDocument
void printBoundingBoxDocument(maps *, maps *, FILE *)
Print an ows:BoundingBox XML document.
Definition: response_print.c:3187

maps
linked list of map pointer
Definition: main_conf_read.y:292

capabilities
static const char * capabilities[2][7]
Name and corresponding attributes depending on the WPS version.
Definition: response_print.h:181

printOutputDefinitions
void printOutputDefinitions(xmlDocPtr, xmlNodePtr, xmlNsPtr, xmlNsPtr, elements *, maps *, const char *)
Print a XML document.
Definition: response_print.c:2218

printHeaders
void printHeaders(maps *)
Print the HTTP headers based on a map.
Definition: response_print.c:89

addMetadata
void addMetadata(map *, xmlDocPtr, xmlNodePtr, xmlNsPtr, xmlNsPtr, int)
Add a Metadata node to any existing node.
Definition: response_print.c:824

nbReqJob
static int nbReqJob
Definitions requests requiring jobid (only for WPS version 2.0.0)
Definition: response_print.h:169

map
KVP linked list.
Definition: service.h:244

wpsStatus
static char wpsStatus[3][11]
Definitions of acceptable final status.
Definition: response_print.h:139

printBoundingBox
void printBoundingBox(xmlNsPtr, xmlNodePtr, map *)
Create required XML nodes for boundingbox and update the current XML node.
Definition: response_print.c:3082

printDescription
void printDescription(xmlNodePtr, xmlNsPtr, const char *, map *, int)
Create XML node with basic ows metadata information (Identifier,Title,Abstract)
Definition: response_print.c:2509

SERVICE_URL
static char * SERVICE_URL
Global char* to store the serverAddress value of the [main] section.
Definition: response_print.h:113

produceFileUrl
char * produceFileUrl(service *, maps *, maps *, const char *, int)
Produce a copy file and the corresponding url in case it is required Please, free the returned ressou...
Definition: response_print.c:2746

service
Metadata information about a full Service.
Definition: main_conf_read.y:329

printProcessResponse
void printProcessResponse(maps *, map *, int, service *, const char *, int, maps *, maps *)
Generate a wps:Execute XML document.
Definition: response_print.c:1865

soapEnvelope
xmlNodePtr soapEnvelope(maps *, xmlNodePtr)
Generate a SOAP Envelope node when required (if the isSoap key of the [main] section is set to true)...
Definition: response_print.c:309

registry
Profile registry.
Definition: main_conf_read.y:349

printDocument
void printDocument(maps *, xmlDocPtr, int)
Print a XML document.
Definition: response_print.c:2183

service.h

ZOO_DOC_MAX
#define ZOO_DOC_MAX
Maximum number of XML docs.
Definition: response_print.h:108

printExceptionReportResponse
void printExceptionReportResponse(maps *, map *)
Print an OWS ExceptionReport or exception.yaml Document and HTTP headers (when required) depending on...
Definition: response_print.c:2622

printSessionHeaders
void printSessionHeaders(maps *)
Print the Set-Cookie header if necessary (conf["lenv"]["cookie"]) and save the session file...
Definition: response_print.c:109

printGetCapabilitiesHeader
xmlNodePtr printGetCapabilitiesHeader(xmlDocPtr, maps *, const char *)
Generate a Capabilities header.
Definition: response_print.c:441

elements
Metadata information about input or output.
Definition: main_conf_read.y:314

aapccStatusCodes
static const char *const aapccStatusCodes[][8]
Definition: response_print.h:197

createExceptionReportNode
xmlNodePtr createExceptionReportNode(maps *, map *, int)
Create an OWS ExceptionReport Node.
Definition: response_print.c:2641

nbReqIdentifier
static int nbReqIdentifier
Definitions requests requiring identifier (depending on the WPS version)
Definition: response_print.h:165

nsName
static char * nsName[ZOO_NS_MAX]
Array storing names of the used XML namespace.
Definition: response_print.h:122

printStatusInfo
void printStatusInfo(maps *, map *, char *)
Print a StatusInfo XML document.
Definition: response_print.c:3251

zooXmlAddDoc
int zooXmlAddDoc(xmlNodePtr, const char *, const char *)

root_nodes
static const char * root_nodes[2][4]
Definitions of root node for response depending on the request and the WPS version.
Definition: response_print.h:173

printRawdataOutput
void * printRawdataOutput(maps *, maps *)
Print one outputs as raw.
Definition: response_print.c:3025