first commit

lib/maxmind/GeoIp2/Model/AbstractModel.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+/**
+ * @ignore
+ */
+abstract class AbstractModel implements \JsonSerializable
+{
+    /**
+     * @var array<string, mixed>
+     */
+    protected $raw;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        $this->raw = $raw;
+    }
+
+    /**
+     * @ignore
+     *
+     * @return mixed
+     */
+    protected function get(string $field)
+    {
+        if (isset($this->raw[$field])) {
+            return $this->raw[$field];
+        }
+        if (preg_match('/^is_/', $field)) {
+            return false;
+        }
+
+        return null;
+    }
+
+    /**
+     * @ignore
+     *
+     * @return mixed
+     */
+    public function __get(string $attr)
+    {
+        if ($attr !== 'instance' && property_exists($this, $attr)) {
+            return $this->{$attr};
+        }
+
+        throw new \RuntimeException("Unknown attribute: $attr");
+    }
+
+    /**
+     * @ignore
+     */
+    public function __isset(string $attr): bool
+    {
+        return $attr !== 'instance' && isset($this->{$attr});
+    }
+
+    public function jsonSerialize(): array
+    {
+        return $this->raw;
+    }
+}

lib/maxmind/GeoIp2/Model/AnonymousIp.php

@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+use GeoIp2\Util;
+
+/**
+ * This class provides the GeoIP2 Anonymous IP model.
+ *
+ * @property-read bool $isAnonymous This is true if the IP address belongs to
+ *     any sort of anonymous network.
+ * @property-read bool $isAnonymousVpn This is true if the IP address is
+ *     registered to an anonymous VPN provider. If a VPN provider does not
+ *     register subnets under names associated with them, we will likely only
+ *     flag their IP ranges using the isHostingProvider property.
+ * @property-read bool $isHostingProvider This is true if the IP address belongs
+ *     to a hosting or VPN provider (see description of isAnonymousVpn property).
+ * @property-read bool $isPublicProxy This is true if the IP address belongs to
+ *     a public proxy.
+ * @property-read bool $isResidentialProxy This is true if the IP address is
+ *     on a suspected anonymizing network and belongs to a residential ISP.
+ * @property-read bool $isTorExitNode This is true if the IP address is a Tor
+ *     exit node.
+ * @property-read string $ipAddress The IP address that the data in the model is
+ *     for.
+ * @property-read string $network The network in CIDR notation associated with
+ *      the record. In particular, this is the largest network where all of the
+ *      fields besides $ipAddress have the same value.
+ */
+class AnonymousIp extends AbstractModel
+{
+    /**
+     * @var bool
+     */
+    protected $isAnonymous;
+
+    /**
+     * @var bool
+     */
+    protected $isAnonymousVpn;
+
+    /**
+     * @var bool
+     */
+    protected $isHostingProvider;
+
+    /**
+     * @var bool
+     */
+    protected $isPublicProxy;
+
+    /**
+     * @var bool
+     */
+    protected $isResidentialProxy;
+
+    /**
+     * @var bool
+     */
+    protected $isTorExitNode;
+
+    /**
+     * @var string
+     */
+    protected $ipAddress;
+
+    /**
+     * @var string
+     */
+    protected $network;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        parent::__construct($raw);
+
+        $this->isAnonymous = $this->get('is_anonymous');
+        $this->isAnonymousVpn = $this->get('is_anonymous_vpn');
+        $this->isHostingProvider = $this->get('is_hosting_provider');
+        $this->isPublicProxy = $this->get('is_public_proxy');
+        $this->isResidentialProxy = $this->get('is_residential_proxy');
+        $this->isTorExitNode = $this->get('is_tor_exit_node');
+        $ipAddress = $this->get('ip_address');
+        $this->ipAddress = $ipAddress;
+        $this->network = Util::cidr($ipAddress, $this->get('prefix_len'));
+    }
+}

