#include "cpl_vsi.h"
#include "service_internal.h"
#include "service_callback.h"
#include "request_parser.h"
#include "caching.h"
#include "dirent.h"

Data Structures
union	semun
	arg for semctl system calls. More...

Macros
#define	_LARGEFILE64_SOURCE 1

#define	ERROR_MSG_MAX_LENGTH 1024

#define	MAX_RETRIES 10
	Number of time to try to access a semaphores set. More...

Functions
struct zooLock *	lockFile (maps conf, const char filename, const char mode)
	Lock a file for read, write and upload. More...

int	unlockFile (maps conf, struct zooLock s)
	Remove a lock. More...

char *	getStatusId (maps conf, char pid)
	Read the sid file attached of a service if any. More...

semid	acquireLock (maps *conf)
	Acquire the global lock. More...

char *	_getStatusFile (maps conf, char pid)
	Read the cache file of a running service. More...

char *	_getStatus (maps conf, char lid)
	Get the ongoing status of a running service. More...

void	unhandleStatus (maps *conf)
	Stop handling status repport. More...

int	_updateStatus (maps *conf)
	Update the current status of the running service. More...

int	getKeyValue (maps *conf)
	Set in the pre-allocated key the zoo_sem_[OSID] string where [OSID] is the lid (if any) or osid value from the [lenv] section. More...

int	getShmLockId (maps *conf, int nsems)
	Try to create or access a semaphore set. More...

int	removeShmLock (maps *conf, int nsems)
	Try to remove a semaphore set. More...

int	lockShm (int id)
	Lock a semaphore set. More...

int	unlockShm (int id)
	unLock a semaphore set. More...

char *	getStatus (int pid)
	Get the current status of the running service. More...

int	updateStatus (maps conf, const int percentCompleted, const char message)
	Update the status of an ongoing service. More...

char *	getInputValue (maps inputs, const char parameterName, size_t *numberOfBytes)
	Access an input value. More...

bool	validateVRT (maps pmsConf, const char pccVRTName)
	Validate that the VRT contains only allowed path. More...

char *	readVSIFile (maps conf, const char dataSource)
	Read a file using the GDAL VSI API. More...

int	setOutputValue (maps outputs, const char parameterName, char *data, size_t numberOfBytes)
	Set an output value. More...

char *	file_exists (const char dir, const char name)
	Check if file exists in specified folder. More...

char *	_getStatusField (maps conf, char a, const char *b)

bool	isAsyncCall (maps *pmsConf)
	Verify if an Execute request has been invoked asynchronously. More...

bool	hasDbs (maps *pmsConf)
	Verify if the server rely on database backend. More...

Data Structure Documentation

◆ semun

union semun

arg for semctl system calls.

Data Fields
ushort *	array	array for GETALL & SETALL
struct semid_ds *	buf	buffer for IPC_STAT & IPC_SET
int	val	value for SETVAL

Macro Definition Documentation

◆ _LARGEFILE64_SOURCE

#define _LARGEFILE64_SOURCE 1

◆ ERROR_MSG_MAX_LENGTH

#define ERROR_MSG_MAX_LENGTH 1024

◆ MAX_RETRIES

#define MAX_RETRIES 10

Number of time to try to access a semaphores set.

See also: getShmLockId

Function Documentation

◆ _getStatus()

char* _getStatus	(	maps *	conf,
		char *	lid
	)

Get the ongoing status of a running service.

Parameters

conf	the maps containing the setting of the main.cfg file
pid	the service identifier (usid key from the [lenv] section)

Returns: the reported status char* (MESSAGE|POURCENTAGE)

Warning: make sure to free resources returned by this function

◆ _getStatusField()

char* _getStatusField	(	maps *	conf,
		char *	a,
		const char *	b
	)

◆ _getStatusFile()

char* _getStatusFile	(	maps *	conf,
		char *	pid
	)

Read the cache file of a running service.

Parameters

conf	the maps containing the setting of the main.cfg file
pid	the service identifier (usid key from the [lenv] section)

Returns: the reported status char* (temporary/final result)

◆ _updateStatus()

int _updateStatus ( maps * conf )

Update the current status of the running service.

See also: acquireLock, lockShm

Parameters

conf	the map containing the setting of the main.cfg file

Returns: 0 on success, -2 if shmget failed, -1 if shmat failed

◆ acquireLock()

semid acquireLock ( maps * conf )

Acquire the global lock.

Parameters

conf	the maps containing the setting of the main.cfg file

Returns: a semid

◆ file_exists()

char* file_exists	(	const char *	dir,
		const char *	name
	)

Check if file exists in specified folder.

Parameters

dir	the folder in which to search for file
name	the name of the file (not full path)

Returns: a character string with the full path [dir/name], or NULL if the file does not exist

Attention: Caller is responsible for applying free() to the returned pointer

◆ getInputValue()

char* getInputValue	(	maps *	inputs,
		const char *	parameterName,
		size_t *	numberOfBytes
	)

Access an input value.

Parameters

inputs	the maps to search for the input value
parameterName	the input name to fetch the value
numberOfBytes	the resulting size of the value to add (for binary values), -1 for basic char* data

Returns: a pointer to the input value if found, NULL in other case.

