forked from ip2location/ip2proxy-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class.IP2Proxy.php
1947 lines (1694 loc) · 50.9 KB
/
class.IP2Proxy.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
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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* Copyright (C) 2005-2020 IP2Location.com
* All Rights Reserved
*
* This library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace IP2Proxy;
/**
* IP2Proxy database class.
*/
class Database
{
/**
* Current module's version.
*
* @var string
*/
public const VERSION = '3.0.0';
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Error field constants ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Unsupported field message.
*
* @var string
*/
public const FIELD_NOT_SUPPORTED = 'NOT SUPPORTED';
/**
* Unknown field message.
*
* @var string
*/
public const FIELD_NOT_KNOWN = 'This parameter does not exists. Please verify.';
/**
* Invalid IP address message.
*
* @var string
*/
public const INVALID_IP_ADDRESS = 'INVALID IP ADDRESS';
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Field selection constants ///////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Country code (ISO 3166-1 Alpha 2).
*
* @var int
*/
public const COUNTRY_CODE = 1;
/**
* Country name.
*
* @var int
*/
public const COUNTRY_NAME = 2;
/**
* Region name.
*
* @var int
*/
public const REGION_NAME = 3;
/**
* City name.
*
* @var int
*/
public const CITY_NAME = 4;
/**
* ISP name.
*
* @var int
*/
public const ISP = 5;
/**
* Is proxy.
*
* @var int
*/
public const IS_PROXY = 6;
/**
* Proxy type.
*
* @var int
*/
public const PROXY_TYPE = 7;
/**
* Domain.
*
* @var int
*/
public const DOMAIN = 8;
/**
* Usage type.
*
* @var int
*/
public const USAGE_TYPE = 9;
/**
* ASN.
*
* @var int
*/
public const ASN = 10;
/**
* AS.
*
* @var int
*/
public const _AS = 11;
/**
* Last seen.
*
* @var int
*/
public const LAST_SEEN = 12;
/**
* Security threat.
*
* @var int
*/
public const THREAT = 13;
/**
* Country name and code.
*
* @var int
*/
public const COUNTRY = 101;
/**
* All fields at once.
*
* @var int
*/
public const ALL = 1001;
/**
* Include the IP address of the looked up IP address.
*
* @var int
*/
public const IP_ADDRESS = 1002;
/**
* Include the IP version of the looked up IP address.
*
* @var int
*/
public const IP_VERSION = 1003;
/**
* Include the IP number of the looked up IP address.
*
* @var int
*/
public const IP_NUMBER = 1004;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Exception code constants ////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Generic exception code.
*
* @var int
*/
public const EXCEPTION = 10000;
/**
* No shmop extension found.
*
* @var int
*/
public const EXCEPTION_NO_SHMOP = 10001;
/**
* Failed to open shmop memory segment for reading.
*
* @var int
*/
public const EXCEPTION_SHMOP_READING_FAILED = 10002;
/**
* Failed to open shmop memory segment for writing.
*
* @var int
*/
public const EXCEPTION_SHMOP_WRITING_FAILED = 10003;
/**
* Failed to create shmop memory segment.
*
* @var int
*/
public const EXCEPTION_SHMOP_CREATE_FAILED = 10004;
/**
* The specified database file was not found.
*
* @var int
*/
public const EXCEPTION_DBFILE_NOT_FOUND = 10005;
/**
* Not enough memory to load database file.
*
* @var int
*/
public const EXCEPTION_NO_MEMORY = 10006;
/**
* No candidate databse files found.
*
* @var int
*/
public const EXCEPTION_NO_CANDIDATES = 10007;
/**
* Failed to open database file.
*
* @var int
*/
public const EXCEPTION_FILE_OPEN_FAILED = 10008;
/**
* Failed to determine the current path.
*
* @var int
*/
public const EXCEPTION_NO_PATH = 10009;
/**
* BCMath extension not installed.
*
* @var int
*/
public const EXCEPTION_BCMATH_NOT_INSTALLED = 10010;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Caching method constants ////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Directly read from the databse file.
*
* @var int
*/
public const FILE_IO = 100001;
/**
* Read the whole database into a variable for caching.
*
* @var int
*/
public const MEMORY_CACHE = 100002;
/**
* Use shared memory objects for caching.
*
* @var int
*/
public const SHARED_MEMORY = 100003;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Shared memory constants /////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Share memory segment's permissions (for creation).
*
* @var int
*/
public const SHM_PERMS = 0600;
/**
* Number of bytes to read/write at a time in order to load the shared memory cache (512k).
*
* @var int
*/
public const SHM_CHUNK_SIZE = 524288;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Static data /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Column offset mapping.
*
* Each entry contains an array mapping databse version (0-3) to offset within a record.
* A value of 0 means the column is not present in the given database version.
*
* @static
*
* @var array
*/
private static $columns = [
self::COUNTRY_CODE => [8, 12, 12, 12, 12, 12, 12, 12, 12, 12],
self::COUNTRY_NAME => [8, 12, 12, 12, 12, 12, 12, 12, 12, 12],
self::REGION_NAME => [0, 0, 16, 16, 16, 16, 16, 16, 16, 16],
self::CITY_NAME => [0, 0, 20, 20, 20, 20, 20, 20, 20, 20],
self::ISP => [0, 0, 0, 24, 24, 24, 24, 24, 24, 24],
self::PROXY_TYPE => [0, 8, 8, 8, 8, 8, 8, 8, 8, 8],
self::DOMAIN => [0, 0, 0, 0, 28, 28, 28, 28, 28, 28],
self::USAGE_TYPE => [0, 0, 0, 0, 0, 32, 32, 32, 32, 32],
self::ASN => [0, 0, 0, 0, 0, 0, 36, 36, 36, 36],
self::_AS => [0, 0, 0, 0, 0, 0, 40, 40, 40, 40],
self::LAST_SEEN => [0, 0, 0, 0, 0, 0, 0, 44, 44, 44],
self::THREAT => [0, 0, 0, 0, 0, 0, 0, 0, 48, 48],
];
/**
* Column name mapping.
*
* @static
*
* @var array
*/
private static $names = [
self::COUNTRY_CODE => 'countryCode',
self::COUNTRY_NAME => 'countryName',
self::REGION_NAME => 'regionName',
self::CITY_NAME => 'cityName',
self::ISP => 'isp',
self::IS_PROXY => 'isProxy',
self::PROXY_TYPE => 'proxyType',
self::DOMAIN => 'domain',
self::USAGE_TYPE => 'usageType',
self::ASN => 'asn',
self::_AS => 'as',
self::LAST_SEEN => 'lastSeen',
self::THREAT => 'threat',
self::IP_ADDRESS => 'ipAddress',
self::IP_VERSION => 'ipVersion',
self::IP_NUMBER => 'ipNumber',
];
/**
* Database names, in order of preference for file lookup.
*
* @var array
*/
private static $databases = [
// IPv4 databases
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP',
'IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY',
'IP2PROXY-IP-PROXYTYPE-COUNTRY',
'IP2PROXY-IP-COUNTRY',
// IPv6 databases
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY-ISP',
'IPV6-PROXYTYPE-COUNTRY-REGION-CITY',
'IPV6-PROXYTYPE-COUNTRY',
'IPV6-COUNTRY',
];
/**
* Static memory buffer to use for MEMORY_CACHE mode, the keys will be BIN filenames and the values their contents.
*
* @static
*
* @var array
*/
private static $buffer = [];
/**
* The machine's float size.
*
* @static
*
* @var int
*/
private static $floatSize = null;
/**
* The configured memory limit.
*
* @static
*
* @var int
*/
private static $memoryLimit = null;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Caching backend controls ////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Caching mode to use (one of FILE_IO, MEMORY_CACHE, or SHARED_MEMORY).
*
* @var int
*/
private $mode;
/**
* File pointer to use for FILE_IO mode, BIN filename for MEMORY_CACHE mode, or shared memory id to use for SHARED_MEMORY mode.
*
* @var false|int|resource
*/
private $resource = false;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Database metadata ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Database's compilation date.
*
* @var int
*/
private $date;
/**
* Database's type (0-3).
*
* @var int
*/
private $type;
/**
* Database's register width (as an array mapping 4 to IPv4 width, and 6 to IPv6 width).
*
* @var array
*/
private $columnWidth = [];
/**
* Database's pointer offset (as an array mapping 4 to IPv4 offset, and 6 to IPv6 offset).
*
* @var array
*/
private $offset = [];
/**
* Amount of IP address ranges the database contains (as an array mapping 4 to IPv4 count, and 6 to IPv6 count).
*
* @var array
*/
private $ipCount = [];
/**
* Offset withing the database where IP data begins (as an array mapping 4 to IPv4 base, and 6 to IPv6 base).
*
* @var array
*/
private $ipBase = [];
//hjlim
private $indexBaseAddr = [];
private $year;
private $month;
private $day;
// This variable will be used to hold the raw row of columns's positions
private $rawPositionsRow;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Default fields //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Default fields to return during lookup.
*
* @var array|int
*/
private $defaultFields = self::ALL;
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Administrative public interface /////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Constructor.
*/
public function __construct()
{
}
/**
* Destructor.
*/
public function __destruct()
{
}
/**
* @param string $file Filename of the BIN database to load
* @param int $mode Caching mode (one of FILE_IO, MEMORY_CACHE, or SHARED_MEMORY)
* @param mixed $defaultFields
*
* @throws \Exception
*/
public function open($file = null, $mode = self::FILE_IO, $defaultFields = self::ALL)
{
if (!\function_exists('bcadd')) {
throw new \Exception(__CLASS__ . ': BCMath extension is not installed.', self::EXCEPTION_BCMATH_NOT_INSTALLED);
}
// find the referred file and its size
$rfile = self::findFile($file);
$size = filesize($rfile);
// initialize caching backend
switch ($mode) {
case self::SHARED_MEMORY:
// verify the shmop extension is loaded
if (!\extension_loaded('shmop')) {
throw new \Exception(__CLASS__ . ": Please make sure your PHP setup has the 'shmop' extension enabled.", self::EXCEPTION_NO_SHMOP);
}
$limit = self::getMemoryLimit();
if ($limit !== false && $size > $limit) {
throw new \Exception(__CLASS__ . ": Insufficient memory to load file '{$rfile}'.", self::EXCEPTION_NO_MEMORY);
}
$this->mode = self::SHARED_MEMORY;
$shmKey = self::getShmKey($rfile);
// try to open the shared memory segment
$this->resource = @shmop_open($shmKey, 'a', 0, 0);
if ($this->resource === false) {
// the segment did not exist, create it and load the database into it
$fp = fopen($rfile, 'r');
if ($fp === false) {
throw new \Exception(__CLASS__ . ": Unable to open file '{$rfile}'.", self::EXCEPTION_FILE_OPEN_FAILED);
}
// try to open the memory segment for exclusive access
$shmId = @shmop_open($shmKey, 'n', self::SHM_PERMS, $size);
if ($shmId === false) {
throw new \Exception(__CLASS__ . ": Unable to create shared memory block '{$shmKey}'.", self::EXCEPTION_SHMOP_CREATE_FAILED);
}
// load SHM_CHUNK_SIZE bytes at a time
$pointer = 0;
while ($pointer < $size) {
$buf = fread($fp, self::SHM_CHUNK_SIZE);
shmop_write($shmId, $buf, $pointer);
$pointer += self::SHM_CHUNK_SIZE;
}
shmop_close($shmId);
fclose($fp);
// now open the memory segment for readonly access
$this->resource = @shmop_open($shmKey, 'a', 0, 0);
if ($this->resource === false) {
throw new \Exception(__CLASS__ . ": Unable to access shared memory block '{$shmKey}' for reading.", self::EXCEPTION_SHMOP_READING_FAILED);
}
}
break;
case self::FILE_IO:
$this->mode = self::FILE_IO;
$this->resource = @fopen($rfile, 'r');
if ($this->resource === false) {
throw new \Exception(__CLASS__ . ": Unable to open file '{$rfile}'.", self::EXCEPTION_FILE_OPEN_FAILED);
}
break;
case self::MEMORY_CACHE:
$this->mode = self::MEMORY_CACHE;
$this->resource = $rfile;
if (!\array_key_exists($rfile, self::$buffer)) {
$limit = self::getMemoryLimit();
if ($limit !== false && $size > $limit) {
throw new \Exception(__CLASS__ . ": Insufficient memory to load file '{$rfile}'.", self::EXCEPTION_NO_MEMORY);
}
self::$buffer[$rfile] = @file_get_contents($rfile);
if (self::$buffer[$rfile] === false) {
throw new \Exception(__CLASS__ . ": Unable to open file '{$rfile}'.", self::EXCEPTION_FILE_OPEN_FAILED);
}
}
break;
default:
}
// determine the platform's float size
//
// NB: this should be a constant instead, and some unpack / typebanging magic
// should be used to accomodate different float sizes, but, as the libreary
// is written, this is the sanest thing to do anyway
//
if (self::$floatSize === null) {
self::$floatSize = \strlen(pack('f', M_PI));
}
// set default fields to retrieve
$this->defaultFields = $defaultFields;
// extract database metadata
$this->type = $this->readByte(1) - 1;
$this->columnWidth[4] = $this->readByte(2) * 4;
$this->columnWidth[6] = $this->columnWidth[4] + 12;
$this->offset[4] = -4;
$this->offset[6] = 8;
$this->year = 2000 + $this->readByte(3);
$this->month = $this->readByte(4);
$this->day = $this->readByte(5);
$this->date = date('Y-m-d', strtotime("{$this->year}-{$this->month}-{$this->day}"));
$this->ipCount[4] = $this->readWord(6);
$this->ipBase[4] = $this->readWord(10);
$this->ipCount[6] = $this->readWord(14);
$this->ipBase[6] = $this->readWord(18);
$this->indexBaseAddr[4] = $this->readWord(22);
$this->indexBaseAddr[6] = $this->readWord(26);
}
/**
* Close.
*/
public function close()
{
switch ($this->mode) {
case self::FILE_IO:
// free the file pointer
if ($this->resource !== false) {
fclose($this->resource);
$this->resource = false;
}
break;
case self::SHARED_MEMORY:
// detach from the memory segment
if ($this->resource !== false) {
shmop_close($this->resource);
$this->resource = false;
}
break;
}
}
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Public interface ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Get the database's package (1-4).
*
* @return int
*/
public function getPackageVersion()
{
return $this->type + 1;
}
/**
* Return the version of module.
*/
public function getModuleVersion()
{
return self::VERSION;
}
/**
* Return the version of module.
*/
public function getDatabaseVersion()
{
return $this->year . '.' . $this->month . '.' . $this->day;
}
/**
* Return -1, 0, 1, 2.
*
* @param mixed $ip
*/
public function isProxy($ip)
{
return self::lookup($ip, self::IS_PROXY);
}
// Return string
public function getCountryShort($ip)
{
return self::lookup($ip, self::COUNTRY_CODE);
}
// Return string
public function getCountryLong($ip)
{
return self::lookup($ip, self::COUNTRY_NAME);
}
// Return string
public function getRegion($ip)
{
return self::lookup($ip, self::REGION_NAME);
}
// Return string
public function getCity($ip)
{
return self::lookup($ip, self::CITY_NAME);
}
// Return string
public function getISP($ip)
{
return self::lookup($ip, self::ISP);
}
// Return string
public function getProxyType($ip)
{
return self::lookup($ip, self::PROXY_TYPE);
}
// Return string
public function getDomain($ip)
{
return self::lookup($ip, self::DOMAIN);
}
// Return string
public function getUsageType($ip)
{
return self::lookup($ip, self::USAGE_TYPE);
}
// Return string
public function getASN($ip)
{
return self::lookup($ip, self::ASN);
}
// Return string
public function getAS($ip)
{
return self::lookup($ip, self::_AS);
}
// Return string
public function getLastSeen($ip)
{
return self::lookup($ip, self::LAST_SEEN);
}
// Return string
public function getThreat($ip)
{
return self::lookup($ip, self::THREAT);
}
// Return array
public function getAll($ip)
{
return self::lookup($ip, self::ALL);
}
/**
* Tear down a shared memory segment created for the given file.
*
* @param string $file Filename of the BIN database whise segment must be deleted
*
* @throws \Exception
*/
protected function shmTeardown($file)
{
// verify the shmop extension is loaded
if (!\extension_loaded('shmop')) {
throw new \Exception(__CLASS__ . ": Please make sure your PHP setup has the 'shmop' extension enabled.", self::EXCEPTION_NO_SHMOP);
}
// Get actual file path
$rfile = realpath($file);
// If the file cannot be found, except away
if ($rfile === false) {
throw new \Exception(__CLASS__ . ": Database file '{$file}' does not seem to exist.", self::EXCEPTION_DBFILE_NOT_FOUND);
}
$shmKey = self::getShmKey($rfile);
// Try to open the memory segment for writing
$shmId = @shmop_open($shmKey, 'w', 0, 0);
if ($shmId === false) {
throw new \Exception(__CLASS__ . ": Unable to access shared memory block '{$shmKey}' for writing.", self::EXCEPTION_SHMOP_WRITING_FAILED);
}
// Delete and close the descriptor
shmop_delete($shmId);
shmop_close($shmId);
}
/**
* Return this database's available fields.
*
* @param bool $asNames Whether to return the mapped names intead of numbered constants
*
* @return array
*/
protected function getFields($asNames = false)
{
$result = array_keys(array_filter(self::$columns, function ($field) {
return $field[$this->type] !== 0;
}));
if ($asNames) {
$return = [];
foreach ($result as $field) {
$return[] = self::$names[$field];
}
return $return;
}
return $result;
}
/**
* This function will look the given IP address up in the database and return the result(s) asked for.
*
* If a single, SINGULAR, field is specified, only its mapped value is returned.
* If many fields are given (as an array) or a MULTIPLE field is specified, an
* array whith the returned singular field names as keys and their corresponding
* values is returned.
*
* @param string $ip IP address to look up
* @param array|int $fields Field(s) to return
* @param bool $asNamed Whether to return an associative array instead
*
* @return array|bool|mixed
*/
protected function lookup($ip, $fields = null, $asNamed = true)
{
// Extract IP version and number
list($ipVersion, $ipNumber) = self::ipVersionAndNumber($ip);
// Perform the binary search proper (if the IP address was invalid, binSearch will return false)
$pointer = $this->binSearch($ipVersion, $ipNumber);
// Apply defaults if needed
if ($fields === null) {
$fields = $this->defaultFields;
}
// Get the entire row based on the pointer value.
// The length of the row differs based on the IP version.
if ($ipVersion === 4) {
$this->rawPositionsRow = $this->read($pointer - 1, $this->columnWidth[4] + 4);
} elseif ($ipVersion === 6) {
$this->rawPositionsRow = $this->read($pointer - 1, $this->columnWidth[6]);
}
$ifields = (array) $fields;
if (\in_array(self::ALL, $ifields)) {
$ifields[] = self::REGION_NAME;
$ifields[] = self::CITY_NAME;
$ifields[] = self::ISP;
$ifields[] = self::IS_PROXY;
$ifields[] = self::PROXY_TYPE;
$ifields[] = self::DOMAIN;
$ifields[] = self::USAGE_TYPE;
$ifields[] = self::ASN;
$ifields[] = self::_AS;
$ifields[] = self::LAST_SEEN;
$ifields[] = self::THREAT;
$ifields[] = self::COUNTRY;
$ifields[] = self::IP_ADDRESS;
$ifields[] = self::IP_VERSION;
$ifields[] = self::IP_NUMBER;
}
$afields = array_keys(array_flip($ifields));
rsort($afields);
$done = [
self::COUNTRY_CODE => false,
self::COUNTRY_NAME => false,
self::REGION_NAME => false,
self::CITY_NAME => false,
self::ISP => false,
self::IS_PROXY => false,
self::PROXY_TYPE => false,
self::DOMAIN => false,
self::USAGE_TYPE => false,
self::ASN => false,
self::_AS => false,
self::LAST_SEEN => false,
self::THREAT => false,
self::COUNTRY => false,
self::IP_ADDRESS => false,
self::IP_VERSION => false,
self::IP_NUMBER => false,
];
$results = [];
foreach ($afields as $afield) {
switch ($afield) {
case self::ALL:
break;
case self::COUNTRY:
if (!$done[self::COUNTRY]) {
list($results[self::COUNTRY_NAME], $results[self::COUNTRY_CODE]) = $this->readCountryNameAndCode($pointer);
$done[self::COUNTRY] = true;
$done[self::COUNTRY_CODE] = true;
$done[self::COUNTRY_NAME] = true;
}
break;
case self::COUNTRY_CODE:
if (!$done[self::COUNTRY_CODE]) {
$results[self::COUNTRY_CODE] = $this->readCountryNameAndCode($pointer)[1];
$done[self::COUNTRY_CODE] = true;
}
break;
case self::COUNTRY_NAME:
if (!$done[self::COUNTRY_CODE]) {
$results[self::COUNTRY_CODE] = $this->readCountryNameAndCode($pointer)[0];
$done[self::COUNTRY_CODE] = true;
}
break;
case self::REGION_NAME:
if (!$done[self::REGION_NAME]) {
$results[self::REGION_NAME] = $this->readRegionName($pointer);
$done[self::REGION_NAME] = true;
}
break;
case self::CITY_NAME:
if (!$done[self::CITY_NAME]) {
$results[self::CITY_NAME] = $this->readCityName($pointer);
$done[self::CITY_NAME] = true;
}
break;
case self::ISP:
if (!$done[self::ISP]) {
$results[self::ISP] = $this->readIsp($pointer);
$done[self::ISP] = true;
}
break;
case self::PROXY_TYPE:
if (!$done[self::PROXY_TYPE]) {
$results[self::PROXY_TYPE] = $this->readProxyType($pointer);
$done[self::PROXY_TYPE] = true;
}
break;
case self::IS_PROXY:
if (!$done[self::IS_PROXY]) {
// Special case for PX1
if ($this->type == 0) {
$countryCode = $this->readCountryNameAndCode($pointer)[1];
$results[self::IS_PROXY] = ($countryCode == '-') ? 0 : 1;
if (\strlen($countryCode) > 2) {
$results[self::IS_PROXY] = -1;