Skip to content

Allow override for Nominatim base URL (v4) #418

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 1 commit into
base: v4
Choose a base branch
from
Open

Allow override for Nominatim base URL (v4) #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion docs/getting-started/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,15 @@ return [
#### `disablePopulateMissingFieldData`
_Default: `false`_

Will disable the automatic population of missing field data. This can be useful
Will disable the automatic population of missing field data. This can be useful
in preventing API spam when importing lots of map data.

#### `nominatimBaseUrl`
_Default: `'https://nominatim.openstreetmap.org'`_

The base URL for the Nominatim service. Override to use a self-hosted instance
or a proxy.

#### `geoLocationService`
_Default: `GeoLocationService::None`_

Expand Down
6 changes: 6 additions & 0 deletions src/models/Settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ class Settings extends Model
*/
public bool $disablePopulateMissingFieldData = false;

/**
* @var string The base URL for the Nominatim service. Override to use a
* self-hosted instance or a proxy.
*/
public string $nominatimBaseUrl = 'https://nominatim.openstreetmap.org';

// Properties: w3w
// -------------------------------------------------------------------------

Expand Down
12 changes: 6 additions & 6 deletions src/services/GeoService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ public static function latLngFromAddress (string $address, string $country = nul
$address, $country
),
GeoEnum::Nominatim => static::_latLngFromAddress_Nominatim(
$address, $country
$address, $country, $settings->nominatimBaseUrl
),
default => throw new Exception(
'Unknown geo-coding service: ' . $settings->geoService
Expand Down Expand Up @@ -638,7 +638,7 @@ public static function addressFromLatLng (float $lat, float $lng): ?array
$lat, $lng
),
GeoEnum::Nominatim => static::_addressFromLatLng_Nominatim(
$lat, $lng
$lat, $lng, $settings->nominatimBaseUrl
),
default => throw new Exception(
'Unknown geo-coding service: ' . $settings->geoService
Expand Down Expand Up @@ -783,9 +783,9 @@ private static function _latLngFromAddress_Mapbox ($token, $address, $country):
];
}

private static function _latLngFromAddress_Nominatim ($address, $country): ?array
private static function _latLngFromAddress_Nominatim ($address, $country, $baseUrl): ?array
{
$url = 'https://nominatim.openstreetmap.org/search?format=jsonv2&limit=1';
$url = $baseUrl . '/search?format=jsonv2&limit=1';
$url .= '&accept-language=' . Craft::$app->locale->getLanguageID();
$url .= '&q=' . rawurlencode($address);
if ($country !== null)
Expand Down Expand Up @@ -877,9 +877,9 @@ private static function _addressFromLatLng_Mapbox ($token, $lat, $lng): ?array
];
}

private static function _addressFromLatLng_Nominatim ($lat, $lng): ?array
private static function _addressFromLatLng_Nominatim ($lat, $lng, $baseUrl): ?array
{
$url = 'https://nominatim.openstreetmap.org/reverse?format=jsonv2&limit=1&addressdetails=1';
$url = $baseUrl . '/reverse?format=jsonv2&limit=1&addressdetails=1';
$url .= '&accept-language=' . Craft::$app->locale->getLanguageID();
$url .= '&lat=' . rawurlencode($lat) . '&lon=' . rawurldecode($lng);

Expand Down