-
Notifications
You must be signed in to change notification settings - Fork 2
/
BaseWork.php
456 lines (394 loc) · 14 KB
/
BaseWork.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
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
455
456
<?php
/**
* @author Yurko Fedoriv <yurko.fedoriv@gmail.com>
*/
namespace gearman;
/**
* Base class for all gearman works, which actually implement worker functionality.
* Children class names should have "Work" suffix to be recognised as work class.
*
* @property array $tasks Array in which keys contain gearman function aliases and values realising methods for this work object
* @property-read Job $currentJob Currently handled Job object
*/
abstract class BaseWork extends \CComponent
{
/**
* @var string Name of the current Work
*/
public $id;
public $jobClass = '\gearman\Job';
/**
* @var Job Stores currently handled job object. Is set when work receives task.
* @see BaseWork::getCurrentJob();
*/
private $_currentJob;
/**
* @var array
* @see BaseWork::getTasks()
*/
private $_tasks;
/**
* @var Module reference to German Module
*/
protected $_gearmanModule;
private $_class;
private $_reflections = array();
/**
* Constructor.
*
* @param string $id Name of current work
*/
public function __construct($id) {
$this->id = strtolower($id);
}
/**
* Initialises object. Children classes should call it, if override this method.
*
* @return void
*/
public function init() {
$this->_gearmanModule = \Yii::app()->getModule('gearman');
$this->_class = get_class($this);
}
/**
* Logs message defining category.
*
* @param string $msg Message to log
* @param string $level Message level
*
* @return void
*/
public function log($msg, $level = \CLogger::LEVEL_INFO) {
\Yii::log($msg, $level, $this->getCurrentJob() ? $this->getCurrentJob()->function : "gearman.{$this->id}");
}
/**
* Main method. Attached as gearman function to worker.
* Unserializes GearmanJob workload and routes calls to actual implementation methods
* Catches exceptions. Declines job if it was passed to worker too many times (means error in internal implementation, or unhandable input data causing fatal errors).
* Sends callback jobs
*
* @param \GearmanJob $gearmanJob
*
* @return string Value returned by task, or job handle
* @throws WorkException
*/
public function execute($gearmanJob) {
$startTime = microtime(true);
/** @var $job Job */
$job = new $this->jobClass($gearmanJob);
\Yii::app()->setLogPrefix($job->getHandle(), $job->logPrefix);
$this->_currentJob = $job;
$jobHandle = $job->getHandle();
$returnData = null;
try {
$method = $this->mapTask($job->function);
//check if $job should be rejected because of too many handling retries.
/** @var $cache MemCache */
$cache = $this->_gearmanModule->getComponent('cache');
$times = $cache->get($jobHandle);
if ($times === false) {
$cache->set($jobHandle, 1);
}
elseif ($times <= 5) {
$cache->increment($jobHandle);
}
else {
throw new WorkException("Job <{$jobHandle}> canceled. Too many retries.");
}
$this->log('Received task');
//calls realisation method with workload data
$returnData = $this->call($method, $job->params);
$cache->delete($jobHandle);
$this->log('Finished. Job took: ' . round(microtime(true) - $startTime, 3) . ' seconds.');
$job->done();
}
catch (JobRefused $e) { //Job execution runtime may decide that job shouldn't be executed. This also disables callback.
$this->log('Job refused' . ($e->getMessage() ? " Reason: {$e->getMessage()}." : ''));
return $jobHandle;
}
catch (\Exception $e) { //handling of any exceptions appeared. Marks work as failed, and logs exception. Worker will continue it's normal runtime.
$job->failed($e);
$this->log(YII_DEBUG ? $e : $e->getMessage(), \CLogger::LEVEL_ERROR);
\Yii::app()->onException(new \CExceptionEvent($this, $e));
$this->error($gearmanJob->workload(), $e);
}
if ($job->callback) {
try {
$callback = $job->callback;
if (is_array($callback)) {
$function = array_shift($callback);
$params = $callback;
}
else {
$function = $callback;
$params = array();
}
$params['status'] = $job->getStatusInfo();
$params['result'] = $returnData;
/** @var $callbackJob Job */
$callbackJob = new $this->jobClass($params, $function, null, $job->logPrefix);
$callbackJob->send();
} catch (\Exception $e) {
$this->log("Failed to send callback for job {$job->getHandle()}: {$e->getMessage()}");
}
}
\Yii::app()->setLogPrefix();
$this->_currentJob = null;
return $returnData === null ? $jobHandle : $this->encodeReturnData($returnData);
}
/**
* Method that encodes task result before returning it to gearman
*
* @param mixed $data data to encode
*
* @return string
*/
protected function encodeReturnData($data) {
return base64_encode(\CJSON::encode($data));
}
/**
* Wrapper for smart calling task methods
*
* @param string $method Method of current instance to call
* @param array $params Params to be passed to method. Supports param name or param position indexed array
*
* @return mixed Method return value
* @throws WorkException
*/
protected function call($method, $params) {
$reflection = $this->getReflectionMethod($method);
$callParams = array();
foreach ($reflection['params'] as $number => $parameter) {
/** @var $parameter \ReflectionParameter */
if (array_key_exists($parameter->name, $params)) {
$callParams[$parameter->name] = $params[$parameter->name];
}
elseif (array_key_exists($number, $params)) {
$callParams[$parameter->name] = $params[$number];
}
elseif ($parameter->isOptional()) {
$callParams[$parameter->name] = $parameter->getDefaultValue();
}
else {
throw new WorkException("Missing parameter {$parameter->name} in workload.");
}
if ($parameter->isArray() && !is_array($callParams[$parameter->name])
&& is_null($callParams[$parameter->name])
) {
throw new WorkException("Parameter {$parameter->name} should be array, but {$callParams[$parameter->name]} was provided.");
}
}
$info = array();
foreach ($callParams as $name => $value) {
if (is_array($value)) {
$value = 'Array';
}
$info[] = "\$$name=$value";
}
$this->log("Invoking {$this->_class}::$method(" . implode(', ', $info) . ')');
return $reflection['method']->invokeArgs($this, $callParams);
}
/**
* Method to retrieve reflection information for current instance method. Caches data in memory for multiple usages
*
* @param string $method Method name of current instance
*
* @return array Array containig 'method' key with method reflection and 'params' key with array reflections of all method params.
*/
public function getReflectionMethod($method) {
if (!isset($this->_reflections[$method])) {
$reflection = new \ReflectionMethod($this, $method);
$this->_reflections[$method] = array(
'method' => $reflection,
'params' => $reflection->getParameters(),
);
}
return $this->_reflections[$method];
}
/**
* Returns method name associated with gearman function
*
* @param string $function gearman function to map
*
* @return string method name of current instance associated with gearman function
* @throws WorkException if mapping is possible
*/
public function mapTask($function) {
$tasks = $this->getTasks();
if (!isset($tasks[$function])) {
throw new WorkException("[$function] does not exist in [{$this->_class}] task map");
}
if (!method_exists($this, $tasks[$function])) {
throw new WorkException(
"[{$this->_class}::{$tasks[$function]}] is not implemented. [$function] cannot be mapped");
}
return $tasks[$function];
}
/**
* This will map work method to gearman function according to work's function map definition.
*
* @param string $method Work method name
*
* @return string Corresponding gearman function
* @throws WorkException In case method is not present in map
*/
public function mapMethod($method) {
$function = array_search($method, $this->getTasks());
if ($function) {
return $function;
}
throw new WorkException("Cannot map $method to gearman function.");
}
/**
* GETTER
* Returns currently handled Job object
*
* @return Job
*/
public function getCurrentJob() {
return $this->_currentJob;
}
/**
* GETTER
*
* @return array Current task map
*/
public function getTasks() {
if ($this->_tasks === null) {
$this->_tasks = $this->tasks();
}
return $this->_tasks;
}
/**
* SETTER
*
* @param array $value <gearman function> => <class method> map
*
* @return bool
*/
public function setTasks(array $value) {
if (!$value) {
return false;
}
foreach ($value as $function => &$method) {
if (method_exists($this, $method)) {
continue;
}
elseif (method_exists($this, "task$method")) {
$method = "task$method";
}
else {
throw new WorkException("Cannot map function $function to undefined method $method");
}
}
$this->_tasks = $value;
return true;
}
/**
* Defines default <german function> => <class method> map
* May be overriden in children classes to hardcode gearman function => work method association
* By default scans all class methods with prefix 'task' and associates them with gearman function retrieved from {@link formatFunctionName()} call
*
* @return array <german function> => <class method> map
*/
public function tasks() {
$taskMethods = array_filter(
get_class_methods($this),
function($method) { return $method != 'tasks' && stripos($method, 'task') === 0; }
);
$map = array();
foreach ($taskMethods as $method) {
$map[$this->formatFunctionName($method)] = $method;
}
return $map;
}
/**
* Default implementatin for generation geearman function names. uses [application id].[work id].[task name] pattern
*
* @param string $method Work method name to generate gearman function name for
*
* @return string Gearman function name
*/
public function formatFunctionName($method) {
return strtolower(
implode(
'.', array(
\Yii::app()->name,
$this->id,
preg_replace('/task(.*)/i', '\1', $method)
)
)
);
}
/**
* Register worker for handling gearman functions
*
* @param string $function gearman function to regiter for
* @param string $method current work method name to be mapped to function
*/
public function register($function, $method) {
$tasks = $this->getTasks();
if (!isset($tasks[$function])) {
$this->_tasks[$function] = $method;
}
elseif ($tasks[$function] != $method) {
$this->unregister($function);
$this->_tasks[$function] = $method;
}
$this->_gearmanModule->worker->addFunction($function, array($this, 'execute'));
$reflection = $this->getReflectionMethod($method);
$params = array();
foreach ($reflection['params'] as $parameter) {
/** @var $parameter \ReflectionParameter */
$param = '$' . $parameter->getName();
if ($parameter->isOptional()) {
$param = "[$param]";
}
$params[] = $param;
}
$this->log(
"Registered: $function => " . $this->_class . '::' . $method . '('
. implode(', ', $params) . ')'
);
}
/**
* Unregisters worker from gearman function
*
* @param string $function geramn function
*/
public function unregister($function) {
$this->_gearmanModule->worker->unregister($function);
unset($this->_tasks[$function]);
$this->log("Unregistered $function");
}
/**
* Registers worker to handle all functions mapped to current work
*/
public function registerAll() {
foreach ($this->getTasks() as $function => $method) {
$this->register($function, $method);
}
}
public function error($workload, $exception) {
}
public function setOptions($options) {
foreach($options as $key=>$value){
if(property_exists($this, $key) || $this->canSetProperty($key)){
$this->$key = $value;
}
}
return $this;
}
}
/**
* If job implementation throws this exception, this means that job is totally refused and callback wont be raised.
*/
class JobRefused extends Exception
{
}
/**
* Exception class used to identify work internal errors
*/
class WorkException extends Exception
{
}