source: trunk/zoo-project/zoo-kernel/service.h @ 788

Last change on this file since 788 was 788, checked in by knut, 7 years ago

Implemented support for PHP 7: The Zend API for PHP 7/PHPNG is substantially different from older versions. Therefore, an alternative implementation of zoo_php_support is provided in the new source file service_internal_php7.c. Presently the Zoo kernel can be built with support for either PHP 7 or older versions, see the makefiles (for Windows) nmake.opt and makefile.vc. Other makefiles have not been updated.

Fixed problem with ambiguous symbol in service_conf.y. Fixed problem with conversion of line endings yielding extra bytes in _getStatusFile on Windows platforms. Removed call to free() stack memory in zoo_service_loader.c. Fixed issue with size of structs in service.h.

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/x-chdr
File size: 9.7 KB
RevLine 
[579]1/*
[1]2 * Author : Gérald FENOY
3 *
[576]4 * Copyright (c) 2009-2015 GeoLabs SARL
[1]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_SERVICE_H
26#define ZOO_SERVICE_H 1
27
28#pragma once
29
[216]30#ifdef WIN32
[680]31#define ZOO_DLL_EXPORT __declspec( dllexport )
32#else
33#define ZOO_DLL_EXPORT
34#endif
35
36#ifdef WIN32
[375]37#define strncasecmp _strnicmp
38#define strcasecmp _stricmp
[757]39#if defined(_MSC_VER) && _MSC_VER < 1900
40#define snprintf _snprintf
[453]41#endif
42#define zStrdup _strdup
43#define zMkdir _mkdir
44#define zOpen _open
45#define zWrite _write
[507]46#define zSleep Sleep
[514]47#include <sys/timeb.h>
48struct ztimeval {
49  long tv_sec; /* seconds */
50  long tv_usec; /* and microseconds */
51};
[554]52static int zGettimeofday(struct ztimeval* tp, void* tzp)
[514]53{
[554]54  if (tp == 0) {
55    return -1;
56  }
57 
[514]58  struct _timeb theTime;
59  _ftime(&theTime);
60  tp->tv_sec = theTime.time;
61  tp->tv_usec = theTime.millitm * 1000;
[554]62 
63  return 0; // The gettimeofday() function shall return 0 on success
[514]64}
[712]65
[379]66#else
[579]67/**
68 * The crossplatform strdup alias
69 */
[453]70#define zStrdup strdup
[579]71/**
72 * The crossplatform mkdir alias
73 */
[453]74#define zMkdir mkdir
[579]75/**
76 * The crossplatform open alias
77 */
[454]78#define zOpen open
[579]79/**
80 * The crossplatform write alias
81 */
[454]82#define zWrite write
[579]83/**
84 * The crossplatform sleep alias
85 */
[507]86#define zSleep sleep
[579]87/**
88 * The crossplatform gettimeofday alias
89 */
[514]90#define zGettimeofday gettimeofday
[579]91/**
92 * The crossplatform timeval alias
93 */
[514]94#define ztimeval timeval
[216]95#endif
96
[1]97#ifdef __cplusplus
98extern "C" {
99#endif
100
[444]101#ifdef WIN32
102#ifdef USE_MS
103#include <mapserver.h>
104#endif
105#endif
[1]106#include <stdlib.h>
107#include <ctype.h>
[712]108
[1]109#include <stdio.h>
[712]110
[1]111#include <string.h>
[364]112#ifndef WIN32
[618]113#include <ctype.h>
[767]114#include <stdbool.h>
[490]115#endif
[9]116
[579]117/**
118 * The global accepted status for a service
119 */
[1]120#define SERVICE_ACCEPTED 0
[579]121/**
122 * The global started status for a service
123 */
[1]124#define SERVICE_STARTED 1
[579]125/**
126 * The global paused status for a service
127 */
[1]128#define SERVICE_PAUSED 2
[579]129/**
130 * The global succeeded status for a service
131 */
[1]132#define SERVICE_SUCCEEDED 3
[579]133/**
134 * The global failed status for a service
135 */
[1]136#define SERVICE_FAILED 4
[9]137
[579]138/**
139 * The memory size to create an elements
140 */
[640]141#define ELEMENTS_SIZE (sizeof(char*)+(((2*sizeof(char*))+sizeof(maps*))*2)+sizeof(char*)+(((2*sizeof(char*))+sizeof(iotype*))*2)+(2*sizeof(elements*)))
[579]142/**
143 * The memory size to create a map
144 */
[788]145//#define MAP_SIZE (2*sizeof(char*))+sizeof(NULL) // knut: size of NULL pointer may be different from regular pointer (platform dependent)
146#define MAP_SIZE (2*sizeof(char*))+sizeof(map*)
[579]147/**
148 * The memory size to create an iotype
149 */
[788]150//#define IOTYPE_SIZE MAP_SIZE+sizeof(NULL)
151#define IOTYPE_SIZE sizeof(map*) + sizeof(iotype*)
[579]152/**
153 * The memory size to create a maps
154 */
[788]155//#define MAPS_SIZE (2*sizeof(char*))+sizeof(map*)+MAP_SIZE
156#define MAPS_SIZE sizeof(char*)+sizeof(map*)+sizeof(maps*)
[579]157/**
158 * The memory size to create a service
159 */
[788]160//#define SERVICE_SIZE (ELEMENTS_SIZE*2)+(MAP_SIZE*2)+sizeof(char*)
161#define SERVICE_SIZE sizeof(char*) + 2*sizeof(map*) + 2*sizeof(elements*)
[607]162/**
163 * The memory size to create a services
164 */
[788]165//#define SERVICES_SIZE SERVICE_SIZE+sizeof(services*)
166#define SERVICES_SIZE sizeof(service*)+sizeof(services*)
[607]167/**
168 * The memory size to create a registry
169 */
[788]170//#define REGISTRY_SIZE SERVICES_SIZE+sizeof(char*)
171#define REGISTRY_SIZE sizeof(char*)+sizeof(services*)+sizeof(registry*)
[1]172
[26]173#define SHMSZ     27
[1]174
[465]175#include "version.h"
[1]176
[375]177#ifdef DEBUG_STACK
178  void debugStack(const char* file,const int line){
179    int stack;
180    fprintf(stderr,"stack %p (%s: %d) \n",&stack,file,line);
181  }
182#endif
183
[9]184  /**
[579]185   * KVP linked list
[9]186   */
[1]187  typedef struct map{
[607]188    char* name; //!< the key
189    char* value; //!< the value
190    struct map* next; //!< the pointer to the next map if any or NULL
[1]191  } map;
192
193#ifdef WIN32
194#define NULLMAP ((map*) 0)
195#else
196#define NULLMAP NULL
197#endif
198
[114]199  /**
[579]200   * linked list of map pointer
[114]201   *
202   * Small object to store WPS KVP set.
203   */
204  typedef struct maps{
[607]205    char* name; //!< the maps name
206    struct map* content; //!< the content map
207    struct maps* next; //!< the pointer to the next maps if any or NULL
[114]208  } maps;
[601]209 
[579]210  /**
211   * Not named linked list
[114]212   *
[781]213   * Used to store information about formats, such as mimeType, encoding ...
[114]214   */
[1]215  typedef struct iotype{
[607]216    struct map* content; //!< the content map
217    struct iotype* next; //!< the pointer to the next iotype if any or NULL
[1]218  } iotype;
219
[114]220  /**
[579]221   * Metadata information about input or output.
[114]222   *
[781]223   * The elements are used to store metadata information defined in the ZCFG.
[114]224   */
[1]225  typedef struct elements{
[607]226    char* name; //!< the name
227    struct map* content; //!< the content map
228    struct map* metadata; //!< the metadata map
229    char* format; //!< the format: LiteralData or ComplexData or BoundingBoxData
230    struct iotype* defaults; //!< the default iotype
231    struct iotype* supported; //!< the supported iotype
[640]232    struct elements* child; //!< the pointer to the children element if any (or NULL)
[607]233    struct elements* next; //!< the pointer to the next element if any (or NULL)
[1]234  } elements;
235
[579]236  /**
[781]237   * Metadata information about a full Service.
[579]238   */
[1]239  typedef struct service{
[607]240    char* name; //!< the name
241    struct map* content; //!< the content map
242    struct map* metadata; //!< the metadata map
243    struct elements* inputs; //!< the inputs elements
244    struct elements* outputs; //!< the outputs elements
[1]245  } service;
246
[579]247  /**
[607]248   * Services chained list.
[579]249   */
[1]250  typedef struct services{
[607]251    struct service* content; //!< the content service pointer
252    struct services* next; //!< the pointer to the next services*
[1]253  } services;
254
[579]255  /**
[607]256   * Profile registry.
257   */
258  typedef struct registry{
259    char *name; //!< the name
260    struct services* content; //!< the content services pointer
261    struct registry* next; //!< the next registry pointer
262  } registry;
263
[680]264  ZOO_DLL_EXPORT void _dumpMap(map*);
265  ZOO_DLL_EXPORT void dumpMap(map*);
266  ZOO_DLL_EXPORT void dumpMaps(maps* m);
[682]267  ZOO_DLL_EXPORT void dumpMapToFile(map*,FILE*); // (used only internally)
268  ZOO_DLL_EXPORT void dumpMapsToFile(maps*,char*,int);
[680]269  ZOO_DLL_EXPORT map* createMap(const char*,const char*);
270  ZOO_DLL_EXPORT int count(map*);
271  ZOO_DLL_EXPORT bool hasKey(map*,const char*);
272  ZOO_DLL_EXPORT maps* getMaps(maps*,const char*);
273  ZOO_DLL_EXPORT map* getMap(map*,const char*);
274  ZOO_DLL_EXPORT map* getLastMap(map*);
275  ZOO_DLL_EXPORT map* getMapFromMaps(maps*,const char*,const char*);
276  ZOO_DLL_EXPORT void freeMap(map**);
277  ZOO_DLL_EXPORT void freeMaps(maps** mo);
[550]278 
279
[680]280  ZOO_DLL_EXPORT bool hasElement(elements*,const char*);
281  ZOO_DLL_EXPORT elements* getElements(elements*,char*);
282  ZOO_DLL_EXPORT void freeIOType(iotype**);
283  ZOO_DLL_EXPORT void freeElements(elements**);
284  ZOO_DLL_EXPORT void freeService(service**);
285  ZOO_DLL_EXPORT void addToMap(map*,const char*,const char*);
286  ZOO_DLL_EXPORT void addIntToMap(map*,const char*,const int);
[738]287  ZOO_DLL_EXPORT map* addToMapWithSize(map*,const char*,const char*,int);
[680]288  ZOO_DLL_EXPORT void addMapToMap(map**,map*);
289  ZOO_DLL_EXPORT void addMapToIoType(iotype**,map*);
290  ZOO_DLL_EXPORT map* getMapOrFill(map**,const char*,const char*);
291  ZOO_DLL_EXPORT bool contains(map*,map*);
292  ZOO_DLL_EXPORT iotype* getIoTypeFromElement(elements*,char*, map*);
293  ZOO_DLL_EXPORT void loadMapBinary(map**,map*,int);
294  ZOO_DLL_EXPORT void loadMapBinaries(map**,map*);
295  ZOO_DLL_EXPORT maps* dupMaps(maps**);
296  ZOO_DLL_EXPORT void addMapsToMaps(maps**,maps*);
297  ZOO_DLL_EXPORT map* getMapArray(map*,const char*,int);
298  ZOO_DLL_EXPORT void setMapArray(map*,const char*,int,const char*);
299  ZOO_DLL_EXPORT map* getMapType(map*);
300  ZOO_DLL_EXPORT int addMapsArrayToMaps(maps**,maps*,char*);
301  ZOO_DLL_EXPORT void setMapInMaps(maps*,const char*,const char*,const char*);
302  ZOO_DLL_EXPORT void dumpElements(elements*);
303  ZOO_DLL_EXPORT void dumpElementsAsYAML(elements*);
304  ZOO_DLL_EXPORT elements* dupElements(elements*);
305  ZOO_DLL_EXPORT void addToElements(elements**,elements*);
306  ZOO_DLL_EXPORT void dumpService(service*);
307  ZOO_DLL_EXPORT void dumpServiceAsYAML(service*);
308  ZOO_DLL_EXPORT service* dupService(service*);
309  ZOO_DLL_EXPORT void dumpRegistry(registry*);
310  ZOO_DLL_EXPORT bool addServiceToRegistry(registry**,char*,service*);
311  ZOO_DLL_EXPORT void freeRegistry(registry**);
312  ZOO_DLL_EXPORT service* getServiceFromRegistry(registry*,char*,char*);
313  ZOO_DLL_EXPORT void inheritMap(map**,map*);
314  ZOO_DLL_EXPORT void inheritIOType(iotype**,iotype*);
315  ZOO_DLL_EXPORT void inheritElements(elements**,elements*);
316  ZOO_DLL_EXPORT void inheritance(registry*,service**);
317  ZOO_DLL_EXPORT void mapsToCharXXX(maps*,char***);
318  ZOO_DLL_EXPORT void charxxxToMaps(char***,maps**);
[757]319#if defined(_MSC_VER) && _MSC_VER < 1800
[712]320  // snprintf for Visual Studio compiler;
321  // it is also used by services (e.g., GetStatus), therefore exported to shared library
322  ZOO_DLL_EXPORT int snprintf(char *buffer, size_t n, const char *format, ...);
[757]323#endif
[1]324#ifdef __cplusplus
325}
326#endif
327
328#endif
Note: See TracBrowser for help on using the repository browser.

Search

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