CDPP / AMDA_Integration

Blame view

src/InputOutput/IHMImpl/Tools/IHMJobsManagerClass.php 11 KB
Edit Raw Normal View History
22521f1c   Benjamin Renard   First commit 
1
2
3
4
5
6
7
8
9
10
11
12
 
<?php
/**
 * @class IHMJobsManagerClass
 * @brief Jobs manager
 * @details
 */
class IHMJobsManagerClass {

	protected $jobXml, $jobXmlName;

	protected $bkgRootNode = array('condition' => 'bkgSearch-treeRootNode',
			'request' => 'bkgPlot-treeRootNode',
01ff2cc6   elena   catalog draft 
13
14
 
			'download' => 'bkgDown-treeRootNode',
			'statistics' => 'bkgStatistics-treeRootNode');
22521f1c   Benjamin Renard   First commit 
15
16
17
 

	protected $resRootNode = array('condition' => 'resSearch-treeRootNode',
			'request' => 'resPlot-treeRootNode',
01ff2cc6   elena   catalog draft 
18
19
 
			'download' => 'resDown-treeRootNode',
			'statistics' => 'resStatistics-treeRootNode');
22521f1c   Benjamin Renard   First commit 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 

	/*
	 * @brief Constructor
	*/
	function __construct()
	{
	}

	/*
	 * @brief Load jobs file and create it if needed
	*/
	private function init()
	{
		$this->jobXmlName = IHMConfigClass::getUserJobsFile();
		$this->jobXml = new DomDocument("1.0");

		if (!file_exists($this->jobXmlName))
		{
			$res = $this->createJobsFile();
			if (!$res['success'])
				return $res;
		}

		$res = $this->jobXml->load($this->jobXmlName);
		if (!$res)
			return array(
					"success" => false,
					"message" => "Cannot load jobs file");

		return array("success" => true);
	}

	/*
	 * @brief Create a new jobs file
	*/
	private function createJobsFile()
	{
		$rootElement = $this->jobXml->createElement('jobs');
		$jobsInProgress = $this->jobXml->createElement('jobsInProgress');

		foreach ($this->bkgRootNode as $key => $value)
		{
			$element = $this->jobXml->createElement("$key");
			$element->setAttribute('xml:id',$value);
			$jobsInProgress->appendChild($element);
		}
		$jobsFinished = $this->jobXml->createElement('jobsFinished');

		foreach ($this->resRootNode as $key => $value)
		{
			$element = $this->jobXml->createElement("$key");
			$element->setAttribute('xml:id',"$value");
			$jobsFinished->appendChild($element);
		}

		$rootElement->appendChild($jobsInProgress);
		$rootElement->appendChild($jobsFinished);
		$this->jobXml->appendChild($rootElement);

		$res = $this->jobXml->save($this->jobXmlName);

		if (!$res)
			return array(
					"success" => false,
					"message" => "Cannot create new jobs file");

		return array("success" => true);
	}

	/*
	 * @brief Get the path of the request object file
	*/
	protected function getRequestObjectFilePath($id)
	{
		return IHMConfigClass::getUserJobsPath().$id.".request";
	}

	/*
	 * @brief Save a request object file
	*/
	protected function saveRequestObjectFile($obj, $id)
	{
		$file = fopen($this->getRequestObjectFilePath($id), 'w');
		fwrite($file, json_encode($obj));
		fclose($file);
	}

	/*
	 * @brief Decode a request object file
	*/
84cb4dbb   Benjamin Renard   Give the possibil... 
110
 
	public function getRequestObjectFile($id)
22521f1c   Benjamin Renard   First commit 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
	{
		if (!file_exists($this->getRequestObjectFilePath($id)))
			return NULL;
		return json_decode(file_get_contents($this->getRequestObjectFilePath($id)));
	}

	/*
	 * @brief Delete a request object file
	*/
	protected function deleteRequestObjectFile($id) {
		if (file_exists($this->getRequestObjectFilePath($id)))
			unlink($this->getRequestObjectFilePath($id));
	}

	/*
	 * @brief get a job status from process info
	*/
	protected function getJobStatus($running,$exitcode)
	{
		if ($running)
			return 'in_progress';

		if ($exitcode == 0)
			return 'done';

		return 'error';
	}

	/*
	 * @brief delete a job
	*/
	public function deleteJob($id)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;

		$job = $this->jobXml->getElementById($id);

		//delete job
		if (!$job)
			return array('success' => false, 'message' => "Job not reachable");

		$folder = $job->getAttribute('folder');

