-
Notifications
You must be signed in to change notification settings - Fork 199
Expand file tree
/
Copy pathHandlerBase.php
More file actions
532 lines (465 loc) · 12.6 KB
/
HandlerBase.php
File metadata and controls
532 lines (465 loc) · 12.6 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
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<?php
/**
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
* @license
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* @link http://phpwhois.pw
* @copyright Copyright (c) 2015 Dmitry Lukashin
*/
namespace phpWhois\Handler;
use phpWhois\Provider\ProviderAbstract;
use phpWhois\Provider\WhoisServer;
use phpWhois\Query;
use phpWhois\Response;
class HandlerBase
{
/**
* @var string[]|null Date format in php date() format
*/
protected $dateFormat = null;
/**
* @var string[] Patterns for finding Expires field in response
*/
protected $patternExpires = [
'/expir(e|y|es|ation)/i',
'/renew(al)?/i',
'/paid\-till/i',
'/validity/i',
'/billeduntil/i'
];
/**
* @var string[] Patterns for finding Registered field in response
*/
protected $patternRegistered = [
'/creat(ed|ion)/i',
'/regist(ered|ration)/i',
'/commencement/i',
];
/**
* @var string[] Patterns for finding Updated field in response
*/
protected $patternUpdated = [
'/update(d)?/i',
'/modif(y|ied|ication)/i',
'/changed/i',
];
/**
* @var array Patterns for realizing that domain is registered
*/
protected $patternStatusRegistered = [
'/status$/i' => '/^ok/i',
];
/**
* @var string[] Patterns for finding name servers
*/
protected $patternNServer = [
'/nserver/i',
'/name server/i'
];
/**
* @var string[] Indicates that line is a comment
*/
protected $patternComment = [
'/^%/i',
];
/**
* @var string[] Row separators arranged descending by priority
*/
protected $patternRowSeparator = [
'/(:)/i',
];
/**
* @var string Name of whois information class provider. Class must extend ProviderAbstract
*/
protected $providerClass = WhoisServer::class;
/**
* @var string Server address for the provider
*/
protected $server;
/**
* ***************************************************************
* WARNING: Variables below are not supposed to be overwritten in
* inherited classes
* ***************************************************************
*/
/**
* @var array Parsed data
*/
private $parsed;
/**
* @var ProviderAbstract Provider instance
*/
private $provider;
/**
* @var Query
*/
private $query;
/**
* @var string Raw response from whois server
*/
private $raw;
/**
* @var string[] Response rows split by newline
*/
private $rows;
/**
* Handler constructor
*
* @param Query $query Query for whois server
* @param string|null $server Whois server address
*/
public function __construct(Query $query, $server = null)
{
$this->setQuery($query);
// Default provider is WhoisServer
$provider = new $this->providerClass($query);
if (!($provider instanceof ProviderAbstract)) {
throw new \InvalidArgumentException('Provider class must extend phpWhois\Provider\ProviderAbstract');
}
$this->setProvider($provider);
if (is_null($server)) {
$server = $this->getServer();
}
$this->setServer($server);
}
/**
* Set query
*
* @param Query $query
*
* @return $this
*/
protected function setQuery(Query $query)
{
$this->query = $query;
return $this;
}
/**
* Get query
*
* @return Query
*/
public function getQuery()
{
return $this->query;
}
/**
* Set provider server address
*
* @param string $server
*
* @return $this
*/
public function setServer($server)
{
$this->server = $server;
$this->getProvider()->setServer($server);
return $this;
}
/**
* Get provider server address
*
* @return string|null
*/
public function getServer()
{
return $this->server;
}
/**
* Set provider
*
* @param ProviderAbstract $provider
*
* @return $this
*/
protected function setProvider(ProviderAbstract $provider)
{
$this->provider = $provider;
return $this;
}
/**
* Get provider
*
* @return ProviderAbstract
*/
public function getProvider()
{
return $this->provider;
}
/**
* Set raw response from the whois server
*
* @param string|null $raw
*
* @return $this
*/
public function setRaw($raw)
{
$this->raw = $raw;
return $this;
}
/**
* Get raw response from the whois server
*
* @return string
*/
public function getRaw()
{
return $this->raw;
}
/**
* Set response split into rows by newline
*
* @param string[] $rows
*
* @return $this
*/
protected function setRows(array $rows)
{
$this->rows = $rows;
return $this;
}
/**
* Get response split by newline
*
* @return array
*/
public function getRows()
{
return $this->rows;
}
/**
* Set array with parsed data
*
* @param array $parsed
*
* @return $this
*/
protected function setParsed(array $parsed)
{
$this->parsed = $parsed;
return $this;
}
/**
* Get array with parsed data
*
* @return array
*/
public function getParsed()
{
return $this->parsed;
}
/**
* Check if handler has all the necessary data assigned
*
* @return bool
*/
public function hasData()
{
return $this->getQuery()->hasData()
&& ($this->getProvider() instanceof ProviderAbstract);
}
/**
* Split raw data response into array by newline
*
* @param string|null $raw Raw response from whois server
*
* @return string[]
*/
public function splitRows($raw = null)
{
if (is_null($raw)) {
$raw = $this->getRaw();
}
// Line ending could be \r\n, \r, \n
$rows = preg_split('/(\r\n|[\r\n])/', $raw);
return $rows;
}
/**
* Try to split row into key => value array
*
* @param string $row Line to parse
* @param string[] $splitBy Regexp for splitting the line. Method only looks for the first occurence of regexp
* @param string[] $ignorePattern Don't parse rows which match the given expression, just return false
* @return array|false Return key => value array if regex found, or array with just 1 element otherwise
*/
public function splitRow($row, array $splitBy = [], array $ignorePattern = [])
{
/**
* TODO: Trim row's custom symbols (See .JP)
*/
// If ignorePrefix is not empty and row matches it - return false
if (!count($ignorePattern)) {
$ignorePattern = $this->patternComment;
}
foreach ($ignorePattern as $pattern) {
if (preg_match($pattern, $row)) {
return false;
}
}
$row = trim($row);
if (!count($splitBy)) {
$splitBy = $this->patternRowSeparator;
}
$parts = [];
foreach ($splitBy as $separator) {
$parts = preg_split($separator, $row, 2);
if (count($parts) == 2) {
$parts[1] = trim($parts[1]);
// If string was split by two parts - return immediately
// Otherwise try another patterns
return $parts;
}
}
return $parts;
}
/**
* Extract unix timestamp from the defined string
*
* @param string $date Date
*
* @return int|false Unix timestamp
*/
protected function parseDate($date)
{
$result = false;
if ($this->dateFormat == null) {
$result = strtotime($date);
} elseif (count($this->dateFormat)) {
foreach ($this->dateFormat as $format) {
if ($dateTime = \DateTime::createFromFormat($format, $date)) {
$result = $dateTime->format('U');
break;
}
}
}
return $result;
}
/**
* Try to extract the date from the given key and value
*
* @param string $row Line from raw whois response
* @param string[] $patterns Array with patterns for matching the $key
* @param string[] $antiPatterns Array with patterns which $key must not match
*
* @return false|int Unix timestamp
*/
protected function extractDate($row, array $patterns, array $antiPatterns = [])
{
$result = false;
foreach ($antiPatterns as $ap) {
if (preg_match($ap, $row)) {
$result = false;
return $result;
}
}
$parts = $this->splitRow($row);
if (count($parts) == 2) {
$key = $parts[0];
$value = $parts[1];
} else {
return false;
}
foreach ($patterns as $pattern) {
if (preg_match($pattern, $key) && $time = $this->parseDate($value)) {
$result = $time;
break;
}
}
return $result;
}
/**
* Try to extract `registered`, `expires` and `updated` dates from the rows
*
* @param string[] $rows Rows in key => value format
*
* @return string[]
*/
protected function extractDates(array $rows)
{
$dates = ['expires' => false, 'registered' => false, 'updated' => false];
foreach ($rows as $row) {
// Registration date
if (!$dates['registered']) {
$dates['registered'] = ($this->extractDate($row, $this->patternRegistered)) ?: $dates['registered'];
}
// Expiration date
if (!$dates['expires']) {
$dates['expires'] = ($this->extractDate($row, $this->patternExpires)) ?: $dates['expires'];
}
// Updated date
if (!$dates['updated']) {
$dates['updated'] = ($this->extractDate($row, $this->patternUpdated, ['/>>>/i'])) ?: $dates['updated'];
}
}
return $dates;
}
/**
* Try to parse response into key => value array
* WARNING: This is very dirty solution, since multiple keys will override each other
*
* @param string[] $rows
* @return array
*/
protected function extractKeyValue(array $rows)
{
$keyValue = [];
foreach ($rows as $row) {
$parts = $this->splitRow($row);
if (count($parts) == 2) {
$keyValue[$parts[0]] = $parts[1];
}
}
return $keyValue;
}
/**
* Perform parsing and set necessary properties
*
* @return array
*/
protected function parse()
{
$rows = $this->splitRows();
$this->setRows($rows);
$parsed = [];
$parsed['dates'] = $this->extractDates($rows);
$parsed['keyValue'] = $this->extractKeyValue($rows);
$this->setParsed($parsed);
return $this->getParsed();
}
/**
* Perform a lookup of defined query
*
* @return Response
*
* @throws \InvalidArgumentException
*/
public function lookup()
{
if (!$this->hasData()) {
throw new \InvalidArgumentException('Handler doesn\'t have query or provider set');
}
// Get raw response from provider
$raw = $this->getProvider()->lookup();
$this->setRaw($raw);
// Set Response raw fields
$response = new Response($this->getQuery());
$response->setRaw($raw);
$parsed = $this->parse();
$response->setParsed($parsed);
return $response;
}
}