/
ExecutionTrait.php
349 lines (298 loc) · 13.5 KB
/
ExecutionTrait.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
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
110
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
313
314
315
316
317
318
319
320
321
322
323
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
<?php
/**
* Elements.at
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Enterprise License (PEL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) elements.at New Media Solutions GmbH (https://www.elements.at)
* @license http://www.pimcore.org/license GPLv3 and PEL
*/
namespace Elements\Bundle\ProcessManagerBundle;
use Elements\Bundle\ProcessManagerBundle\Model\Configuration;
use Elements\Bundle\ProcessManagerBundle\Model\MonitoringItem;
use Monolog\Logger;
use phpDocumentor\Reflection\Types\Static_;
trait ExecutionTrait
{
protected $commandObject;
protected static $childProcessErrorHandling = 'strict';
protected static $childProcessCheckInterval = 500000; //microseconds
/**
* @param int $microseconds
*/
public static function setChildProcessCheckInterval($microseconds){
self::$childProcessCheckInterval = $microseconds;
}
protected static function getCommand($options)
{
global $argv;
$command = !empty($options['command']) ? $options['command'] : implode(' ', $argv);
return trim($command);
}
/**
* @return string
*/
public static function getChildProcessErrorHandling(): string
{
return static::$childProcessErrorHandling;
}
/**
* @param string $childProcessErrorHandling
* @return $this
*/
public static function setChildProcessErrorHandling($childProcessErrorHandling)
{
static::$childProcessErrorHandling = $childProcessErrorHandling;
}
/**
* @param $monitoringId
* @param array $options
*
* @return MonitoringItem
*/
public static function initProcessManager($monitoringId, $options = [])
{
if (!ElementsProcessManagerBundle::getMonitoringItem(false)) {
if(!array_key_exists("autoCreate",$options)){
$options['autoCreate'] = false;
}
$monitoringItem = null;
if ($monitoringId) {
$monitoringItem = MonitoringItem::getById($monitoringId);
ElementsProcessManagerBundle::setMonitoringItem($monitoringItem);
}elseif(getenv(ElementsProcessManagerBundle::MONITORING_ITEM_ENV_VAR)){ //check for env passed
$monitoringId = getenv(ElementsProcessManagerBundle::MONITORING_ITEM_ENV_VAR);
$monitoringItem = MonitoringItem::getById($monitoringId);
ElementsProcessManagerBundle::setMonitoringItem($monitoringItem);
}
if ($options['autoCreate'] && !$monitoringItem) {
$options['command'] = self::getCommand($options);
if(!array_key_exists('name',$options)){
$commandParts = explode_and_trim(" ",$options['command']);
$options['name'] = $commandParts[1] ?? '';
}
$monitoringItem = new MonitoringItem();
$monitoringItem->setValues($options);
if ($configId = $monitoringItem->getConfigurationId()) {
$config = Configuration::getById($configId);
if ($executor = $config->getExecutorClassObject()) {
$monitoringItem->setLoggers($executor->getLoggers());
}
}
unset($options['id']);
/**
* only set console logger if dont pass loggers or the config doesn't have loggers
*/
if (empty($options['loggers']) && empty($monitoringItem->getLoggers())) {
$monitoringItem->setLoggers([
[
'logLevel' => 'DEBUG',
'simpleLogFormat' => 'on',
'class' => '\Elements\Bundle\ProcessManagerBundle\Executor\Logger\Console'
]
]);
}
$monitoringItem->setStatus($monitoringItem::STATUS_INITIALIZING);
$monitoringItem->setPid(getmypid());
$monitoringItem->save();
$monitoringId = $monitoringItem->getId();
ElementsProcessManagerBundle::setMonitoringItem($monitoringItem);
}
$monitoringItem = ElementsProcessManagerBundle::getMonitoringItem();
if ($monitoringId) {
if ($monitoringItem) {
$config = Configuration::getById($monitoringItem->getConfigurationId());
if ($config) {
if (!$monitoringItem->getName()) {
$monitoringItem->setName($config->getName())->save();
}
if (!$config->getActive()) {
exit('ProcessManager: Config with ID ' . $config->getId().' is disabled - exiting');
}
}
$values = $config ? $config->getExecutorClassObject()->getValues() : $options;
if (!empty($values['uniqueExecution']) && !$monitoringItem->getParentId()) { //dont check if it is a child process
self::doUniqueExecutionCheck($config, $options);
}
}
$options['monitoringItem'] = $monitoringItem;
if (!defined('PIMCORE_CONSOLE') || !PIMCORE_CONSOLE) {
register_shutdown_function(function ($arguments) {
ElementsProcessManagerBundle::shutdownHandler($arguments);
}, $options);
}
ElementsProcessManagerBundle::startup($options);
$monitoringItem->setCurrentStep($options['currentStop'] ?? 1)
->setTotalSteps($options['totalSteps'] ?? 1)->setStatus(MonitoringItem::STATUS_RUNNING)->save();
}
}
self::checkExecutingUser(ElementsProcessManagerBundle::getConfiguration()->getAdditionalScriptExecutionUsers());
return ElementsProcessManagerBundle::getMonitoringItem();
}
/**
* @param $config
* @param $options
*/
protected static function doUniqueExecutionCheck($config, $options)
{
//when we have a config we check for the config id to determine the processes
if ($config) {
$processesRunning = $config->getRunningProcesses();
} else {
$list = new MonitoringItem\Listing();
$list->setCondition('command = ? AND pid <> ""', [$options['command']]);
$processesRunning = [];
foreach ($list->load() as $item) {
if ($item->isAlive()) {
$processesRunning[] = $item;
}
}
}
//remove own pid
foreach ($processesRunning as $i => $item) {
if ($item->getPid() == getmypid()) {
unset($processesRunning[$i]);
}
}
if ($count = count($processesRunning)) {
foreach ($processesRunning as $process) {
//only delete the item if the other process doesn't use the same monitoring ID
if ($process->getId() != ElementsProcessManagerBundle::getMonitoringItem()->getId()) {
ElementsProcessManagerBundle::getMonitoringItem()->delete();
}
}
ElementsProcessManagerBundle::getMonitoringItem()->getLogger()->info('Another process with the PID ' . getmypid().' started. Exiting Process:' . getmypid());
ElementsProcessManagerBundle::setMonitoringItem(null);
exit("\n\nProcessManager: $count ".($count > 1 ? 'processes running' : 'process running'). " - exiting\n\n");
}
}
/**
* @return MonitoringItem
*/
public static function getMonitoringItem()
{
return ElementsProcessManagerBundle::getMonitoringItem();
}
/**
* @return mixed
*/
public function getCommandObject()
{
return $this->commandObject;
}
/**
* @param mixed $commandObject
*
* @return $this
*/
public function setCommandObject($commandObject)
{
$this->commandObject = $commandObject;
return $this;
}
/**
* @param array $allowedUsers
*
* @throws \Exception
*/
public static function checkExecutingUser($allowedUsers = [])
{
$configFile = \Pimcore\Config::locateConfigFile('system.yml');
$owner = fileowner($configFile);
if ($owner === false) {
throw new \Exception("Couldn't get user from file " . $configFile);
}
if(function_exists('posix_getpwuid')){
$userData = posix_getpwuid($owner);
if($userData) {
$allowedUsers[] = $userData['name'];
$scriptExecutingUserData = posix_getpwuid(posix_geteuid());
$scriptExecutingUser = $scriptExecutingUserData['name'];
if (!in_array($scriptExecutingUser, $allowedUsers)) {
throw new \Exception("The current system user is not allowed to execute this script. Allowed users: '" . implode(',', $allowedUsers) ."' Executing user: '$scriptExecutingUser'.");
}
}
}
}
/**
* @param MonitoringItem $monitoringItem
* @param int $numberOfchildProcesses number of child processes to run in parallel
* @param array $workload workload to process
* @param int $batchSize items to process per child process
* @param null $callback callback to modifiy the monitoring item before start (e.g. alter actions,loggers...)
* @param int $startAfterPackage Start after package (skip packages before)
* @throws \Exception
*/
public static function executeChildProcesses(MonitoringItem $monitoringItem,array $workload, $numberOfchildProcesses = 5, $batchSize = 10, $callback = null, $startAfterPackage = null){
$workloadChunks = array_chunk($workload,$batchSize); //entries per process
$childProcesses = $monitoringItem->getChildProcesses();
foreach($childProcesses as $c){
$c->delete();
}
$monitoringItem->setCurrentWorkload(0)->setTotalWorkload(count($workload))->setMessage('Starting child processes')->save();
$i = 0;
foreach($workloadChunks as $i => $package){
if($startAfterPackage && $startAfterPackage > ($i+1)){
$monitoringItem->getLogger()->debug('Skipping Package' . ($i+1));
continue;
}
$monitoringItem->setMessage('Processing batch '. ($i+1) . ' of ' . count($workloadChunks))->save();
for($x = 1; $x <= 3; $x++){
$result = Helper::executeJob($monitoringItem->getConfigurationId(), $monitoringItem->getCallbackSettings(), 0, json_encode($package), $monitoringItem->getId(), $callback);
if($result['success'] == false){
$monitoringItem->getLogger()->warning("Can't start child (tried ". $i ." time ) - reason: " . $result['message']);
sleep(5);
if($x == 3){
throw new \Exception("Can't start child - reason: " . $result['message']);
}
}else{
break;
}
}
self::waitForChildProcesses($monitoringItem, $i * $batchSize, $numberOfchildProcesses);
}
self::waitForChildProcesses($monitoringItem, $i * $batchSize);
}
protected static function childProcessCheck(MonitoringItem $monitoringItem){
$statuses = $monitoringItem->getChildProcessesStatus();
$monitoringItem->setModificationDate(time())->save();
if($statuses['summary']['failed'] && static::getChildProcessErrorHandling() == 'strict'){
foreach([MonitoringItem::STATUS_RUNNING,MonitoringItem::STATUS_INITIALIZING,MonitoringItem::STATUS_UNKNOWN] as $status){
$items = $statuses['details'][$status] ?? [];
foreach((array)$items as $entry){
$mItem = MonitoringItem::getById($entry['id']);
if($mItem){
$mItem->stopProcess();
$mItem->setMessage('Killed by MonitoringItem ID '. $monitoringItem->getId(). ' because child process failed',false)->save();
}
}
}
throw new \Exception('Exiting because child failed: ' .print_r($statuses['details'][MonitoringItem::STATUS_FAILED],true));
}
}
/**
* @param MonitoringItem $monitoringItem
* @param int $i
* @param int $batchSize
* @param int $numberOfchildProcesses
* @throws \Exception
*/
protected static function waitForChildProcesses(MonitoringItem $monitoringItem, int $baseline, int $maxProcesses = 0): void
{
do {
$status = $monitoringItem->getChildProcessesStatus();
$activeProcesses = $status['summary']['active'];
$monitoringItem->setCurrentWorkload($baseline + $status['currentWorkload'])->save();
$monitoringItem->getLogger()->info('Waiting to start child processes -> status: ' . print_r($status['summary'], true));
static::childProcessCheck($monitoringItem);
usleep(static::$childProcessCheckInterval);
} while ($activeProcesses > $maxProcesses);
if ($status['summary']['failed'] > 0) {
throw new \Exception('Child process failed');
}
}
}