aparser-api-php-client.php
11.9 KB
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
<?php
/**
* The A-Parser API Client
*
* This client assists in making calls to A-Parser API.
*
* @url https://github.com/ice2038/aparser-api-php-client
* @url http://a-parser.com/wiki/user-api/
*
* @author Pavel Zima <ice2038@mail.ru>
* @version 0.2
*/
class Aparser
{
/**
* @var string $password The password for the A-Parser API
*/
private $password;
/**
* @var string $host The base URL to use for calls to the API
*/
private $host;
/**
* @var array
*/
protected $options;
/**
* @param string $host
* @param string $password
* @param array $options
*/
public function __construct($host, $password, $options = array())
{
$this->setHost($host);
$this->setPassword($password);
$this->addOption('debug', FALSE);
$this->configure($options);
}
/**
* Adds a new option value with a default value.
*
* @param string $name The option name
* @param mixed $value The default value
*/
public function addOption($name, $value = null)
{
$this->options[$name] = $value;
}
/**
* Changes an option value.
*
* @param string $name The option name
* @param mixed $value The value
* @throws InvalidArgumentException
*/
public function setOption($name, $value)
{
if (!in_array($name, array_keys($this->options))) {
throw new InvalidArgumentException(sprintf('%s does not support the following option: \'%s\'.', get_class($this), $name));
}
$this->options[$name] = $value;
}
/**
* Gets an option value.
*
* @param string $name The option name
*
* @return mixed The option value
*/
protected function getOption($name)
{
return isset($this->options[$name]) ? $this->options[$name] : null;
}
/**
* Returns true if the option exists.
*
* @param string $name The option name
*
* @return bool true if the option exists, false otherwise
*/
protected function hasOption($name)
{
return array_key_exists($name, $this->options);
}
/**
* Configures the current object.
* This method allows set options during object creation
*
* @param array $options An array of options
* @see __construct()
*/
protected function configure($options = array())
{
if (!empty($options))
foreach ($options as $name => $value) {
$this->addOption($name, $value);
}
}
/**
* @param string $password
*/
public function setPassword($password)
{
$this->password = $password;
}
/**
* @param string $url
*/
public function setHost($url)
{
$this->host = $url;
}
/**
* @throws InvalidArgumentException
*
* @return string
*/
protected function getPassword()
{
if (!is_string($this->password) && !strlen($this->password)) {
throw new InvalidArgumentException('Current Password is incorrect!');
}
return $this->password;
}
/**
* @throws InvalidArgumentException
* @return string
*/
protected function getHost()
{
if (!is_string($this->host) && !strlen($this->host)) {
throw new InvalidArgumentException('Current URL is incorrect!');
}
return $this->host;
}
/**
* The ping method, the server should respond by invoking "pong" on
* the callback data
*
* @return string
*/
public function ping()
{
return $this->makeRequest(__FUNCTION__);
}
/**
* Return total information (pid, version, tasks in queue);
*
* @return array
*/
public function info()
{
return $this->makeRequest(__FUNCTION__);
}
/**
* Getting a list of live proxies
*
* @return array
*/
public function getProxies()
{
return $this->makeRequest(__FUNCTION__);
}
/**
* Single request parsing, you can use any parser and preset. This
* will generate the strings in accordance with the format of the
* result set in the preset, as well as the full log parser.
*
* @param string $query
* @param string $parser
* @param string $preset
* @param int $rawResults
* @param array $options
* @return array
*/
public function oneRequest($query, $parser, $preset = 'default', $rawResults = 0, $options = array())
{
return $this->makeRequest(
__FUNCTION__,
array(
'query' => $query,
'parser' => $parser,
'preset' => $preset,
'rawResults' => $rawResults,
'options' => $options
)
);
}
/**
* Bulk request parsing, you can use any parser and preset, as well
* as the quantity indicated in the threads to produce parsing.
* This will generate the strings in accordance with the format of
* the result set in the preset, as well as the full log parser for
* each thread.
*
* @param array $queries
* @param string $parser
* @param string $preset
* @param int $threads
* @param int $rawResults
* @param array $options
* @return array
*/
public function bulkRequest($queries, $parser, $preset = 'default', $threads = 5, $rawResults = 0, $options = array())
{
return $this->makeRequest(
__FUNCTION__,
array(
'queries' => $queries,
'parser' => $parser,
'preset' => $preset,
'threads' => $threads,
'rawResults' => $rawResults,
'options' => $options,
)
);
}
/**
* Getting of the parser settings and presets
*
* @param $parser
* @param string $preset
* @return array
*/
public function getParserPreset($parser, $preset = 'default')
{
return $this->makeRequest(
__FUNCTION__,
array(
'parser' => $parser,
'preset' => $preset,
)
);
}
/**
* Add a task to turn all options are similar to those that are
* specified in the interface Add Task
*
* @param string $configPreset
* @param string $taskPreset
* @param string $queriesFrom file|text
* @param array $queries
* @param array $options
* @return string taskUid
* @throws InvalidArgumentException
*/
public function addTask($configPreset, $taskPreset, $queriesFrom, $queries, $options = array())
{
$data['configPreset'] = $configPreset ? $configPreset : 'default';
if($taskPreset) {
$data['preset'] = $taskPreset;
} else {
$data['resultsFileName'] = isset($options['resultsFileName']) ? $options['resultsFileName'] : '$datefile.format().txt';
$data['parsers'] = isset($options['parsers']) ? $options['parsers'] : array();
$data['uniqueQueries'] = isset($options['uniqueQueries']) ? $options['uniqueQueries'] : 0;
$data['keepUnique'] = isset($options['keepUnique']) ? $options['keepUnique'] : 0;
$data['resultsPrepend'] = isset($options['resultsPrepend']) ? $options['resultsPrepend'] : '';
$data['moreOptions'] = isset($options['moreOptions']) ? $options['moreOptions'] : '';
$data['resultsUnique'] = isset($options['resultsUnique']) ? $options['resultsUnique'] : 'no';
$data['doLog'] = isset($options['doLog']) ? $options['doLog'] : 'no';
$data['queryFormat'] = isset($options['queryFormat']) ? $options['queryFormat'] : '$query';
$data['resultsSaveTo'] = isset($options['resultsSaveTo']) ? $options['resultsSaveTo'] : 'file';
$data['configOverrides'] = isset($options['configOverrides']) ? $options['configOverrides'] : array();
$data['resultsFormat'] = isset($options['resultsFormat']) ? $options['resultsFormat'] : '';
$data['resultsAppend'] = isset($options['resultsAppend']) ? $options['resultsAppend'] : '';
$data['queryBuilders'] = isset($options['queryBuilders']) ? $options['queryBuilders'] : array();
$data['resultsBuilders'] = isset($options['resultsBuilders']) ? $options['resultsBuilders'] : array();
}
switch($queriesFrom){
case 'file':
$data['queriesFrom'] = 'file';
$data['queriesFile'] = isset($options['queriesFile']) ? $options['queriesFile'] : FALSE;
break;
case 'text':
$data['queriesFrom'] = 'text';
$data['queries'] = $queries ? $queries : array();
break;
default:
throw new InvalidArgumentException('Argument $queriesFrom is incorrect!');
}
return $this->makeRequest(__FUNCTION__, $data);
}
/**
* Getting the status of task by uid
*
* @param int $taskUid
* @return array
*/
public function getTaskState($taskUid)
{
return $this->makeRequest(__FUNCTION__, array('taskUid' => $taskUid));
}
/**
* Getting configuration task by uid
*
* @param int $taskUid
* @return array
*/
public function getTaskConf($taskUid)
{
return $this->makeRequest(__FUNCTION__, array('taskUid' => $taskUid));
}
/**
* Change status of a task by id
*
* @param int $taskUid
* @param string $toStatus starting|pausing|stopping|deleting
* @return array
*/
public function changeTaskStatus($taskUid, $toStatus)
{
return $this->makeRequest(__FUNCTION__, array('taskUid' => $taskUid, 'toStatus' => $toStatus));
}
/**
* @param int $taskUid
* @param string $direction start|end|up|down
* @return array
*/
public function moveTask($taskUid, $direction)
{
return $this->makeRequest(__FUNCTION__, array('taskUid' => $taskUid, 'direction' => $direction));
}
/**
* @param string $action
* @param array $data
* @return mixed
*/
private function makeRequest($action, $data = array())
{p($action,1);
try {
$request = array(
'action' => $action,
'password' => $this->getPassword(),
);
if (!empty($data)) {
$request['data'] = $data;
}
$request_json = json_encode($request);
if ($this->getOption('debug')) {
echo "Request:\n" . $request_json . "\n";
}
$ch = curl_init($this->getHost());
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request_json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Length: ' . strlen($request_json)));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: text/plain; charset=UTF-8'));
$response = curl_exec($ch);
$error = curl_error($ch);
curl_close($ch);
if($response === FALSE) {
throw new Exception('Response fail: '. $error);
}
if ($this->getOption('debug')) {
echo "Response:\n" . $response . "\n";
}
$response = json_decode($response, TRUE);
if(!$response['success']) {
throw new Exception( 'Response fail: ' . (
isset($response['msg']) ? $response['msg'] : 'unknow error')
);
}
return isset($response['data']) ? $response['data'] : TRUE;
} catch (Exception $e) {
die('Error: ' . $e->getMessage() . "\n");
}
}
}