├── LICENSE ├── README.md ├── composer.json └── src └── XdbSearcher.php /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ip2region SDK for PHP 2 | 3 | [![Author](https://img.shields.io/badge/author-@chinayin-blue.svg)](https://github.com/chinayin) 4 | [![Software License](https://img.shields.io/badge/license-Apache--2.0-brightgreen.svg)](LICENSE) 5 | [![Latest Version](https://img.shields.io/packagist/v/chinayin/ip2region-core.svg)](https://packagist.org/packages/chinayin/ip2region-core) 6 | [![Total Downloads](https://img.shields.io/packagist/dt/chinayin/ip2region-core.svg)](https://packagist.org/packages/chinayin/ip2region-core) 7 | ![php 7.1+](https://img.shields.io/badge/php-min%207.1-red.svg) 8 | 9 | ### Installation 10 | 11 | 运行环境要求 PHP 7.1 及以上版本，以及[cURL](http://php.net/manual/zh/book.curl.php)。 12 | 13 | #### 官方原生查询包 14 | 15 | 特点：包更小，数据路径自定义 16 | 17 | > composer require chinayin/ip2region-core 18 | 19 | #### 包含数据查询包 20 | 21 | 特点：`xdb数据`封装在composer包内，数据会不定期更新 22 | 23 | 使用方法：[github.com/chinayin/ip2region](https://github.com/chinayin/ip2region-sdk-php) 24 | 25 | > composer require chinayin/ip2region 26 | 27 | ### Quick Examples 28 | 29 | #### 完全基于文件的查询 30 | 31 | ```php 32 | use ip2region\XdbSearcher; 33 | 34 | $ip = '1.2.3.4'; 35 | $xdb = './ip2region.xdb'; 36 | try { 37 | $region = XdbSearcher::newWithFileOnly($xdb)->search($ip); 38 | var_dump($region); 39 | } catch (\Exception $e) { 40 | var_dump($e->getMessage()); 41 | } 42 | ``` 43 | 44 | > 备注：并发使用，每个线程或者协程需要创建一个独立的 searcher 对象。 45 | 46 | #### 缓存 VectorIndex 索引 47 | 48 | 如果你的 php 母环境支持，可以预先加载 vectorIndex 缓存，然后做成全局变量，每次创建 Searcher 的时候使用全局的 49 | vectorIndex，可以减少一次固定的 IO 操作从而加速查询，减少 io 压力。 50 | 51 | ```php 52 | use ip2region\XdbSearcher; 53 | 54 | $ip = '1.2.3.4'; 55 | $xdb = './ip2region.xdb'; 56 | try { 57 | // 1、加载 VectorIndex 缓存，把下述的 vIndex 变量缓存到内存里面。 58 | $vIndex = XdbSearcher::loadVectorFromFile($xdb); 59 | if (null === $vIndex) { 60 | throw new \RuntimeException("failed to load vector index from '$xdb'."); 61 | } 62 | // 2、使用全局的 vIndex 创建带 VectorIndex 缓存的查询对象。 63 | $searcher = XdbSearcher::newWithVectorIndex($xdb, $vIndex); 64 | // 3、查询 65 | $region = $searcher->search($ip); 66 | var_dump($region); 67 | } catch (\Exception $e) { 68 | var_dump($e->getMessage()); 69 | } 70 | ``` 71 | 72 | > 备注：并发使用，每个线程或者协程需要创建一个独立的 searcher 对象，但是都共享统一的只读 vectorIndex。 73 | 74 | #### 缓存整个 xdb 数据 75 | 76 | 如果你的 PHP 母环境支持，可以预先加载整个 xdb 的数据到内存，这样可以实现完全基于内存的查询，类似之前的 memory search 查询。 77 | 78 | ```php 79 | use ip2region\XdbSearcher; 80 | 81 | $ip = '1.2.3.4'; 82 | $xdb = './ip2region.xdb'; 83 | try { 84 | // 1、加载整个 xdb 到内存。 85 | $cBuff = XdbSearcher::loadContentFromFile($xdb); 86 | if (null === $cBuff) { 87 | throw new \RuntimeException("failed to load content buffer from '$xdb'"); 88 | } 89 | // 2、使用全局的 cBuff 创建带完全基于内存的查询对象。 90 | $searcher = XdbSearcher::newWithBuffer($cBuff); 91 | // 3、查询 92 | $region = $searcher->search($ip); 93 | var_dump($region); 94 | } catch (\Exception $e) { 95 | var_dump($e->getMessage()); 96 | } 97 | ``` 98 | 99 | > 备注：并发使用，用整个 xdb 缓存创建的 searcher 对象可以安全用于并发。 100 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "chinayin/ip2region-core", 3 | "description": "Ip2region (2.0 - xdb) is a offline IP address manager framework and locator with ten microsecond searching performance. xdb engine implementation for many programming languages\n\n", 4 | "authors": [ 5 | { 6 | "name": "lionsoul2014", 7 | "email": "1187582057@qq.com" 8 | }, 9 | { 10 | "name": "chinayin", 11 | "email": "whereismoney@qq.com" 12 | } 13 | ], 14 | "license": "Apache-2.0", 15 | "require": { 16 | "PHP": ">=7.1" 17 | }, 18 | "require-dev": { 19 | "phpunit/phpunit": "^6.0|^9.5", 20 | "friendsofphp/php-cs-fixer": "^3.0", 21 | "phpstan/phpstan": "^1.0" 22 | }, 23 | "autoload": { 24 | "psr-4": { 25 | "ip2region\\": "src" 26 | } 27 | }, 28 | "autoload-dev": { 29 | "psr-4": { 30 | "ip2region\\Tests\\": "tests" 31 | } 32 | }, 33 | "scripts": { 34 | "test": "vendor/bin/phpunit", 35 | "test-ci": "vendor/bin/phpunit --coverage-text", 36 | "lint": "vendor/bin/php-cs-fixer fix -v", 37 | "analyse": "vendor/bin/phpstan analyse", 38 | "travis": [ 39 | "composer lint", 40 | "composer analyse" 41 | ] 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/XdbSearcher.php: -------------------------------------------------------------------------------- 1 | vectorIndex = null; 76 | $this->contentBuff = $cBuff; 77 | } else { 78 | // open the xdb binary file 79 | $this->handle = fopen($dbFile, "r"); 80 | if ($this->handle === false) { 81 | throw new \Exception("failed to open xdb file '%s'", $dbFile); 82 | } 83 | 84 | $this->vectorIndex = $vectorIndex; 85 | } 86 | } 87 | 88 | public function close() 89 | { 90 | if ($this->handle != null) { 91 | fclose($this->handle); 92 | } 93 | } 94 | 95 | public function getIOCount() 96 | { 97 | return $this->ioCount; 98 | } 99 | 100 | /** 101 | * find the region info for the specified ip address 102 | * @throws \Exception 103 | */ 104 | public function search($ip) 105 | { 106 | // check and convert the sting ip to a 4-bytes long 107 | if (is_string($ip)) { 108 | $t = self::ip2long($ip); 109 | if ($t === null) { 110 | throw new \Exception("invalid ip address `$ip`"); 111 | } 112 | $ip = $t; 113 | } 114 | 115 | // reset the global counter 116 | $this->ioCount = 0; 117 | 118 | // locate the segment index block based on the vector index 119 | $il0 = ($ip >> 24) & 0xFF; 120 | $il1 = ($ip >> 16) & 0xFF; 121 | $idx = $il0 * self::VectorIndexCols * self::VectorIndexSize + $il1 * self::VectorIndexSize; 122 | if ($this->vectorIndex != null) { 123 | $sPtr = self::getLong($this->vectorIndex, $idx); 124 | $ePtr = self::getLong($this->vectorIndex, $idx + 4); 125 | } elseif ($this->contentBuff != null) { 126 | $sPtr = self::getLong($this->contentBuff, self::HeaderInfoLength + $idx); 127 | $ePtr = self::getLong($this->contentBuff, self::HeaderInfoLength + $idx + 4); 128 | } else { 129 | // read the vector index block 130 | $buff = $this->read(self::HeaderInfoLength + $idx, 8); 131 | if ($buff === null) { 132 | throw new \Exception("failed to read vector index at {$idx}"); 133 | } 134 | 135 | $sPtr = self::getLong($buff, 0); 136 | $ePtr = self::getLong($buff, 4); 137 | } 138 | 139 | // printf("sPtr: %d, ePtr: %d\n", $sPtr, $ePtr); 140 | 141 | // binary search the segment index to get the region info 142 | $dataLen = 0; 143 | $dataPtr = null; 144 | $l = 0; 145 | $h = ($ePtr - $sPtr) / self::SegmentIndexSize; 146 | while ($l <= $h) { 147 | $m = ($l + $h) >> 1; 148 | $p = $sPtr + $m * self::SegmentIndexSize; 149 | 150 | // read the segment index 151 | $buff = $this->read($p, self::SegmentIndexSize); 152 | if ($buff == null) { 153 | throw new \Exception("failed to read segment index at {$p}"); 154 | } 155 | 156 | $sip = self::getLong($buff, 0); 157 | if ($ip < $sip) { 158 | $h = $m - 1; 159 | } else { 160 | $eip = self::getLong($buff, 4); 161 | if ($ip > $eip) { 162 | $l = $m + 1; 163 | } else { 164 | $dataLen = self::getShort($buff, 8); 165 | $dataPtr = self::getLong($buff, 10); 166 | break; 167 | } 168 | } 169 | } 170 | 171 | // match nothing interception. 172 | // @TODO: could this even be a case ? 173 | // printf("dataLen: %d, dataPtr: %d\n", $dataLen, $dataPtr); 174 | if ($dataPtr == null) { 175 | return null; 176 | } 177 | 178 | // load and return the region data 179 | $buff = $this->read($dataPtr, $dataLen); 180 | if ($buff == null) { 181 | return null; 182 | } 183 | 184 | return $buff; 185 | } 186 | 187 | // read specified bytes from the specified index 188 | private function read($offset, $len) 189 | { 190 | // check the in-memory buffer first 191 | if ($this->contentBuff != null) { 192 | return substr($this->contentBuff, $offset, $len); 193 | } 194 | 195 | // read from the file 196 | $r = fseek($this->handle, $offset); 197 | if ($r == -1) { 198 | return null; 199 | } 200 | 201 | $this->ioCount++; 202 | $buff = fread($this->handle, $len); 203 | if ($buff === false) { 204 | return null; 205 | } 206 | 207 | if (strlen($buff) != $len) { 208 | return null; 209 | } 210 | 211 | return $buff; 212 | } 213 | 214 | // --- static util functions ---- 215 | 216 | // convert a string ip to long 217 | public static function ip2long($ip) 218 | { 219 | $ip = ip2long($ip); 220 | if ($ip === false) { 221 | return null; 222 | } 223 | 224 | // convert signed int to unsigned int if on 32 bit operating system 225 | if ($ip < 0 && PHP_INT_SIZE == 4) { 226 | $ip = sprintf("%u", $ip); 227 | } 228 | 229 | return $ip; 230 | } 231 | 232 | // read a 4bytes long from a byte buffer 233 | public static function getLong($b, $idx) 234 | { 235 | $val = (ord($b[$idx])) | (ord($b[$idx + 1]) << 8) 236 | | (ord($b[$idx + 2]) << 16) | (ord($b[$idx + 3]) << 24); 237 | 238 | // convert signed int to unsigned int if on 32 bit operating system 239 | if ($val < 0 && PHP_INT_SIZE == 4) { 240 | $val = sprintf("%u", $val); 241 | } 242 | 243 | return $val; 244 | } 245 | 246 | // read a 2bytes short from a byte buffer 247 | public static function getShort($b, $idx) 248 | { 249 | return ((ord($b[$idx])) | (ord($b[$idx + 1]) << 8)); 250 | } 251 | 252 | // load header info from a specified file handle 253 | public static function loadHeader($handle) 254 | { 255 | if (fseek($handle, 0) == -1) { 256 | return null; 257 | } 258 | 259 | $buff = fread($handle, self::HeaderInfoLength); 260 | if ($buff === false) { 261 | return null; 262 | } 263 | 264 | // read bytes length checking 265 | if (strlen($buff) != self::HeaderInfoLength) { 266 | return null; 267 | } 268 | 269 | // return the decoded header info 270 | return [ 271 | 'version' => self::getShort($buff, 0), 272 | 'indexPolicy' => self::getShort($buff, 2), 273 | 'createdAt' => self::getLong($buff, 4), 274 | 'startIndexPtr' => self::getLong($buff, 8), 275 | 'endIndexPtr' => self::getLong($buff, 12) 276 | ]; 277 | } 278 | 279 | // load header info from the specified xdb file path 280 | public static function loadHeaderFromFile($dbFile) 281 | { 282 | $handle = fopen($dbFile, 'r'); 283 | if ($handle === false) { 284 | return null; 285 | } 286 | 287 | return self::loadHeader($handle); 288 | } 289 | 290 | // load vector index from a file handle 291 | public static function loadVectorIndex($handle) 292 | { 293 | if (fseek($handle, self::HeaderInfoLength) == -1) { 294 | return null; 295 | } 296 | 297 | $rLen = self::VectorIndexRows * self::VectorIndexCols * self::SegmentIndexSize; 298 | $buff = fread($handle, $rLen); 299 | if ($buff === false) { 300 | return null; 301 | } 302 | 303 | if (strlen($buff) != $rLen) { 304 | return null; 305 | } 306 | 307 | return $buff; 308 | } 309 | 310 | // load vector index from a specified xdb file path 311 | public static function loadVectorIndexFromFile($dbFile) 312 | { 313 | $handle = fopen($dbFile, 'r'); 314 | if ($handle === false) { 315 | return null; 316 | } 317 | 318 | return self::loadVectorIndex($handle); 319 | } 320 | 321 | // load the xdb content from a file handle 322 | public static function loadContent($handle) 323 | { 324 | if (fseek($handle, 0, SEEK_END) == -1) { 325 | return null; 326 | } 327 | 328 | $size = ftell($handle); 329 | if ($size === false) { 330 | return null; 331 | } 332 | 333 | // seek to the head for reading 334 | if (fseek($handle, 0) == -1) { 335 | return null; 336 | } 337 | 338 | $buff = fread($handle, $size); 339 | if ($buff === false) { 340 | return null; 341 | } 342 | 343 | // read length checking 344 | if (strlen($buff) != $size) { 345 | return null; 346 | } 347 | 348 | return $buff; 349 | } 350 | 351 | // load the xdb content from a file path 352 | public static function loadContentFromFile($dbFile) 353 | { 354 | $str = file_get_contents($dbFile, false); 355 | if ($str === false) { 356 | return null; 357 | } else { 358 | return $str; 359 | } 360 | } 361 | 362 | public static function now() 363 | { 364 | return (microtime(true) * 1000); 365 | } 366 | } 367 | --------------------------------------------------------------------------------