Blame view

src/InputOutput/IHMImpl/Tools/IHMJobsManagerClass.php 14.6 KB
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
	{
		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);
c6b591d9   Nathanael Jourdane   Send runningPath ...
202
203
204
205
206
207

		$attributes = [];
		foreach( $job->attributes as $attrName => $attrNode) {
			$attributes[$attrName] = $attrNode->nodeValue;
		}

22521f1c   Benjamin Renard   First commit
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
		$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...
233
234
235
236
237
238
239
			$sendToSamp = $job->getAttribute('sendToSamp');
			if (empty($sendToSamp)) {
				$sendToSamp = false;
			}
			else {
				$sendToSamp = ($sendToSamp == "true");
			}
22521f1c   Benjamin Renard   First commit
240
241
242
243
244
245
246
247
248
249
250
251
252
		}
		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...
253
254
255
				'compression' => $compression,
				'sendToSamp'  => $sendToSamp,
		);
22521f1c   Benjamin Renard   First commit
256
257
	}

22521f1c   Benjamin Renard   First commit
258
259
260
	/*
	 * @brief Add a new job
	*/
01c17a02   Nathanael Jourdane   Add detailled inf...
261
	public function addJob($obj, $id, $folder, $running, $start, $result, $exitcode)
22521f1c   Benjamin Renard   First commit
262
	{
01c17a02   Nathanael Jourdane   Add detailled inf...
263
		$obj = get_object_vars($obj); // Allow access to elements where the key is in dash-separated form.
22521f1c   Benjamin Renard   First commit
264
265
266
267
		$res = $this->init();
		if (!$res['success'])
			return $res;

01c17a02   Nathanael Jourdane   Add detailled inf...
268
269
270
271
		$infos = [];
		switch ($obj['nodeType']) {
			// Data mining
			case 'condition':
22521f1c   Benjamin Renard   First commit
272
				$name = 'datamining_'.time();
2b83ab1a   Nathanael Jourdane   improve job tooltip
273
274
275
				if($obj['name'] != '') {
					$infos['Name'] = $obj['name'];
				}
01c17a02   Nathanael Jourdane   Add detailled inf...
276
277
278
				$infos['Condition'] = $obj['expression'];
				$infos['Start date'] = $obj['startDate'];
				$infos['Stop date'] = $obj['stopDate'];
22521f1c   Benjamin Renard   First commit
279
				break;
01c17a02   Nathanael Jourdane   Add detailled inf...
280
281

			case 'statistics':
01ff2cc6   elena   catalog draft
282
				$name = 'statistics_'.time();
2b83ab1a   Nathanael Jourdane   improve job tooltip
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
				$infos['Name'] =  $obj['name']; // TODO: name toujours égal à 'test' (?)

				// TODO : lire data/user/TT/tt_0.xml -> trouver ttname + nbIntervals

				if(array_key_exists('timeTables', $obj)) {
					$ttXml = new DomDocument();
					$ttXml->load(USERWSDIR . 'Tt.xml');

					$ttIntervals = [];
					foreach ($ttXml->getElementsByTagName('timetab') as $tt) {
						$ttIntervals[$tt->getAttribute('name')] = $tt->getAttribute('intervals');
					}

					if(count($obj['timeTables']) == 1) {
						$infos['Time table'] = $obj['timeTables'][0]->timeTableName;
						$infos['Nb Intervals'] = $ttIntervals[$infos['Time table']];
					} else {
						foreach ($obj['timeTables'] as $tt) {
							if($tt === reset($obj['timeTables'])) {
								$infos['Time tables'] = $tt->timeTableName . '(' . $ttIntervals[$tt->timeTableName] . ' int.)';
							} else {
								$infos['Time tables'] .= ', ' . $tt->timeTableName . '(' . $ttIntervals[$tt->timeTableName] . ' int.)';
							}
						}
					}
				} else {
					$infos['Start date'] = $obj['startDate'];
					$infos['Stop date'] = $obj['stopDate'];
				}

01c17a02   Nathanael Jourdane   Add detailled inf...
313
314
315
316
317
318
319
320
321
322
323
324
				if(array_key_exists('expression', $obj)) {
					$infos['Expression'] =  $obj['expression'];
				}
				$params = [];
				foreach ($obj['parameter'] as $param) {
					$params[] = $param->function . '(' . $param->paramid . ')';
				}
				if(count($params) == 1) {
					$infos['Parameter'] = $params[0];
				} else {
					$infos['Parameters'] = '<ul><li>' . join('</li><li>', $params) . '</li></ul>';
				}
01ff2cc6   elena   catalog draft
325
				break;
01c17a02   Nathanael Jourdane   Add detailled inf...
326
327
328
329
330
331
332
333
334
335
336

			case 'download':
				$name = $obj['downloadSrc'] == '2' ? "download_fits_".time() : "download_data_".time();
				$params = [];
				foreach ($obj['list'] as $param) {
					$params[] = $param->paramid;
				}
				if(count($params) == 1) {
					$infos['Parameter'] = $params[0];
				} else {
					$infos['Parameters'] = join(', ', $params);
22521f1c   Benjamin Renard   First commit
337
				}
01c17a02   Nathanael Jourdane   Add detailled inf...
338
339
				$infos['Start date'] = $obj['startDate'];
				$infos['Stop date'] = $obj['stopDate'];
22521f1c   Benjamin Renard   First commit
340
				break;
01c17a02   Nathanael Jourdane   Add detailled inf...
341
342
343

			// Plot
			case 'request':
22521f1c   Benjamin Renard   First commit
344
				$name = "request_".time();
01c17a02   Nathanael Jourdane   Add detailled inf...
345
346
347
348
349
350

				$infos['Output'] = strtolower($obj['file-format']) . ' (' . strtolower($obj['file-output']) . ')';
				foreach ($obj['tabs'] as $tab) {
					if($tab->id == $obj['last-plotted-tab']) {
						$infos['Start date'] = $tab->startDate;
						$infos['Stop date'] = $tab->stopDate;
01c17a02   Nathanael Jourdane   Add detailled inf...
351
352

						$strPanels = [];
2b83ab1a   Nathanael Jourdane   improve job tooltip
353

01c17a02   Nathanael Jourdane   Add detailled inf...
354
						foreach ($tab->panels as $panel) {
2b83ab1a   Nathanael Jourdane   improve job tooltip
355
							$strParams = '';
01c17a02   Nathanael Jourdane   Add detailled inf...
356
							foreach ($panel->params as $param) {
2b83ab1a   Nathanael Jourdane   improve job tooltip
357
								$strParams .= $param->paramid . ($param === end($panel->params) ? '' : ', ');
01c17a02   Nathanael Jourdane   Add detailled inf...
358
							}
6e9bb13d   Nathanael Jourdane   improve job toolt...
359
							$infos['• Panel ' . $panel->id] = $strParams;
01c17a02   Nathanael Jourdane   Add detailled inf...
360
361
362
						}

						continue;
22521f1c   Benjamin Renard   First commit
363
364
365
					}
				}
				break;
01c17a02   Nathanael Jourdane   Add detailled inf...
366

22521f1c   Benjamin Renard   First commit
367
368
			default:
				$name = "unknown_".time();
22521f1c   Benjamin Renard   First commit
369
		}
a125e4f0   Nathanael Jourdane   Remove interval d...
370
		$infos['Started at'] = gmdate("Y-m-d H:i:s", $start);
22521f1c   Benjamin Renard   First commit
371

01c17a02   Nathanael Jourdane   Add detailled inf...
372
373
		$strInfo = '';
		foreach ($infos as $key => $info) {
2b83ab1a   Nathanael Jourdane   improve job tooltip
374
			$strInfo .= ($key == 'Started at' ? '<hr/>' : '') . '<b>' . $key . '</b>: ' . $info . '<br/>';
01c17a02   Nathanael Jourdane   Add detailled inf...
375
		}
22521f1c   Benjamin Renard   First commit
376

01c17a02   Nathanael Jourdane   Add detailled inf...
377
378
379
380
381
		$newJob = $this->jobXml->createElement('job');
		$newJob->setAttribute('xml:id', $id);
		$newJob->setAttribute('jobType', $obj['nodeType']);
		$newJob->setAttribute('name', $name);
		$newJob->setAttribute('info', $strInfo);
22521f1c   Benjamin Renard   First commit
382
		$newJob->setAttribute('folder', $folder);
22521f1c   Benjamin Renard   First commit
383
		$newJob->setAttribute('result', $result);
22521f1c   Benjamin Renard   First commit
384
		$newJob->setAttribute('start', date('d-m-Y H:i:s', $start));
22521f1c   Benjamin Renard   First commit
385
386
387
		//to know if know if it's an immediate job or not
		$newJob->setAttribute('immediate', !$running);

01c17a02   Nathanael Jourdane   Add detailled inf...
388
		$sendToSamp = isset($obj['sendToSamp']) ? $obj['sendToSamp'] : FALSE;
5cf99396   Benjamin Renard   Add SAMP export i...
389
390
391
392
		if ($sendToSamp) {
			 $newJob->setAttribute('sendToSamp', "true");
		}

01c17a02   Nathanael Jourdane   Add detailled inf...
393
		$key = $obj['nodeType'];
22521f1c   Benjamin Renard   First commit
394
395
		if ($running)
		{
01c17a02   Nathanael Jourdane   Add detailled inf...
396
			$rootJobNode = $this->jobXml->getElementById($this->bkgRootNode[$key]);
22521f1c   Benjamin Renard   First commit
397
398
			if (!$rootJobNode)
			{
22521f1c   Benjamin Renard   First commit
399
				$rootJobNode =  $this->jobXml->createElement("$key");
01c17a02   Nathanael Jourdane   Add detailled inf...
400
				$rootJobNode->setAttribute('xml:id', $this->bkgRootNode[$key]);
22521f1c   Benjamin Renard   First commit
401
402
403
404
405
406
				$jobsInProgress = $this->jobXml->getElementsByTagName('jobsInProgress')->item(0);
				$jobsInProgress->appendChild($rootJobNode);
			}
		}
		else
		{
01c17a02   Nathanael Jourdane   Add detailled inf...
407
			$rootJobNode = $this->jobXml->getElementById($this->resRootNode[$key]);
22521f1c   Benjamin Renard   First commit
408
409
			if (!$rootJobNode)
			{
22521f1c   Benjamin Renard   First commit
410
				$rootJobNode =  $this->jobXml->createElement("$key");
01c17a02   Nathanael Jourdane   Add detailled inf...
411
				$rootJobNode->setAttribute('xml:id', $this->resRootNode[$key]);
22521f1c   Benjamin Renard   First commit
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
				$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);

8fc77945   Nathanael Jourdane   Show number of in...
440
		if (!isset($job)) {
22521f1c   Benjamin Renard   First commit
441
			return array("success" => false, "message" => "Cannot found job");
8fc77945   Nathanael Jourdane   Show number of in...
442
443
		}

22521f1c   Benjamin Renard   First commit
444
445
446
		$jobstatus = $this->getJobStatus($running,$exitcode);
		$job->setAttribute('status', $jobstatus);

efe25e99   Nathanael Jourdane   update job info o...
447
448
		$infos = [];

8fc77945   Nathanael Jourdane   Show number of in...
449
		if ($running) {
22521f1c   Benjamin Renard   First commit
450
			$job->setAttribute('stop', 'unknown');
8fc77945   Nathanael Jourdane   Show number of in...
451
		} else if ($job->getAttribute('stop') == '' || $job->getAttribute('stop') == 'unknown') {
22521f1c   Benjamin Renard   First commit
452
			$job->setAttribute('stop', date('d-m-Y H:i:s', time()));
efe25e99   Nathanael Jourdane   update job info o...
453

3945ae76   Nathanael Jourdane   Add error code on...
454
455
456
457
			$start = new DateTime($job->getAttribute('start'));
			$interval = (new DateTime('now'))->diff($start);
			$infos['Job duration'] = $interval->format('%Hh %Im %Ss');

8fc77945   Nathanael Jourdane   Show number of in...
458
459
460
461
462
463
464
465
466
467
			$resPath = glob(USERWORKINGDIR . $job->getAttribute('folder') . '/' . $job->getAttribute('result') . '*')[0];

			if($job->getAttribute('jobType') == 'condition') {
				error_log('resPath: ' . $resPath);
				$resXml = new DomDocument();
				$resXml->load($resPath);
				$infos['nb intervals'] = $resXml->getElementsByTagName('nbIntervals')->item(0)->nodeValue;
			}

			$fileSize = filesize($resPath);
efe25e99   Nathanael Jourdane   update job info o...
468
469
470
471
472
473
474
475
476
477
478
			if ($fileSize < 1024) {
				$strSize = number_format($fileSize, 2, '.', ' ') . 'b';
			} else if($fileSize < 1024*1024) {
				$strSize = number_format($fileSize/1024, 2, '.', ' ') . 'kb';
			} else if($fileSize < 1024*1024*1024) {
				$strSize = number_format($fileSize/(1024*1024), 2, '.', ' ') . 'mb';
			} else {
				$strSize = number_format($fileSize/(1024*1024*1024), 2, '.', ' ') . 'gb';
			}
			$infos['File size'] = $strSize;

22521f1c   Benjamin Renard   First commit
479
480
			$this->jobXml->getElementById($this->resRootNode[$job->getAttribute('jobType')])->appendChild($job);
		}
efe25e99   Nathanael Jourdane   update job info o...
481

3945ae76   Nathanael Jourdane   Add error code on...
482
483
484
485
		if($exitcode != 0) {
			$infos['Error code'] = $exitcode;
		}

efe25e99   Nathanael Jourdane   update job info o...
486
487
488
489
490
491
		$strInfo = $job->getAttribute('info');
		foreach ($infos as $key => $info) {
			$strInfo .= '<b>' . $key . '</b>: ' . $info . '<br/>';
		}
		$job->setAttribute('info', $strInfo);

22521f1c   Benjamin Renard   First commit
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
		$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);
	}
}
?>