Blame view

src/InputOutput/IHMImpl/Params/IHMInputOutputParamsAbstractClass.php 6.88 KB
22521f1c   Benjamin Renard   First commit
1
2
3
4
5
6
7
8
9
10
11
12
<?php

/**
 * @class IHMInputOutputParamsAbstractClass
 * @brief Abstract class that's implement an InputOutputInterface used to treat input/output of a "param" (ie. download, data mining, plot, ...) request
 * @details
 */
abstract class IHMInputOutputParamsAbstractClass implements InputOutputInterface
{
	protected $paramManager      = null;
	protected $expressionManager = null;
	protected $jobsManager       = null;
bf27ba04   Benjamin Renard   Add templated par...
13
	
22521f1c   Benjamin Renard   First commit
14
15
16
	protected $paramsData        = null;
	protected $requestID         = "";
	protected $requestDirPrefix  = "";
d5a86709   Elena.Budnik   interim commit
17
18
	protected $input             = null;
	protected $sendToSamp        = FALSE;
22521f1c   Benjamin Renard   First commit
19
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

	/*
	 * @brief Constructor
	*/
	function __construct()
	{
		$this->paramManager     = new IHMParamManagerClass();
		$this->expressionParser = new IHMExpressionParserClass();
		$this->jobsManager      = new IHMJobsManagerClass();
	}

	/*
	 * @brief Generate a unique ID for the current request
	*/
	protected function generateNewRequestId()
	{
		$this->requestID = CommonClass::generateRandomString(6);
	}

	/*
	 * @brief Get working dir name
	*/
	protected function getWorkingDirName()
	{
		return $this->requestDirPrefix.$this->requestID."_";
	}

	/*
	 * @brief Get full working dir path
	*/
	protected function getWorkingPath()
	{
		return IHMConfigClass::getRequestPath().$this->getWorkingDirName().'/';
	}

	/*
	 * @brief Unmarshall the time definition from the IHM request
	*/
00a22067   Benjamin Renard   TT navigation
57
	protected function unmarshallTimeDefinition($input, $requestIndex, $ttFileIndex = -1, $ttIntIndex = -1)
22521f1c   Benjamin Renard   First commit
58
	{
f7093283   Benjamin Renard   Fix pb with PHP v...
59
60
		$requestNodes = $this->paramsData->getRequestNodes();
		$timesNode = $requestNodes[$requestIndex]->getTimesNode();
22521f1c   Benjamin Renard   First commit
61
62
63
64

		switch ($input->timesrc)
		{
			case "TimeTable" :
00a22067   Benjamin Renard   TT navigation
65
66
67
68
				if (($ttFileIndex >= 0) && ($ttFileIndex >= count($input->timeTables)))
					throw new Exception('Try to use a non-existing Time table index in the request.');
				
				$crtIndex = 0;
22521f1c   Benjamin Renard   First commit
69
70
				foreach ($input->timeTables as $tt)
				{
00a22067   Benjamin Renard   TT navigation
71
72
73
74
75
76
77
					if (($ttFileIndex >= 0 ) && ($ttFileIndex != $crtIndex))
					{
						// Do not plot this TT
						++$crtIndex;
						continue;
					}
						
a242857a   Benjamin Renard   Shared objects
78
79
80
81
82
83
84
85
86
87
88
89
90
					if (strpos($tt->id, "sharedtimeTable_") === 0) {
						$result = IHMSharedObjectsClass::getPath("timeTable", $tt->id);
						if (!$result['success'])
							throw new Exception($result['message']);
						$ttPath = $result['path'];
					}
					else if (strpos($tt->id, "sharedcatalog_") === 0) {
						$result = IHMSharedObjectsClass::getPath("catalog", $tt->id);
						if (!$result['success'])
							throw new Exception($result['message']);
						$ttPath = $result['path'];
					}
					else {
22521f1c   Benjamin Renard   First commit
91
						$ttPath = IHMConfigClass::getUserTTPath();
a242857a   Benjamin Renard   Shared objects
92
93
94
95
						$ttPath .= ($tt->id.".xml");
					}
					
					if ((strpos($tt->id, "cat_") === 0) || (strpos($tt->id, "sharedcatalog_") === 0))
00a22067   Benjamin Renard   TT navigation
96
						$timesNode->addCatalog($ttPath, $tt->{'timeTableName'}, $ttIntIndex);
c0e7e5be   Benjamin Renard   Add integration f...
97
					else
00a22067   Benjamin Renard   TT navigation
98
99
						$timesNode->addTimeTable($ttPath, $tt->{'timeTableName'}, $ttIntIndex);
					++$crtIndex;
22521f1c   Benjamin Renard   First commit
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
				}
				break;
			case "Interval" :
				date_default_timezone_set('UTC');
				$timeStamp = strtotime($input->startDate);
				$start = CommonClass::timeStampToDDTime($timeStamp);
				$timeStamp = strtotime($input->stopDate) - strtotime($input->startDate);
				$duration = CommonClass::timeStampToDDTime($timeStamp);
				$timesNode->addInterval($start, $duration);
				break;
			default :
				throw new Exception('Time source type not implemented.');
		}
	}

