forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIpInfoDb.php
More file actions
154 lines (128 loc) · 4.63 KB
/
Copy pathIpInfoDb.php
File metadata and controls
154 lines (128 loc) · 4.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
/**
* This file is part of the Geocoder package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Geocoder\Provider;
use Geocoder\Exception\InvalidArgument;
use Geocoder\Exception\InvalidCredentials;
use Geocoder\Exception\NoResult;
use Geocoder\Exception\UnsupportedOperation;
use Ivory\HttpAdapter\HttpAdapterInterface;
/**
* @author William Durand <william.durand1@gmail.com>
*/
class IpInfoDb extends AbstractHttpProvider implements Provider
{
/**
* @var string
*/
const CITY_PRECISION_ENDPOINT_URL = 'http://api.ipinfodb.com/v3/ip-city/?key=%s&format=json&ip=%s';
/**
* @var string
*/
const COUNTRY_PRECISION_ENDPOINT_URL = 'http://api.ipinfodb.com/v3/ip-country/?key=%s&format=json&ip=%s';
/**
* @var string
*/
private $apiKey;
/**
* @var string
*/
private $endpointUrl;
/**
* @param HttpAdapterInterface $adapter An HTTP adapter.
* @param string $apiKey An API key.
* @param string $precision The endpoint precision. Either "city" or "country" (faster)
*
* @throws Geocoder\Exception\InvalidArgument
*/
public function __construct(HttpAdapterInterface $adapter, $apiKey, $precision = 'city')
{
parent::__construct($adapter);
$this->apiKey = $apiKey;
switch ($precision) {
case 'city':
$this->endpointUrl = self::CITY_PRECISION_ENDPOINT_URL;
break;
case 'country':
$this->endpointUrl = self::COUNTRY_PRECISION_ENDPOINT_URL;
break;
default:
throw new InvalidArgument(sprintf(
'Invalid precision value "%s" (allowed values: "city", "country").',
$precision
));
}
}
/**
* {@inheritDoc}
*/
public function geocode($address)
{
if (null === $this->apiKey) {
throw new InvalidCredentials('No API Key provided.');
}
if (!filter_var($address, FILTER_VALIDATE_IP)) {
throw new UnsupportedOperation('The IpInfoDb provider does not support street addresses, only IPv4 addresses.');
}
// This API does not support IPv6
if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
throw new UnsupportedOperation('The IpInfoDb provider does not support IPv6 addresses, only IPv4 addresses.');
}
if ('127.0.0.1' === $address) {
return $this->returnResults([ $this->getLocalhostDefaults() ]);
}
$query = sprintf($this->endpointUrl, $this->apiKey, $address);
return $this->executeQuery($query);
}
/**
* {@inheritDoc}
*/
public function reverse($latitude, $longitude)
{
throw new UnsupportedOperation('The IpInfoDb provider is not able to do reverse geocoding.');
}
/**
* {@inheritDoc}
*/
public function getName()
{
return 'ip_info_db';
}
/**
* @param string $query
*
* @return \Geocoder\Model\AddressCollection
*/
private function executeQuery($query)
{
$content = (string) $this->getAdapter()->get($query)->getBody();
if (empty($content)) {
throw new NoResult(sprintf('Could not execute query "%s".', $query));
}
$data = (array) json_decode($content);
if (empty($data) || 'OK' !== $data['statusCode']) {
throw new NoResult(sprintf('Could not execute query "%s".', $query));
}
$timezone = null;
if (isset($data['timeZone'])) {
$timezone = timezone_name_from_abbr("", (int) substr($data['timeZone'], 0, strpos($data['timeZone'], ':')) * 3600, 0);
}
return $this->returnResults([
array_merge($this->getDefaults(), array(
'latitude' => isset($data['latitude']) ? $data['latitude'] : null,
'longitude' => isset($data['longitude']) ? $data['longitude'] : null,
'locality' => isset($data['cityName']) ? $data['cityName'] : null,
'postalCode' => isset($data['zipCode']) ? $data['zipCode'] : null,
'adminLevels' => isset($data['regionName']) ? [['name' => $data['regionName'], 'level' => 1]] : [],
'country' => isset($data['countryName']) ? $data['countryName'] : null,
'countryCode' => isset($data['countryName']) ? $data['countryCode'] : null,
'timezone' => $timezone,
))
]);
}
}