1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Html;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Registry;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use JsonException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use function json_decode;
use function strlen;
use const JSON_THROW_ON_ERROR;
/**
* Trait ModuleMapGeoLocationTrait - default implementation of ModuleMapGeoLocationInterface
*/
trait ModuleMapGeoLocationTrait
{
/**
* A unique internal name for this module (based on the installation folder).
*
* @return string
*/
abstract public function name(): string;
public function description(): string
{
return I18N::translate('Use an external service to find locations.');
}
/**
* @param string $place
*
* @return array<string>
*/
public function searchPlaceNames(string $place): array
{
if (strlen($place) <= 2) {
return [];
}
$key = $this->name() . $place;
$cache = Registry::cache()->file();
$ttl = 86400;
return $cache->remember($key, function () use ($place) {
$request = $this->searchLocationsRequest($place);
$client = new Client([
'timeout' => 3,
]);
$response = $client->send($request);
if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
return $this->extractLocationsFromResponse($response);
}
return [];
}, $ttl);
}
/**
* @param string $place
*
* @return RequestInterface
*/
protected function searchLocationsRequest(string $place): RequestInterface
{
$uri = Html::url('https://nominatim.openstreetmap.org/search', [
'accept-language' => I18N::languageTag(),
'format' => 'jsonv2',
'limit' => 50,
'q' => $place,
]);
return new Request('GET', $uri);
}
/**
* @param ResponseInterface $response
*
* @return array<string>
*/
protected function extractLocationsFromResponse(ResponseInterface $response): array
{
$body = $response->getBody()->getContents();
try {
return json_decode($body, false, 512, JSON_THROW_ON_ERROR);
} catch (JsonException) {
return [];
}
}
}
|