		//be sure that it's an AMDA working dir before deletion...
		$fullFolderPath = IHMConfigClass::getRequestPath().$folder.'/';
		if ((isset($folder)) &&
		($folder != "") &&
		is_dir($fullFolderPath) &&
		(preg_match("/DD[0-9A-Za-z]*_/",$folder) ||
		 preg_match("/Plot[0-9]*_/",$folder)))
		{
			foreach (glob($fullFolderPath.'*') as $filename)
			{
				if (is_dir($filename) && (basename($filename) == 'params'))
				{
					//recursive deletion only for "params" dir (a full recursive deletion is probably too dangerous...)
					foreach (glob($filename.'/*') as $paramname)
						unlink($paramname);
					rmdir($filename);
				}
				else
					unlink($filename);
			}
			rmdir($fullFolderPath);
		}

		$this->deleteRequestObjectFile($id);

		$job->parentNode->removeChild($job);
		$res = $this->jobXml->save($this->jobXmlName);

		if (!$res)
			return array(
					'success' => false,
					'message' => "Cannot save jobs file");
			
		return array('success' => true, 'id' => $id);
	}

	/*
	 * @brief get job info about a job
	*/
	public function getJobInfo($id)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;

		$job = $this->jobXml->getElementById($id);
		$format = 'unknown';
		$compression = 'unknown';
		if($job)
		{
			$name = $job->getAttribute('name');
			$status = $job->getAttribute('status');
			$jobType = $job->getAttribute('jobType');
			$info = $job->getAttribute('info');
			$start = $job->getAttribute('start');
			$stop = $job->getAttribute('stop');
			$result = $job->getAttribute('result');
			$folder = $job->getAttribute('folder');
			$request_obj = $this->getRequestObjectFile($id);
			if (isset($request_obj))
			{
				if (isset($request_obj->format))
				{
					$format = strtolower($request_obj->format);
					if (($format == "pdf") || ($format == "ps"))
						//auto compression for plot request
						$compression = ".tar.gz";
				}
				if (isset($request_obj->compression))
					$compression = strtolower($request_obj->compression);
			}
5cf99396   Benjamin Renard   Add SAMP export i... 
227
228
229
230
231
232
233
 
			$sendToSamp = $job->getAttribute('sendToSamp');
			if (empty($sendToSamp)) {
				$sendToSamp = false;
			}
			else {
				$sendToSamp = ($sendToSamp == "true");
			}
22521f1c   Benjamin Renard   First commit 
234
235
236
237
238
239
240
241
242
243
244
245
246
 
		}
		return array(
				'success'     => true,
				'id'          => $id,
				'name'        => $name,
				'status'      => $status,
				'jobType'     => $jobType,
				'info'        => $info,
				'start'       => $start,
				'stop'        => $stop,
				'folder'      => $folder,
				'result'      => $result,
				'format'      => $format,
5cf99396   Benjamin Renard   Add SAMP export i... 
247
248
249
 
				'compression' => $compression,
				'sendToSamp'  => $sendToSamp,
		);
22521f1c   Benjamin Renard   First commit 
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
	}

	/*
	 * @brief Add a new job
	*/
	public function addJob($obj, $id, $folder,
			$running, $start, $result, $exitcode)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;

		$newJob = $this->jobXml->createElement('job');

		$newJob->setAttribute('xml:id', $id);
		$newJob->setAttribute('jobType', $obj->nodeType);

		switch ($obj->nodeType)
		{
			case 'condition' :
				$name = 'datamining_'.time();
				$info = $obj->expression;
				break;
01ff2cc6   elena   catalog draft 
273
274
275
276
 
			case 'statistics' :
				$name = 'statistics_'.time();
				$info = $obj->expression;
				break;
22521f1c   Benjamin Renard   First commit 
277
278
279
280
281
282
283
284
285
286
287
 
			case 'download' :
				if ($obj->downloadSrc == '2') //fits image
					$name = "download_fits_".time();
				else
					$name = "download_data_".time();
				$info = '';
				foreach ($obj->list as $param)
				{
					if ($obj->downloadSrc == '2') //fits image
						$info = $info.' '.$param->url;
					else
3182799a   Benjamin Renard   Use param indexes... 
288
 
						$info = $info.' '.$param->name; //data
22521f1c   Benjamin Renard   First commit 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
				}
				break;
			case 'request'	 :
				$name = "request_".time();
				$info = '';
				for ($i=0; $i < count($obj->children); $i++) {
					for ($j=0; $j < count($obj->children[$i]->children); $j++) {
						$info = $info.' '.$obj->children[$i]->children[$j]->name;
					}
				}
				break;
			default:
				$name = "unknown_".time();
				$info = '';
		}

		$newJob->setAttribute('name', $name);
		$newJob->setAttribute('info', $info);

		$newJob->setAttribute('folder', $folder);

		$newJob->setAttribute('result', $result);

		$newJob->setAttribute('start', date('d-m-Y H:i:s', $start));

		$newJob->setAttribute('result', $result);

		//to know if know if it's an immediate job or not
		$newJob->setAttribute('immediate', !$running);
