Skip to content

Add referer header to Nominatim requests (v4) #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bplubell wants to merge 2 commits into
base: v4
Choose a base branch
from
Open

Add referer header to Nominatim requests (v4) #416

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da516d7
Add referer header to Nominatim requests
bplubell Sep 15, 2025
a48b80d
Add app identifier to User-Agent for Nominatim requests
bplubell Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions src/services/GeoService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use GuzzleHttp\Client;
use Mapkit\JWT;
use Exception;
use function GuzzleHttp\default_user_agent;

/**
* Class GeoService
Expand Down Expand Up @@ -763,13 +764,9 @@ private static function _latLngFromAddress_Mapbox ($token, $address, $country):
$url = str_replace('.json', rawurlencode(', ' . $country) . '.json', $url);
}

$referer = Craft::$app->getRequest()->getIsConsoleRequest()
? Craft::getAlias('@web')
: Craft::$app->urlManager->getHostInfo();

$data = (string) static::_client()->get($url, [
'headers' => [
'referer' => $referer,
'referer' => static::_referer(),
]
])->getBody();
$data = Json::decodeIfJson($data);
Expand All @@ -796,7 +793,12 @@ private static function _latLngFromAddress_Nominatim ($address, $country): ?arra
$url .= '&country=' . rawurlencode($country);
}

$data = (string) static::_client()->get($url)->getBody();
$data = (string) static::_client()->get($url, [
'headers' => [
'referer' => static::_referer(),
'user-agent' => static::_userAgent(),
]
])->getBody();
$data = Json::decodeIfJson($data);

if (!is_array($data) || empty($data))
Expand Down Expand Up @@ -883,7 +885,12 @@ private static function _addressFromLatLng_Nominatim ($lat, $lng): ?array
$url .= '&accept-language=' . Craft::$app->locale->getLanguageID();
$url .= '&lat=' . rawurlencode($lat) . '&lon=' . rawurldecode($lng);

$data = (string) static::_client()->get($url)->getBody();
$data = (string) static::_client()->get($url, [
'headers' => [
'referer' => static::_referer(),
'user-agent' => static::_userAgent(),
]
])->getBody();
$data = Json::decodeIfJson($data);

if (!is_array($data) || empty($data) || array_key_exists('error', $data))
Expand Down Expand Up @@ -914,6 +921,21 @@ private static function _client ()
return $client;
}

private static function _referer ()
{
return Craft::$app->getRequest()->getIsConsoleRequest()
? Craft::getAlias('@web')
: Craft::$app->urlManager->getHostInfo();
}

private static function _userAgent ()
{
// User agent form based on Craft::createGuzzleClient
return 'Craft/' . Craft::$app->getVersion()
. ' ' . default_user_agent()
. ' ' . static::_referer();
}

private static function _validateCountryCode (string $code): bool
{
return in_array(strtoupper($code), array_keys(static::$countries));
Expand Down