-
Notifications
You must be signed in to change notification settings - Fork 2
/
Job.php
258 lines (225 loc) · 6.39 KB
/
Job.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
<?php
/**
* @author Yurko Fedoriv <yurko.fedoriv@gmail.com>
*/
namespace gearman;
/**
* Class to be used for sending and handling gearman jobs.
*/
class Job extends \CComponent
{
const STATUS_IN_PROGRESS = 'inProgress';
const STATUS_DONE = 'done';
const STATUS_FAILED = 'failed';
/**
* @var array Params passed to Job
*/
public $params;
/**
* @var string|array|null Log prefix value to be attached to logs while performing this job
*/
public $logPrefix;
/**
* @var null|array Callback gearman function to send job to after task completion. First item must be name of function, other params will be treated as additional params in callback
*/
public $callback;
/**
* @var string Gearman function this Job instance is used for
*/
public $function;
/**
* @var string Which priority to use when sending the job
*/
public $priority = Client::PRIORITY_NORMAL;
/**
* @var bool Whether to perform job in background mode
*/
public $background = true;
/**
* @var string Unique id of the job
*/
public $unique;
/**
* @var string Status of the job
*/
private $_status;
/**
* @var int Last modified timestamp. Updated when status changes
*/
private $_lastModified;
/**
* @var \Exception Exception object catched during job
*/
private $_exception;
/**
* @var \GearmanJob If instance created from \GearmanJob instance, this is reference to it.
*/
private $_gearmanJob;
/**
* @var string Handle of current job if present
*/
private $_handle;
/**
* Constructor
*
* @param array|\GearmanJob $params
* @param string $function Gearman function to associate instance with. May be passed in params array as 'function' key
* @param array $callback Callback info. May ba passed in params as 'callback' key
* @param mixed $logPrefix Log prefix to used while job will be performed. May be passed in params array as 'logPrefix' key
*/
function __construct($params, $function = null, $callback = null, $logPrefix = null) {
if ($params instanceof \GearmanJob) {
$this->_gearmanJob = $params;
$this->_handle = $this->_gearmanJob->handle();
$params = $this->decode($params->workload());
$function = $this->_gearmanJob->functionName();
}
if (isset($params['logPrefix'])) {
$logPrefix = $params['logPrefix'];
unset($params['logPrefix']);
}
if (isset($params['callback'])) {
$callback = $params['callback'];
unset($params['callback']);
}
if (isset($params['params'])) {
$params = $params['params'];
}
$this->params = $params;
$this->logPrefix = $logPrefix;
$this->callback = $callback;
$this->function = $function;
$this->_lastModified = time();
}
/**
* @return null|string Get handle of current Job.
*/
public function getHandle() {
return $this->_handle;
}
/**
* @return string
*/
function __toString() {
return $this->encode();
}
/**
* @return string Encoded workload to be sent to gearman job server
*/
public function encode() {
return base64_encode(
\CJSON::encode(
array(
'params' => $this->params,
'logPrefix' => $this->logPrefix,
'callback' => $this->callback,
)
)
);
}
/**
* Decodes workload
*
* @param string $workload Workload recieved from gearman job server to decode
*
* @return mixed
*/
public function decode($workload) {
return \CJSON::decode(base64_decode($workload));
}
/**
* Sends job to gearman job server
*
* @return string Result of sending job.
*/
public function send() {
$result = $this->getClient()->send(
$this->function,
$this->encode(),
$this->priority,
$this->background,
$this->unique
);
if ($this->background) {
$this->_handle = $result;
}
return $result;
}
/**
* Shortcut to gearman client instance
*
* @return Client
*/
public function getClient() {
return \Yii::app()->getModule('gearman')->getComponent('client');
}
/**
* Modifies status to done state
*
* @return void
*/
public function done() {
$this->_status = self::STATUS_DONE;
$this->_lastModified = time();
}
/**
* Modifies status to failed state
*
* @param \Exception $e Exception describing why job was failed
*
* @return void
*/
public function failed(\Exception $e = null) {
$this->_status = self::STATUS_FAILED;
$this->_exception = $e;
$this->_lastModified = time();
}
/**
* GETTER
*
* @return string Status message
*/
public function getStatus() {
return $this->_status;
}
/**
* @return null|string Class of exception thrown during task performing
*/
public function getExceptionClass() {
return is_object($this->_exception) ? get_class($this->_exception) : null;
}
/**
* @return null|string Formatted string of error occurred.
*/
public function getFailMassage() {
if ($this->_exception) {
return '[' . date('Y/m/d H:i:s', $this->_lastModified) . '] [' . $this->function . '] '
. $this->_exception->getMessage();
}
else {
return null;
}
}
/**
* GETTER
*
* @return array Full status info. Used to send to callback tasks
*/
public function getStatusInfo() {
return array(
'function' => $this->function,
'jobHandle' => $this->getHandle(),
'status' => $this->_status,
'exception' => $this->_exception
?
array(
'class' => $this->getExceptionClass(),
'message' => $this->_exception->getMessage(),
)
:
false,
'lastModified' => $this->_lastModified,
'machine' => \Yii::app()->instanceId,
);
}
}