5cf99396   Benjamin Renard   Add SAMP export i... 
319
320
321
322
323
 
		$sendToSamp = isset($obj->sendToSamp) ? $obj->sendToSamp : FALSE;
		if ($sendToSamp) {
			 $newJob->setAttribute('sendToSamp', "true");
		}
22521f1c   Benjamin Renard   First commit 
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
		if ($running)
		{
			$rootJobNode = $this->jobXml->getElementById($this->bkgRootNode[$obj->nodeType]);
			if (!$rootJobNode)
			{
				$key = $obj->nodeType;
				$rootJobNode =  $this->jobXml->createElement("$key");
				$rootJobNode->setAttribute('xml:id', $this->bkgRootNode[$obj->nodeType]);
				$jobsInProgress = $this->jobXml->getElementsByTagName('jobsInProgress')->item(0);
				$jobsInProgress->appendChild($rootJobNode);
			}
		}
		else
		{
			$rootJobNode = $this->jobXml->getElementById($this->resRootNode[$obj->nodeType]);
			if (!$rootJobNode)
			{
				$key = $obj->nodeType;
				$rootJobNode =  $this->jobXml->createElement("$key");
				$rootJobNode->setAttribute('xml:id', $this->resRootNode[$obj->nodeType]);
				$jobsFinished = $this->jobXml->getElementsByTagName('jobsFinished')->item(0);
				$jobsFinished->appendChild($rootJobNode);
			}
		}

		$rootJobNode->appendChild($newJob);
		 
		if (!$this->jobXml->save($this->jobXmlName))
			return  array("success" => false, "message" => "Cannot save job manager file");

		$this->saveRequestObjectFile($obj, $id);

		$this->updateJobStatus($id, $running, $exitcode);

		return  $this->getJobInfo($id);
	}

	/*
	 * @brief Update the status of a job
	*/
	public function updateJobStatus($id, $running, $exitcode)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;

		$job = $this->jobXml->getElementById($id);

		if (!isset($job))
			return array("success" => false, "message" => "Cannot found job");
			
		$jobstatus = $this->getJobStatus($running,$exitcode);
		$job->setAttribute('status', $jobstatus);

		if ($running)
			$job->setAttribute('stop', 'unknown');
		else if ($job->getAttribute('stop') == '' || $job->getAttribute('stop') == 'unknown')
		{
			$job->setAttribute('stop', date('d-m-Y H:i:s', time()));
			$this->jobXml->getElementById($this->resRootNode[$job->getAttribute('jobType')])->appendChild($job);
		}
			
		$res = $this->jobXml->save($this->jobXmlName);

		if (!$res)
			return array(
					'success' => false,
					'message' => "Cannot save jobs status file");
			
		return $this->getJobInfo($id);
	}

	/*
	 * @brief Get the list of jobs with a specific status
	*/
	public function getJobsByStatus($status)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;
			
		$xp = new domxpath($this->jobXml);
		$jobs = $xp->query("//job[@status='".$status."']");

		$jobsId = array();
		foreach ($jobs as $job)
			$jobsId[] = $job->getAttribute('xml:id');

		return array('success' => true, 'jobs' => $jobsId);
	}
	
	/*
	 * @brief Get jobs that use a specific working dir
	*/
	public function getJobsByWorkingDir($folder)
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;
			
		$xp = new domxpath($this->jobXml);
		$jobs = $xp->query("//job[@folder='".$folder."']");
	
		$jobsId = array();
		foreach ($jobs as $job)
			$jobsId[] = $job->getAttribute('xml:id');
	
		return array('success' => true, 'jobs' => $jobsId);
	}

	/*
	 * @brief Get all jobs to clean (immediate result jobs)
	*/
	public function getJobsToClean()
	{
		$res = $this->init();
		if (!$res['success'])
			return $res;

		// Get immediate jobs
		$xp = new domxpath($this->jobXml);
		$jobs = $xp->query("//job[@immediate='1']");

		$jobsId = array();
		foreach ($jobs as $job)
			$jobsId[] = $job->getAttribute('xml:id');

		return array("success" => true, "jobs" => $jobsId);
	}
}
?>