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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<?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 Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\Html;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Validator;
use GuzzleHttp\Psr7\Request;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use function array_filter;
use function implode;
use function json_decode;
use function redirect;
use function usort;
use const JSON_THROW_ON_ERROR;
/**
* Class OpenRouteServiceAutocomplete - use openrouteservice.org to search for place names
*/
class OpenRouteServiceAutocomplete extends AbstractModule implements ModuleConfigInterface, ModuleMapAutocompleteInterface
{
use ModuleConfigTrait;
use ModuleMapAutocompleteTrait;
/**
* Name of the map provider.
*
* @return string
*/
public function description(): string
{
$link = '<a href="https://openrouteservice.org">openrouteservice.org</a>';
return I18N::translate('Search for place names using %s.', $link);
}
/**
* @return ResponseInterface
*/
public function getAdminAction(): ResponseInterface
{
$this->layout = 'layouts/administration';
$api_key = $this->getPreference('api_key');
return $this->viewResponse('modules/openrouteservice/config', [
'api_key' => $api_key,
'title' => $this->title(),
]);
}
/**
* Name of the map provider.
*
* @return string
*/
public function title(): string
{
return I18N::translate('OpenRouteService');
}
public function isEnabledByDefault(): bool
{
return false;
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postAdminAction(ServerRequestInterface $request): ResponseInterface
{
$api_key = Validator::parsedBody($request)->string('api_key');
$this->setPreference('api_key', $api_key);
FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');
return redirect($this->getConfigLink());
}
/**
* @param string $place
*
* @return RequestInterface
*/
protected function createPlaceNameSearchRequest(string $place): RequestInterface
{
$api_key = $this->getPreference('api_key');
$uri = Html::url('https://api.openrouteservice.org/geocode/autocomplete', [
'api_key' => $api_key,
'text' => $place,
'layers' => 'coarse',
]);
return new Request('GET', $uri);
}
/**
* @param ResponseInterface $response
*
* @return array<string>
*/
protected function parsePlaceNameSearchResponse(ResponseInterface $response): array
{
$body = $response->getBody()->getContents();
$places = [];
$results = json_decode($body, false, 512, JSON_THROW_ON_ERROR);
foreach ($results->features as $result) {
$result->properties->name ??= null;
$result->properties->county ??= null;
$result->properties->region ??= null;
$result->properties->macroregion ??= null;
$result->properties->country ??= null;
if ($result->properties->country === 'United Kingdom') {
// macroregion will contain England, Scotland, etc.
$result->properties->country = null;
// region will contain the county.
$result->properties->region = null;
}
$parts = [
$result->properties->name,
$result->properties->county,
$result->properties->region,
$result->properties->macroregion,
$result->properties->country,
];
$places[] = implode(Gedcom::PLACE_SEPARATOR, array_filter($parts)) ?: $result->properties->label;
}
usort($places, I18N::comparator());
return $places;
}
}
|