lib/maxmind/GeoIp2/Model/Asn.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+use GeoIp2\Util;
+
+/**
+ * This class provides the GeoLite2 ASN model.
+ *
+ * @property-read int|null $autonomousSystemNumber The autonomous system number
+ *     associated with the IP address.
+ * @property-read string|null $autonomousSystemOrganization The organization
+ *     associated with the registered autonomous system number for the IP
+ *     address.
+ * @property-read string $ipAddress The IP address that the data in the model is
+ *     for.
+ * @property-read string $network The network in CIDR notation associated with
+ *      the record. In particular, this is the largest network where all of the
+ *      fields besides $ipAddress have the same value.
+ */
+class Asn extends AbstractModel
+{
+    /**
+     * @var int|null
+     */
+    protected $autonomousSystemNumber;
+
+    /**
+     * @var string|null
+     */
+    protected $autonomousSystemOrganization;
+
+    /**
+     * @var string
+     */
+    protected $ipAddress;
+
+    /**
+     * @var string
+     */
+    protected $network;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        parent::__construct($raw);
+        $this->autonomousSystemNumber = $this->get('autonomous_system_number');
+        $this->autonomousSystemOrganization =
+            $this->get('autonomous_system_organization');
+        $ipAddress = $this->get('ip_address');
+        $this->ipAddress = $ipAddress;
+        $this->network = Util::cidr($ipAddress, $this->get('prefix_len'));
+    }
+}

lib/maxmind/GeoIp2/Model/City.php

@@ -0,0 +1,123 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+/**
+ * Model class for the data returned by City Plus web service and City
+ * database.
+ *
+ * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
+ * details.
+ *
+ * @property-read \GeoIp2\Record\City $city City data for the requested IP
+ * address.
+ * @property-read \GeoIp2\Record\Location $location Location data for the
+ * requested IP address.
+ * @property-read \GeoIp2\Record\Postal $postal Postal data for the
+ * requested IP address.
+ * @property-read array $subdivisions An array \GeoIp2\Record\Subdivision
+ * objects representing the country subdivisions for the requested IP
+ * address. The number and type of subdivisions varies by country, but a
+ * subdivision is typically a state, province, county, etc. Subdivisions
+ * are ordered from most general (largest) to most specific (smallest).
+ * If the response did not contain any subdivisions, this method returns
+ * an empty array.
+ * @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
+ * representing the most specific subdivision returned. If the response
+ * did not contain any subdivisions, this method returns an empty
+ * \GeoIp2\Record\Subdivision object.
+ */
+class City extends Country
+{
+    /**
+     * @ignore
+     *
+     * @var \GeoIp2\Record\City
+     */
+    protected $city;
+
+    /**
+     * @ignore
+     *
+     * @var \GeoIp2\Record\Location
+     */
+    protected $location;
+
+    /**
+     * @ignore
+     *
+     * @var \GeoIp2\Record\Postal
+     */
+    protected $postal;
+
+    /**
+     * @ignore
+     *
+     * @var array<\GeoIp2\Record\Subdivision>
+     */
+    protected $subdivisions = [];
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw, array $locales = ['en'])
+    {
+        parent::__construct($raw, $locales);
+
+        $this->city = new \GeoIp2\Record\City($this->get('city'), $locales);
+        $this->location = new \GeoIp2\Record\Location($this->get('location'));
+        $this->postal = new \GeoIp2\Record\Postal($this->get('postal'));
+
+        $this->createSubdivisions($raw, $locales);
+    }
+
+    private function createSubdivisions(array $raw, array $locales): void
+    {
+        if (!isset($raw['subdivisions'])) {
+            return;
+        }
+
+        foreach ($raw['subdivisions'] as $sub) {
+            $this->subdivisions[] =
+                new \GeoIp2\Record\Subdivision($sub, $locales)
+            ;
+        }
+    }
+
+    /**
+     * @ignore
+     *
+     * @return mixed
+     */
+    public function __get(string $attr)
+    {
+        if ($attr === 'mostSpecificSubdivision') {
+            return $this->{$attr}();
+        }
+
+        return parent::__get($attr);
+    }
+
+    /**
+     * @ignore
+     */
+    public function __isset(string $attr): bool
+    {
+        if ($attr === 'mostSpecificSubdivision') {
+            // We always return a mostSpecificSubdivision, even if it is the
+            // empty subdivision
+            return true;
+        }
+
+        return parent::__isset($attr);
+    }
+
+    private function mostSpecificSubdivision(): \GeoIp2\Record\Subdivision
+    {
+        return empty($this->subdivisions) ?
+            new \GeoIp2\Record\Subdivision([], $this->locales) :
+            end($this->subdivisions);
+    }
+}

