geocoder-php / geo-plugin-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\GeoPlugin;

use Geocoder\Collection;

use Geocoder\Exception\InvalidServerResponse;

use Geocoder\Exception\UnsupportedOperation;

use Geocoder\Http\Provider\AbstractHttpProvider;

use Geocoder\Model\Address;

use Geocoder\Model\AddressCollection;

use Geocoder\Provider\Provider;

use Geocoder\Query\GeocodeQuery;

use Geocoder\Query\ReverseQuery;

/**

 * @author Andrea Cristaudo <[email protected]>

 */

final class GeoPlugin extends AbstractHttpProvider implements Provider

{

    /**

     * @var string

     */

    public const GEOCODE_ENDPOINT_URL = 'http://www.geoplugin.net/json.gp?ip=%s';

    public function geocodeQuery(GeocodeQuery $query): Collection

    {

        $address = $query->getText();

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

            throw new UnsupportedOperation('The GeoPlugin provider does not support street addresses, only IP addresses.');

        }

        if (in_array($address, ['127.0.0.1', '::1'])) {

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

        }

        $url = sprintf(self::GEOCODE_ENDPOINT_URL, $address);

        return $this->executeQuery($url);

    }

    public function reverseQuery(ReverseQuery $query): Collection

    {

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

    }

    public function getName(): string

    {

        return 'geo_plugin';

    }

    private function executeQuery(string $url): AddressCollection

    {

        $content = $this->getUrlContents($url);

        $json = json_decode($content, true);

        if (!is_array($json) || !count($json)) {

            throw InvalidServerResponse::create($url);

        }

        if (!array_key_exists('geoplugin_status', $json) || (200 !== $json['geoplugin_status'] && 206 !== $json['geoplugin_status'])) {

            return new AddressCollection([]);

        }

        // Return empty collection if address was not found

        if ('' === $json['geoplugin_regionName']

        && '' === $json['geoplugin_regionCode']

        && '' === $json['geoplugin_city']

        && '' === $json['geoplugin_countryName']

        && '' === $json['geoplugin_countryCode']

        && '0' === $json['geoplugin_latitude']

        && '0' === $json['geoplugin_longitude']) {

            return new AddressCollection([]);

        }

        $data = array_filter($json);

        $adminLevels = [];

        $region = \igorw\get_in($data, ['geoplugin_regionName']);

        $regionCode = \igorw\get_in($data, ['geoplugin_regionCode']);

        if (null !== $region || null !== $regionCode) {

            $adminLevels[] = ['name' => $region, 'code' => $regionCode, 'level' => 1];

        }

        $results = [];

        $results[] = Address::createFromArray([

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

            'locality' => isset($data['geoplugin_city']) ? $data['geoplugin_city'] : null,

            'country' => isset($data['geoplugin_countryName']) ? $data['geoplugin_countryName'] : null,

            'countryCode' => isset($data['geoplugin_countryCode']) ? $data['geoplugin_countryCode'] : null,

            'adminLevels' => $adminLevels,

            'latitude' => isset($data['geoplugin_latitude']) ? $data['geoplugin_latitude'] : null,

            'longitude' => isset($data['geoplugin_longitude']) ? $data['geoplugin_longitude'] : null,

        ]);

        return new AddressCollection($results);

    }

}