◆ getKeyValue()

int getKeyValue ( maps * conf )

Set in the pre-allocated key the zoo_sem_[OSID] string where [OSID] is the lid (if any) or osid value from the [lenv] section.

Parameters

conf	the map containing the setting of the main.cfg file

◆ getShmLockId()

int getShmLockId	(	maps *	conf,
		int	nsems
	)

Try to create or access a semaphore set.

See also: getKeyValue

Parameters

conf	the map containing the setting of the main.cfg file
nsems	number of semaphores

Returns: a semaphores set indentifier on success, -1 in other case

◆ getStatus()

char* getStatus ( int pid )

Get the current status of the running service.

See also: getKeyValue, getShmLockId, lockShm

Parameters

pid	the semaphores

Returns: 0 on success, -2 if shmget failed, -1 if shmat failed

◆ getStatusId()

char* getStatusId	(	maps *	conf,
		char *	pid
	)

Read the sid file attached of a service if any.

Parameters

conf	the maps containing the setting of the main.cfg file
pid	the service identifier (usid key from the [lenv] section)

Returns: the reported status char* (temporary/final result)

Warning: make sure to free resources returned by this function

◆ hasDbs()

bool hasDbs ( maps * pmsConf )

Verify if the server rely on database backend.

Parameters

pmsConf the maps pointing to the main configuration

Returns: true if the server rely no database, false otherwise

◆ isAsyncCall()

bool isAsyncCall ( maps * pmsConf )

Verify if an Execute request has been invoked asynchronously.

Parameters

pmsConf the maps pointing to the main configuration

Returns: true if the service should be invoked asynchronously, false otherwise

◆ lockFile()

struct zooLock* lockFile	(	maps *	conf,
		const char *	filename,
		const char	mode
	)

Lock a file for read, write and upload.

Parameters

conf	the main configuration maps
filename	the file to lock
mode	define access: 'r' for read, 'w' for write

Returns: a new zooLock structure on sucess, NULL on failure

◆ lockShm()

int lockShm ( int id )

Lock a semaphore set.

Parameters

id	the semaphores set indetifier

Returns: 0 if the semaphore can be locked, -1 in other case.

◆ readVSIFile()

char* readVSIFile	(	maps *	conf,
		const char *	dataSource
	)

Read a file using the GDAL VSI API.

Parameters

conf	the maps containing the settings of the main.cfg file
dataSource	the datasource name to read

Warning: make sure to free resources returned by this function

◆ removeShmLock()

int removeShmLock	(	maps *	conf,
		int	nsems
	)

Try to remove a semaphore set.

Parameters

conf	the map containing the setting of the main.cfg file
nsems	number of semaphores

Returns: 0 if the semaphore can be removed, -1 in other case.

◆ setOutputValue()

int setOutputValue	(	maps *	outputs,
		const char *	parameterName,
		char *	data,
		size_t	numberOfBytes
	)

Set an output value.

Parameters

outputs	the maps to define the output value
parameterName	the output name to set the value
data	the value to set
numberOfBytes	size of the value to add (for binary values), -1 for basic char* data

Returns: 0

◆ unhandleStatus()

void unhandleStatus ( maps * conf )

Stop handling status repport.

Parameters

conf	the map containing the setting of the main.cfg file

◆ unlockFile()

int unlockFile	(	maps *	conf,
		struct zooLock *	s
	)

Remove a lock.

Parameters

conf	the main configuration maps
s	the zooLock structure

Returns: 0 on success, -1 on failure.

◆ unlockShm()

int unlockShm ( int id )

unLock a semaphore set.

Parameters

id	the semaphores set indetifier

Returns: 0 if the semaphore can be locked, -1 in other case.

◆ updateStatus()

int updateStatus	(	maps *	conf,
		const int	percentCompleted,
		const char *	message
	)

Update the status of an ongoing service.

Parameters

conf	the maps containing the settings of the main.cfg file
percentCompleted	percentage of completude of execution of the service
message	information about the current step executed

Returns: the value of _updateStatus

See also: _updateStatus

◆ validateVRT()

bool validateVRT	(	maps *	pmsConf,
		const char *	pccVRTName
	)

Validate that the VRT contains only allowed path.

Parameters

pmsConf	the maps pointing to the main configuration
pccVRTName	the name of the VRT file to validate

Returns: true if the VRT is valid, false otherwise

Data Structures

Macros

Functions

Data Structure Documentation

◆ semun

Macro Definition Documentation

◆ _LARGEFILE64_SOURCE

◆ ERROR_MSG_MAX_LENGTH

◆ MAX_RETRIES

Function Documentation

◆ _getStatus()

◆ _getStatusField()

◆ _getStatusFile()

◆ _updateStatus()

◆ acquireLock()

◆ file_exists()

◆ getInputValue()

◆ getKeyValue()

◆ getShmLockId()

◆ getStatus()

◆ getStatusId()

◆ hasDbs()

◆ isAsyncCall()

◆ lockFile()

◆ lockShm()

◆ readVSIFile()

◆ removeShmLock()

◆ setOutputValue()

◆ unhandleStatus()

◆ unlockFile()

◆ unlockShm()

◆ updateStatus()

◆ validateVRT()