lib/maxmind/GeoIp2/Model/ConnectionType.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+use GeoIp2\Util;
+
+/**
+ * This class provides the GeoIP2 Connection-Type model.
+ *
+ * @property-read string|null $connectionType The connection type may take the
+ *     following values: "Dialup", "Cable/DSL", "Corporate", "Cellular".
+ *     Additional values may be added in the future.
+ * @property-read string $ipAddress The IP address that the data in the model is
+ *     for.
+ * @property-read string $network The network in CIDR notation associated with
+ *      the record. In particular, this is the largest network where all of the
+ *      fields besides $ipAddress have the same value.
+ */
+class ConnectionType extends AbstractModel
+{
+    /**
+     * @var string|null
+     */
+    protected $connectionType;
+
+    /**
+     * @var string
+     */
+    protected $ipAddress;
+
+    /**
+     * @var string
+     */
+    protected $network;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        parent::__construct($raw);
+
+        $this->connectionType = $this->get('connection_type');
+        $ipAddress = $this->get('ip_address');
+        $this->ipAddress = $ipAddress;
+        $this->network = Util::cidr($ipAddress, $this->get('prefix_len'));
+    }
+}

lib/maxmind/GeoIp2/Model/Country.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+/**
+ * Model class for the data returned by GeoIP2 Country web service and database.
+ *
+ * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
+ *
+ * @property-read \GeoIp2\Record\Continent $continent Continent data for the
+ * requested IP address.
+ * @property-read \GeoIp2\Record\Country $country Country data for the requested
+ * IP address. This object represents the country where MaxMind believes the
+ * end user is located.
+ * @property-read \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
+ * account.
+ * @property-read \GeoIp2\Record\Country $registeredCountry Registered country
+ * data for the requested IP address. This record represents the country
+ * where the ISP has registered a given IP block and may differ from the
+ * user's country.
+ * @property-read \GeoIp2\Record\RepresentedCountry $representedCountry
+ * Represented country data for the requested IP address. The represented
+ * country is used for things like military bases. It is only present when
+ * the represented country differs from the country.
+ * @property-read \GeoIp2\Record\Traits $traits Data for the traits of the
+ * requested IP address.
+ * @property-read array $raw The raw data from the web service.
+ */
+class Country extends AbstractModel
+{
+    /**
+     * @var \GeoIp2\Record\Continent
+     */
+    protected $continent;
+
+    /**
+     * @var \GeoIp2\Record\Country
+     */
+    protected $country;
+
+    /**
+     * @var array<string>
+     */
+    protected $locales;
+
+    /**
+     * @var \GeoIp2\Record\MaxMind
+     */
+    protected $maxmind;
+
+    /**
+     * @var \GeoIp2\Record\Country
+     */
+    protected $registeredCountry;
+
+    /**
+     * @var \GeoIp2\Record\RepresentedCountry
+     */
+    protected $representedCountry;
+
+    /**
+     * @var \GeoIp2\Record\Traits
+     */
+    protected $traits;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw, array $locales = ['en'])
+    {
+        parent::__construct($raw);
+
+        $this->continent = new \GeoIp2\Record\Continent(
+            $this->get('continent'),
+            $locales
+        );
+        $this->country = new \GeoIp2\Record\Country(
+            $this->get('country'),
+            $locales
+        );
+        $this->maxmind = new \GeoIp2\Record\MaxMind($this->get('maxmind'));
+        $this->registeredCountry = new \GeoIp2\Record\Country(
+            $this->get('registered_country'),
+            $locales
+        );
+        $this->representedCountry = new \GeoIp2\Record\RepresentedCountry(
+            $this->get('represented_country'),
+            $locales
+        );
+        $this->traits = new \GeoIp2\Record\Traits($this->get('traits'));
+
+        $this->locales = $locales;
+    }
+}

