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) 2021 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\Fact;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Tree;
use Illuminate\Support\Collection;
use function e;
use function str_contains;
use function strtoupper;
/**
* Class FixPrimaryTag
*/
class FixPrimaryTag extends AbstractModule implements ModuleDataFixInterface
{
use ModuleDataFixTrait;
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Convert _PRIM tags to GEDCOM 5.5.1');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of a “Data fix” module */
return I18N::translate('“Highlighted image” (_PRIM) tags are used by some genealogy applications to indicate the preferred image for an individual. An alternative is to re-order the images so that the preferred one is listed first.');
}
/**
* XREFs of media records that might need fixing.
*
* @param Tree $tree
* @param array<string,string> $params
*
* @return Collection<string>
*/
public function mediaToFix(Tree $tree, array $params): Collection
{
return $this->mediaToFixQuery($tree, $params)
->where('m_file', '=', $tree->id())
->where('m_gedcom', 'LIKE', "%\n1 _PRIM %")
->pluck('m_id');
}
/**
* Does a record need updating?
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return bool
*/
public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
{
return str_contains($record->gedcom(), "\n1 _PRIM ");
}
/**
* Show the changes we would make
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return string
*/
public function previewUpdate(GedcomRecord $record, array $params): string
{
$html = '';
foreach ($record->facts(['_PRIM']) as $prim) {
$html = '<p>' . I18N::translate('Delete') . ' – <code>' . e($prim->gedcom()) . '</code></p>';
}
$html .= '<ul>';
foreach ($record->linkedIndividuals('OBJE') as $individual) {
$html .= '<li>' . I18N::translate('Re-order media') . ' – <a href="' . e($individual->url()) . '">' . $individual->fullName() . '</a></li>';
}
$html .= '</ul>';
return $html;
}
/**
* Fix a record
*
* @param GedcomRecord $record
* @param array<string,string> $params
*
* @return void
*/
public function updateRecord(GedcomRecord $record, array $params): void
{
$facts = $record->facts(['_PRIM'])->filter(static function (Fact $fact): bool {
return !$fact->isPendingDeletion();
});
foreach ($facts as $fact) {
$primary = strtoupper($fact->value()) !== 'N';
foreach ($record->linkedIndividuals('OBJE') as $individual) {
$this->updateMediaLinks($individual, $record->xref(), $primary);
}
$record->deleteFact($fact->id(), false);
}
}
/**
* @param Individual $individual
* @param string $xref
* @param bool $primary
*/
private function updateMediaLinks(Individual $individual, string $xref, bool $primary): void
{
$facts = $individual->facts([], false, null, true);
$facts1 = new Collection();
$facts2 = new Collection();
$facts3 = new Collection();
$facts4 = new Collection();
foreach ($facts as $fact) {
if ($fact->tag() !== 'INDI:OBJE') {
$facts1->push($fact);
} elseif ($fact->value() !== '@' . $xref . '@') {
$facts3->push($fact);
} elseif ($primary) {
$facts2->push($fact);
} else {
$facts4->push($fact);
}
}
$sorted_facts = $facts1->concat($facts2)->concat($facts3)->concat($facts4);
$gedcom = $sorted_facts->map(static function (Fact $fact): string {
return "\n" . $fact->gedcom();
})->implode('');
$gedcom = '0 @' . $individual->xref() . '@ INDI' . $gedcom;
$individual->updateRecord($gedcom, false);
}
}
|
