Blame view

php/WebServices/WebServer.php 23.9 KB
16035364   Benjamin Renard   First commit
1
<?php
b8502f4d   Elena.Budnik   getStatus(), thro...
2
3
4
5
/** 
*   @file WebServer.php
*   @brief  Web services AMDA
*/
16035364   Benjamin Renard   First commit
6
7
8

class WebServer
{
b8502f4d   Elena.Budnik   getStatus(), thro...
9
	private $isSoap = false;
1ba8d04c   Elena.Budnik   time tables list,...
10
	private $userID, $userPWD = null, $sessionID = null, $IPclient;
b8502f4d   Elena.Budnik   getStatus(), thro...
11
	private $dataFileName;
8385c27c   Elena.Budnik   interim commit
12
13
	private $requestManager = null;
	private $paramLoader = null;
4bc7749a   Elena.Budnik   getParameter (sim...
14
	private $service;
1ba8d04c   Elena.Budnik   time tables list,...
15
	private $requestTime;
8a92ee19   Elena.Budnik   timeTobatch speci...
16
	
b8502f4d   Elena.Budnik   getStatus(), thro...
17
18
	function __construct() 
	{
a55dc57a   Elena.Budnik   interim commit
19
		if (!is_dir(WSConfigClass::getWsResultDir())) mkdir(WSConfigClass::getWsResultDir(), 0775);
b8502f4d   Elena.Budnik   getStatus(), thro...
20
	}
b8502f4d   Elena.Budnik   getStatus(), thro...
21

039d19ac   Benjamin Renard   Fix getParameter ...
22
	protected function init($data = NULL) 
b8502f4d   Elena.Budnik   getStatus(), thro...
23
	{
1ba8d04c   Elena.Budnik   time tables list,...
24
25
26
		$this->requestTime = date('Ymd',time());
		
		if (!isset($data)) {
98c5bd44   Benjamin Renard   Introduce anonymo...
27
			$this->userID  = WSConfigClass::getAnonymousUserName();
1ba8d04c   Elena.Budnik   time tables list,...
28
29
30
			return array('success' => true);
		}
		
b8502f4d   Elena.Budnik   getStatus(), thro...
31
32
33
34
35
36
37
		if(is_object($data)){
			$vars = get_object_vars($data);
			$this->isSoap = true; 
		}
		else {
			$vars = $data;
		}
8f6112a7   Nathanael Jourdane   Reformat webserver
38

b8502f4d   Elena.Budnik   getStatus(), thro...
39
40
		if (isset($vars['userID'])){
			$this->userID  = $vars['userID'];
4bf776ac   Elena.Budnik   init user
41
			IHMConfigClass::setUserName($this->userID);
b8502f4d   Elena.Budnik   getStatus(), thro...
42
43
		}
		else {
98c5bd44   Benjamin Renard   Introduce anonymo...
44
			$this->userID  = WSConfigClass::getAnonymousUserName();
b8502f4d   Elena.Budnik   getStatus(), thro...
45
46
47
48
49
50
51
		}
		
		$this->sessionID = $this->userID;
		
		if (isset($vars['password']))
			$this->userPWD = $vars['password'];
		else 
98c5bd44   Benjamin Renard   Introduce anonymo...
52
			$this->userPWD = WSConfigClass::getAnonymousUserPwd();
8a92ee19   Elena.Budnik   timeTobatch speci...
53
		
b8502f4d   Elena.Budnik   getStatus(), thro...
54
55
56
		return array('success' => true, 'vars' => $vars);
	}
	
b64d304e   Elena.Budnik   implement groups ...
57
	private function initUserMgr($setPathOnly = false) 
1ba8d04c   Elena.Budnik   time tables list,...
58
59
	{
		$wsUserMgr = new WSUserMgr();
039d19ac   Benjamin Renard   Fix getParameter ...
60
		$wsUserMgr->initWS($this->userID, $this->userPWD, $this->sessionID,  $setPathOnly, $this->isSoap);
1ba8d04c   Elena.Budnik   time tables list,...
61
62
63
64
65
66
		
		$this->IPclient = $wsUserMgr->getIPClient();
		
		return array('success' => true);
	}
	
b8502f4d   Elena.Budnik   getStatus(), thro...
67
68
69
70
71
	private function throwError($errorType, $msg)
	{
		if ($this->isSoap) 
			throw new SoapFault($errorType, $msg); 
		else 
fe5a16b4   Elena.Budnik   error for rest
72
			exit(json_encode(array("error" => $msg)));
b8502f4d   Elena.Budnik   getStatus(), thro...
73
74
	}
	
b8194303   Elena.Budnik   getPlot final
75
76
77
78
79
	private function isGetPlotRequest($name){

		return (substr($name,0,7) == 'getplot');
	}
	
cd1dd332   Elena.Budnik   getTimeTable
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
	private function xsl2vot($inputName, $outputName) 
	{   
		// Load Time table
		$xml = new DomDocument("1.0");
		if (!@$xml->load($inputName))
			$this->throwError("wokrspaceError", "Cannot load time table $inputName for ".$this->userID);

		// Load XSL file
		$xsl = new DomDocument("1.0");
		if (!@$xsl->load(WSConfigClass::getXslDir()."xml2vot.xsl"))
			$this->throwError("systemError", "Cannot load xsl file");
	
		// Import XSL and write output file in vot format
		$xslt = new XSLTProcessor();
		$xslt->importStylesheet($xsl);
		$vot = new DomDocument("1.0");
		if (!@$vot->loadXML($xslt->transformToXML($xml)))
				$this->throwError("systemError", "Cannot convert time table to VOtable");
		
		if (!$vot->save(WSConfigClass::getWsResultDir().$outputName))
			$this->throwError("systemError", "Cannot save time table to result dir");
	}
8f6112a7   Nathanael Jourdane   Reformat webserver
102

1922ad04   Elena.Budnik   getOrbites()
103
104
105
106
107
108
109
110
111
112
113
114
	private function getDatasetInfo($id)
	{
		$dataSetXml = WSConfigClass::getDataSetInfoDir().$id.".xml";
      
		if (!file_exists($dataSetXml))
			$this->throwError("systemError", "Cannot find info file for dataset ".$id); 
			
		$dataSetDom = new DomDocument("1.0");
		
		if (!@$dataSetDom->load($dataSetXml))
			$this->throwError("systemError", "Cannot load info file for dataset ".$id); 
			
b84e2792   Elena.Budnik   getdataSetInfo re...
115
		return $dataSetDom;
1922ad04   Elena.Budnik   getOrbites()
116
117
	}
	
1ba8d04c   Elena.Budnik   time tables list,...
118
/*
98c5bd44   Benjamin Renard   Introduce anonymo...
119
*  get user TimeTables list; Shared for anonymous user ('impex')
1ba8d04c   Elena.Budnik   time tables list,...
120
121
*/
	private function getTimeTablesCatalogsList($object) 
b8502f4d   Elena.Budnik   getStatus(), thro...
122
	{
7ac2915f   Myriam Bouchemit   call initUserMgr ...
123
		$this->initUserMgr();
b8502f4d   Elena.Budnik   getStatus(), thro...
124
		$dom = new DOMDocument("1.0");
1ba8d04c   Elena.Budnik   time tables list,...
125
		
98c5bd44   Benjamin Renard   Introduce anonymo...
126
		if ($this->userID == WSConfigClass::getAnonymousUserName()) {
b8502f4d   Elena.Budnik   getStatus(), thro...
127
128
			$sharedObjMgr = new SharedObjectsMgr();
			if (!@$dom->load($sharedObjMgr->getTreeFilePath()))
1ba8d04c   Elena.Budnik   time tables list,...
129
					$this->throwError("workspaceError", "Workspace Error : Cannot load Shared TimeTable list");
183fc1af   Myriam Bouchemit   getTimeTablesCata...
130
                        $tagName = $object == "timetables" ? "timeTableList" : "catalogList";
b8502f4d   Elena.Budnik   getStatus(), thro...
131
132
		}
		else {
1ba8d04c   Elena.Budnik   time tables list,...
133
134
				if (!@$dom->load(USERWSDIR.'Tt.xml'))
					$this->throwError("workspaceError", "Workspace Error : Cannot load TimeTable list for ".$this->userID);
183fc1af   Myriam Bouchemit   getTimeTablesCata...
135
                        $tagName = $object == "timetables" ? "timetabList" : "catalogList";
b8502f4d   Elena.Budnik   getStatus(), thro...
136
137
		}
    
1ba8d04c   Elena.Budnik   time tables list,...
138
		$timetabNode = $dom->getElementsByTagName($tagName);
8f6112a7   Nathanael Jourdane   Reformat webserver
139

b8502f4d   Elena.Budnik   getStatus(), thro...
140
		if ($timetabNode->length < 1){
1ba8d04c   Elena.Budnik   time tables list,...
141
				$this->throwError("workspaceWarning", "Workspace Warning : No $object");
b8502f4d   Elena.Budnik   getStatus(), thro...
142
143
144
145
146
147
148
149
		}
		
		$outDOM = new DOMDocument("1.0");
		$outDOM->formatOutput = TRUE;
		$outDOM->preserveWhiteSpace = FALSE;
    
		$newNode = $outDOM->importNode($timetabNode->item(0),TRUE);
		$outDOM->appendChild($newNode);
1ba8d04c   Elena.Budnik   time tables list,...
150
151
152
153
154
		
		$ttListResult = $object.'_'.$this->userID.'_'.$this->requestTime.'.xml';
		
		if (!$outDOM->save(WSConfigClass::getWsResultDir().$ttListResult))
			$this->throwError("workspaceError", "Workspace Error : problem while saving $object list file");
8f6112a7   Nathanael Jourdane   Reformat webserver
155

1ba8d04c   Elena.Budnik   time tables list,...
156
		return WSConfigClass::getUrl().$ttListResult;
b8502f4d   Elena.Budnik   getStatus(), thro...
157
	}
1922ad04   Elena.Budnik   getOrbites()
158

b8502f4d   Elena.Budnik   getStatus(), thro...
159
/*
1922ad04   Elena.Budnik   getOrbites()
160
161
162
*  Get corresponding orbit parameter ID
*/
	private function getOrbitParameter($orbitRequest) 
b8502f4d   Elena.Budnik   getStatus(), thro...
163
	{
1922ad04   Elena.Budnik   getOrbites()
164
165
166
167
		if (!file_exists(WSConfigClass::getOrbitsXml()))
			$this->throwError('systemError', "No AMDA system orbits file");
			
		$orbitsXml = new DomDocument();
b8502f4d   Elena.Budnik   getStatus(), thro...
168

1922ad04   Elena.Budnik   getOrbites()
169
170
171
172
173
		if (!@$orbitsXml->load(WSConfigClass::getOrbitsXml()))
			$this->throwError('systemError', "Cannot load AMDA system orbits file");
			
		$spacecraft = strtolower($orbitRequest['spacecraft']);
		$spacecraft = str_replace('-', '', $spacecraft);
b8502f4d   Elena.Budnik   getStatus(), thro...
174
		
1922ad04   Elena.Budnik   getOrbites()
175
176
		$xpath = new DOMXpath($orbitsXml);
		$path = '//orbites[@mission="'.$spacecraft.'" and @coordinate_system="'.$orbitRequest['coordinateSystem'].'" and @units="'.$orbitRequest['units'].'" ] ';
8f6112a7   Nathanael Jourdane   Reformat webserver
177

1922ad04   Elena.Budnik   getOrbites()
178
		$orbits = $xpath->query($path);
b8502f4d   Elena.Budnik   getStatus(), thro...
179
		
1922ad04   Elena.Budnik   getOrbites()
180
181
182
183
184
185
186
		foreach ($orbits as $orbit)
		{
			$datasetID = strtr($orbit->getAttribute('dataset'),"_","-");
			$dataSetDom = $this->getDatasetInfo($datasetID); 
  
			$paramStart = strtotime($dataSetDom->getElementsByTagName('global_start')->item(0)->nodeValue);
			$paramStop =  strtotime($dataSetDom->getElementsByTagName('global_stop')->item(0)->nodeValue);
b8502f4d   Elena.Budnik   getStatus(), thro...
187

1922ad04   Elena.Budnik   getOrbites()
188
			if(($paramStart <= strtotime($orbitRequest['startTime']) && (strtotime($orbitRequest['stopTime'])) <= $paramStop)) { 
8f6112a7   Nathanael Jourdane   Reformat webserver
189

1922ad04   Elena.Budnik   getOrbites()
190
191
192
				return array('success' => true, 
								 'parameterID' => $orbit->getAttribute('xml:id')   
				);
b8502f4d   Elena.Budnik   getStatus(), thro...
193
			}
b8502f4d   Elena.Budnik   getStatus(), thro...
194
		}
1922ad04   Elena.Budnik   getOrbites()
195
196
197
		
		$this->throwError('systemError', 
		"Cannot find orbit data for ".$orbitRequest['spacecraft']." for ".$orbitRequest['startTime']."-".$orbitRequest['stopTime']." in ".$orbitRequest['units']."  ".$orbitRequest['coordinateSystem']."($paramStart  - $paramStop)");
b8502f4d   Elena.Budnik   getStatus(), thro...
198
	}
1922ad04   Elena.Budnik   getOrbites()
199
	
9846ec70   Benjamin Renard   WS getDataset wit...
200
	private function doDownloadRequest($interval, $paramList, $formatInfo, $file_info) 
b8502f4d   Elena.Budnik   getStatus(), thro...
201
	{
b8502f4d   Elena.Budnik   getStatus(), thro...
202
		if (!isset($this->paramLoader))
14ae289b   Benjamin Renard   IHMUserParamLoade...
203
			$this->paramLoader = new IHMUserParamManagerClass();
b8502f4d   Elena.Budnik   getStatus(), thro...
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

		//Build parameter list
		$params = array();
		
		//TODO template arguments to implement ?
		foreach ($paramList['params'] as $paramId)
		{
			$param = new stdClass;
			
			if (preg_match("#^ws_#",$paramId))
			{
				$res = $this->paramLoader->getDerivedParameterNameFromId($paramId);
				
				if (!$res["success"]) {
					$this->throwError("serverError", "Not available derived parameter $paramId");
				}
				$param->paramid = "ws_".$res['name'];
			}
			else if (preg_match("#^wsd_#",$paramId))
			{
				$res = $this->paramLoader->getUploadedParameterNameFromId($paramId);
				
				if (!$res["success"]){
					$this->throwError("serverError", "Not available parameter $paramId");
				}
				$param->paramid = "wsd_".$res['name'];
			}
4bdd7ad9   Elena.Budnik   interim commit
231
			else {
b8502f4d   Elena.Budnik   getStatus(), thro...
232
233
				$param->paramid = $paramId;
			}
b8502f4d   Elena.Budnik   getStatus(), thro...
234
235
			$params[] = $param;
		}
8385c27c   Elena.Budnik   interim commit
236

61193896   Benjamin Renard   WS - getParameter...
237
		$ref_sampling_param = isset($interval['ref_sampling_param']) ? $interval['ref_sampling_param'] : NULL;
9846ec70   Benjamin Renard   WS getDataset wit...
238

b8502f4d   Elena.Budnik   getStatus(), thro...
239
		$obj = (object)array(
8a92ee19   Elena.Budnik   timeTobatch speci...
240
						"sampling" => $interval['sampling'],
8a92ee19   Elena.Budnik   timeTobatch speci...
241
242
243
						"startDate" => $interval['startTime'],
						"stopDate" => $interval['stopTime'],
						"list" => $params,
4bdd7ad9   Elena.Budnik   interim commit
244
245
						"fileformat" => $formatInfo['format'],
						"timeformat" => $formatInfo['timeFormat'],
9846ec70   Benjamin Renard   WS getDataset wit...
246
247
248
						"compression" => $formatInfo['gzip'],
						"ref_sampling_param" => $ref_sampling_param,
						"file_info" => $file_info,
8385c27c   Elena.Budnik   interim commit
249
			);	
039d19ac   Benjamin Renard   Fix getParameter ...
250
251


b8502f4d   Elena.Budnik   getStatus(), thro...
252
253
		if (!isset($this->requestManager))
			$this->requestManager = new RequestManagerClass();
8385c27c   Elena.Budnik   interim commit
254
		 
b8502f4d   Elena.Budnik   getStatus(), thro...
255
		try {
4bc7749a   Elena.Budnik   getParameter (sim...
256
			$downloadResult = $this->requestManager->runWSRequest($this->userID, $this->IPclient, FunctionTypeEnumClass::PARAMS, $this->service, $obj);
b8502f4d   Elena.Budnik   getStatus(), thro...
257
		} catch (Exception $e) {
8385c27c   Elena.Budnik   interim commit
258
			$this->throwError("executionError", "Exception detected : ".$e->getMessage()); 
b8502f4d   Elena.Budnik   getStatus(), thro...
259
		}
039d19ac   Benjamin Renard   Fix getParameter ...
260

b8502f4d   Elena.Budnik   getStatus(), thro...
261
262
263
264
265
266
			
		if (!$downloadResult['success']) {
			$this->throwError("serverError", $downloadResult['message']);
		}
		
		if($downloadResult['status'] == 'in_progress') {
8385c27c   Elena.Budnik   interim commit
267
268
269
			return ['success' => true, 'status' => 'in progress', 'id' => $downloadResult['id']];
		} elseif ($downloadResult['status'] == 'done') 
		{
4bc7749a   Elena.Budnik   getParameter (sim...
270
			$this->deleteProcess($downloadResult['id']);
039d19ac   Benjamin Renard   Fix getParameter ...
271
			return array('success' => true, 'status' => 'done', 'dataFileURLs' => WSConfigClass::getUrl().$downloadResult['result'], 'exectime' => $downloadResult['exectime']);
b8502f4d   Elena.Budnik   getStatus(), thro...
272
273
274
275
276
		} else {
			return ['success' => false, 'message' => 'Unknown status ' . $downloadResult['status']];
		} 
	}
	
4bc7749a   Elena.Budnik   getParameter (sim...
277
/*
2b26bbdd   Elena.Budnik   getPlot partial c...
278
*         delete process after execution : 
4bc7749a   Elena.Budnik   getParameter (sim...
279
280
281
282
*         delete temporary files/folders ( JOBS/process_xxxx, RES/DDxxx ); 
*         delete job node in processManager.xml
*/
	private function deleteProcess($id)
b8502f4d   Elena.Budnik   getStatus(), thro...
283
	{
4bdd7ad9   Elena.Budnik   interim commit
284
		$obj = (object)array('id' => $id);
b8502f4d   Elena.Budnik   getStatus(), thro...
285
286
287
288
   
		if (!isset($this->requestManager))
			$this->requestManager = new RequestManagerClass();

4bdd7ad9   Elena.Budnik   interim commit
289
		try {
4bc7749a   Elena.Budnik   getParameter (sim...
290
			$downloadResult = $this->requestManager->runWSRequest($this->userID, $this->IPclient, FunctionTypeEnumClass::PROCESSDELETE, null, $obj);
4bdd7ad9   Elena.Budnik   interim commit
291
		} catch (Exception $e) {
4bc7749a   Elena.Budnik   getParameter (sim...
292
			$this->throwError("deleteProcessError", $e->getMessage());
4bdd7ad9   Elena.Budnik   interim commit
293
		}
b8502f4d   Elena.Budnik   getStatus(), thro...
294
	}
b64d304e   Elena.Budnik   implement groups ...
295
296
297
298
299
300
	
	private function excludePrivateNodes($locParamSrc, $locParamDst)
	{
		$locParamSrcDom = new DomDocument("1.0");
		$locParamSrcDom->preserveWhiteSpace = FALSE; /// Important !!! otherwise removeChild() leaves empty text nodes
		
9846ec70   Benjamin Renard   WS getDataset wit...
301
		if (!@$locParamSrcDom->load($locParamSrc))
b64d304e   Elena.Budnik   implement groups ...
302
303
304
305
			$this->throwError("getObsDataTree", "Cannot load  Amda Local DataBase Parameters description file".$this->userID);
 
		$xp =  new domxpath($locParamSrcDom);
		$restricted = $xp->query("//*[@group]");
2b26bbdd   Elena.Budnik   getPlot partial c...
306

b64d304e   Elena.Budnik   implement groups ...
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
		foreach ($restricted as $node) {
				$parentNode = $node->parentNode;
				$parentNode->removeChild($node);
				
				if (!$parentNode->hasChildNodes()) {
					if ($parentNode->parentNode){
						$parentParentNode = $parentNode->parentNode;  
						$parentParentNode->removeChild($parentNode);
					}
				}
			}
 
		if (!$locParamSrcDom->save(WSConfigClass::getWsResultDir().$locParamDst))
			$this->throwError('workspaceError', 'Cannot save Amda Local DataBase Parameters description file'.$this->userID);   
	}
	
189a6f4f   Elena.Budnik   coorect timie
323
324
325
326
327
328
	private function checkInputTime($startTime, $stopTime) 
	{
		if ($stopTime <= $startTime ) 
			$this->throwError("requestError", "Requested time interval should be greater than 0"); 
	}
	
1ba8d04c   Elena.Budnik   time tables list,...
329
/************************** WEB SERVICES **************************************/	
189a6f4f   Elena.Budnik   coorect timie
330
331
332
333
334
335
336
337
338
339
340
/*
*   generate AUTH token for access to REST services 
*/
	public function getNewToken()
	{
		// generate token from timeStamp and some salt
		$newToken = md5(1321 * (int)( time() / WSConfigClass::$timeLimitQuery));
		
		return array('success' => true, 'token' => $newToken);
	}
	
cd1dd332   Elena.Budnik   getTimeTable
341
/*
98c5bd44   Benjamin Renard   Introduce anonymo...
342
*   public data only : anonymous user (impex)
cd1dd332   Elena.Budnik   getTimeTable
343
344
345
346
347
348
349
*/
	public function getObsDataTree() 
	{         
		$res = $this->init();	
		$this->initUserMgr();
		
		$locParamSrc = USERWSDIR.'LocalParams.xml'; 
b64d304e   Elena.Budnik   implement groups ...
350
		
1922ad04   Elena.Budnik   getOrbites()
351
		$locParamDst = substr(strtolower(__FUNCTION__),3).'_'.$this->userID.'_'.$this->requestTime.'_AmdaLocalDataBaseParameters.xml';
cd1dd332   Elena.Budnik   getTimeTable
352

b64d304e   Elena.Budnik   implement groups ...
353
354
// 		if (!copy($locParamSrc,WSConfigClass::getWsResultDir().$locParamDst))
// 			$this->throwError('workspaceError', 'No Amda Local DataBase Parameters description file');   
cd1dd332   Elena.Budnik   getTimeTable
355

b64d304e   Elena.Budnik   implement groups ...
356
		$this->excludePrivateNodes($locParamSrc,$locParamDst);
cd1dd332   Elena.Budnik   getTimeTable
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
		return  array('success' => true,'WorkSpace' => array("LocalDataBaseParameters" => WSConfigClass::getUrl().$locParamDst));
	}

/*
*   get Parameter List for given user
*/
	public function getParameterList($data) 
	{         
		$res = $this->init($data);
		$this->initUserMgr(); 

		$vars = $res['vars'];

		$locParamSrc = USERWSDIR.'LocalParams.xml'; 
		$wsParamSrc =  USERWSDIR.'WsParams.xml';
		
1922ad04   Elena.Budnik   getOrbites()
373
374
		$locParamDst = substr(strtolower(__FUNCTION__),3).'_'.$this->userID.'_'.$this->requestTime.'_AmdaLocalDataBaseParameters.xml';
		$wsParamDst = substr(strtolower(__FUNCTION__),3).'_'.$this->userID.'_'.$this->requestTime.'_UserDefinedParameters.xml';
cd1dd332   Elena.Budnik   getTimeTable
375

b64d304e   Elena.Budnik   implement groups ...
376
377
378
379
// 		if (!copy($locParamSrc, WSConfigClass::getWsResultDir().$locParamDst))
// 			$this->throwError('workspaceError', 'No Amda Local DataBase Parameters description file for '.$this->userID);
		
		$this->excludePrivateNodes($locParamSrc,$locParamDst);
cd1dd332   Elena.Budnik   getTimeTable
380
		
9846ec70   Benjamin Renard   WS getDataset wit...
381
		if (($this->userID == WSConfigClass::getAnonymousUserName()) ||  !copy($wsParamSrc, WSConfigClass::getWsResultDir().$wsParamDst))
7ac2915f   Myriam Bouchemit   call initUserMgr ...
382
383
			return  array('success' => true,'ParameterList' => 
					array("LocalDataBaseParameters" =>  WSConfigClass::getUrl().$locParamDst));
9846ec70   Benjamin Renard   WS getDataset wit...
384

cd1dd332   Elena.Budnik   getTimeTable
385
386
		return  array('success' => true,'ParameterList' => 
					array("UserDefinedParameters" => WSConfigClass::getUrl().$wsParamDst, 
7ac2915f   Myriam Bouchemit   call initUserMgr ...
387
							"LocalDataBaseParameters" =>  WSConfigClass::getUrl().$locParamDst));
cd1dd332   Elena.Budnik   getTimeTable
388
389
	}

1ba8d04c   Elena.Budnik   time tables list,...
390
391
392
393
394
/*
*   getParameter 
*/
	public function getParameter($data) 
	{
1ba8d04c   Elena.Budnik   time tables list,...
395
396
397
398
399
400
401
402
403
		$res = $this->init($data);
    
		if (!$res['success']){
			$this->throwError("requestError", "Cannot parse request"); 
		}

		$this->initUserMgr();

		$vars = $res['vars'];
039d19ac   Benjamin Renard   Fix getParameter ...
404
405
406
407
408
409
410
411

		if (empty($vars["startTime"])) {
			$this->throwError("requestError", "Missing startTime definition");
		}

		if (empty($vars["stopTime"])) {
			$this->throwError("requestError", "Missing stopTime definition");
		}
189a6f4f   Elena.Budnik   coorect timie
412
413
414
415
416
417
418
419
		
		if (is_numeric($vars["startTime"])) {
			$this->checkInputTime($vars["startTime"],$vars["stopTime"]);
			$vars["startTime"] = date("Y-m-d\TH:i:s", $vars["startTime"]);
			$vars["stopTime"] = date("Y-m-d\TH:i:s", $vars["stopTime"]);
		}
		else {
			$this->checkInputTime(strtotime($vars["startTime"]),strtotime($vars["stopTime"])); 
1ba8d04c   Elena.Budnik   time tables list,...
420
421
		}
		
039d19ac   Benjamin Renard   Fix getParameter ...
422
		if (empty($vars["timeFormat"])) {
1ba8d04c   Elena.Budnik   time tables list,...
423
			$timeFormat = "ISO8601";
189a6f4f   Elena.Budnik   coorect timie
424
425
		}
		else {
1ba8d04c   Elena.Budnik   time tables list,...
426
			$timeFormat = $vars["timeFormat"];
189a6f4f   Elena.Budnik   coorect timie
427
		}
039d19ac   Benjamin Renard   Fix getParameter ...
428

61193896   Benjamin Renard   WS - getParameter...
429
430
431
		$sampling = !empty($vars["sampling"]) ? $vars["sampling"] : NULL;
		$ref_sampling_param = NULL;
		$file_info = "";
039d19ac   Benjamin Renard   Fix getParameter ...
432
433
434
435

		if (empty($vars["parameterID"])) {
			$this->throwError("requestError", "Missing parameterID definition");
		}
189a6f4f   Elena.Budnik   coorect timie
436
		$paramId = array();
61193896   Benjamin Renard   WS - getParameter...
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
		if (strpos($vars["parameterID"], ',')) {
			$paramId = explode(',', $vars["parameterID"]);

			if (!isset($sampling))
			{
				$ref_sampling_param = trim($paramId[0]);
			}

			foreach ($paramId as &$id) {
				$id = trim($id);
				if (!empty($file_info)) {
					$file_info .= "-";
				}
				$file_info .= $id;
			}
		}
		else {
			array_push($paramId, $vars["parameterID"]);
			$file_info = $vars["parameterID"];
		}
1ba8d04c   Elena.Budnik   time tables list,...
457

039d19ac   Benjamin Renard   Fix getParameter ...
458
		if (empty($vars["gzip"]))
1ba8d04c   Elena.Budnik   time tables list,...
459
460
			$gzip = 0;
		else
039d19ac   Benjamin Renard   Fix getParameter ...
461
			$gzip = ($vars["gzip"] == 1);
1ba8d04c   Elena.Budnik   time tables list,...
462

039d19ac   Benjamin Renard   Fix getParameter ...
463
		$outputFormat = !empty($vars["outputFormat"]) ? $vars["outputFormat"] : 'ASCII'; 
1ba8d04c   Elena.Budnik   time tables list,...
464
465
466
467
			
		$this->service = strtolower(__FUNCTION__);

		$res = $this->doDownloadRequest(
61193896   Benjamin Renard   WS - getParameter...
468
469
					array("startTime" => $vars["startTime"], "stopTime" => $vars["stopTime"], "sampling" => $sampling,
						"ref_sampling_param" => $ref_sampling_param),
1ba8d04c   Elena.Budnik   time tables list,...
470
					array("params" => $paramId),
61193896   Benjamin Renard   WS - getParameter...
471
					array("format" => $outputFormat, "timeFormat"=> $timeFormat, "gzip"=>$gzip), $file_info);
1ba8d04c   Elena.Budnik   time tables list,...
472
473
474
475
 
		if ($res['success']) 
			return $res;
	
039d19ac   Benjamin Renard   Fix getParameter ...
476
		$this->throwError("serverError", $res['message']); 
1ba8d04c   Elena.Budnik   time tables list,...
477
478
479
	}
	
/*
98c5bd44   Benjamin Renard   Introduce anonymo...
480
*  get user Catalogs list; Shared for anonymous user (impex)
1ba8d04c   Elena.Budnik   time tables list,...
481
482
483
484
*/
	public function getCatalogsList($data) 
	{
		$this->init($data);
fc76cba2   Elena.Budnik   rm duplicated init()
485
	
1ba8d04c   Elena.Budnik   time tables list,...
486
487
488
489
		return array('success' => true, 'CatalogsList' => $this->getTimeTablesCatalogsList('catalogs'));
	}

/*
98c5bd44   Benjamin Renard   Introduce anonymo...
490
*  get user TimeTables list; Shared for anonymous user (impex)
1ba8d04c   Elena.Budnik   time tables list,...
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
*/
	public function getTimeTablesList($data) 
	{
		$this->init($data);
		 
		return array('success' => true, 'TimeTablesList' => $this->getTimeTablesCatalogsList('timetables'));
	}
	
	public function isAlive()
	{ 
		return true;
	}
    
/*
*   get Dataset
*/
	public function getDataset($data) 
	{
		$res = $this->init($data);
		
		if (!$res['success']){
			$this->throwError("requestError", "Cannot parse request"); 
		}
		
50fd9404   Elena.Budnik   getDataset()
515
		$this->initUserMgr();
1ba8d04c   Elena.Budnik   time tables list,...
516
517

		$vars = $res['vars'];
50fd9404   Elena.Budnik   getDataset()
518
		
189a6f4f   Elena.Budnik   coorect timie
519
520
521
522
523
524
525
526
527
		if (is_numeric($vars["startTime"])) {
			$this->checkInputTime($vars["startTime"],$vars["stopTime"]);
			$vars["startTime"] = date("Y-m-d\TH:i:s", $vars["startTime"]);
			$vars["stopTime"] = date("Y-m-d\TH:i:s", $vars["stopTime"]);
		}
		else {
			$this->checkInputTime(strtotime($vars["startTime"]),strtotime($vars["stopTime"])); 
		}
	 
9846ec70   Benjamin Renard   WS getDataset wit...
528
		if (empty($vars["timeFormat"])) {
189a6f4f   Elena.Budnik   coorect timie
529
530
531
532
533
			$timeFormat = "ISO8601";
		}
		else {
			$timeFormat = $vars["timeFormat"];
		}
9846ec70   Benjamin Renard   WS getDataset wit...
534
535
536
537
538
539

		if (empty($vars['datasetID'])) {
			$this->throwError("requestError", "Missing datasetID definition");
		}
		$datasetId = $vars['datasetID'];
		$dataSetDom = $this->getDatasetInfo($datasetId);
50fd9404   Elena.Budnik   getDataset()
540
		
50fd9404   Elena.Budnik   getDataset()
541
542
543
		$params = $dataSetDom->getElementsByTagName("parameter");
		
		if ($params->length == 0)
9846ec70   Benjamin Renard   WS getDataset wit...
544
			$this->throwError("systemError", "Cannot find parameter list for dataset ".$datasetId); 
50fd9404   Elena.Budnik   getDataset()
545
      
1ba8d04c   Elena.Budnik   time tables list,...
546
		$paramId = array();
50fd9404   Elena.Budnik   getDataset()
547
548
549
	  
		foreach ($params as $p)
				$paramId[] =  $p->nodeValue;
1ba8d04c   Elena.Budnik   time tables list,...
550
 
9846ec70   Benjamin Renard   WS getDataset wit...
551
		if (empty($vars["sampling"]))
50fd9404   Elena.Budnik   getDataset()
552
		{ 
9846ec70   Benjamin Renard   WS getDataset wit...
553
554
			$sampling = NULL;
			$ref_sampling_param = $paramId[0];
1ba8d04c   Elena.Budnik   time tables list,...
555
		}
50fd9404   Elena.Budnik   getDataset()
556
557
		else {
			$sampling = $vars["sampling"];
9846ec70   Benjamin Renard   WS getDataset wit...
558
			$ref_sampling_param = NULL;
50fd9404   Elena.Budnik   getDataset()
559
		}
1ba8d04c   Elena.Budnik   time tables list,...
560
 
9846ec70   Benjamin Renard   WS getDataset wit...
561
		if (empty($vars["gzip"]))
1ba8d04c   Elena.Budnik   time tables list,...
562
563
			$gzip = 0;
		else
9846ec70   Benjamin Renard   WS getDataset wit...
564
565
566
			$gzip = ($vars["gzip"] == 1);

		$outputFormat = !empty($vars["outputFormat"]) ? $vars["outputFormat"] : 'ASCII';
1ba8d04c   Elena.Budnik   time tables list,...
567

50fd9404   Elena.Budnik   getDataset()
568
569
		$this->service = strtolower(__FUNCTION__);

1ba8d04c   Elena.Budnik   time tables list,...
570
		$res = $this->doDownloadRequest(
9846ec70   Benjamin Renard   WS getDataset wit...
571
					array("startTime" => $vars["startTime"], "stopTime" => $vars["stopTime"], "sampling" => $sampling, "ref_sampling_param" => $ref_sampling_param),
1ba8d04c   Elena.Budnik   time tables list,...
572
					array("params" => $paramId),
9846ec70   Benjamin Renard   WS getDataset wit...
573
					array("format" => $outputFormat, "timeFormat"=> $timeFormat, "gzip"=>$gzip), $datasetId);
1ba8d04c   Elena.Budnik   time tables list,...
574
575
576
577
578
  
		if ($res['success']) return $res;

		$this->throwError("serverError", $res['message']); 
	}
cd1dd332   Elena.Budnik   getTimeTable
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
	
/*
*   get status for jobs in batch
*/
	public function getStatus($data) 
	{
		$result = $this->init($data);
		
		$id = $result['vars']['id'];
		
		if (!isset($this->requestManager))
			$this->requestManager = new RequestManagerClass();
			
		try 
		{
			$res = $this->requestManager->runWSRequest('nobody', 'nobody', FunctionTypeEnumClass::PROCESSGETINFO, null, $id);
		} 
		catch (Exception $e) 
		{
39bae1d7   Benjamin Renard   Fix getStatus API
598
			$this->throwError("executionError", "Exception detected : ".$e->getMessage());
cd1dd332   Elena.Budnik   getTimeTable
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
		}
		
		if (!$res['success']) {
			$this->throwError("processError","Cannot retrieve process $id info");
		}

		if ($res['status'] == 'in_progress') {
			return array('success' => true, 'status' => 'in progress');
		}
		
		if ($res['error']) {
			$this->throwError("processError","Process $id error code");
		}
		
		$this->deleteProcess($res['id']);
b8194303   Elena.Budnik   getPlot final
614
615
616
617
		
		$resultTag = $this->isGetPlotRequest($res['result']) ? 'plotURL' : 'dataFileURLs';
		
		return  array('success' => true, 'status' => $res['status'],  $resultTag => WSConfigClass::getUrl().$res['result']);
cd1dd332   Elena.Budnik   getTimeTable
618
619
620
621
622
623
	}
	
/*
*    TODO Can be done by TTCONVERT function of AMDA_Kernel - more hard !!!
*    TODO Think about this if merge/union will be also done by AMDA_Kernel
*
98c5bd44   Benjamin Renard   Introduce anonymo...
624
*    get Time Table : shared for anonymous user (impex) ; user' for user
cd1dd332   Elena.Budnik   getTimeTable
625
626
627
628
629
630
631
632
633
*/
	public function getTimeTable($data) 
	{
		$res = $this->init($data);
		
		if (!$res['success']){
			$this->throwError("requestError", "Cannot parse request"); 
		}
		
7ac2915f   Myriam Bouchemit   call initUserMgr ...
634
		$this->initUserMgr();
cd1dd332   Elena.Budnik   getTimeTable
635
636
637
		
		$ttID = $res['vars']['ttID'];

98c5bd44   Benjamin Renard   Introduce anonymo...
638
		if ($this->userID == WSConfigClass::getAnonymousUserName()) {
cd1dd332   Elena.Budnik   getTimeTable
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
			$sharedObjMgr = new SharedObjectsMgr();
			$ttSrc = $sharedObjMgr->getDataFilePath('timeTable', $ttID);
		}
		else
			$ttSrc = USERTTDIR.$ttID.'.xml';

		if (!file_exists($ttSrc)) {
			$this->throwError("workspaceError", "No such table ".$ttID." for user ".$this->userID);
		}

		$ttDst = substr(strtolower(__FUNCTION__), 3)."_".$this->userID."_".$this->requestTime."_$ttID.xml"; 

		//TODO can be done by
		// $res = $this->requestManager->runWSRequest($this->userID, $this->IPclient,FunctionTypeEnumClass::TTCONVERT, null, $ttID);
		$this->xsl2vot($ttSrc,$ttDst);

		return array('success' => true, 'ttFileURL' => WSConfigClass::getUrl().$ttDst);
	}
1922ad04   Elena.Budnik   getOrbites()
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671

/*
*   get Orbits
*/ 
	public function getOrbites($data) 
	{
		$res = $this->init($data);
		
		if (!$res['success']){
			$this->throwError("requestError", "Cannot parse request"); 
		}
		
		$this->initUserMgr();

		$vars = $res['vars'];
189a6f4f   Elena.Budnik   coorect timie
672
673
674
675
676
677
678
679
680
681
		
		if (is_numeric($vars["startTime"])) {
			$this->checkInputTime($vars["startTime"],$vars["stopTime"]);
			$vars["startTime"] = date("Y-m-d\TH:i:s", $vars["startTime"]);
			$vars["stopTime"] = date("Y-m-d\TH:i:s", $vars["stopTime"]);
		}
		else {
			$this->checkInputTime(strtotime($vars["startTime"]),strtotime($vars["stopTime"])); 
		}
	 
9846ec70   Benjamin Renard   WS getDataset wit...
682
		if (empty($vars["timeFormat"])) {
189a6f4f   Elena.Budnik   coorect timie
683
684
685
686
			$timeFormat = "ISO8601";
		}
		else {
			$timeFormat = $vars["timeFormat"];
1922ad04   Elena.Budnik   getOrbites()
687
		}
9846ec70   Benjamin Renard   WS getDataset wit...
688
689
690
691

		if (empty($vars["spacecraft"])) {
			$this->throwError("requestError", "Missing spacecraft definition");
		}
1922ad04   Elena.Budnik   getOrbites()
692
		$spacecraft = $vars["spacecraft"];
9846ec70   Benjamin Renard   WS getDataset wit...
693
694
695
696

		if (empty($vars["coordinateSystem"])) {
			$this->throwError("requestError", "Missing coordinateSystem definition");
		}
1922ad04   Elena.Budnik   getOrbites()
697
698
		$coordinateSystem = $vars["coordinateSystem"];

9846ec70   Benjamin Renard   WS getDataset wit...
699
		if (empty($vars["units"]))
1922ad04   Elena.Budnik   getOrbites()
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
			$units = "km";
		else
			$units = $vars["units"];

		$orbitRequest = array("startTime" => $vars["startTime"],
				"stopTime"  => $vars["stopTime"],
				"spacecraft" => $spacecraft,
				"coordinateSystem" => $coordinateSystem,
				"units" => $units
				);
  
		$orbitParam = $this->getOrbitParameter($orbitRequest);
		
		$paramId = array();
		array_push($paramId, $orbitParam['parameterID']);

9846ec70   Benjamin Renard   WS getDataset wit...
716
		if (empty($vars["gzip"]))
1922ad04   Elena.Budnik   getOrbites()
717
718
			$gzip = 0;
		else
9846ec70   Benjamin Renard   WS getDataset wit...
719
720
721
722
723
			$gzip = ($vars["gzip"] == 1);

		$sampling = !empty($vars["sampling"]) ? $vars["sampling"] : NULL;

		$outputFormat = !empty($vars["outputFormat"]) ? $vars["outputFormat"] : 'ASCII';
1922ad04   Elena.Budnik   getOrbites()
724
			
9846ec70   Benjamin Renard   WS getDataset wit...
725
		$this->service = strtolower(__FUNCTION__);
1922ad04   Elena.Budnik   getOrbites()
726
727
      
		$res = $this->doDownloadRequest(
9846ec70   Benjamin Renard   WS getDataset wit...
728
					array("startTime" => $vars["startTime"], "stopTime" => $vars["stopTime"], "sampling" => $sampling),
1922ad04   Elena.Budnik   getOrbites()
729
					array("params" => $paramId),
9846ec70   Benjamin Renard   WS getDataset wit...
730
					array("format" => $outputFormat, "timeFormat"=> $timeFormat, "gzip"=>$gzip), $orbitParam['parameterID']);
1922ad04   Elena.Budnik   getOrbites()
731
732
733
734
735
 	 
		if ($res['success']) return $res;
 
		$this->throwError("serverError",$res['message']);    
	}
2b26bbdd   Elena.Budnik   getPlot partial c...
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751

/*
*  getPlot : predefined;  by mission
*/
	public function getPlot($data) 
	{
		$res = $this->init($data);
		
		if (!$res['success']){
			$this->throwError("requestError", "Cannot parse request"); 
		}
		
		$this->initUserMgr();
		
		$vars = $res['vars'];
		$mission = $vars["missionID"];
b8194303   Elena.Budnik   getPlot final
752
		
189a6f4f   Elena.Budnik   coorect timie
753
754
755
756
757
758
759
760
761
		if (is_numeric($vars["startTime"])) {
			$this->checkInputTime($vars["startTime"],$vars["stopTime"]);
			$vars["startTime"] = date("Y-m-d\TH:i:s", $vars["startTime"]);
			$vars["stopTime"] = date("Y-m-d\TH:i:s", $vars["stopTime"]);
		}
		else {
			$this->checkInputTime(strtotime($vars["startTime"]),strtotime($vars["stopTime"])); 
		}
	 
b8194303   Elena.Budnik   getPlot final
762
763
		$resultFilePrefix = strtolower(__FUNCTION__)."_".$mission."_".date("YmdHms",strtotime($vars["startTime"]))."_".date("YmdHms",strtotime($vars["stopTime"]));
		
98c5bd44   Benjamin Renard   Introduce anonymo...
764
		if ($this->userID != WSConfigClass::getAnonymousUserName()) 
b8194303   Elena.Budnik   getPlot final
765
			$resultFilePrefix .= "_".$this->userID;
2b26bbdd   Elena.Budnik   getPlot partial c...
766
767

		$dom = new DomDocument("1.0");
e48a45d7   Elena.Budnik   WebServices folder
768
769
		if (!@$dom->load(WSConfigClass::getXslDir()."AmdaPlots.xml"))
			$this->throwError("systemError", "Cannot load predefined plot definition"); ;
2b26bbdd   Elena.Budnik   getPlot partial c...
770
771
772
773
774
775
776
777
778
779
780

		$missionTag = $dom->getElementById($mission);
		$params = $missionTag->getElementsByTagName('param');

		$paramsList = array();
		foreach ($params as $param)
			$paramsList[] = $param->getAttribute('name');

		$requestObject = (Object) array(
			"nodeType" => "request",
			"file-format" => "PNG",
b8194303   Elena.Budnik   getPlot final
781
			"result-file" => $resultFilePrefix,
2b26bbdd   Elena.Budnik   getPlot partial c...
782
783
784
			"timesrc" => "Interval",
			"startDate" => $vars["startTime"],
			"stopDate" => $vars["stopTime"],
b8194303   Elena.Budnik   getPlot final
785
			"parameters" => array()
2b26bbdd   Elena.Budnik   getPlot partial c...
786
787
		);
    
2b26bbdd   Elena.Budnik   getPlot partial c...
788
789
		foreach ($paramsList as $paramToPlot)
		{
2b26bbdd   Elena.Budnik   getPlot partial c...
790
			$paramObject = (Object) array(
b8194303   Elena.Budnik   getPlot final
791
				"paramid" => $paramToPlot
2b26bbdd   Elena.Budnik   getPlot partial c...
792
			);
2b26bbdd   Elena.Budnik   getPlot partial c...
793
			
b8194303   Elena.Budnik   getPlot final
794
			$requestObject->{"parameters"}[] = $paramObject;
2b26bbdd   Elena.Budnik   getPlot partial c...
795
		}
b8194303   Elena.Budnik   getPlot final
796

2b26bbdd   Elena.Budnik   getPlot partial c...
797
798
799
800
801
802
803
804
805
806
		$this->service = strtolower(__FUNCTION__);
		
		if (!isset($this->requestManager))
			$this->requestManager = new RequestManagerClass();
		
		try {
			$plotResult = $this->requestManager->runWSRequest($this->userID, $this->IPclient, FunctionTypeEnumClass::PARAMS, $this->service, $requestObject);
		} catch (Exception $e) {
				$this->throwError("plotError", "Exeption detected : ".$e->getMessage());
		}
b8194303   Elena.Budnik   getPlot final
807
808
809
810
811
812
813
814
815
816
817
818
819
820
		
		if (!$plotResult['success']) {
			$this->throwError("serverError", $plotResult['message']);
		}
		
		if($plotResult['status'] == 'in_progress') {
			return ['success' => true, 'status' => 'in progress', 'id' => $plotResult['id']];
		} elseif ($plotResult['status'] == 'done') 
		{
			$this->deleteProcess($plotResult['id']);
			return array('success' => true, 'status' => 'done', 'plotFileURL' => WSConfigClass::getUrl().$plotResult['result']);
		} else {
			return ['success' => false, 'message' => 'Unknown status ' . $plotResult['status']];
		} 
2b26bbdd   Elena.Budnik   getPlot partial c...
821
	}
16035364   Benjamin Renard   First commit
822
}
cd1dd332   Elena.Budnik   getTimeTable
823
?>