-
Notifications
You must be signed in to change notification settings - Fork 199
Expand file tree
/
Copy pathProviderAbstract.php
More file actions
417 lines (365 loc) · 8.61 KB
/
ProviderAbstract.php
File metadata and controls
417 lines (365 loc) · 8.61 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
<?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\Provider;
use phpWhois\Query;
use phpWhois\Response;
/**
* Abstract class Provider - defines the algorithms for communicating with various whois servers
*/
abstract class ProviderAbstract {
/**
* @var string Whois server to query
*/
protected $server;
/**
* @var int Whois server port
*/
protected $port;
/**
* @var int Timeout for connecting to the server
*/
protected $timeout = 10;
/**
* @var int Number of retries to connect to the server. 0 - connect once (no retries)
*/
protected $retry = 0;
/**
* @var int Number of seconds to sleep before retry
*/
protected $sleep = 1;
/**
* @var int Connection error number
*/
protected $connectionErrNo;
/**
* @var string Connection error string
*/
protected $connectionErrStr;
/**
* @var resource Connection pointer
*/
protected $connectionPointer;
/**
* @var Query
*/
protected $query;
/**
* @var string This is a raw query which will be sent to the Whois server (e.g. add "\r\n" to domain)
*/
protected $rawQuery;
/**
* Connect to the defined server
*
* @return $this
*
* @throws \InvalidArgumentException if server is not specified
*/
abstract protected function connect();
/**
* Perform a request
*
* Perform a request to the defined whois server through the established connection
* and return raw response
*
* @return string
*/
abstract protected function performRequest();
/**
* @param Query $query
* @param string|null $server
*/
public function __construct(Query $query, $server = null)
{
$this->setQuery($query);
$this->setServer($server);
}
/**
* Set server and parse it if it is in a host:port format
*
* @param string $server
*
* @return $this
*/
public function setServer($server)
{
/**
* TODO: Check if server is not empty
*/
$parts = explode(':', $server);
$this->server = $parts[0];
if (count($parts) == 2) {
$this->setPort(intval($parts[1]));
}
return $this;
}
/**
* @return string|null
*/
public function getServer()
{
return $this->server;
}
/**
* Set whois server port number
*
* @param int $port
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setPort($port)
{
if (!is_int($port)) {
throw new \InvalidArgumentException('Port number must be an integer');
}
$this->port = $port;
return $this;
}
/**
* Get whois server port number
*
* @return int|null
*/
public function getPort()
{
return $this->port;
}
/**
* Set connection timeout
*
* @param int $timeout
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setTimeout($timeout = 10)
{
if (!is_int($timeout)) {
throw new \InvalidArgumentException("Timeout must be integer number of seconds");
}
$this->timeout = $timeout;
return $this;
}
/**
* Get connection timeout
*
* @return int
*/
public function getTimeout()
{
return $this->timeout;
}
/**
* Set number of connection retries.
*
* @param int $retry Number of retries. 0 - connect once (no retries)
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setRetry($retry = 0)
{
if (!is_int($retry)) {
throw new \InvalidArgumentException("Number of retries must be integer value");
}
$this->retry = $retry;
return $this;
}
/**
* Get number of retries
*
* @return int Number of retries. 0 - connect once (no retries)
*/
public function getRetry()
{
return $this->retry;
}
/**
* Set number of seconds to sleep before next retry
*
* @param int $sleep
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setSleep($sleep = 0)
{
if (!is_int($sleep)) {
throw new \InvalidArgumentException("Number of seconds to sleep must be integer");
}
$this->sleep = $sleep;
return $this;
}
/**
* Get number of seconds to sleep before next retry
*
* @return int
*/
public function getSleep()
{
return $this->sleep;
}
/**
* Set connection error number
*
* @param int $errno
*
* @return $this
*/
protected function setConnectionErrNo($errno)
{
$this->connectionErrNo = $errno;
return $this;
}
/**
* Get connection error number
*
* @return int|null
*/
public function getConnectionErrNo()
{
return $this->connectionErrNo;
}
/**
* Set connection error message as a string
*
* @param string $errstr
*
* @return $this
*/
protected function setConnectionErrStr($errstr)
{
$this->connectionErrStr = $errstr;
return $this;
}
/**
* Get connection error message as a string
*
* @return string|null
*/
public function getConnectionErrStr()
{
return $this->connectionErrStr;
}
/**
* Set connection pointer
*
* @param resource $pointer
* @return $this
*
* @throws \InvalidArgumentException if pointer is not valid
*/
protected function setConnectionPointer($pointer)
{
if ($pointer) {
$this->connectionPointer = $pointer;
} else {
throw new \InvalidArgumentException('Valid connection pointer (resource) must be provided');
}
return $this;
}
/**
* Get connection pointer
*
* @return resource|null
*/
protected function getConnectionPointer()
{
return $this->connectionPointer;
}
/**
* Check if connection is established with the whois server
*
* @return bool
*/
protected function isConnected()
{
if ($this->getConnectionPointer()) {
return true;
} else {
return false;
}
}
/**
* Set query
*
* @param Query $query
*
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setQuery(Query $query)
{
if ($query->hasData()) {
$this->query = $query;
} else {
throw new \InvalidArgumentException('Cannot assign an empty query');
}
return $this;
}
public function getQuery()
{
return $this->query;
}
/**
* Set raw query for querying whois server
*
* @param string $rawQuery
*
* @return $this
*/
public function setRawQuery($rawQuery)
{
$this->rawQuery = $rawQuery;
return $this;
}
/**
* @return string
*/
public function getRawQuery()
{
return $this->rawQuery;
}
/**
* Check if instance has set query, server and server port
*
* @return bool
*/
public function hasData() {
return $this->getQuery()->hasData()
&& !empty($this->getServer())
&& !empty($this->getPort());
}
/**
* Perform a lookup and return Response object
*
* @return string
*/
public function lookup()
{
$raw = $this
->connect()
->performRequest();
return $raw;
}
}