MDL-23720 importing latest PEAR GeoIP module
[moodle.git] / lib / pear / Net / GeoIP.php
1 <?php\r
2 /**\r
3  * +----------------------------------------------------------------------+\r
4  * | PHP version 5                                                        |\r
5  * +----------------------------------------------------------------------+\r
6  * | Copyright (C) 2004 MaxMind LLC                                       |\r
7  * +----------------------------------------------------------------------+\r
8  * | This library is free software; you can redistribute it and/or        |\r
9  * | modify it under the terms of the GNU Lesser General Public           |\r
10  * | License as published by the Free Software Foundation; either         |\r
11  * | version 2.1 of the License, or (at your option) any later version.   |\r
12  * |                                                                      |\r
13  * | This library is distributed in the hope that it will be useful,      |\r
14  * | but WITHOUT ANY WARRANTY; without even the implied warranty of       |\r
15  * | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU    |\r
16  * | Lesser General Public License for more details.                      |\r
17  * |                                                                      |\r
18  * | You should have received a copy of the GNU Lesser General Public     |\r
19  * | License along with this library; if not, write to the Free Software  |\r
20  * | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 |\r
21  * | USA, or view it online at http://www.gnu.org/licenses/lgpl.txt.      |\r
22  * +----------------------------------------------------------------------+\r
23  * | Authors: Jim Winstead <jimw@apache.org> (original Maxmind version)   |\r
24  * |          Hans Lellelid <hans@xmpl.org>                               |\r
25  * +----------------------------------------------------------------------+\r
26  *\r
27  * @category Net\r
28  * @package  Net_GeoIP\r
29  * @author   Jim Winstead <jimw@apache.org> (original Maxmind PHP API)\r
30  * @author   Hans Lellelid <hans@xmpl.org>\r
31  * @license  LGPL http://www.gnu.org/licenses/lgpl.txt\r
32  * @link     http://pear.php.net/package/Net_GeoIp\r
33  * $Id$\r
34  */\r
35 \r
36 require_once 'PEAR/Exception.php';\r
37 \r
38 /**\r
39  * GeoIP class provides an API for performing geo-location lookups based on IP\r
40  * address.\r
41  *\r
42  * To use this class you must have a [binary version] GeoIP database. There is\r
43  * a free GeoIP country database which can be obtained from Maxmind:\r
44  * {@link http://www.maxmind.com/app/geoip_country}\r
45  *\r
46  *\r
47  * <b>SIMPLE USE</b>\r
48  *\r
49  *\r
50  * Create an instance:\r
51  *\r
52  * <code>\r
53  * $geoip = Net_GeoIP::getInstance('/path/to/geoipdb.dat', Net_GeoIP::SHARED_MEMORY);\r
54  * </code>\r
55  *\r
56  * Depending on which database you are using (free, or one of paid versions)\r
57  * you must use appropriate lookup method:\r
58  *\r
59  * <code>\r
60  * // for free country db:\r
61  * $country_name = $geoip->lookupCountryName($_SERVER['REMOTE_ADDR']);\r
62  * $country_code = $geoip->lookupCountryCode($_SERVER['REMOTE_ADDR']);\r
63  *\r
64  * // for [non-free] region db:\r
65  * list($ctry_code, $region) = $geoip->lookupRegion($_SERVER['REMOTE_ADDR']);\r
66  *\r
67  * // for [non-free] city db:\r
68  * $location = $geoip->lookupLocation($_SERVER['REMOTE_ADDR']);\r
69  * print "city: " . $location->city . ", " . $location->region;\r
70  * print "lat: " . $location->latitude . ", long: " . $location->longitude;\r
71  *\r
72  * // for organization or ISP db:\r
73  * $org_or_isp_name = $geoip->lookupOrg($_SERVER['REMOTE_ADDR']);\r
74  * </code>\r
75  *\r
76  *\r
77  * <b>MULTIPLE INSTANCES</b>\r
78  *\r
79  *\r
80  * You can have several instances of this class, one for each database file\r
81  * you are using.  You should use the static getInstance() singleton method\r
82  * to save on overhead of setting up database segments.  Note that only one\r
83  * instance is stored per filename, and any flags will be ignored if an\r
84  * instance already exists for the specifiedfilename.\r
85  *\r
86  * <b>Special note on using SHARED_MEMORY flag</b>\r
87  *\r
88  * If you are using SHARED_MEMORY (shmop) you can only use SHARED_MEMORY for\r
89  * one (1) instance  (i.e. for one database). Any subsequent attempts to\r
90  * instantiate using SHARED_MEMORY will read the same shared memory block\r
91  * already initialized, and therefore will cause problems since the expected\r
92  * database format won't match the database in the shared memory block.\r
93  *\r
94  * Note that there is no easy way to flag "nice errors" to prevent attempts\r
95  * to create new instances using SHARED_MEMORY flag and it is also not posible\r
96  * (in a safe way) to allow new instances to overwrite the shared memory block.\r
97  *\r
98  * In short, is you are using multiple databses, use the SHARED_MEMORY flag\r
99  * with care.\r
100  *\r
101  *\r
102  * <b>LOOKUPS ON HOSTNAMES</b>\r
103  *\r
104  *\r
105  * Note that this PHP API does NOT support lookups on hostnames.  This is so\r
106  * that the public API can be kept simple and so that the lookup functions\r
107  * don't need to try name lookups if IP lookup fails (which would be the only\r
108  * way to keep the API simple and support name-based lookups).\r
109  *\r
110  * If you do not know the IP address, you can convert an name to IP very\r
111  * simply using PHP native functions or other libraries:\r
112  *\r
113  * <code>\r
114  *     $geoip->lookupCountryName(gethostbyname('www.sunset.se'));\r
115  * </code>\r
116  *\r
117  * Or, if you don't know whether an address is a name or ip address, use\r
118  * application-level logic:\r
119  *\r
120  * <code>\r
121  * if (ip2long($ip_or_name) === false) {\r
122  *   $ip = gethostbyname($ip_or_name);\r
123  * } else {\r
124  *   $ip = $ip_or_name;\r
125  * }\r
126  * $ctry = $geoip->lookupCountryName($ip);\r
127  * </code>\r
128  *\r
129  * @category Net\r
130  * @package  Net_GeoIP\r
131  * @author   Jim Winstead <jimw@apache.org> (original Maxmind PHP API)\r
132  * @author   Hans Lellelid <hans@xmpl.org>\r
133  * @license  LGPL http://www.gnu.org/licenses/lgpl.txt\r
134  * @link     http://pear.php.net/package/Net_GeoIp\r
135  */\r
136 class Net_GeoIP\r
137 {\r
138     /**\r
139      * Exception error code used for invalid IP address.\r
140      */\r
141     const ERR_INVALID_IP =  218624992; // crc32('Net_GeoIP::ERR_INVALID_IP')\r
142 \r
143     /**\r
144      * Exception error code when there is a DB-format-related error.\r
145      */\r
146     const ERR_DB_FORMAT = 866184008; // crc32('Net_GeoIP::ERR_DB_FORMAT')\r
147 \r
148     public static $COUNTRY_CODES = array(\r
149       "", "AP", "EU", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ",\r
150       "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH",\r
151       "BI", "BJ", "BM", "BN", "BO", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA",\r
152       "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU",\r
153       "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG",\r
154       "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB",\r
155       "GD", "GE", "GF", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT",\r
156       "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN",\r
157       "IO", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM",\r
158       "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS",\r
159       "LT", "LU", "LV", "LY", "MA", "MC", "MD", "MG", "MH", "MK", "ML", "MM", "MN",\r
160       "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA",\r
161       "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA",\r
162       "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY",\r
163       "QA", "RE", "RO", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI",\r
164       "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD",\r
165       "TF", "TG", "TH", "TJ", "TK", "TM", "TN", "TO", "TL", "TR", "TT", "TV", "TW",\r
166       "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN",\r
167       "VU", "WF", "WS", "YE", "YT", "RS", "ZA", "ZM", "ME", "ZW", "A1", "A2", "O1",\r
168       "AX", "GG", "IM", "JE", "BL", "MF"\r
169         );\r
170 \r
171     public static $COUNTRY_CODES3 = array(\r
172     "","AP","EU","AND","ARE","AFG","ATG","AIA","ALB","ARM","ANT","AGO","AQ","ARG",\r
173     "ASM","AUT","AUS","ABW","AZE","BIH","BRB","BGD","BEL","BFA","BGR","BHR","BDI",\r
174     "BEN","BMU","BRN","BOL","BRA","BHS","BTN","BV","BWA","BLR","BLZ","CAN","CC",\r
175     "COD","CAF","COG","CHE","CIV","COK","CHL","CMR","CHN","COL","CRI","CUB","CPV",\r
176     "CX","CYP","CZE","DEU","DJI","DNK","DMA","DOM","DZA","ECU","EST","EGY","ESH",\r
177     "ERI","ESP","ETH","FIN","FJI","FLK","FSM","FRO","FRA","FX","GAB","GBR","GRD",\r
178     "GEO","GUF","GHA","GIB","GRL","GMB","GIN","GLP","GNQ","GRC","GS","GTM","GUM",\r
179     "GNB","GUY","HKG","HM","HND","HRV","HTI","HUN","IDN","IRL","ISR","IND","IO",\r
180     "IRQ","IRN","ISL","ITA","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA",\r
181     "PRK","KOR","KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU",\r
182     "LUX","LVA","LBY","MAR","MCO","MDA","MDG","MHL","MKD","MLI","MMR","MNG","MAC",\r
183     "MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM","NCL",\r
184     "NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NIU","NZL","OMN","PAN","PER",\r
185     "PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT","PLW","PRY","QAT",\r
186     "REU","ROU","RUS","RWA","SAU","SLB","SYC","SDN","SWE","SGP","SHN","SVN","SJM",\r
187     "SVK","SLE","SMR","SEN","SOM","SUR","STP","SLV","SYR","SWZ","TCA","TCD","TF",\r
188     "TGO","THA","TJK","TKL","TLS","TKM","TUN","TON","TUR","TTO","TUV","TWN","TZA",\r
189     "UKR","UGA","UM","USA","URY","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT",\r
190     "WLF","WSM","YEM","YT","SRB","ZAF","ZMB","MNE","ZWE","A1","A2","O1",\r
191     "ALA","GGY","IMN","JEY","BLM","MAF"\r
192         );\r
193 \r
194     public static $COUNTRY_NAMES = array(\r
195         "", "Asia/Pacific Region", "Europe", "Andorra", "United Arab Emirates",\r
196         "Afghanistan", "Antigua and Barbuda", "Anguilla", "Albania", "Armenia",\r
197         "Netherlands Antilles", "Angola", "Antarctica", "Argentina", "American Samoa",\r
198         "Austria", "Australia", "Aruba", "Azerbaijan", "Bosnia and Herzegovina",\r
199         "Barbados", "Bangladesh", "Belgium", "Burkina Faso", "Bulgaria", "Bahrain",\r
200         "Burundi", "Benin", "Bermuda", "Brunei Darussalam", "Bolivia", "Brazil",\r
201         "Bahamas", "Bhutan", "Bouvet Island", "Botswana", "Belarus", "Belize",\r
202         "Canada", "Cocos (Keeling) Islands", "Congo, The Democratic Republic of the",\r
203         "Central African Republic", "Congo", "Switzerland", "Cote D'Ivoire", "Cook Islands",\r
204         "Chile", "Cameroon", "China", "Colombia", "Costa Rica", "Cuba", "Cape Verde",\r
205         "Christmas Island", "Cyprus", "Czech Republic", "Germany", "Djibouti",\r
206         "Denmark", "Dominica", "Dominican Republic", "Algeria", "Ecuador", "Estonia",\r
207         "Egypt", "Western Sahara", "Eritrea", "Spain", "Ethiopia", "Finland", "Fiji",\r
208         "Falkland Islands (Malvinas)", "Micronesia, Federated States of", "Faroe Islands",\r
209         "France", "France, Metropolitan", "Gabon", "United Kingdom",\r
210         "Grenada", "Georgia", "French Guiana", "Ghana", "Gibraltar", "Greenland",\r
211         "Gambia", "Guinea", "Guadeloupe", "Equatorial Guinea", "Greece", "South Georgia and the South Sandwich Islands",\r
212         "Guatemala", "Guam", "Guinea-Bissau",\r
213         "Guyana", "Hong Kong", "Heard Island and McDonald Islands", "Honduras",\r
214         "Croatia", "Haiti", "Hungary", "Indonesia", "Ireland", "Israel", "India",\r
215         "British Indian Ocean Territory", "Iraq", "Iran, Islamic Republic of",\r
216         "Iceland", "Italy", "Jamaica", "Jordan", "Japan", "Kenya", "Kyrgyzstan",\r
217         "Cambodia", "Kiribati", "Comoros", "Saint Kitts and Nevis", "Korea, Democratic People's Republic of",\r
218         "Korea, Republic of", "Kuwait", "Cayman Islands",\r
219         "Kazakstan", "Lao People's Democratic Republic", "Lebanon", "Saint Lucia",\r
220         "Liechtenstein", "Sri Lanka", "Liberia", "Lesotho", "Lithuania", "Luxembourg",\r
221         "Latvia", "Libyan Arab Jamahiriya", "Morocco", "Monaco", "Moldova, Republic of",\r
222         "Madagascar", "Marshall Islands", "Macedonia",\r
223         "Mali", "Myanmar", "Mongolia", "Macau", "Northern Mariana Islands",\r
224         "Martinique", "Mauritania", "Montserrat", "Malta", "Mauritius", "Maldives",\r
225         "Malawi", "Mexico", "Malaysia", "Mozambique", "Namibia", "New Caledonia",\r
226         "Niger", "Norfolk Island", "Nigeria", "Nicaragua", "Netherlands", "Norway",\r
227         "Nepal", "Nauru", "Niue", "New Zealand", "Oman", "Panama", "Peru", "French Polynesia",\r
228         "Papua New Guinea", "Philippines", "Pakistan", "Poland", "Saint Pierre and Miquelon",\r
229         "Pitcairn Islands", "Puerto Rico", "Palestinian Territory",\r
230         "Portugal", "Palau", "Paraguay", "Qatar", "Reunion", "Romania",\r
231         "Russian Federation", "Rwanda", "Saudi Arabia", "Solomon Islands",\r
232         "Seychelles", "Sudan", "Sweden", "Singapore", "Saint Helena", "Slovenia",\r
233         "Svalbard and Jan Mayen", "Slovakia", "Sierra Leone", "San Marino", "Senegal",\r
234         "Somalia", "Suriname", "Sao Tome and Principe", "El Salvador", "Syrian Arab Republic",\r
235         "Swaziland", "Turks and Caicos Islands", "Chad", "French Southern Territories",\r
236         "Togo", "Thailand", "Tajikistan", "Tokelau", "Turkmenistan",\r
237         "Tunisia", "Tonga", "Timor-Leste", "Turkey", "Trinidad and Tobago", "Tuvalu",\r
238         "Taiwan", "Tanzania, United Republic of", "Ukraine",\r
239         "Uganda", "United States Minor Outlying Islands", "United States", "Uruguay",\r
240         "Uzbekistan", "Holy See (Vatican City State)", "Saint Vincent and the Grenadines",\r
241         "Venezuela", "Virgin Islands, British", "Virgin Islands, U.S.",\r
242         "Vietnam", "Vanuatu", "Wallis and Futuna", "Samoa", "Yemen", "Mayotte",\r
243         "Serbia", "South Africa", "Zambia", "Montenegro", "Zimbabwe",\r
244         "Anonymous Proxy","Satellite Provider","Other",\r
245         "Aland Islands","Guernsey","Isle of Man","Jersey","Saint Barthelemy","Saint Martin"\r
246         );\r
247 \r
248     // storage / caching flags\r
249     const STANDARD = 0;\r
250     const MEMORY_CACHE = 1;\r
251     const SHARED_MEMORY = 2;\r
252 \r
253     // Database structure constants\r
254     const COUNTRY_BEGIN = 16776960;\r
255     const STATE_BEGIN_REV0 = 16700000;\r
256     const STATE_BEGIN_REV1 = 16000000;\r
257 \r
258     const STRUCTURE_INFO_MAX_SIZE = 20;\r
259     const DATABASE_INFO_MAX_SIZE = 100;\r
260     const COUNTRY_EDITION = 106;\r
261     const REGION_EDITION_REV0 = 112;\r
262     const REGION_EDITION_REV1 = 3;\r
263     const CITY_EDITION_REV0 = 111;\r
264     const CITY_EDITION_REV1 = 2;\r
265     const ORG_EDITION = 110;\r
266     const SEGMENT_RECORD_LENGTH = 3;\r
267     const STANDARD_RECORD_LENGTH = 3;\r
268     const ORG_RECORD_LENGTH = 4;\r
269     const MAX_RECORD_LENGTH = 4;\r
270     const MAX_ORG_RECORD_LENGTH = 300;\r
271     const FULL_RECORD_LENGTH = 50;\r
272 \r
273     const US_OFFSET = 1;\r
274     const CANADA_OFFSET = 677;\r
275     const WORLD_OFFSET = 1353;\r
276     const FIPS_RANGE = 360;\r
277 \r
278     // SHMOP memory address\r
279     const SHM_KEY = 0x4f415401;\r
280 \r
281     /**\r
282      * @var int\r
283      */\r
284     private $flags = 0;\r
285 \r
286     /**\r
287      * @var resource\r
288      */\r
289     private $filehandle;\r
290 \r
291     /**\r
292      * @var string\r
293      */\r
294     private $memoryBuffer;\r
295 \r
296     /**\r
297      * @var int\r
298      */\r
299     private $databaseType;\r
300 \r
301     /**\r
302      * @var int\r
303      */\r
304     private $databaseSegments;\r
305 \r
306     /**\r
307      * @var int\r
308      */\r
309     private $recordLength;\r
310 \r
311     /**\r
312      * The memory addr "id" for use with SHMOP.\r
313      * @var int\r
314      */\r
315     private $shmid;\r
316 \r
317     /**\r
318      * Support for singleton pattern.\r
319      * @var array\r
320      */\r
321     private static $instances = array();\r
322 \r
323     /**\r
324      * Construct a Net_GeoIP instance.\r
325      * You should use the getInstance() method if you plan to use multiple databases or\r
326      * the same database from several different places in your script.\r
327      *\r
328      * @param string $filename Path to binary geoip database.\r
329      * @param int    $flags    Flags\r
330      *\r
331      * @see getInstance()\r
332      */\r
333     public function __construct($filename = null, $flags = null)\r
334     {\r
335         if ($filename !== null) {\r
336             $this->open($filename, $flags);\r
337         }\r
338         // store the instance, so that it will be returned by a call to\r
339         // getInstance() (with the same db filename).\r
340         self::$instances[$filename] = $this;\r
341     }\r
342 \r
343     /**\r
344      * Calls the close() function to free any resources.\r
345      * @see close()\r
346      *\r
347      * COMMENTED OUT TO ADDRESS BUG IN PHP 5.0.4, 5.0.5dev.  THIS RESOURCE\r
348      * SHOULD AUTOMATICALLY BE FREED AT SCRIPT CLOSE, SO A DESTRUCTOR\r
349      * IS A GOOD IDEA BUT NOT NECESSARILY A NECESSITY.\r
350     public function __destruct()\r
351     {\r
352         $this->close();\r
353     }\r
354     */\r
355 \r
356     /**\r
357      * Singleton method, use this to get an instance and avoid re-parsing the db.\r
358      *\r
359      * Unique instances are instantiated based on the filename of the db. The flags\r
360      * are ignored -- in that requests to for instance with same filename but different\r
361      * flags will return the already-instantiated instance.  For example:\r
362      * <code>\r
363      * // create new instance with memory_cache enabled\r
364      * $geoip = Net_GeoIP::getInstance('C:\mydb.dat', Net_GeoIP::MEMORY_CACHE);\r
365      * ....\r
366      *\r
367      * // later in code, request instance with no flags specified.\r
368      * $geoip = Net_GeoIP::getInstance('C:\mydb.dat');\r
369      *\r
370      * // Normally this means no MEMORY_CACHE but since an instance\r
371      * // with memory cache enabled has already been created for 'C:\mydb.dat', the\r
372      * // existing instance (with memory cache) will be returned.\r
373      * </code>\r
374      *\r
375      * NOTE: You can only use SHARED_MEMORY flag for one instance!  Any subsquent instances\r
376      * that attempt to use the SHARED_MEMORY will use the *same* shared memory, which will break\r
377      * your script.\r
378      *\r
379      * @param string $filename Filename\r
380      * @param int    $flags    Flags that control class behavior.\r
381      *          + Net_GeoIp::SHARED_MEMORY\r
382      *             Use SHMOP to share a db among multiple PHP instances.\r
383      *             NOTE: ONLY ONE GEOIP INSTANCE CAN USE SHARED MEMORY!!!\r
384      *          + Net_GeoIp::MEMORY_CACHE\r
385      *             Store the full contents of the database in memory for current script.\r
386      *             This is useful if you access the database several times in a script.\r
387      *          + Net_GeoIp::STANDARD\r
388      *             [default] standard no-cache version.\r
389      *\r
390      * @return Net_GeoIP\r
391      */\r
392     public static function getInstance($filename = null, $flags = null)\r
393     {\r
394         if (!isset(self::$instances[$filename])) {\r
395             self::$instances[$filename] = new Net_GeoIP($filename, $flags);\r
396         }\r
397         return self::$instances[$filename];\r
398     }\r
399 \r
400     /**\r
401      * Opens geoip database at filename and with specified flags.\r
402      *\r
403      * @param string $filename File to open\r
404      * @param int    $flags    Flags\r
405      *\r
406      * @return void\r
407      *\r
408      * @throws PEAR_Exception if unable to open specified file or shared memory.\r
409      */\r
410     public function open($filename, $flags = null)\r
411     {\r
412         if ($flags !== null) {\r
413             $this->flags = $flags;\r
414         }\r
415         if ($this->flags & self::SHARED_MEMORY) {\r
416             $this->shmid = @shmop_open(self::SHM_KEY, "a", 0, 0);\r
417             if ($this->shmid === false) {\r
418                 $this->loadSharedMemory($filename);\r
419                 $this->shmid = @shmop_open(self::SHM_KEY, "a", 0, 0);\r
420                 if ($this->shmid === false) { // should never be false as loadSharedMemory() will throw Exc if cannot create\r
421                     throw new PEAR_Exception("Unable to open shared memory at key: " . dechex(self::SHM_KEY));\r
422                 }\r
423             }\r
424         } else {\r
425             $this->filehandle = fopen($filename, "rb");\r
426             if (!$this->filehandle) {\r
427                 throw new PEAR_Exception("Unable to open file: $filename");\r
428             }\r
429             if ($this->flags & self::MEMORY_CACHE) {\r
430                 $s_array = fstat($this->filehandle);\r
431                 $this->memoryBuffer = fread($this->filehandle, $s_array['size']);\r
432             }\r
433         }\r
434         $this->setupSegments();\r
435     }\r
436 \r
437     /**\r
438      * Loads the database file into shared memory.\r
439      *\r
440      * @param string $filename Path to database file to read into shared memory.\r
441      *\r
442      * @return void\r
443      *\r
444      * @throws PEAR_Exception     - if unable to read the db file.\r
445      */\r
446     protected function loadSharedMemory($filename)\r
447     {\r
448         $fp = fopen($filename, "rb");\r
449         if (!$fp) {\r
450             throw new PEAR_Exception("Unable to open file: $filename");\r
451         }\r
452         $s_array = fstat($fp);\r
453         $size = $s_array['size'];\r
454 \r
455         if ($shmid = @shmop_open(self::SHM_KEY, "w", 0, 0)) {\r
456             shmop_delete($shmid);\r
457             shmop_close($shmid);\r
458         }\r
459 \r
460         if ($shmid = @shmop_open(self::SHM_KEY, "c", 0644, $size)) {\r
461             $offset = 0;\r
462             while ($offset < $size) {\r
463                 $buf = fread($fp, 524288);\r
464                 shmop_write($shmid, $buf, $offset);\r
465                 $offset += 524288;\r
466             }\r
467             shmop_close($shmid);\r
468         }\r
469 \r
470         fclose($fp);\r
471     }\r
472 \r
473     /**\r
474      * Parses the database file to determine what kind of database is being used and setup\r
475      * segment sizes and start points that will be used by the seek*() methods later.\r
476      *\r
477      * @return void\r
478      */\r
479     protected function setupSegments()\r
480     {\r
481 \r
482         $this->databaseType = self::COUNTRY_EDITION;\r
483         $this->recordLength = self::STANDARD_RECORD_LENGTH;\r
484 \r
485         if ($this->flags & self::SHARED_MEMORY) {\r
486 \r
487             $offset = shmop_size($this->shmid) - 3;\r
488             for ($i = 0; $i < self::STRUCTURE_INFO_MAX_SIZE; $i++) {\r
489                 $delim = shmop_read($this->shmid, $offset, 3);\r
490                 $offset += 3;\r
491                 if ($delim == (chr(255).chr(255).chr(255))) {\r
492                     $this->databaseType = ord(shmop_read($this->shmid, $offset, 1));\r
493                     $offset++;\r
494                     if ($this->databaseType === self::REGION_EDITION_REV0) {\r
495                         $this->databaseSegments = self::STATE_BEGIN_REV0;\r
496                     } elseif ($this->databaseType === self::REGION_EDITION_REV1) {\r
497                         $this->databaseSegments = self::STATE_BEGIN_REV1;\r
498                     } elseif (($this->databaseType === self::CITY_EDITION_REV0)\r
499                                 || ($this->databaseType === self::CITY_EDITION_REV1)\r
500                                 || ($this->databaseType === self::ORG_EDITION)) {\r
501                         $this->databaseSegments = 0;\r
502                         $buf = shmop_read($this->shmid, $offset, self::SEGMENT_RECORD_LENGTH);\r
503                         for ($j = 0; $j < self::SEGMENT_RECORD_LENGTH; $j++) {\r
504                             $this->databaseSegments += (ord($buf[$j]) << ($j * 8));\r
505                         }\r
506                         if ($this->databaseType === self::ORG_EDITION) {\r
507                             $this->recordLength = self::ORG_RECORD_LENGTH;\r
508                         }\r
509                     }\r
510                     break;\r
511                 } else {\r
512                     $offset -= 4;\r
513                 }\r
514             }\r
515             if ($this->databaseType == self::COUNTRY_EDITION) {\r
516                 $this->databaseSegments = self::COUNTRY_BEGIN;\r
517             }\r
518 \r
519         } else {\r
520 \r
521             $filepos = ftell($this->filehandle);\r
522             fseek($this->filehandle, -3, SEEK_END);\r
523             for ($i = 0; $i < self::STRUCTURE_INFO_MAX_SIZE; $i++) {\r
524                 $delim = fread($this->filehandle, 3);\r
525                 if ($delim == (chr(255).chr(255).chr(255))) {\r
526                     $this->databaseType = ord(fread($this->filehandle, 1));\r
527                     if ($this->databaseType === self::REGION_EDITION_REV0) {\r
528                         $this->databaseSegments = self::STATE_BEGIN_REV0;\r
529                     } elseif ($this->databaseType === self::REGION_EDITION_REV1) {\r
530                         $this->databaseSegments = self::STATE_BEGIN_REV1;\r
531                     } elseif ($this->databaseType === self::CITY_EDITION_REV0\r
532                                 || $this->databaseType === self::CITY_EDITION_REV1\r
533                                 || $this->databaseType === self::ORG_EDITION) {\r
534                         $this->databaseSegments = 0;\r
535                         $buf = fread($this->filehandle, self::SEGMENT_RECORD_LENGTH);\r
536                         for ($j = 0; $j < self::SEGMENT_RECORD_LENGTH; $j++) {\r
537                             $this->databaseSegments += (ord($buf[$j]) << ($j * 8));\r
538                         }\r
539                         if ($this->databaseType === self::ORG_EDITION) {\r
540                             $this->recordLength = self::ORG_RECORD_LENGTH;\r
541                         }\r
542                     }\r
543                     break;\r
544                 } else {\r
545                     fseek($this->filehandle, -4, SEEK_CUR);\r
546                 }\r
547             }\r
548             if ($this->databaseType === self::COUNTRY_EDITION) {\r
549                 $this->databaseSegments = self::COUNTRY_BEGIN;\r
550             }\r
551             fseek($this->filehandle, $filepos, SEEK_SET);\r
552 \r
553         }\r
554     }\r
555 \r
556     /**\r
557      * Closes the geoip database.\r
558      *\r
559      * @return int Status of close command.\r
560      */\r
561     public function close()\r
562     {\r
563         if ($this->flags & self::SHARED_MEMORY) {\r
564             return shmop_close($this->shmid);\r
565         } else {\r
566             // right now even if file was cached in RAM the file was not closed\r
567             // so it's safe to expect no error w/ fclose()\r
568             return fclose($this->filehandle);\r
569         }\r
570     }\r
571 \r
572     /**\r
573      * Get the country index.\r
574      *\r
575      * This method is called by the lookupCountryCode() and lookupCountryName()\r
576      * methods.  It lookups up the index ('id') for the country which is the key\r
577      * for the code and name.\r
578      *\r
579      * @param string $addr IP address (hostname not allowed)\r
580      *\r
581      * @throws PEAR_Exception  - if IP address is invalid.\r
582      *                         - if database type is incorrect\r
583      *\r
584      * @return string ID for the country\r
585      */\r
586     protected function lookupCountryId($addr)\r
587     {\r
588         $ipnum = ip2long($addr);\r
589         if ($ipnum === false) {\r
590             throw new PEAR_Exception("Invalid IP address: " . var_export($addr, true), self::ERR_INVALID_IP);\r
591         }\r
592         if ($this->databaseType !== self::COUNTRY_EDITION) {\r
593             throw new PEAR_Exception("Invalid database type; lookupCountry*() methods expect Country database.");\r
594         }\r
595         return $this->seekCountry($ipnum) - self::COUNTRY_BEGIN;\r
596     }\r
597 \r
598     /**\r
599      * Returns 2-letter country code (e.g. 'CA') for specified IP address.\r
600      * Use this method if you have a Country database.\r
601      *\r
602      * @param string $addr IP address (hostname not allowed).\r
603      *\r
604      * @return string 2-letter country code\r
605      *\r
606      * @throws PEAR_Exception (see lookupCountryId())\r
607      * @see lookupCountryId()\r
608      */\r
609     public function lookupCountryCode($addr)\r
610     {\r
611         return self::$COUNTRY_CODES[$this->lookupCountryId($addr)];\r
612     }\r
613 \r
614     /**\r
615      * Returns full country name for specified IP address.\r
616      * Use this method if you have a Country database.\r
617      *\r
618      * @param string $addr IP address (hostname not allowed).\r
619      *\r
620      * @return string Country name\r
621      * @throws PEAR_Exception (see lookupCountryId())\r
622      * @see lookupCountryId()\r
623      */\r
624     public function lookupCountryName($addr)\r
625     {\r
626         return self::$COUNTRY_NAMES[$this->lookupCountryId($addr)];\r
627     }\r
628 \r
629     /**\r
630      * Using the record length and appropriate start points, seek to the country that corresponds\r
631      * to the converted IP address integer.\r
632      *\r
633      * @param int $ipnum Result of ip2long() conversion.\r
634      *\r
635      * @return int Offset of start of record.\r
636      * @throws PEAR_Exception - if fseek() fails on the file or no results after traversing the database (indicating corrupt db).\r
637      */\r
638     protected function seekCountry($ipnum)\r
639     {\r
640         $offset = 0;\r
641         for ($depth = 31; $depth >= 0; --$depth) {\r
642             if ($this->flags & self::MEMORY_CACHE) {\r
643                   $buf = substr($this->memoryBuffer, 2 * $this->recordLength * $offset, 2 * $this->recordLength);\r
644             } elseif ($this->flags & self::SHARED_MEMORY) {\r
645                 $buf = shmop_read($this->shmid, 2 * $this->recordLength * $offset, 2 * $this->recordLength);\r
646             } else {\r
647                 if (fseek($this->filehandle, 2 * $this->recordLength * $offset, SEEK_SET) !== 0) {\r
648                     throw new PEAR_Exception("fseek failed");\r
649                 }\r
650                 $buf = fread($this->filehandle, 2 * $this->recordLength);\r
651             }\r
652             $x = array(0,0);\r
653             for ($i = 0; $i < 2; ++$i) {\r
654                 for ($j = 0; $j < $this->recordLength; ++$j) {\r
655                     $x[$i] += ord($buf[$this->recordLength * $i + $j]) << ($j * 8);\r
656                 }\r
657             }\r
658             if ($ipnum & (1 << $depth)) {\r
659                 if ($x[1] >= $this->databaseSegments) {\r
660                     return $x[1];\r
661                 }\r
662                 $offset = $x[1];\r
663             } else {\r
664                 if ($x[0] >= $this->databaseSegments) {\r
665                     return $x[0];\r
666                 }\r
667                 $offset = $x[0];\r
668             }\r
669         }\r
670         throw new PEAR_Exception("Error traversing database - perhaps it is corrupt?");\r
671     }\r
672 \r
673     /**\r
674      * Lookup the organization (or ISP) for given IP address.\r
675      * Use this method if you have an Organization/ISP database.\r
676      *\r
677      * @param string $addr IP address (hostname not allowed).\r
678      *\r
679      * @throws PEAR_Exception  - if IP address is invalid.\r
680      *                         - if database is of wrong type\r
681      *\r
682      * @return string The organization\r
683      */\r
684     public function lookupOrg($addr)\r
685     {\r
686         $ipnum = ip2long($addr);\r
687         if ($ipnum === false) {\r
688             throw new PEAR_Exception("Invalid IP address: " . var_export($addr, true), self::ERR_INVALID_IP);\r
689         }\r
690         if ($this->databaseType !== self::ORG_EDITION) {\r
691             throw new PEAR_Exception("Invalid database type; lookupOrg() method expects Org/ISP database.", self::ERR_DB_FORMAT);\r
692         }\r
693         return $this->getOrg($ipnum);\r
694     }\r
695 \r
696     /**\r
697      * Lookup the region for given IP address.\r
698      * Use this method if you have a Region database.\r
699      *\r
700      * @param string $addr IP address (hostname not allowed).\r
701      *\r
702      * @return array Array containing country code and region: array($country_code, $region)\r
703      *\r
704      * @throws PEAR_Exception - if IP address is invalid.\r
705      */\r
706     public function lookupRegion($addr)\r
707     {\r
708         $ipnum = ip2long($addr);\r
709         if ($ipnum === false) {\r
710             throw new PEAR_Exception("Invalid IP address: " . var_export($addr, true), self::ERR_INVALID_IP);\r
711         }\r
712         if ($this->databaseType !== self::REGION_EDITION_REV0 && $this->databaseType !== self::REGION_EDITION_REV1) {\r
713             throw new PEAR_Exception("Invalid database type; lookupRegion() method expects Region database.", self::ERR_DB_FORMAT);\r
714         }\r
715         return $this->getRegion($ipnum);\r
716     }\r
717 \r
718     /**\r
719      * Lookup the location record for given IP address.\r
720      * Use this method if you have a City database.\r
721      *\r
722      * @param string $addr IP address (hostname not allowed).\r
723      *\r
724      * @return Net_GeoIP_Location The full location record.\r
725      *\r
726      * @throws PEAR_Exception - if IP address is invalid.\r
727      */\r
728     public function lookupLocation($addr)\r
729     {\r
730         include_once 'Net/GeoIP/Location.php';\r
731         $ipnum = ip2long($addr);\r
732         if ($ipnum === false) {\r
733             throw new PEAR_Exception("Invalid IP address: " . var_export($addr, true), self::ERR_INVALID_IP);\r
734         }\r
735         if ($this->databaseType !== self::CITY_EDITION_REV0 && $this->databaseType !== self::CITY_EDITION_REV1) {\r
736             throw new PEAR_Exception("Invalid database type; lookupLocation() method expects City database.");\r
737         }\r
738         return $this->getRecord($ipnum);\r
739     }\r
740 \r
741     /**\r
742      * Seek and return organization (or ISP) name for converted IP addr.\r
743      *\r
744      * @param int $ipnum Converted IP address.\r
745      *\r
746      * @return string The organization\r
747      */\r
748     protected function getOrg($ipnum)\r
749     {\r
750         $seek_org = $this->seekCountry($ipnum);\r
751         if ($seek_org == $this->databaseSegments) {\r
752             return null;\r
753         }\r
754         $record_pointer = $seek_org + (2 * $this->recordLength - 1) * $this->databaseSegments;\r
755         if ($this->flags & self::SHARED_MEMORY) {\r
756             $org_buf = shmop_read($this->shmid, $record_pointer, self::MAX_ORG_RECORD_LENGTH);\r
757         } else {\r
758             fseek($this->filehandle, $record_pointer, SEEK_SET);\r
759             $org_buf = fread($this->filehandle, self::MAX_ORG_RECORD_LENGTH);\r
760         }\r
761         $org_buf = substr($org_buf, 0, strpos($org_buf, 0));\r
762         return $org_buf;\r
763     }\r
764 \r
765     /**\r
766      * Seek and return the region info (array containing country code and region name) for converted IP addr.\r
767      *\r
768      * @param int $ipnum Converted IP address.\r
769      *\r
770      * @return array Array containing country code and region: array($country_code, $region)\r
771      */\r
772     protected function getRegion($ipnum)\r
773     {\r
774         if ($this->databaseType == self::REGION_EDITION_REV0) {\r
775             $seek_region = $this->seekCountry($ipnum) - self::STATE_BEGIN_REV0;\r
776             if ($seek_region >= 1000) {\r
777                 $country_code = "US";\r
778                 $region = chr(($seek_region - 1000)/26 + 65) . chr(($seek_region - 1000)%26 + 65);\r
779             } else {\r
780                 $country_code = self::$COUNTRY_CODES[$seek_region];\r
781                 $region = "";\r
782             }\r
783             return array($country_code, $region);\r
784         } elseif ($this->databaseType == self::REGION_EDITION_REV1) {\r
785             $seek_region = $this->seekCountry($ipnum) - self::STATE_BEGIN_REV1;\r
786             //print $seek_region;\r
787             if ($seek_region < self::US_OFFSET) {\r
788                 $country_code = "";\r
789                 $region = "";\r
790             } elseif ($seek_region < self::CANADA_OFFSET) {\r
791                 $country_code = "US";\r
792                 $region = chr(($seek_region - self::US_OFFSET)/26 + 65) . chr(($seek_region - self::US_OFFSET)%26 + 65);\r
793             } elseif ($seek_region < self::WORLD_OFFSET) {\r
794                 $country_code = "CA";\r
795                 $region = chr(($seek_region - self::CANADA_OFFSET)/26 + 65) . chr(($seek_region - self::CANADA_OFFSET)%26 + 65);\r
796             } else {\r
797                 $country_code = self::$COUNTRY_CODES[($seek_region - self::WORLD_OFFSET) / self::FIPS_RANGE];\r
798                 $region = "";\r
799             }\r
800             return array ($country_code,$region);\r
801         }\r
802     }\r
803 \r
804     /**\r
805      * Seek and populate Net_GeoIP_Location object for converted IP addr.\r
806      * Note: this\r
807      *\r
808      * @param int $ipnum Converted IP address.\r
809      *\r
810      * @return Net_GeoIP_Location\r
811      */\r
812     protected function getRecord($ipnum)\r
813     {\r
814         $seek_country = $this->seekCountry($ipnum);\r
815         if ($seek_country == $this->databaseSegments) {\r
816             return null;\r
817         }\r
818 \r
819         $record_pointer = $seek_country + (2 * $this->recordLength - 1) * $this->databaseSegments;\r
820 \r
821         if ($this->flags & self::SHARED_MEMORY) {\r
822             $record_buf = shmop_read($this->shmid, $record_pointer, self::FULL_RECORD_LENGTH);\r
823         } else {\r
824             fseek($this->filehandle, $record_pointer, SEEK_SET);\r
825             $record_buf = fread($this->filehandle, self::FULL_RECORD_LENGTH);\r
826         }\r
827 \r
828         $record = new Net_GeoIP_Location();\r
829 \r
830         $record_buf_pos = 0;\r
831         $char = ord(substr($record_buf, $record_buf_pos, 1));\r
832 \r
833         $record->countryCode  = self::$COUNTRY_CODES[$char];\r
834         $record->countryCode3 = self::$COUNTRY_CODES3[$char];\r
835         $record->countryName  = self::$COUNTRY_NAMES[$char];\r
836         $record_buf_pos++;\r
837         $str_length = 0;\r
838 \r
839         //get region\r
840         $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
841         while ($char != 0) {\r
842             $str_length++;\r
843             $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
844         }\r
845         if ($str_length > 0) {\r
846             $record->region = substr($record_buf, $record_buf_pos, $str_length);\r
847         }\r
848         $record_buf_pos += $str_length + 1;\r
849         $str_length = 0;\r
850 \r
851         //get city\r
852         $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
853         while ($char != 0) {\r
854             $str_length++;\r
855             $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
856         }\r
857         if ($str_length > 0) {\r
858             $record->city = substr($record_buf, $record_buf_pos, $str_length);\r
859         }\r
860         $record_buf_pos += $str_length + 1;\r
861         $str_length = 0;\r
862 \r
863         //get postal code\r
864         $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
865         while ($char != 0) {\r
866             $str_length++;\r
867             $char = ord(substr($record_buf, $record_buf_pos+$str_length, 1));\r
868         }\r
869         if ($str_length > 0) {\r
870             $record->postalCode = substr($record_buf, $record_buf_pos, $str_length);\r
871         }\r
872         $record_buf_pos += $str_length + 1;\r
873         $str_length = 0;\r
874         $latitude   = 0;\r
875         $longitude  = 0;\r
876         for ($j = 0;$j < 3; ++$j) {\r
877             $char = ord(substr($record_buf, $record_buf_pos++, 1));\r
878             $latitude += ($char << ($j * 8));\r
879         }\r
880         $record->latitude = ($latitude/10000) - 180;\r
881 \r
882         for ($j = 0;$j < 3; ++$j) {\r
883             $char = ord(substr($record_buf, $record_buf_pos++, 1));\r
884             $longitude += ($char << ($j * 8));\r
885         }\r
886         $record->longitude = ($longitude/10000) - 180;\r
887 \r
888         if ($this->databaseType === self::CITY_EDITION_REV1) {\r
889             $dmaarea_combo = 0;\r
890             if ($record->countryCode == "US") {\r
891                 for ($j = 0;$j < 3;++$j) {\r
892                     $char = ord(substr($record_buf, $record_buf_pos++, 1));\r
893                     $dmaarea_combo += ($char << ($j * 8));\r
894                 }\r
895                 $record->dmaCode = floor($dmaarea_combo/1000);\r
896                 $record->areaCode = $dmaarea_combo%1000;\r
897             }\r
898         }\r
899 \r
900         return $record;\r
901     }\r
902 \r
903 }\r
904 \r