	/*
	 * @brief Add a job to the job manager
	*/
	protected function addToJobsFile($data,$resultKey)
	{
d5a86709   Elena.Budnik   interim commit
120
121
122
123
124
125
126
		$waitingResult = $data->getWaitingResult($resultKey);
		if ($this->sendToSamp && ($data->getStatus() == ProcessStatusEnumClass::DONE)) {
			$waitingResult = explode("\n", file_get_contents(IHMConfigClass::getRequestPath()."/".$this->getWorkingDirName()."/".$waitingResult));
			$waitingResult = implode(',', $waitingResult);
			$waitingResult = rtrim($waitingResult, ',');
		}

22521f1c   Benjamin Renard   First commit
127
128
129
130
131
132
		return $this->jobsManager->addJob(
				$this->input,
				$data->getId(),
				$this->getWorkingDirName(),
				$data->getStatus() == ProcessStatusEnumClass::RUNNING,
				$data->getStart(),
5cf99396   Benjamin Renard   Add SAMP export i...
133
				$waitingResult,
ba82a624   Benjamin Renard   Get kernel execut...
134
135
				$data->getErrorCode(),
				$data->getExecTime());
22521f1c   Benjamin Renard   First commit
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
	}
	
	/*
	 * @brief Delete current working dir + delete jobs that use this working dir + delete process
	 */
	protected function deleteWorkingDir()
	{
		$res = $this->jobsManager->getJobsByWorkingDir($this->getWorkingDirName());
		
		if (!$res['success'])
			return;
		
		foreach ($res['jobs'] as $jobId)
		{
			//delete process
d5a86709   Elena.Budnik   interim commit
151
152
153
154
155
156
157
158
159
			$deleteData = new ProcessRequestDataClass();
			$deleteData->setManagerFilePath(IHMConfigClass::getProcessManagerFilePath());
			$deleteData->setType(ProcessTypeEnumClass::DELETE);
			$deleteData->setId($jobId);
				
			$processRequest = new ProcessRequestClass();
			$processRequest->setData($deleteData);

			if ($processRequest->init())
22521f1c   Benjamin Renard   First commit
160
161
				$processRequest->run();
			
d5a86709   Elena.Budnik   interim commit
162
			//delete job and working dir
22521f1c   Benjamin Renard   First commit
163
164
165
166
167
168
			$this->jobsManager->deleteJob($jobId);
		}
	}
	/*
	 * @brief Marshall request result for the IHM client
	*/
d5a86709   Elena.Budnik   interim commit
169
170
171
172
173
174
175
176
177
	protected function commonMarshallResult($data,$resultKey)
	{
		if (!$data->getSuccess())
			return array(
					'success' => false,
					'message' => $data->getLastErrorMessage());

		switch ($data->getStatus())
		{
22521f1c   Benjamin Renard   First commit
178
			case ProcessStatusEnumClass::ERROR :
d5a86709   Elena.Budnik   interim commit
179
			case ProcessStatusEnumClass::RUNNING :
22521f1c   Benjamin Renard   First commit
180
			case ProcessStatusEnumClass::DONE :
d5a86709   Elena.Budnik   interim commit
181
182
183
184
185
186
				return $this->addToJobsFile($data,$resultKey);
			default :
				return array(
				'success' => false,
				'message'   => 'Unknown Process Status');
		}
22521f1c   Benjamin Renard   First commit
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
	}

	/*
	 * @brief translate input data from IHM client to AMDA_Integration module for a "param" request
	*/
	public function getInputData($input,$function,$requestId = "")
	{
		if (isset($this->paramsData))
			unset($this->paramsData);

		$this->paramsData = new ParamsRequestDataClass();
		if ($requestId == "")
		{
			$this->requestDirPrefix = "DD";
			$this->generateNewRequestId();
		}
		else
		{
d5a86709   Elena.Budnik   interim commit
205
			$this->requestDirPrefix = "";
22521f1c   Benjamin Renard   First commit
206
			$this->requestID = $requestId;
22521f1c   Benjamin Renard   First commit
207
208
209
		}
		$this->paramsData->setWorkingPath($this->getWorkingPath());
		$this->paramsData->setCompilationPath(IHMConfigClass::getCompilationPath());
944199fe   Benjamin Renard   Use table definit...
210
		$this->paramsData->setLocalBasePath(IHMConfigClass::getLocalBasePath());
22521f1c   Benjamin Renard   First commit
211
		$this->paramsData->setManagerFilePath(IHMConfigClass::getProcessManagerFilePath());
2438ca9c   Elena.Budnik   add function
212
		$this->paramsData->setTask($input->nodeType);
22521f1c   Benjamin Renard   First commit
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
		$this->input = $input;

		return $this->unmarshallRequest($input);
	}

	/*
	 * @brief translate output data from AMDA_Integration module to IHM client for a "param" request
	*/
	public function getOutput($data)
	{
		return $this->marshallResult($data);
	}

	/*
	 * @brief Abstract method to unmarshall a "param" request
	*/
	abstract protected function unmarshallRequest($input);

	/*
	 * @brief Abstract method to marshall the result of a "param" request
	*/
	abstract protected function marshallResult($data);
}

d5a86709   Elena.Budnik   interim commit
237
?>