 ?>)
| Country: | {$currentCountry} | ||
| Current IP: | {$ip} |
+
diff --git a/app/design/adminhtml/default/default/template/webbhuset/geoip/system/notifications.phtml b/app/design/adminhtml/default/default/template/webbhuset/geoip/system/notifications.phtml
new file mode 100644
index 0000000..e9c21b8
--- /dev/null
+++ b/app/design/adminhtml/default/default/template/webbhuset/geoip/system/notifications.phtml
@@ -0,0 +1,3 @@
+checkFilePermissions()) : ?>
+ + * This attribute is only available from the Insights web service and the + * GeoIP2 Enterprise database. + *
+ */ +class Traits extends AbstractRecord +{ + /** + * @ignore + */ + protected $validAttributes = [ + 'autonomousSystemNumber', + 'autonomousSystemOrganization', + 'connectionType', + 'domain', + 'ipAddress', + 'isAnonymous', + 'isAnonymousProxy', + 'isAnonymousVpn', + 'isHostingProvider', + 'isLegitimateProxy', + 'isp', + 'isPublicProxy', + 'isSatelliteProvider', + 'isTorExitNode', + 'organization', + 'userType', + ]; +} diff --git a/lib/GeoIp2/WebService/Client.php b/lib/GeoIp2/WebService/Client.php new file mode 100644 index 0000000..1a1ccf1 --- /dev/null +++ b/lib/GeoIp2/WebService/Client.php @@ -0,0 +1,239 @@ +locales = $locales; + + // This is for backwards compatibility. Do not remove except for a + // major version bump. + if (is_string($options)) { + $options = ['host' => $options]; + } + + if (!isset($options['host'])) { + $options['host'] = 'geoip.maxmind.com'; + } + + $options['userAgent'] = $this->userAgent(); + + $this->client = new WsClient($accountId, $licenseKey, $options); + } + + private function userAgent() + { + return 'GeoIP2-API/' . self::VERSION; + } + + /** + * This method calls the GeoIP2 Precision: City service. + * + * @param string $ipAddress IPv4 or IPv6 address as a string. If no + * address is provided, the address that the web service is called + * from will be used. + * + * @throws \GeoIp2\Exception\AddressNotFoundException if the address you + * provided is not in our database (e.g., a private address). + * @throws \GeoIp2\Exception\AuthenticationException if there is a problem + * with the account ID or license key that you provided + * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out + * of queries + * @throws \GeoIp2\Exception\InvalidRequestException} if your request was received by the web service but is + * invalid for some other reason. This may indicate an issue + * with this API. Please report the error to MaxMind. + * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error code or message was returned. + * This could indicate a problem with the connection between + * your server and the web service or that the web service + * returned an invalid document or 500 error code. + * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent + * class to the above exceptions. It will be thrown directly + * if a 200 status code is returned but the body is invalid. + * + * @return \GeoIp2\Model\City + */ + public function city($ipAddress = 'me') + { + return $this->responseFor('city', 'City', $ipAddress); + } + + /** + * This method calls the GeoIP2 Precision: Country service. + * + * @param string $ipAddress IPv4 or IPv6 address as a string. If no + * address is provided, the address that the web service is called + * from will be used. + * + * @throws \GeoIp2\Exception\AddressNotFoundException if the address you provided is not in our database (e.g., + * a private address). + * @throws \GeoIp2\Exception\AuthenticationException if there is a problem + * with the account ID or license key that you provided + * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out of queries + * @throws \GeoIp2\Exception\InvalidRequestException} if your request was received by the web service but is + * invalid for some other reason. This may indicate an + * issue with this API. Please report the error to MaxMind. + * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error + * code or message was returned. This could indicate a problem + * with the connection between your server and the web service + * or that the web service returned an invalid document or 500 + * error code. + * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent class to the above exceptions. It + * will be thrown directly if a 200 status code is returned but + * the body is invalid. + * + * @return \GeoIp2\Model\Country + */ + public function country($ipAddress = 'me') + { + return $this->responseFor('country', 'Country', $ipAddress); + } + + /** + * This method calls the GeoIP2 Precision: Insights service. + * + * @param string $ipAddress IPv4 or IPv6 address as a string. If no + * address is provided, the address that the web service is called + * from will be used. + * + * @throws \GeoIp2\Exception\AddressNotFoundException if the address you + * provided is not in our database (e.g., a private address). + * @throws \GeoIp2\Exception\AuthenticationException if there is a problem + * with the account ID or license key that you provided + * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out + * of queries + * @throws \GeoIp2\Exception\InvalidRequestException} if your request was received by the web service but is + * invalid for some other reason. This may indicate an + * issue with this API. Please report the error to MaxMind. + * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error code or message was returned. + * This could indicate a problem with the connection between + * your server and the web service or that the web service + * returned an invalid document or 500 error code. + * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent + * class to the above exceptions. It will be thrown directly + * if a 200 status code is returned but the body is invalid. + * + * @return \GeoIp2\Model\Insights + */ + public function insights($ipAddress = 'me') + { + return $this->responseFor('insights', 'Insights', $ipAddress); + } + + private function responseFor($endpoint, $class, $ipAddress) + { + $path = implode('/', [self::$basePath, $endpoint, $ipAddress]); + + try { + $body = $this->client->get('GeoIP2 ' . $class, $path); + } catch (\MaxMind\Exception\IpAddressNotFoundException $ex) { + throw new AddressNotFoundException( + $ex->getMessage(), + $ex->getStatusCode(), + $ex + ); + } catch (\MaxMind\Exception\AuthenticationException $ex) { + throw new AuthenticationException( + $ex->getMessage(), + $ex->getStatusCode(), + $ex + ); + } catch (\MaxMind\Exception\InsufficientFundsException $ex) { + throw new OutOfQueriesException( + $ex->getMessage(), + $ex->getStatusCode(), + $ex + ); + } catch (\MaxMind\Exception\InvalidRequestException $ex) { + throw new InvalidRequestException( + $ex->getMessage(), + $ex->getErrorCode(), + $ex->getStatusCode(), + $ex->getUri(), + $ex + ); + } catch (\MaxMind\Exception\HttpException $ex) { + throw new HttpException( + $ex->getMessage(), + $ex->getStatusCode(), + $ex->getUri(), + $ex + ); + } catch (\MaxMind\Exception\WebServiceException $ex) { + throw new GeoIp2Exception( + $ex->getMessage(), + $ex->getCode(), + $ex + ); + } + + $class = 'GeoIp2\\Model\\' . $class; + + return new $class($body, $this->locales); + } +} diff --git a/lib/MaxMind/Db/Reader.php b/lib/MaxMind/Db/Reader.php new file mode 100644 index 0000000..745f7bb --- /dev/null +++ b/lib/MaxMind/Db/Reader.php @@ -0,0 +1,309 @@ +get method. + */ +class Reader +{ + private static $DATA_SECTION_SEPARATOR_SIZE = 16; + private static $METADATA_START_MARKER = "\xAB\xCD\xEFMaxMind.com"; + private static $METADATA_START_MARKER_LENGTH = 14; + private static $METADATA_MAX_SIZE = 131072; // 128 * 1024 = 128KB + + private $decoder; + private $fileHandle; + private $fileSize; + private $ipV4Start; + private $metadata; + + /** + * Constructs a Reader for the MaxMind DB format. The file passed to it must + * be a valid MaxMind DB file such as a GeoIp2 database file. + * + * @param string $database + * the MaxMind DB file to use + * + * @throws \InvalidArgumentException for invalid database path or unknown arguments + * @throws \MaxMind\Db\Reader\InvalidDatabaseException + * if the database is invalid or there is an error reading + * from it + */ + public function __construct($database) + { + if (\func_num_args() !== 1) { + throw new \InvalidArgumentException( + 'The constructor takes exactly one argument.' + ); + } + + if (!is_readable($database)) { + throw new \InvalidArgumentException( + "The file \"$database\" does not exist or is not readable." + ); + } + $this->fileHandle = @fopen($database, 'rb'); + if ($this->fileHandle === false) { + throw new \InvalidArgumentException( + "Error opening \"$database\"." + ); + } + $this->fileSize = @filesize($database); + if ($this->fileSize === false) { + throw new \UnexpectedValueException( + "Error determining the size of \"$database\"." + ); + } + + $start = $this->findMetadataStart($database); + $metadataDecoder = new Decoder($this->fileHandle, $start); + list($metadataArray) = $metadataDecoder->decode($start); + $this->metadata = new Metadata($metadataArray); + $this->decoder = new Decoder( + $this->fileHandle, + $this->metadata->searchTreeSize + self::$DATA_SECTION_SEPARATOR_SIZE + ); + } + + /** + * Looks up theaddress in the MaxMind DB.
+ *
+ * @param string $ipAddress
+ * the IP address to look up
+ *
+ * @throws \BadMethodCallException if this method is called on a closed database
+ * @throws \InvalidArgumentException if something other than a single IP address is passed to the method
+ * @throws InvalidDatabaseException
+ * if the database is invalid or there is an error reading
+ * from it
+ *
+ * @return array the record for the IP address
+ */
+ public function get($ipAddress)
+ {
+ if (\func_num_args() !== 1) {
+ throw new \InvalidArgumentException(
+ 'Method takes exactly one argument.'
+ );
+ }
+
+ if (!\is_resource($this->fileHandle)) {
+ throw new \BadMethodCallException(
+ 'Attempt to read from a closed MaxMind DB.'
+ );
+ }
+
+ if (!filter_var($ipAddress, FILTER_VALIDATE_IP)) {
+ throw new \InvalidArgumentException(
+ "The value \"$ipAddress\" is not a valid IP address."
+ );
+ }
+
+ if ($this->metadata->ipVersion === 4 && strrpos($ipAddress, ':')) {
+ throw new \InvalidArgumentException(
+ "Error looking up $ipAddress. You attempted to look up an"
+ . ' IPv6 address in an IPv4-only database.'
+ );
+ }
+ $pointer = $this->findAddressInTree($ipAddress);
+ if ($pointer === 0) {
+ return null;
+ }
+
+ return $this->resolveDataPointer($pointer);
+ }
+
+ private function findAddressInTree($ipAddress)
+ {
+ // XXX - could simplify. Done as a byte array to ease porting
+ $rawAddress = array_merge(unpack('C*', inet_pton($ipAddress)));
+
+ $bitCount = \count($rawAddress) * 8;
+
+ // The first node of the tree is always node 0, at the beginning of the
+ // value
+ $node = $this->startNode($bitCount);
+
+ for ($i = 0; $i < $bitCount; ++$i) {
+ if ($node >= $this->metadata->nodeCount) {
+ break;
+ }
+ $tempBit = 0xFF & $rawAddress[$i >> 3];
+ $bit = 1 & ($tempBit >> 7 - ($i % 8));
+
+ $node = $this->readNode($node, $bit);
+ }
+ if ($node === $this->metadata->nodeCount) {
+ // Record is empty
+ return 0;
+ } elseif ($node > $this->metadata->nodeCount) {
+ // Record is a data pointer
+ return $node;
+ }
+ throw new InvalidDatabaseException('Something bad happened');
+ }
+
+ private function startNode($length)
+ {
+ // Check if we are looking up an IPv4 address in an IPv6 tree. If this
+ // is the case, we can skip over the first 96 nodes.
+ if ($this->metadata->ipVersion === 6 && $length === 32) {
+ return $this->ipV4StartNode();
+ }
+ // The first node of the tree is always node 0, at the beginning of the
+ // value
+ return 0;
+ }
+
+ private function ipV4StartNode()
+ {
+ // This is a defensive check. There is no reason to call this when you
+ // have an IPv4 tree.
+ if ($this->metadata->ipVersion === 4) {
+ return 0;
+ }
+
+ if ($this->ipV4Start) {
+ return $this->ipV4Start;
+ }
+ $node = 0;
+
+ for ($i = 0; $i < 96 && $node < $this->metadata->nodeCount; ++$i) {
+ $node = $this->readNode($node, 0);
+ }
+ $this->ipV4Start = $node;
+
+ return $node;
+ }
+
+ private function readNode($nodeNumber, $index)
+ {
+ $baseOffset = $nodeNumber * $this->metadata->nodeByteSize;
+
+ // XXX - probably could condense this.
+ switch ($this->metadata->recordSize) {
+ case 24:
+ $bytes = Util::read($this->fileHandle, $baseOffset + $index * 3, 3);
+ list(, $node) = unpack('N', "\x00" . $bytes);
+
+ return $node;
+ case 28:
+ $middleByte = Util::read($this->fileHandle, $baseOffset + 3, 1);
+ list(, $middle) = unpack('C', $middleByte);
+ if ($index === 0) {
+ $middle = (0xF0 & $middle) >> 4;
+ } else {
+ $middle = 0x0F & $middle;
+ }
+ $bytes = Util::read($this->fileHandle, $baseOffset + $index * 4, 3);
+ list(, $node) = unpack('N', \chr($middle) . $bytes);
+
+ return $node;
+ case 32:
+ $bytes = Util::read($this->fileHandle, $baseOffset + $index * 4, 4);
+ list(, $node) = unpack('N', $bytes);
+
+ return $node;
+ default:
+ throw new InvalidDatabaseException(
+ 'Unknown record size: '
+ . $this->metadata->recordSize
+ );
+ }
+ }
+
+ private function resolveDataPointer($pointer)
+ {
+ $resolved = $pointer - $this->metadata->nodeCount
+ + $this->metadata->searchTreeSize;
+ if ($resolved > $this->fileSize) {
+ throw new InvalidDatabaseException(
+ "The MaxMind DB file's search tree is corrupt"
+ );
+ }
+
+ list($data) = $this->decoder->decode($resolved);
+
+ return $data;
+ }
+
+ /*
+ * This is an extremely naive but reasonably readable implementation. There
+ * are much faster algorithms (e.g., Boyer-Moore) for this if speed is ever
+ * an issue, but I suspect it won't be.
+ */
+ private function findMetadataStart($filename)
+ {
+ $handle = $this->fileHandle;
+ $fstat = fstat($handle);
+ $fileSize = $fstat['size'];
+ $marker = self::$METADATA_START_MARKER;
+ $markerLength = self::$METADATA_START_MARKER_LENGTH;
+ $metadataMaxLengthExcludingMarker
+ = min(self::$METADATA_MAX_SIZE, $fileSize) - $markerLength;
+
+ for ($i = 0; $i <= $metadataMaxLengthExcludingMarker; ++$i) {
+ for ($j = 0; $j < $markerLength; ++$j) {
+ fseek($handle, $fileSize - $i - $j - 1);
+ $matchBit = fgetc($handle);
+ if ($matchBit !== $marker[$markerLength - $j - 1]) {
+ continue 2;
+ }
+ }
+
+ return $fileSize - $i;
+ }
+ throw new InvalidDatabaseException(
+ "Error opening database file ($filename). " .
+ 'Is this a valid MaxMind DB file?'
+ );
+ }
+
+ /**
+ * @throws \InvalidArgumentException if arguments are passed to the method
+ * @throws \BadMethodCallException if the database has been closed
+ *
+ * @return Metadata object for the database
+ */
+ public function metadata()
+ {
+ if (\func_num_args()) {
+ throw new \InvalidArgumentException(
+ 'Method takes no arguments.'
+ );
+ }
+
+ // Not technically required, but this makes it consistent with
+ // C extension and it allows us to change our implementation later.
+ if (!\is_resource($this->fileHandle)) {
+ throw new \BadMethodCallException(
+ 'Attempt to read from a closed MaxMind DB.'
+ );
+ }
+
+ return $this->metadata;
+ }
+
+ /**
+ * Closes the MaxMind DB and returns resources to the system.
+ *
+ * @throws \Exception
+ * if an I/O error occurs
+ */
+ public function close()
+ {
+ if (!\is_resource($this->fileHandle)) {
+ throw new \BadMethodCallException(
+ 'Attempt to close a closed MaxMind DB.'
+ );
+ }
+ fclose($this->fileHandle);
+ }
+}
diff --git a/lib/MaxMind/Db/Reader/Decoder.php b/lib/MaxMind/Db/Reader/Decoder.php
new file mode 100644
index 0000000..a71b3de
--- /dev/null
+++ b/lib/MaxMind/Db/Reader/Decoder.php
@@ -0,0 +1,341 @@
+fileStream = $fileStream;
+ $this->pointerBase = $pointerBase;
+
+ $this->pointerBaseByteSize = $pointerBase > 0 ? log($pointerBase, 2) / 8 : 0;
+ $this->pointerTestHack = $pointerTestHack;
+
+ $this->switchByteOrder = $this->isPlatformLittleEndian();
+ }
+
+ public function decode($offset)
+ {
+ list(, $ctrlByte) = unpack(
+ 'C',
+ Util::read($this->fileStream, $offset, 1)
+ );
+ ++$offset;
+
+ $type = $ctrlByte >> 5;
+
+ // Pointers are a special case, we don't read the next $size bytes, we
+ // use the size to determine the length of the pointer and then follow
+ // it.
+ if ($type === self::_POINTER) {
+ list($pointer, $offset) = $this->decodePointer($ctrlByte, $offset);
+
+ // for unit testing
+ if ($this->pointerTestHack) {
+ return [$pointer];
+ }
+
+ list($result) = $this->decode($pointer);
+
+ return [$result, $offset];
+ }
+
+ if ($type === self::_EXTENDED) {
+ list(, $nextByte) = unpack(
+ 'C',
+ Util::read($this->fileStream, $offset, 1)
+ );
+
+ $type = $nextByte + 7;
+
+ if ($type < 8) {
+ throw new InvalidDatabaseException(
+ 'Something went horribly wrong in the decoder. An extended type '
+ . 'resolved to a type number < 8 ('
+ . $type
+ . ')'
+ );
+ }
+
+ ++$offset;
+ }
+
+ list($size, $offset) = $this->sizeFromCtrlByte($ctrlByte, $offset);
+
+ return $this->decodeByType($type, $offset, $size);
+ }
+
+ private function decodeByType($type, $offset, $size)
+ {
+ switch ($type) {
+ case self::_MAP:
+ return $this->decodeMap($size, $offset);
+ case self::_ARRAY:
+ return $this->decodeArray($size, $offset);
+ case self::_BOOLEAN:
+ return [$this->decodeBoolean($size), $offset];
+ }
+
+ $newOffset = $offset + $size;
+ $bytes = Util::read($this->fileStream, $offset, $size);
+ switch ($type) {
+ case self::_BYTES:
+ case self::_UTF8_STRING:
+ return [$bytes, $newOffset];
+ case self::_DOUBLE:
+ $this->verifySize(8, $size);
+
+ return [$this->decodeDouble($bytes), $newOffset];
+ case self::_FLOAT:
+ $this->verifySize(4, $size);
+
+ return [$this->decodeFloat($bytes), $newOffset];
+ case self::_INT32:
+ return [$this->decodeInt32($bytes, $size), $newOffset];
+ case self::_UINT16:
+ case self::_UINT32:
+ case self::_UINT64:
+ case self::_UINT128:
+ return [$this->decodeUint($bytes, $size), $newOffset];
+ default:
+ throw new InvalidDatabaseException(
+ 'Unknown or unexpected type: ' . $type
+ );
+ }
+ }
+
+ private function verifySize($expected, $actual)
+ {
+ if ($expected !== $actual) {
+ throw new InvalidDatabaseException(
+ "The MaxMind DB file's data section contains bad data (unknown data type or corrupt data)"
+ );
+ }
+ }
+
+ private function decodeArray($size, $offset)
+ {
+ $array = [];
+
+ for ($i = 0; $i < $size; ++$i) {
+ list($value, $offset) = $this->decode($offset);
+ array_push($array, $value);
+ }
+
+ return [$array, $offset];
+ }
+
+ private function decodeBoolean($size)
+ {
+ return $size === 0 ? false : true;
+ }
+
+ private function decodeDouble($bits)
+ {
+ // This assumes IEEE 754 doubles, but most (all?) modern platforms
+ // use them.
+ //
+ // We are not using the "E" format as that was only added in
+ // 7.0.15 and 7.1.1. As such, we must switch byte order on
+ // little endian machines.
+ list(, $double) = unpack('d', $this->maybeSwitchByteOrder($bits));
+
+ return $double;
+ }
+
+ private function decodeFloat($bits)
+ {
+ // This assumes IEEE 754 floats, but most (all?) modern platforms
+ // use them.
+ //
+ // We are not using the "G" format as that was only added in
+ // 7.0.15 and 7.1.1. As such, we must switch byte order on
+ // little endian machines.
+ list(, $float) = unpack('f', $this->maybeSwitchByteOrder($bits));
+
+ return $float;
+ }
+
+ private function decodeInt32($bytes, $size)
+ {
+ switch ($size) {
+ case 0:
+ return 0;
+ case 1:
+ case 2:
+ case 3:
+ $bytes = str_pad($bytes, 4, "\x00", STR_PAD_LEFT);
+ break;
+ case 4:
+ break;
+ default:
+ throw new InvalidDatabaseException(
+ "The MaxMind DB file's data section contains bad data (unknown data type or corrupt data)"
+ );
+ }
+
+ list(, $int) = unpack('l', $this->maybeSwitchByteOrder($bytes));
+
+ return $int;
+ }
+
+ private function decodeMap($size, $offset)
+ {
+ $map = [];
+
+ for ($i = 0; $i < $size; ++$i) {
+ list($key, $offset) = $this->decode($offset);
+ list($value, $offset) = $this->decode($offset);
+ $map[$key] = $value;
+ }
+
+ return [$map, $offset];
+ }
+
+ private function decodePointer($ctrlByte, $offset)
+ {
+ $pointerSize = (($ctrlByte >> 3) & 0x3) + 1;
+
+ $buffer = Util::read($this->fileStream, $offset, $pointerSize);
+ $offset = $offset + $pointerSize;
+
+ switch ($pointerSize) {
+ case 1:
+ $packed = (pack('C', $ctrlByte & 0x7)) . $buffer;
+ list(, $pointer) = unpack('n', $packed);
+ $pointer += $this->pointerBase;
+ break;
+ case 2:
+ $packed = "\x00" . (pack('C', $ctrlByte & 0x7)) . $buffer;
+ list(, $pointer) = unpack('N', $packed);
+ $pointer += $this->pointerBase + 2048;
+ break;
+ case 3:
+ $packed = (pack('C', $ctrlByte & 0x7)) . $buffer;
+
+ // It is safe to use 'N' here, even on 32 bit machines as the
+ // first bit is 0.
+ list(, $pointer) = unpack('N', $packed);
+ $pointer += $this->pointerBase + 526336;
+ break;
+ case 4:
+ // We cannot use unpack here as we might overflow on 32 bit
+ // machines
+ $pointerOffset = $this->decodeUint($buffer, $pointerSize);
+
+ $byteLength = $pointerSize + $this->pointerBaseByteSize;
+
+ if ($byteLength <= _MM_MAX_INT_BYTES) {
+ $pointer = $pointerOffset + $this->pointerBase;
+ } elseif (\extension_loaded('gmp')) {
+ $pointer = gmp_strval(gmp_add($pointerOffset, $this->pointerBase));
+ } elseif (\extension_loaded('bcmath')) {
+ $pointer = bcadd($pointerOffset, $this->pointerBase);
+ } else {
+ throw new \RuntimeException(
+ 'The gmp or bcmath extension must be installed to read this database.'
+ );
+ }
+ }
+
+ return [$pointer, $offset];
+ }
+
+ private function decodeUint($bytes, $byteLength)
+ {
+ if ($byteLength === 0) {
+ return 0;
+ }
+
+ $integer = 0;
+
+ for ($i = 0; $i < $byteLength; ++$i) {
+ $part = \ord($bytes[$i]);
+
+ // We only use gmp or bcmath if the final value is too big
+ if ($byteLength <= _MM_MAX_INT_BYTES) {
+ $integer = ($integer << 8) + $part;
+ } elseif (\extension_loaded('gmp')) {
+ $integer = gmp_strval(gmp_add(gmp_mul($integer, 256), $part));
+ } elseif (\extension_loaded('bcmath')) {
+ $integer = bcadd(bcmul($integer, 256), $part);
+ } else {
+ throw new \RuntimeException(
+ 'The gmp or bcmath extension must be installed to read this database.'
+ );
+ }
+ }
+
+ return $integer;
+ }
+
+ private function sizeFromCtrlByte($ctrlByte, $offset)
+ {
+ $size = $ctrlByte & 0x1f;
+
+ if ($size < 29) {
+ return [$size, $offset];
+ }
+
+ $bytesToRead = $size - 28;
+ $bytes = Util::read($this->fileStream, $offset, $bytesToRead);
+
+ if ($size === 29) {
+ $size = 29 + \ord($bytes);
+ } elseif ($size === 30) {
+ list(, $adjust) = unpack('n', $bytes);
+ $size = 285 + $adjust;
+ } elseif ($size > 30) {
+ list(, $adjust) = unpack('N', "\x00" . $bytes);
+ $size = ($adjust & (0x0FFFFFFF >> (32 - (8 * $bytesToRead))))
+ + 65821;
+ }
+
+ return [$size, $offset + $bytesToRead];
+ }
+
+ private function maybeSwitchByteOrder($bytes)
+ {
+ return $this->switchByteOrder ? strrev($bytes) : $bytes;
+ }
+
+ private function isPlatformLittleEndian()
+ {
+ $testint = 0x00FF;
+ $packed = pack('S', $testint);
+
+ return $testint === current(unpack('v', $packed));
+ }
+}
diff --git a/lib/MaxMind/Db/Reader/InvalidDatabaseException.php b/lib/MaxMind/Db/Reader/InvalidDatabaseException.php
new file mode 100644
index 0000000..d2a9a77
--- /dev/null
+++ b/lib/MaxMind/Db/Reader/InvalidDatabaseException.php
@@ -0,0 +1,10 @@
+binaryFormatMajorVersion =
+ $metadata['binary_format_major_version'];
+ $this->binaryFormatMinorVersion =
+ $metadata['binary_format_minor_version'];
+ $this->buildEpoch = $metadata['build_epoch'];
+ $this->databaseType = $metadata['database_type'];
+ $this->languages = $metadata['languages'];
+ $this->description = $metadata['description'];
+ $this->ipVersion = $metadata['ip_version'];
+ $this->nodeCount = $metadata['node_count'];
+ $this->recordSize = $metadata['record_size'];
+ $this->nodeByteSize = $this->recordSize / 4;
+ $this->searchTreeSize = $this->nodeCount * $this->nodeByteSize;
+ }
+
+ public function __get($var)
+ {
+ return $this->$var;
+ }
+}
diff --git a/lib/MaxMind/Db/Reader/Util.php b/lib/MaxMind/Db/Reader/Util.php
new file mode 100644
index 0000000..87ebbf1
--- /dev/null
+++ b/lib/MaxMind/Db/Reader/Util.php
@@ -0,0 +1,26 @@
+uri = $uri;
+ parent::__construct($message, $httpStatus, $previous);
+ }
+
+ public function getUri()
+ {
+ return $this->uri;
+ }
+
+ public function getStatusCode()
+ {
+ return $this->getCode();
+ }
+}
diff --git a/lib/MaxMind/Exception/InsufficientFundsException.php b/lib/MaxMind/Exception/InsufficientFundsException.php
new file mode 100644
index 0000000..fe159a2
--- /dev/null
+++ b/lib/MaxMind/Exception/InsufficientFundsException.php
@@ -0,0 +1,10 @@
+error = $error;
+ parent::__construct($message, $httpStatus, $uri, $previous);
+ }
+
+ public function getErrorCode()
+ {
+ return $this->error;
+ }
+}
diff --git a/lib/MaxMind/Exception/IpAddressNotFoundException.php b/lib/MaxMind/Exception/IpAddressNotFoundException.php
new file mode 100644
index 0000000..31608f7
--- /dev/null
+++ b/lib/MaxMind/Exception/IpAddressNotFoundException.php
@@ -0,0 +1,7 @@
+accountId = $accountId;
+ $this->licenseKey = $licenseKey;
+
+ $this->httpRequestFactory = isset($options['httpRequestFactory'])
+ ? $options['httpRequestFactory']
+ : new RequestFactory();
+
+ if (isset($options['host'])) {
+ $this->host = $options['host'];
+ }
+ if (isset($options['userAgent'])) {
+ $this->userAgentPrefix = $options['userAgent'] . ' ';
+ }
+
+ $this->caBundle = isset($options['caBundle']) ?
+ $this->caBundle = $options['caBundle'] : $this->getCaBundle();
+
+ if (isset($options['connectTimeout'])) {
+ $this->connectTimeout = $options['connectTimeout'];
+ }
+ if (isset($options['timeout'])) {
+ $this->timeout = $options['timeout'];
+ }
+
+ if (isset($options['proxy'])) {
+ $this->proxy = $options['proxy'];
+ }
+ }
+
+ /**
+ * @param string $service name of the service querying
+ * @param string $path the URI path to use
+ * @param array $input the data to be posted as JSON
+ *
+ * @throws InvalidInputException when the request has missing or invalid
+ * data
+ * @throws AuthenticationException when there is an issue authenticating the
+ * request
+ * @throws InsufficientFundsException when your account is out of funds
+ * @throws InvalidRequestException when the request is invalid for some
+ * other reason, e.g., invalid JSON in the POST.
+ * @throws HttpException when an unexpected HTTP error occurs
+ * @throws WebServiceException when some other error occurs. This also
+ * serves as the base class for the above exceptions.
+ *
+ * @return array The decoded content of a successful response
+ */
+ public function post($service, $path, $input)
+ {
+ $body = json_encode($input);
+ if ($body === false) {
+ throw new InvalidInputException(
+ 'Error encoding input as JSON: '
+ . $this->jsonErrorDescription()
+ );
+ }
+
+ $request = $this->createRequest(
+ $path,
+ ['Content-Type: application/json']
+ );
+
+ list($statusCode, $contentType, $body) = $request->post($body);
+
+ return $this->handleResponse(
+ $statusCode,
+ $contentType,
+ $body,
+ $service,
+ $path
+ );
+ }
+
+ public function get($service, $path)
+ {
+ $request = $this->createRequest($path);
+
+ list($statusCode, $contentType, $body) = $request->get();
+
+ return $this->handleResponse(
+ $statusCode,
+ $contentType,
+ $body,
+ $service,
+ $path
+ );
+ }
+
+ private function userAgent()
+ {
+ $curlVersion = curl_version();
+
+ return $this->userAgentPrefix . 'MaxMind-WS-API/' . self::VERSION . ' PHP/' . PHP_VERSION .
+ ' curl/' . $curlVersion['version'];
+ }
+
+ private function createRequest($path, $headers = [])
+ {
+ array_push(
+ $headers,
+ 'Authorization: Basic '
+ . base64_encode($this->accountId . ':' . $this->licenseKey),
+ 'Accept: application/json'
+ );
+
+ return $this->httpRequestFactory->request(
+ $this->urlFor($path),
+ [
+ 'caBundle' => $this->caBundle,
+ 'connectTimeout' => $this->connectTimeout,
+ 'headers' => $headers,
+ 'proxy' => $this->proxy,
+ 'timeout' => $this->timeout,
+ 'userAgent' => $this->userAgent(),
+ ]
+ );
+ }
+
+ /**
+ * @param int $statusCode the HTTP status code of the response
+ * @param string $contentType the Content-Type of the response
+ * @param string $body the response body
+ * @param string $service the name of the service
+ * @param string $path the path used in the request
+ *
+ * @throws AuthenticationException when there is an issue authenticating the
+ * request
+ * @throws InsufficientFundsException when your account is out of funds
+ * @throws InvalidRequestException when the request is invalid for some
+ * other reason, e.g., invalid JSON in the POST.
+ * @throws HttpException when an unexpected HTTP error occurs
+ * @throws WebServiceException when some other error occurs. This also
+ * serves as the base class for the above exceptions
+ *
+ * @return array The decoded content of a successful response
+ */
+ private function handleResponse(
+ $statusCode,
+ $contentType,
+ $body,
+ $service,
+ $path
+ ) {
+ if ($statusCode >= 400 && $statusCode <= 499) {
+ $this->handle4xx($statusCode, $contentType, $body, $service, $path);
+ } elseif ($statusCode >= 500) {
+ $this->handle5xx($statusCode, $service, $path);
+ } elseif ($statusCode !== 200) {
+ $this->handleUnexpectedStatus($statusCode, $service, $path);
+ }
+
+ return $this->handleSuccess($body, $service);
+ }
+
+ /**
+ * @return string describing the JSON error
+ */
+ private function jsonErrorDescription()
+ {
+ $errno = json_last_error();
+ switch ($errno) {
+ case JSON_ERROR_DEPTH:
+ return 'The maximum stack depth has been exceeded.';
+ case JSON_ERROR_STATE_MISMATCH:
+ return 'Invalid or malformed JSON.';
+ case JSON_ERROR_CTRL_CHAR:
+ return 'Control character error.';
+ case JSON_ERROR_SYNTAX:
+ return 'Syntax error.';
+ case JSON_ERROR_UTF8:
+ return 'Malformed UTF-8 characters.';
+ default:
+ return "Other JSON error ($errno).";
+ }
+ }
+
+ /**
+ * @param string $path the path to use in the URL
+ *
+ * @return string the constructed URL
+ */
+ private function urlFor($path)
+ {
+ return 'https://' . $this->host . $path;
+ }
+
+ /**
+ * @param int $statusCode the HTTP status code
+ * @param string $contentType the response content-type
+ * @param string $body the response body
+ * @param string $service the service name
+ * @param string $path the path used in the request
+ *
+ * @throws AuthenticationException
+ * @throws HttpException
+ * @throws InsufficientFundsException
+ * @throws InvalidRequestException
+ */
+ private function handle4xx(
+ $statusCode,
+ $contentType,
+ $body,
+ $service,
+ $path
+ ) {
+ if (strlen($body) === 0) {
+ throw new HttpException(
+ "Received a $statusCode error for $service with no body",
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+ if (!strstr($contentType, 'json')) {
+ throw new HttpException(
+ "Received a $statusCode error for $service with " .
+ 'the following body: ' . $body,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+
+ $message = json_decode($body, true);
+ if ($message === null) {
+ throw new HttpException(
+ "Received a $statusCode error for $service but could " .
+ 'not decode the response as JSON: '
+ . $this->jsonErrorDescription() . ' Body: ' . $body,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+
+ if (!isset($message['code']) || !isset($message['error'])) {
+ throw new HttpException(
+ 'Error response contains JSON but it does not ' .
+ 'specify code or error keys: ' . $body,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+
+ $this->handleWebServiceError(
+ $message['error'],
+ $message['code'],
+ $statusCode,
+ $path
+ );
+ }
+
+ /**
+ * @param string $message the error message from the web service
+ * @param string $code the error code from the web service
+ * @param int $statusCode the HTTP status code
+ * @param string $path the path used in the request
+ *
+ * @throws AuthenticationException
+ * @throws InvalidRequestException
+ * @throws InsufficientFundsException
+ */
+ private function handleWebServiceError(
+ $message,
+ $code,
+ $statusCode,
+ $path
+ ) {
+ switch ($code) {
+ case 'IP_ADDRESS_NOT_FOUND':
+ case 'IP_ADDRESS_RESERVED':
+ throw new IpAddressNotFoundException(
+ $message,
+ $code,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ case 'ACCOUNT_ID_REQUIRED':
+ case 'ACCOUNT_ID_UNKNOWN':
+ case 'AUTHORIZATION_INVALID':
+ case 'LICENSE_KEY_REQUIRED':
+ case 'USER_ID_REQUIRED':
+ case 'USER_ID_UNKNOWN':
+ throw new AuthenticationException(
+ $message,
+ $code,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ case 'OUT_OF_QUERIES':
+ case 'INSUFFICIENT_FUNDS':
+ throw new InsufficientFundsException(
+ $message,
+ $code,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ case 'PERMISSION_REQUIRED':
+ throw new PermissionRequiredException(
+ $message,
+ $code,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ default:
+ throw new InvalidRequestException(
+ $message,
+ $code,
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+ }
+
+ /**
+ * @param int $statusCode the HTTP status code
+ * @param string $service the service name
+ * @param string $path the URI path used in the request
+ *
+ * @throws HttpException
+ */
+ private function handle5xx($statusCode, $service, $path)
+ {
+ throw new HttpException(
+ "Received a server error ($statusCode) for $service",
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+
+ /**
+ * @param int $statusCode the HTTP status code
+ * @param string $service the service name
+ * @param string $path the URI path used in the request
+ *
+ * @throws HttpException
+ */
+ private function handleUnexpectedStatus($statusCode, $service, $path)
+ {
+ throw new HttpException(
+ 'Received an unexpected HTTP status ' .
+ "($statusCode) for $service",
+ $statusCode,
+ $this->urlFor($path)
+ );
+ }
+
+ /**
+ * @param string $body the successful request body
+ * @param string $service the service name
+ *
+ * @throws WebServiceException if the request body cannot be decoded as
+ * JSON
+ *
+ * @return array the decoded request body
+ */
+ private function handleSuccess($body, $service)
+ {
+ if (strlen($body) === 0) {
+ throw new WebServiceException(
+ "Received a 200 response for $service but did not " .
+ 'receive a HTTP body.'
+ );
+ }
+
+ $decodedContent = json_decode($body, true);
+ if ($decodedContent === null) {
+ throw new WebServiceException(
+ "Received a 200 response for $service but could " .
+ 'not decode the response as JSON: '
+ . $this->jsonErrorDescription() . ' Body: ' . $body
+ );
+ }
+
+ return $decodedContent;
+ }
+
+ private function getCaBundle()
+ {
+ $curlVersion = curl_version();
+
+ // On OS X, when the SSL version is "SecureTransport", the system's
+ // keychain will be used.
+ if ($curlVersion['ssl_version'] === 'SecureTransport') {
+ return;
+ }
+ $cert = CaBundle::getSystemCaRootBundlePath();
+
+ // Check if the cert is inside a phar. If so, we need to copy the cert
+ // to a temp file so that curl can see it.
+ if (substr($cert, 0, 7) === 'phar://') {
+ $tempDir = sys_get_temp_dir();
+ $newCert = tempnam($tempDir, 'geoip2-');
+ if ($newCert === false) {
+ throw new \RuntimeException(
+ "Unable to create temporary file in $tempDir"
+ );
+ }
+ if (!copy($cert, $newCert)) {
+ throw new \RuntimeException(
+ "Could not copy $cert to $newCert: "
+ . var_export(error_get_last(), true)
+ );
+ }
+
+ // We use a shutdown function rather than the destructor as the
+ // destructor isn't called on a fatal error such as an uncaught
+ // exception.
+ register_shutdown_function(
+ function () use ($newCert) {
+ unlink($newCert);
+ }
+ );
+ $cert = $newCert;
+ }
+ if (!file_exists($cert)) {
+ throw new \RuntimeException("CA cert does not exist at $cert");
+ }
+
+ return $cert;
+ }
+}
diff --git a/lib/MaxMind/WebService/Http/CurlRequest.php b/lib/MaxMind/WebService/Http/CurlRequest.php
new file mode 100644
index 0000000..e44e408
--- /dev/null
+++ b/lib/MaxMind/WebService/Http/CurlRequest.php
@@ -0,0 +1,110 @@
+url = $url;
+ $this->options = $options;
+ }
+
+ /**
+ * @param $body
+ *
+ * @return array
+ */
+ public function post($body)
+ {
+ $curl = $this->createCurl();
+
+ curl_setopt($curl, CURLOPT_POST, true);
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $body);
+
+ return $this->execute($curl);
+ }
+
+ public function get()
+ {
+ $curl = $this->createCurl();
+
+ curl_setopt($curl, CURLOPT_HTTPGET, true);
+
+ return $this->execute($curl);
+ }
+
+ /**
+ * @return resource
+ */
+ private function createCurl()
+ {
+ $curl = curl_init($this->url);
+
+ if (!empty($this->options['caBundle'])) {
+ $opts[CURLOPT_CAINFO] = $this->options['caBundle'];
+ }
+ $opts[CURLOPT_SSL_VERIFYHOST] = 2;
+ $opts[CURLOPT_FOLLOWLOCATION] = false;
+ $opts[CURLOPT_SSL_VERIFYPEER] = true;
+ $opts[CURLOPT_RETURNTRANSFER] = true;
+
+ $opts[CURLOPT_HTTPHEADER] = $this->options['headers'];
+ $opts[CURLOPT_USERAGENT] = $this->options['userAgent'];
+ $opts[CURLOPT_PROXY] = $this->options['proxy'];
+
+ // The defined()s are here as the *_MS opts are not available on older
+ // cURL versions
+ $connectTimeout = $this->options['connectTimeout'];
+ if (defined('CURLOPT_CONNECTTIMEOUT_MS')) {
+ $opts[CURLOPT_CONNECTTIMEOUT_MS] = ceil($connectTimeout * 1000);
+ } else {
+ $opts[CURLOPT_CONNECTTIMEOUT] = ceil($connectTimeout);
+ }
+
+ $timeout = $this->options['timeout'];
+ if (defined('CURLOPT_TIMEOUT_MS')) {
+ $opts[CURLOPT_TIMEOUT_MS] = ceil($timeout * 1000);
+ } else {
+ $opts[CURLOPT_TIMEOUT] = ceil($timeout);
+ }
+
+ curl_setopt_array($curl, $opts);
+
+ return $curl;
+ }
+
+ private function execute($curl)
+ {
+ $body = curl_exec($curl);
+ if ($errno = curl_errno($curl)) {
+ $errorMessage = curl_error($curl);
+
+ throw new HttpException(
+ "cURL error ({$errno}): {$errorMessage}",
+ 0,
+ $this->url
+ );
+ }
+
+ $statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
+ $contentType = curl_getinfo($curl, CURLINFO_CONTENT_TYPE);
+ curl_close($curl);
+
+ return [$statusCode, $contentType, $body];
+ }
+}
diff --git a/lib/MaxMind/WebService/Http/Request.php b/lib/MaxMind/WebService/Http/Request.php
new file mode 100644
index 0000000..27bdd58
--- /dev/null
+++ b/lib/MaxMind/WebService/Http/Request.php
@@ -0,0 +1,29 @@
+