lib/maxmind/GeoIp2/Model/Domain.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+use GeoIp2\Util;
+
+/**
+ * This class provides the GeoIP2 Domain model.
+ *
+ * @property-read string|null $domain The second level domain associated with the
+ *     IP address. This will be something like "example.com" or
+ *     "example.co.uk", not "foo.example.com".
+ * @property-read string $ipAddress The IP address that the data in the model is
+ *     for.
+ * @property-read string $network The network in CIDR notation associated with
+ *      the record. In particular, this is the largest network where all of the
+ *      fields besides $ipAddress have the same value.
+ */
+class Domain extends AbstractModel
+{
+    /**
+     * @var string|null
+     */
+    protected $domain;
+
+    /**
+     * @var string
+     */
+    protected $ipAddress;
+
+    /**
+     * @var string
+     */
+    protected $network;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        parent::__construct($raw);
+
+        $this->domain = $this->get('domain');
+        $ipAddress = $this->get('ip_address');
+        $this->ipAddress = $ipAddress;
+        $this->network = Util::cidr($ipAddress, $this->get('prefix_len'));
+    }
+}

lib/maxmind/GeoIp2/Model/Enterprise.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+/**
+ * Model class for the data returned by GeoIP2 Enterprise database lookups.
+ *
+ * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
+ * details.
+ */
+class Enterprise extends City
+{
+}

lib/maxmind/GeoIp2/Model/Insights.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+/**
+ * Model class for the data returned by GeoIP2 Insights web service.
+ *
+ * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for
+ * more details.
+ */
+class Insights extends City
+{
+}

lib/maxmind/GeoIp2/Model/Isp.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeoIp2\Model;
+
+use GeoIp2\Util;
+
+/**
+ * This class provides the GeoIP2 ISP model.
+ *
+ * @property-read int|null $autonomousSystemNumber The autonomous system number
+ *     associated with the IP address.
+ * @property-read string|null $autonomousSystemOrganization The organization
+ *     associated with the registered autonomous system number for the IP
+ *     address.
+ * @property-read string|null $isp The name of the ISP associated with the IP
+ *     address.
+ * @property-read string|null $mobileCountryCode The [mobile country code
+ *     (MCC)](https://en.wikipedia.org/wiki/Mobile_country_code) associated with
+ *     the IP address and ISP.
+ * @property-read string|null $mobileNetworkCode The [mobile network code
+ *     (MNC)](https://en.wikipedia.org/wiki/Mobile_country_code) associated with
+ *     the IP address and ISP.
+ * @property-read string|null $organization The name of the organization associated
+ *     with the IP address.
+ * @property-read string $ipAddress The IP address that the data in the model is
+ *     for.
+ * @property-read string $network The network in CIDR notation associated with
+ *      the record. In particular, this is the largest network where all of the
+ *      fields besides $ipAddress have the same value.
+ */
+class Isp extends AbstractModel
+{
+    /**
+     * @var int|null
+     */
+    protected $autonomousSystemNumber;
+
+    /**
+     * @var string|null
+     */
+    protected $autonomousSystemOrganization;
+
+    /**
+     * @var string|null
+     */
+    protected $isp;
+
+    /**
+     * @var string|null
+     */
+    protected $mobileCountryCode;
+
+    /**
+     * @var string|null
+     */
+    protected $mobileNetworkCode;
+
+    /**
+     * @var string|null
+     */
+    protected $organization;
+
+    /**
+     * @var string
+     */
+    protected $ipAddress;
+
+    /**
+     * @var string
+     */
+    protected $network;
+
+    /**
+     * @ignore
+     */
+    public function __construct(array $raw)
+    {
+        parent::__construct($raw);
+        $this->autonomousSystemNumber = $this->get('autonomous_system_number');
+        $this->autonomousSystemOrganization =
+            $this->get('autonomous_system_organization');
+        $this->isp = $this->get('isp');
+        $this->mobileCountryCode = $this->get('mobile_country_code');
+        $this->mobileNetworkCode = $this->get('mobile_network_code');
+        $this->organization = $this->get('organization');
+
+        $ipAddress = $this->get('ip_address');
+        $this->ipAddress = $ipAddress;
+        $this->network = Util::cidr($ipAddress, $this->get('prefix_len'));
+    }
+}