geocoder-php / geoip-provider

<?php

declare(strict_types=1);

/*

 * 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\Geoip;

use Geocoder\Collection;

use Geocoder\Exception\ExtensionNotLoaded;

use Geocoder\Exception\UnsupportedOperation;

use Geocoder\Model\Address;

use Geocoder\Model\AddressCollection;

use Geocoder\Query\GeocodeQuery;

use Geocoder\Query\ReverseQuery;

use Geocoder\Provider\AbstractProvider;

use Geocoder\Provider\Provider;

/**

 * @author William Durand <[email protected]>

 *

 * @see http://php.net/manual/ref.geoip.php

 */

final class Geoip extends AbstractProvider implements Provider

{

    public function __construct()

    {

        if (!function_exists('geoip_record_by_name')) {

            throw new ExtensionNotLoaded('You must install the GeoIP extension, see: https://php.net/manual/book.geoip.php.');

        }

    }

    /**

     * {@inheritdoc}

     */

    public function geocodeQuery(GeocodeQuery $query): Collection

    {

        $address = $query->getText();

        if (!filter_var($address, FILTER_VALIDATE_IP)) {

            throw new UnsupportedOperation('The Geoip 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 Geoip provider does not support IPv6 addresses, only IPv4 addresses.');

        }

        if ('127.0.0.1' === $address) {

            return new AddressCollection([$this->getLocationForLocalhost()]);

        }

        $results = @geoip_record_by_name($address);

        if (!is_array($results)) {

            return new AddressCollection([]);

        }

        if (!empty($results['region']) && !empty($results['country_code'])) {

            $timezone = @geoip_time_zone_by_country_and_region($results['country_code'], $results['region']) ?: null;

            $region = @geoip_region_name_by_code($results['country_code'], $results['region']) ?: $results['region'];

        } else {

            $timezone = null;

            $region = $results['region'];

        }

        return new AddressCollection([

            Address::createFromArray([

                'providedBy' => $this->getName(),

                'latitude' => $results['latitude'],

                'longitude' => $results['longitude'],

                'locality' => $results['city'],

                'postalCode' => $results['postal_code'],

                'adminLevels' => $results['region'] ? [['name' => $region, 'code' => $results['region'], 'level' => 1]] : [],

                'country' => $results['country_name'],

                'countryCode' => $results['country_code'],

                'timezone' => $timezone,

            ]),

        ]);

    }

    /**

     * {@inheritdoc}

     */

    public function reverseQuery(ReverseQuery $query): Collection

    {

        throw new UnsupportedOperation('The Geoip provider is not able to do reverse geocoding.');

    }

    /**

     * {@inheritdoc}

     */

    public function getName(): string

    {

        return 'geoip';

    }

}