├── LICENSE
├── README.md
├── composer.json
└── src
└── ipip
└── db
├── BaseStation.php
├── BaseStationInfo.php
├── City.php
├── CityInfo.php
├── District.php
├── DistrictInfo.php
├── IDC.php
├── IDCInfo.php
└── Reader.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 | # ipdb-php
2 | IPIP.net officially supported IP database ipdb format parsing library
3 |
4 | # Installing
5 |
6 | composer require ipip/db
7 |
8 |
9 | # Example Code
10 |
11 |
12 | Language Support: CN(中文) / EN (English);
13 |
14 | // 全球 IPv4 地级市精度离线库（China：免费版，每周高级版，每日标准版，每日高级版，每日专业版，每日旗舰版）
15 | $city = new ipip\db\City('c:\work\ipdb\city.free.ipdb');
16 | var_dump($city->find('118.28.1.1', 'CN'));
17 | var_dump($city->findMap('118.28.1.1', 'CN'));
18 | var_dump($city->findInfo('118.28.1.1', 'CN'));
19 |
20 | // 全球 IPv6 地级市精度离线库（China：每周高级版，每日标准版，每日高级版，每日专业版，每日旗舰版）
21 | $city = new ipip\db\City('c:\work\ipdb\city.ipv6.ipdb');
22 | //var_dump($city->find('2001:250:200::', 'CN'));
23 | //var_dump($city->findMap('2001:250:200::', 'CN'));
24 | //var_dump($city->findInfo('2001:250:200::', 'CN'));
25 |
26 |
27 | // for China
28 | // 中国地区区县级IPv4离线库
29 | $district = new ipip\db\District('c:\work\ipdb\china_district.ipdb');
30 | var_dump($district->find('1.12.7.255', 'CN'));
31 | var_dump($district->findMap('1.12.7.255', 'CN'));
32 | var_dump($district->findInfo('1.12.7.255', 'CN'));
33 |
34 | // IDC IPv4 列表离线库
35 | $idc = new ipip\db\IDC('c:\work\ipdb\idc_list.ipdb');
36 | var_dump($idc->find('1.1.1.1', 'CN'));
37 | var_dump($idc->findMap('1.1.1.1', 'CN'));
38 | var_dump($idc->findInfo('1.1.1.1', 'CN'));
39 |
40 | // 基站IPv4 离线库
41 | $baseStation = new ipip\db\BaseStation('c:\work\ipdb\base_station.ipdb');
42 | var_dump($baseStation->find('223.220.221.255', 'CN'));
43 | var_dump($baseStation->findMap('223.220.221.255', 'CN'));
44 | var_dump($baseStation->findInfo('223.220.221.255', 'CN'));
45 |
46 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "ipip/db",
3 | "type": "library",
4 | "description": "IPIP.net officially supported IP database ipdb format parsing library",
5 | "keywords": ["ipip.net","geoip","geolocation", "geo","ip","ipdb"],
6 | "homepage": "https://www.ipip.net",
7 | "license": "Apache-2.0",
8 | "authors": [
9 | {
10 | "name": "IPIP.net",
11 | "email": "frk@ipip.net",
12 | "homepage": "https://www.ipip.net"
13 | }
14 | ],
15 | "require": {
16 | "php": ">=5.4.0"
17 | },
18 | "autoload": {
19 | "psr-4": {
20 | "ipip\\db\\": "src/ipip/db/"
21 | }
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/src/ipip/db/BaseStation.php:
--------------------------------------------------------------------------------
1 | reader = new Reader($db);
18 | }
19 |
20 | public function find($ip, $language)
21 | {
22 | return $this->reader->find($ip, $language);
23 | }
24 |
25 | public function findMap($ip, $language)
26 | {
27 | return $this->reader->findMap($ip, $language);
28 | }
29 |
30 | public function findInfo($ip, $language)
31 | {
32 | $map = $this->findMap($ip, $language);
33 | if (NULL === $map)
34 | {
35 | return NULL;
36 | }
37 |
38 | return new BaseStationInfo($map);
39 | }
40 | }
--------------------------------------------------------------------------------
/src/ipip/db/BaseStationInfo.php:
--------------------------------------------------------------------------------
1 | $value)
23 | {
24 | $this->{$field} = $value;
25 | }
26 | }
27 |
28 | public function __get($name)
29 | {
30 | return $this->{$name};
31 | }
32 | }
--------------------------------------------------------------------------------
/src/ipip/db/City.php:
--------------------------------------------------------------------------------
1 | reader = new Reader($db);
18 | }
19 |
20 | public function find($ip, $language)
21 | {
22 | return $this->reader->find($ip, $language);
23 | }
24 |
25 | public function findMap($ip, $language)
26 | {
27 | return $this->reader->findMap($ip, $language);
28 | }
29 |
30 | public function findInfo($ip, $language)
31 | {
32 | $map = $this->findMap($ip, $language);
33 | if (NULL === $map)
34 | {
35 | return NULL;
36 | }
37 |
38 | return new CityInfo($map);
39 | }
40 | }
--------------------------------------------------------------------------------
/src/ipip/db/CityInfo.php:
--------------------------------------------------------------------------------
1 | $value)
37 | {
38 | $this->{$field} = $value;
39 | }
40 | }
41 |
42 | public function __get($name)
43 | {
44 | return $this->{$name};
45 | }
46 | }
--------------------------------------------------------------------------------
/src/ipip/db/District.php:
--------------------------------------------------------------------------------
1 | reader = new Reader($db);
18 | }
19 |
20 | public function find($ip, $language)
21 | {
22 | return $this->reader->find($ip, $language);
23 | }
24 |
25 | public function findMap($ip, $language)
26 | {
27 | return $this->reader->findMap($ip, $language);
28 | }
29 |
30 | public function findInfo($ip, $language)
31 | {
32 | $map = $this->findMap($ip, $language);
33 | if (NULL === $map)
34 | {
35 | return NULL;
36 | }
37 |
38 | return new DistrictInfo($map);
39 | }
40 | }
--------------------------------------------------------------------------------
/src/ipip/db/DistrictInfo.php:
--------------------------------------------------------------------------------
1 | $value)
25 | {
26 | $this->{$field} = $value;
27 | }
28 | }
29 |
30 | public function __get($name)
31 | {
32 | return $this->{$name};
33 | }
34 | }
--------------------------------------------------------------------------------
/src/ipip/db/IDC.php:
--------------------------------------------------------------------------------
1 | reader = new Reader($db);
18 | }
19 |
20 | public function find($ip, $language)
21 | {
22 | return $this->reader->find($ip, $language);
23 | }
24 |
25 | public function findMap($ip, $language)
26 | {
27 | return $this->reader->findMap($ip, $language);
28 | }
29 |
30 | public function findInfo($ip, $language)
31 | {
32 | $map = $this->findMap($ip, $language);
33 | if (NULL === $map)
34 | {
35 | return NULL;
36 | }
37 |
38 | return new IDCInfo($map);
39 | }
40 | }
--------------------------------------------------------------------------------
/src/ipip/db/IDCInfo.php:
--------------------------------------------------------------------------------
1 | $value)
23 | {
24 | $this->{$field} = $value;
25 | }
26 | }
27 |
28 | public function __get($name)
29 | {
30 | return $this->{$name};
31 | }
32 | }
--------------------------------------------------------------------------------
/src/ipip/db/Reader.php:
--------------------------------------------------------------------------------
1 | database = $database;
33 |
34 | $this->init();
35 | }
36 |
37 | private function init()
38 | {
39 | if (is_readable($this->database) === FALSE)
40 | {
41 | throw new \InvalidArgumentException("The IP Database file \"{$this->database}\" does not exist or is not readable.");
42 | }
43 | $this->file = @fopen($this->database, 'rb');
44 | if ($this->file === FALSE)
45 | {
46 | throw new \InvalidArgumentException("IP Database File opening \"{$this->database}\".");
47 | }
48 | $this->fileSize = @filesize($this->database);
49 | if ($this->fileSize === FALSE)
50 | {
51 | throw new \UnexpectedValueException("Error determining the size of \"{$this->database}\".");
52 | }
53 |
54 | $metaLength = unpack('N', fread($this->file, 4))[1];
55 | $text = fread($this->file, $metaLength);
56 |
57 | $this->meta = json_decode($text, 1);
58 |
59 | if (isset($this->meta['fields']) === FALSE || isset($this->meta['languages']) === FALSE)
60 | {
61 | throw new \Exception('IP Database metadata error.');
62 | }
63 |
64 | $fileSize = 4 + $metaLength + $this->meta['total_size'];
65 | if ($fileSize != $this->fileSize)
66 | {
67 | throw new \Exception('IP Database size error.');
68 | }
69 |
70 | $this->nodeCount = $this->meta['node_count'];
71 | $this->nodeOffset = 4 + $metaLength;
72 | }
73 |
74 | /**
75 | * @param $ip
76 | * @param string $language
77 | * @return array|NULL
78 | */
79 | public function find($ip, $language)
80 | {
81 | if (is_resource($this->file) === FALSE)
82 | {
83 | throw new \BadMethodCallException('IPIP DB closed.');
84 | }
85 |
86 | if (isset($this->meta['languages'][$language]) === FALSE)
87 | {
88 | throw new \InvalidArgumentException("language : {$language} not support.");
89 | }
90 |
91 | if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6) === FALSE)
92 | {
93 | throw new \InvalidArgumentException("The value \"$ip\" is not a valid IP address.");
94 | }
95 |
96 | if (strpos($ip, '.') !== FALSE && !$this->supportV4())
97 | {
98 | throw new \InvalidArgumentException("The Database not support IPv4 address.");
99 | }
100 | elseif (strpos($ip, ':') !== FALSE && !$this->supportV6())
101 | {
102 | throw new \InvalidArgumentException("The Database not support IPv6 address.");
103 | }
104 |
105 | try
106 | {
107 | $node = $this->findNode($ip);
108 |
109 | if ($node > 0)
110 | {
111 | $data = $this->resolve($node);
112 |
113 | $values = explode("\t", $data);
114 |
115 | return array_slice($values, $this->meta['languages'][$language], count($this->meta['fields']));
116 | }
117 | }
118 | catch (\Exception $e)
119 | {
120 | return NULL;
121 | }
122 |
123 | return NULL;
124 | }
125 |
126 | public function findMap($ip, $language)
127 | {
128 | $array = $this->find($ip, $language);
129 | if (NULL === $array)
130 | {
131 | return NULL;
132 | }
133 |
134 | return array_combine($this->meta['fields'], $array);
135 | }
136 |
137 | private $v4offset = 0;
138 |
139 | /**
140 | * @param $ip
141 | * @return int
142 | * @throws \Exception
143 | */
144 | private function findNode($ip)
145 | {
146 | $binary = inet_pton($ip);
147 | $bitCount = strlen($binary) * 8; // 32 | 128
148 | $key = substr($binary, 0, 2);
149 | $node = 0;
150 | $index = 0;
151 | if ($bitCount === 32)
152 | {
153 | if ($this->v4offset === 0)
154 | {
155 | for ($i = 0; $i < 96 && $node < $this->nodeCount; $i++)
156 | {
157 | if ($i >= 80)
158 | {
159 | $idx = 1;
160 | }
161 | else
162 | {
163 | $idx = 0;
164 | }
165 | $node = $this->readNode($node, $idx);
166 | if ($node > $this->nodeCount)
167 | {
168 | return 0;
169 | }
170 | }
171 | $this->v4offset = $node;
172 | }
173 | else
174 | {
175 | $node = $this->v4offset;
176 | }
177 | }
178 |
179 | for ($i = $index; $i < $bitCount; $i++)
180 | {
181 | if ($node >= $this->nodeCount)
182 | {
183 | break;
184 | }
185 |
186 | $node = $this->readNode($node, 1 & ((0xFF & ord($binary[$i >> 3])) >> 7 - ($i % 8)));
187 | }
188 |
189 | if ($node === $this->nodeCount)
190 | {
191 | return 0;
192 | }
193 | elseif ($node > $this->nodeCount)
194 | {
195 | return $node;
196 | }
197 |
198 | throw new \Exception("find node failed.");
199 | }
200 |
201 | /**
202 | * @param $node
203 | * @param $index
204 | * @return mixed
205 | * @throws \Exception
206 | */
207 | private function readNode($node, $index)
208 | {
209 | return unpack('N', $this->read($this->file, $node * 8 + $index * 4, 4))[1];
210 | }
211 |
212 | /**
213 | * @param $node
214 | * @return mixed
215 | * @throws \Exception
216 | */
217 | private function resolve($node)
218 | {
219 | $resolved = $node - $this->nodeCount + $this->nodeCount * 8;
220 | if ($resolved >= $this->fileSize)
221 | {
222 | return NULL;
223 | }
224 |
225 | $bytes = $this->read($this->file, $resolved, 2);
226 | $size = unpack('N', str_pad($bytes, 4, "\x00", STR_PAD_LEFT))[1];
227 |
228 | $resolved += 2;
229 |
230 | return $this->read($this->file, $resolved, $size);
231 | }
232 |
233 | public function close()
234 | {
235 | if (is_resource($this->file) === TRUE)
236 | {
237 | fclose($this->file);
238 | }
239 | }
240 |
241 | /**
242 | * @param $stream
243 | * @param $offset
244 | * @param $length
245 | * @return bool|string
246 | * @throws \Exception
247 | */
248 | private function read($stream, $offset, $length)
249 | {
250 | if ($length > 0)
251 | {
252 | if (fseek($stream, $offset + $this->nodeOffset) === 0)
253 | {
254 | $value = fread($stream, $length);
255 | if (strlen($value) === $length)
256 | {
257 | return $value;
258 | }
259 | }
260 |
261 | throw new \Exception("The Database file read bad data.");
262 | }
263 |
264 | return '';
265 | }
266 |
267 | public function supportV6()
268 | {
269 | return ($this->meta['ip_version'] & self::IPV6) === self::IPV6;
270 | }
271 |
272 | public function supportV4()
273 | {
274 | return ($this->meta['ip_version'] & self::IPV4) === self::IPV4;
275 | }
276 |
277 | public function getMeta()
278 | {
279 | return $this->meta;
280 | }
281 |
282 | /**
283 | * @return int UTC Timestamp
284 | */
285 | public function getBuildTime()
286 | {
287 | return $this->meta['build'];
288 | }
289 | }
290 |
--------------------------------------------------------------------------------