You need to sign in before continuing.

Blame view

src/InputOutput/IHMImpl/Params/IHMInputOutputParamsAbstractClass.php 6.97 KB
22521f1c   Benjamin Renard   First commit
1
2
3
4
5
6
7
8
9
10
<?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;
22521f1c   Benjamin Renard   First commit
11
	protected $jobsManager       = null;
bf27ba04   Benjamin Renard   Add templated par...
12
	
22521f1c   Benjamin Renard   First commit
13
14
15
	protected $paramsData        = null;
	protected $requestID         = "";
	protected $requestDirPrefix  = "";
d5a86709   Elena.Budnik   interim commit
16
17
	protected $input             = null;
	protected $sendToSamp        = FALSE;
22521f1c   Benjamin Renard   First commit
18
19
20
21
22
23
24

	/*
	 * @brief Constructor
	*/
	function __construct()
	{
		$this->paramManager     = new IHMParamManagerClass();
22521f1c   Benjamin Renard   First commit
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
		$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().'/';
	}

	/*
131e60ff   Benjamin Renard   Implement real co...
53
54
55
56
57
58
59
60
	 * @brief Get Task
	 */
	protected function getTask($input)
	{
		return $input->nodeType;
	}

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

		switch ($input->timesrc)
		{
			case "TimeTable" :
00a22067   Benjamin Renard   TT navigation
71
				if (($ttFileIndex >= 0) && ($ttFileIndex >= count($input->timeTables)))
79d4f2a1   Hacene SI HADJ MOHAND   ok 7522
72
73
74
				        $ttFileIndex = 0;
                                if($ttFileIndex < 0)
                                        $ttFileIndex =  count($input->timeTables) -1; 
00a22067   Benjamin Renard   TT navigation
75
				$crtIndex = 0;
22521f1c   Benjamin Renard   First commit
76
77
				foreach ($input->timeTables as $tt)
				{
00a22067   Benjamin Renard   TT navigation
78
79
80
81
82
83
84
					if (($ttFileIndex >= 0 ) && ($ttFileIndex != $crtIndex))
					{
						// Do not plot this TT
						++$crtIndex;
						continue;
					}
						
a242857a   Benjamin Renard   Shared objects
85
86
87
88
89
90
91
92
93
94
95
96
97
					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
98
						$ttPath = IHMConfigClass::getUserTTPath();
a242857a   Benjamin Renard   Shared objects
99
100
101
102
						$ttPath .= ($tt->id.".xml");
					}
					
					if ((strpos($tt->id, "cat_") === 0) || (strpos($tt->id, "sharedcatalog_") === 0))
00a22067   Benjamin Renard   TT navigation
103
						$timesNode->addCatalog($ttPath, $tt->{'timeTableName'}, $ttIntIndex);
c0e7e5be   Benjamin Renard   Add integration f...
104
					else
00a22067   Benjamin Renard   TT navigation
105
106
						$timesNode->addTimeTable($ttPath, $tt->{'timeTableName'}, $ttIntIndex);
					++$crtIndex;
22521f1c   Benjamin Renard   First commit
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
				}
				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
127
128
129
130
131
132
133
		$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
134
135
136
137
138
139
		return $this->jobsManager->addJob(
				$this->input,
				$data->getId(),
				$this->getWorkingDirName(),
				$data->getStatus() == ProcessStatusEnumClass::RUNNING,
				$data->getStart(),
5cf99396   Benjamin Renard   Add SAMP export i...
140
				$waitingResult,
ba82a624   Benjamin Renard   Get kernel execut...
141
142
				$data->getErrorCode(),
				$data->getExecTime());
22521f1c   Benjamin Renard   First commit
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
	}
	
	/*
	 * @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
158
159
160
161
162
163
164
165
166
			$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
167
168
				$processRequest->run();
			
d5a86709   Elena.Budnik   interim commit
169
			//delete job and working dir
22521f1c   Benjamin Renard   First commit
170
171
172
173
174
175
			$this->jobsManager->deleteJob($jobId);
		}
	}
	/*
	 * @brief Marshall request result for the IHM client
	*/
d5a86709   Elena.Budnik   interim commit
176
177
178
179
180
181
182
183
184
	protected function commonMarshallResult($data,$resultKey)
	{
		if (!$data->getSuccess())
			return array(
					'success' => false,
					'message' => $data->getLastErrorMessage());

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

	/*
	 * @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
212
			$this->requestDirPrefix = "";
22521f1c   Benjamin Renard   First commit
213
			$this->requestID = $requestId;
22521f1c   Benjamin Renard   First commit
214
215
216
		}
		$this->paramsData->setWorkingPath($this->getWorkingPath());
		$this->paramsData->setCompilationPath(IHMConfigClass::getCompilationPath());
944199fe   Benjamin Renard   Use table definit...
217
		$this->paramsData->setLocalBasePath(IHMConfigClass::getLocalBasePath());
22521f1c   Benjamin Renard   First commit
218
		$this->paramsData->setManagerFilePath(IHMConfigClass::getProcessManagerFilePath());
131e60ff   Benjamin Renard   Implement real co...
219
		$this->paramsData->setTask($this->getTask($input));
22521f1c   Benjamin Renard   First commit
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
		$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
244
?>