JLNTV_IPD/ip2region-sdk-php
4
0
Fork 0
mirror of https://github.com/chinayin/ip2region-sdk-php.git synced 2025-04-05 20:11:16 +08:00
Code Issues Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
lei.tian 2019-09-18 00:20:43 +08:00
commit 50d5b6fdbf
8 changed files with 498 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
/vendor/
/composer.lock
.idea

3
README.md Normal file
View File

@ -0,0 +1,3 @@
### ip2region
> composer require chinayin/ip2region

BIN
assets/ip2region.db Normal file
View File

Binary file not shown.

31
composer.json Normal file
View File

@ -0,0 +1,31 @@
{
"name": "chinayin/ip2region",
"description": "Ip2region is a offline IP location library with accuracy rate of 99.9% and 0.0x millseconds searching performance. DB file is less then 5Mb with all ip address stored",
"authors": [
{
"name": "lionsoul2014",
"email": "1187582057@qq.com"
},
{
"name": "chinayin",
"email": "whereismoney@qq.com"
}
],
"license": "Apache-2.0",
"require": {
"PHP": ">=5.6"
},
"require-dev": {
"phpunit/phpunit": "^6.0"
},
"autoload": {
"psr-4": {
"lionsoul2014\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"lionsoul2014\\Tests\\": "tests/"
}
}
}

23
phpunit.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
backupStaticAttributes="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
bootstrap="tests/Bootstrap.php"
>
<testsuites>
<testsuite name="All">
<directory>./tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
</phpunit>

397
src/Ip2Region.class.php Normal file
View File

