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
165
166
167
168
169
170
171
172
173
174
175
176
|
<?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\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Services\DataFixService;
use Fisharebest\Webtrees\Tree;
use Illuminate\Support\Collection;
use function addcslashes;
use function preg_match;
use function preg_quote;
use function preg_replace;
use function view;
class FixPlaceNames extends AbstractModule implements ModuleDataFixInterface
{
use ModuleDataFixTrait;
private DataFixService $data_fix_service;
/**
* @param DataFixService $data_fix_service
*/
public function __construct(DataFixService $data_fix_service)
{
$this->data_fix_service = $data_fix_service;
}
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Update place names');
}
public function description(): string
{
/* I18N: Description of a “Data fix” module */
return I18N::translate('Update the higher-level parts of place names, while keeping the lower-level parts.');
}
/**
* Options form.
*
* @param Tree $tree
*
* @return string
*/
public function fixOptions(Tree $tree): string
{
return view('modules/fix-place-names/options', []);
}
/**
* A list of all records that need examining. This may include records
* that do not need updating, if we can't detect this quickly using SQL.
*
* @param Tree $tree
* @param array<string,string> $params
*
* @return Collection<int,string>|null
*/
protected function familiesToFix(Tree $tree, array $params): Collection|null
{
if ($params['search-for'] === '' || $params['replace-with'] === '') {
return null;
}
$search = '%' . addcslashes($params['search-for'], '\\%_') . '%';
return $this->familiesToFixQuery($tree, $params)
->where('f_gedcom', 'LIKE', $search)
->pluck('f_id');
}
/**
* A list of all records that need examining. This may include records
* that do not need updating, if we can't detect this quickly using SQL.
*
* @param Tree $tree
* @param array<string,string> $params
*
* @return Collection<int,string>|null
*/
protected function individualsToFix(Tree $tree, array $params): Collection|null
{
if ($params['search-for'] === '' || $params['replace-with'] === '') {
return null;
}
$search = '%' . addcslashes($params['search-for'], '\\%_') . '%';
return $this->individualsToFixQuery($tree, $params)
->where('i_file', '=', $tree->id())
->where('i_gedcom', 'LIKE', $search)
->pluck('i_id');
}
/**
* Does a record need updating?
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return bool
*/
public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
{
$search = preg_quote($params['search-for'], '/');
$regex = '/\n2 PLAC (?:.*, )?' . $search . '(\n|$)/';
return preg_match($regex, $record->gedcom()) === 1;
}
/**
* Show the changes we would make
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return string
*/
public function previewUpdate(GedcomRecord $record, array $params): string
{
$old = $record->gedcom();
$new = $this->updateGedcom($record, $params);
return $this->data_fix_service->gedcomDiff($record->tree(), $old, $new);
}
/**
* Fix a record
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return void
*/
public function updateRecord(GedcomRecord $record, array $params): void
{
$record->updateRecord($this->updateGedcom($record, $params), false);
}
/**
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return string
*/
private function updateGedcom(GedcomRecord $record, array $params): string
{
$search = preg_quote($params['search-for'], '/');
$regex = '/(\n2 PLAC (?:.*, )?)' . $search . '(\n|$)/';
$replace = '$1' . addcslashes($params['replace-with'], '$\\') . '$2';
return preg_replace($regex, $replace, $record->gedcom());
}
}
|
