source: trunk/zoo-project/zoo-kernel/response_print.h @ 968

Last change on this file since 968 was 967, checked in by djay, 4 years ago

Add support for the two inputs / outputs syntaxes discussed in SWG in both the ZOO-Kernel and the HTML basic UI. Update documentation, add a section for the ZOO-API in Python language section. Rename variables in service.c to ease readabiliy.

  • Property svn:keywords set to Id
File size: 7.8 KB
Line 
1/*
2 * Author : Gérald FENOY
3 *
4 * Copyright (c) 2009-2013 GeoLabs SARL
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25#ifndef ZOO_RESPONSE_PRINT_H
26#define ZOO_RESPONSE_PRINT_H 1
27
28#pragma once
29
30/**
31 * The default service url (overriden by serverAddress)
32 */
33#define DEFAULT_SERVICE_URL "http://www.zoo-project.org/"
34/**
35 * The time size
36 */
37#define TIME_SIZE 40
38
39#include <libintl.h>
40#include <locale.h>
41
42/**
43 * ZOO-Kernel internal messages translation function
44 */
45#define _(String) dgettext ("zoo-kernel",String)
46/**
47 * ZOO-Services messages translation function
48 */
49#define _ss(String) dgettext ("zoo-services",String)
50
51/**
52 * ZOO-Kernel was unable to create a lock
53 */
54#define ZOO_LOCK_CREATE_FAILED -4
55/**
56 * ZOO-Kernel was unable to acquire a lock
57 */
58#define ZOO_LOCK_ACQUIRE_FAILED -5
59/**
60 * ZOO-Kernel was unable to release a lock
61 */
62#define ZOO_LOCK_RELEASE_FAILED -6
63
64#include <sys/stat.h>
65#include <sys/types.h>
66#ifndef WIN32
67#include <sys/ipc.h>
68#include <sys/shm.h>
69#include <sys/sem.h>
70#else
71#include <direct.h>
72#endif
73#include <stdio.h>
74#include <time.h>
75#include <ctype.h>
76#ifdef WIN32
77#ifndef USE_RUBY
78#include <unistd.h>
79#endif
80#endif
81#ifndef WIN32
82//#include <locale.h>
83#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)
84#endif
85
86#include "service.h"
87#include <openssl/sha.h>
88#include <openssl/md5.h>
89#include <openssl/hmac.h>
90#include <openssl/evp.h>
91#include <openssl/bio.h>
92#include <openssl/buffer.h>
93
94#include <libxml/parser.h>
95#include <libxml/xpath.h>
96#include "cgic.h"
97
98#ifdef __cplusplus
99extern "C" {
100#endif
101  /**
102   * Maximum number of XML namespaces
103   */
104#define ZOO_NS_MAX 10
105  /**
106   * Maximum number of XML docs
107   */
108#define ZOO_DOC_MAX 20
109
110  /**
111   * Global char* to store the serverAddress value of the [main] section
112   */
113  static char* SERVICE_URL;
114
115  /**
116   * Array of xmlNsPtr storing all used XML namespace
117   */
118  static xmlNsPtr usedNs[ZOO_NS_MAX];
119  /**
120   * Array storing names of the used XML namespace
121   */
122  static char* nsName[ZOO_NS_MAX];
123  /**
124   * Number of XML namespaces
125   */
126  static int nbNs=0;
127  /**
128   * Array of xmlDocPtr storing XML docs
129   */
130  static xmlDocPtr iDocs[ZOO_DOC_MAX];
131  /**
132   * Number of XML docs
133   */
134  static int nbDocs=0;
135
136  /**
137   * Definitions of acceptable final status
138   */
139  static char wpsStatus[3][11]={
140    "Succeeded",
141    "Failed",
142    "Running"
143  };
144  /**
145   * Definitions of schemas depending on the WPS version
146   */
147  static const char* schemas[2][8]={
148    {"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"},
149    {"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/"},
150  };
151  /**
152   * Definitions of support requests (depending on the WPS version)
153   */
154  static int nbSupportedRequests=7;
155  /**
156   * Definitions of requests depending on the WPS version
157   */
158  static const char* requests[2][7]={
159    {"GetCapabilities","DescribeProcess","Execute",NULL},
160    {"GetCapabilities","DescribeProcess","Execute","GetStatus","GetResult","Dismiss",NULL},
161  };
162  /**
163   * Definitions requests requiring identifier (depending on the WPS version)
164   */
165  static int nbReqIdentifier=2;
166  /**
167   * Definitions requests requiring jobid (only for WPS version 2.0.0)
168   */
169  static int nbReqJob=3;
170  /**
171   * Definitions of root node for response depending on the request and the WPS version
172   */
173  static const char* root_nodes[2][4]={
174    {"ProcessOfferings","ProcessDescriptions","ExecuteResponse",NULL},
175    {"Contents","ProcessOfferings","Result",NULL}
176  };
177
178  /**
179   * Name and corresponding attributes depending on the WPS version
180   */
181  static const char* capabilities[2][7]={
182    {
183      "Process",
184      "processVersion","1",
185      "storeSupported","true",
186      "statusSupported","true"
187    },
188    {
189      "ProcessSummary",
190      "processVersion","1.0.0",
191      "jobControlOptions","sync-execute async-execute dismiss",
192      "outputTransmission","value reference"
193    }
194  };
195
196
197  static const char* const aapccStatusCodes[][8] = {
198    {
199      "500 Not Implemented",
200      "OperationNotSupported",
201      "NoApplicableCode",
202      NULL
203    },
204    {
205      "400 Bad request",
206      "MissingParameterValue"
207      "InvalidParameterValue",
208      "InvalidUpdateSequence",
209      "OptionNotSupported",
210      "VersionNegotiationFailed",
211      "NoSuchMode",
212      NULL
213    },
214    {
215      "404 Not Found",
216      "NotFound",
217      "NoSuchProcess",
218      "NoSuchJob",
219      "ResultNotReady",
220      NULL
221    },
222    {
223      "500 Not Implemented",
224      NULL
225    }
226  };
227 
228  void addLangAttr(xmlNodePtr,maps*);
229
230  void printHeaders(maps*);
231  void printSessionHeaders(maps*);
232
233  int zooXmlSearchForNs(const char*);
234  int zooXmlAddNs(xmlNodePtr,const char*,const char*);
235  void zooXmlCleanupNs();
236
237  int zooXmlAddDoc(xmlNodePtr,const char*,const char*);
238  void zooXmlCleanupDocs();
239
240  const char* produceStatusString(maps*,map*);
241  void printExceptionReportResponse(maps*,map*);
242  xmlNodePtr createExceptionReportNode(maps*,map*,int);
243  void printProcessResponse(maps*,map*,int,service*,const char*,int,maps*,maps*);
244  xmlNodePtr printWPSHeader(xmlDocPtr,maps*,const char*,const char*,const char*,int);
245  xmlNodePtr printGetCapabilitiesHeader(xmlDocPtr,maps*,const char*);
246  void printGetCapabilitiesForProcess(registry*,maps*,void*,void*,service*);
247  void printDescribeProcessForProcess(registry*,maps*,void*,void*,service*);
248  void printFullDescription(xmlDocPtr,int,elements*,const char*,xmlNsPtr,xmlNsPtr,xmlNodePtr,int,int,const map*);
249  void printDocument(maps*,xmlDocPtr,int);
250  void printDescription(xmlNodePtr,xmlNsPtr,const char*,map*,int);
251  void printIOType(xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,xmlNsPtr,elements*,maps*,const char*,int);
252  void* printRawdataOutput(maps*,maps*);
253  map* parseBoundingBox(const char*);
254  void printBoundingBox(xmlNsPtr,xmlNodePtr,map*);
255  void printBoundingBoxDocument(maps*,maps*,FILE*);
256  void printOutputDefinitions(xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,elements*,maps*,const char*);
257  void printStatusInfo(maps*,map*,char*);
258  void addAdditionalParameters(map*,xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,int);
259  void addMetadata(map*,xmlDocPtr,xmlNodePtr,xmlNsPtr,xmlNsPtr,int);
260
261  char* produceFileUrl(service*,maps*,maps*,const char*, int);
262  void outputResponse(service*,maps*,maps*,map*,int,maps*,int);
263
264  int errorException(maps *, const char *, const char *, const char*);
265
266  xmlNodePtr soapEnvelope(maps*,xmlNodePtr);
267  int checkForSoapEnvelope(xmlDocPtr);
268 
269#ifdef __cplusplus
270}
271#endif
272
273#endif
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png