@ -0,0 +1,397 @@
<?php
/**
* ip2region php seacher client class
*
* @author chenxin<chenxin619315@gmail.com>
* @date 2015-10-29
*/
namespace lionsoul2014;
defined('INDEX_BLOCK_LENGTH') or define('INDEX_BLOCK_LENGTH', 12);
defined('TOTAL_HEADER_LENGTH') or define('TOTAL_HEADER_LENGTH', 8192);
class Ip2Region
{
/**
* db file handler
*/
private $dbFileHandler = null;
/**
* header block info
*/
private $HeaderSip = null;
private $HeaderPtr = null;
private $headerLen = 0;
/**
* super block index info
*/
private $firstIndexPtr = 0;
private $lastIndexPtr = 0;
private $totalBlocks = 0;
/**
* for memory mode only
* the original db binary string
*/
private $dbBinStr = null;
private $dbFile = null;
/**
* construct method
*
* @param $ip2regionFile
*/
public function __construct($ip2regionFile = null)
{
null === $ip2regionFile &&
$ip2regionFile = __DIR__ . '/../assets/ip2region.db';
$this->dbFile = $ip2regionFile;
}
/**
* all the db binary string will be loaded into memory
* then search the memory only and this will a lot faster than disk base search
*
* @Note:
* invoke it once before put it to public invoke could make it thread safe
*
* @param $ip
*
* @return array|null
* @throws \Exception
*/
public function memorySearch($ip)
{
//check and load the binary string for the first time
if ($this->dbBinStr == null) {
$this->dbBinStr = file_get_contents($this->dbFile);
if ($this->dbBinStr == false) {
throw new \Exception("Fail to open the db file {$this->dbFile}");
}
$this->firstIndexPtr = self::getLong($this->dbBinStr, 0);
$this->lastIndexPtr = self::getLong($this->dbBinStr, 4);
$this->totalBlocks = ($this->lastIndexPtr - $this->firstIndexPtr) / INDEX_BLOCK_LENGTH + 1;
}
if (is_string($ip)) {
$ip = self::safeIp2long($ip);
}
//binary search to define the data
$l = 0;
$h = $this->totalBlocks;
$dataPtr = 0;
while ($l <= $h) {
$m = (($l + $h) >> 1);
$p = $this->firstIndexPtr + $m * INDEX_BLOCK_LENGTH;
$sip = self::getLong($this->dbBinStr, $p);
if ($ip < $sip) {
$h = $m - 1;
} else {
$eip = self::getLong($this->dbBinStr, $p + 4);
if ($ip > $eip) {
$l = $m + 1;
} else {
$dataPtr = self::getLong($this->dbBinStr, $p + 8);
break;
}
}
}
//not matched just stop it here
if ($dataPtr == 0) {
return null;
}
//get the data
$dataLen = (($dataPtr >> 24) & 0xFF);
$dataPtr = ($dataPtr & 0x00FFFFFF);
return [
'city_id' => self::getLong($this->dbBinStr, $dataPtr),
'region' => substr($this->dbBinStr, $dataPtr + 4, $dataLen - 4)
];
}
/**
* get the data block through the specified ip address or long ip numeric with binary search algorithm
*
* @param $ip
*
* @return array|null
* @throws \Exception
*/
public function binarySearch($ip)
{
//check and conver the ip address
if (is_string($ip)) {
$ip = self::safeIp2long($ip);
}
if ($this->totalBlocks == 0) {
//check and open the original db file
if ($this->dbFileHandler == null) {
$this->dbFileHandler = fopen($this->dbFile, 'r');
if ($this->dbFileHandler == false) {
throw new \Exception("Fail to open the db file {$this->dbFile}");
}
}
fseek($this->dbFileHandler, 0);
$superBlock = fread($this->dbFileHandler, 8);
$this->firstIndexPtr = self::getLong($superBlock, 0);
$this->lastIndexPtr = self::getLong($superBlock, 4);
$this->totalBlocks = ($this->lastIndexPtr - $this->firstIndexPtr) / INDEX_BLOCK_LENGTH + 1;
}
//binary search to define the data
$l = 0;
$h = $this->totalBlocks;
$dataPtr = 0;
while ($l <= $h) {
$m = (($l + $h) >> 1);
$p = $m * INDEX_BLOCK_LENGTH;
fseek($this->dbFileHandler, $this->firstIndexPtr + $p);
$buffer = fread($this->dbFileHandler, INDEX_BLOCK_LENGTH);
$sip = self::getLong($buffer, 0);
if ($ip < $sip) {
$h = $m - 1;
} else {
$eip = self::getLong($buffer, 4);
if ($ip > $eip) {
$l = $m + 1;
} else {
$dataPtr = self::getLong($buffer, 8);
break;
}
}
}
//not matched just stop it here
if ($dataPtr == 0) {
return null;
}
//get the data
$dataLen = (($dataPtr >> 24) & 0xFF);
$dataPtr = ($dataPtr & 0x00FFFFFF);
fseek($this->dbFileHandler, $dataPtr);
$data = fread($this->dbFileHandler, $dataLen);
return [
'city_id' => self::getLong($data, 0),
'region' => substr($data, 4)
];
}
/**
* get the data block associated with the specified ip with b-tree search algorithm
*
* @Note: not thread safe
*
* @param $ip
*
* @return array|null
* @throws \Exception
*/
public function btreeSearch($ip)
{
if (is_string($ip)) {
$ip = self::safeIp2long($ip);
}
//check and load the header
if ($this->HeaderSip == null) {
//check and open the original db file
if ($this->dbFileHandler == null) {
$this->dbFileHandler = fopen($this->dbFile, 'r');
if ($this->dbFileHandler == false) {
throw new \Exception("Fail to open the db file {$this->dbFile}");
}
}
fseek($this->dbFileHandler, 8);
$buffer = fread($this->dbFileHandler, TOTAL_HEADER_LENGTH);
//fill the header
$idx = 0;
$this->HeaderSip = [];
$this->HeaderPtr = [];
for ($i = 0; $i < TOTAL_HEADER_LENGTH; $i += 8) {
$startIp = self::getLong($buffer, $i);
$dataPtr = self::getLong($buffer, $i + 4);
if ($dataPtr == 0) {
break;
}
$this->HeaderSip[] = $startIp;
$this->HeaderPtr[] = $dataPtr;
$idx++;
}
$this->headerLen = $idx;
}
//1. define the index block with the binary search
$l = 0;
$h = $this->headerLen;
$sptr = 0;
$eptr = 0;
while ($l <= $h) {
$m = (($l + $h) >> 1);
//perfetc matched, just return it
if ($ip == $this->HeaderSip[$m]) {
if ($m > 0) {
$sptr = $this->HeaderPtr[$m - 1];
$eptr = $this->HeaderPtr[$m];
} else {
$sptr = $this->HeaderPtr[$m];
$eptr = $this->HeaderPtr[$m + 1];
}
break;
}
//less then the middle value
if ($ip < $this->HeaderSip[$m]) {
if ($m == 0) {
$sptr = $this->HeaderPtr[$m];
$eptr = $this->HeaderPtr[$m + 1];
break;
} else {
if ($ip > $this->HeaderSip[$m - 1]) {
$sptr = $this->HeaderPtr[$m - 1];
$eptr = $this->HeaderPtr[$m];
break;
}
}
$h = $m - 1;
} else {
if ($m == $this->headerLen - 1) {
$sptr = $this->HeaderPtr[$m - 1];
$eptr = $this->HeaderPtr[$m];
break;
} else {
if ($ip <= $this->HeaderSip[$m + 1]) {
$sptr = $this->HeaderPtr[$m];
$eptr = $this->HeaderPtr[$m + 1];
break;
}
}
$l = $m + 1;
}
}
//match nothing just stop it
if ($sptr == 0) {
return null;
}
//2. search the index blocks to define the data
$blockLen = $eptr - $sptr;
fseek($this->dbFileHandler, $sptr);
$index = fread($this->dbFileHandler, $blockLen + INDEX_BLOCK_LENGTH);
$dataPtr = 0;
$l = 0;
$h = $blockLen / INDEX_BLOCK_LENGTH;
while ($l <= $h) {
$m = (($l + $h) >> 1);
$p = (int)($m * INDEX_BLOCK_LENGTH);
$sip = self::getLong($index, $p);
if ($ip < $sip) {
$h = $m - 1;
} else {
$eip = self::getLong($index, $p + 4);
if ($ip > $eip) {
$l = $m + 1;
} else {
$dataPtr = self::getLong($index, $p + 8);
break;
}
}
}
//not matched
if ($dataPtr == 0) {
return null;
}
//3. get the data
$dataLen = (($dataPtr >> 24) & 0xFF);
$dataPtr = ($dataPtr & 0x00FFFFFF);
fseek($this->dbFileHandler, $dataPtr);
$data = fread($this->dbFileHandler, $dataLen);
return [
'city_id' => self::getLong($data, 0),
'region' => substr($data, 4)
];
}
/**
* safe self::safeIp2long function
*
* @param $ip
*
* @return int|string
*/
public static function safeIp2long($ip)
{
$ip = ip2long($ip);
// convert signed int to unsigned int if on 32 bit operating system
if ($ip < 0 && PHP_INT_SIZE == 4) {
$ip = sprintf("%u", $ip);
}
return $ip;
}
/**
* read a long from a byte buffer
*
* @param $b
* @param $offset
*
* @return int|string
*/
public static function getLong($b, $offset)
{
$val = (
(ord($b[$offset++])) |
(ord($b[$offset++]) << 8) |
(ord($b[$offset++]) << 16) |
(ord($b[$offset]) << 24)
);
// convert signed int to unsigned int if on 32 bit operating system
if ($val < 0 && PHP_INT_SIZE == 4) {
$val = sprintf("%u", $val);
}
return $val;
}
/**
* destruct method, resource destroy
*/
public function __destruct()
{
if ($this->dbFileHandler != null) {
fclose($this->dbFileHandler);
}
$this->dbBinStr = null;
$this->HeaderSip = null;
$this->HeaderPtr = null;
}
}

4
tests/Bootstrap.php Normal file
View File

@ -0,0 +1,4 @@
<?php
require_once __DIR__ . '/../src/Ip2Region.class.php';

36
tests/TestCase.php Normal file
View File

@ -0,0 +1,36 @@
<?php
namespace lionsoul2014\Tests;
use lionsoul2014\Ip2Region;
class TestCase extends \PHPUnit\Framework\TestCase
{
public function testBinarySearch()
{
$ip = '220.181.38.150';
$ip2region = new Ip2Region;
$s_time = $this->getTime();
$data = $ip2region->binarySearch($ip);
$c_time = $this->getTime() - $s_time;
printf("%s ==> %s|%s in %.5f millseconds\n", $ip, $data['city_id'], $data['region'], $c_time);
$this->assertNotEmpty($data);
}
public function testMemorySearch()
{
$ip = '220.181.38.150';
$ip2region = new Ip2Region;
$s_time = $this->getTime();
$data = $ip2region->memorySearch($ip);
$c_time = $this->getTime() - $s_time;
printf("%s ==> %s|%s in %.5f millseconds\n", $ip, $data['city_id'], $data['region'], $c_time);
$this->assertNotEmpty($data);
}
function getTime()
{
return (microtime(true) * 1000);
}
}