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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 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 <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees\Module\BatchUpdate;
use Fisharebest\Algorithm\MyersDiff;
use Fisharebest\Webtrees\Bootstrap4;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Symfony\Component\HttpFoundation\Request;
/**
* Class BatchUpdateBasePlugin
*/
abstract class BatchUpdateBasePlugin
{
/** @var bool User option; update change record */
public $chan = false;
/**
* @param GedcomRecord $record
*
* @return bool
*/
abstract public function doesRecordNeedUpdate(GedcomRecord $record): bool;
/**
* @param GedcomRecord $record
*
* @return string
*/
abstract public function updateRecord(GedcomRecord $record): string;
/**
* Default is to operate on INDI records
*
* @return string[]
*/
public function getRecordTypesToUpdate()
{
return ['INDI'];
}
/**
* Default option is just the "don't update CHAN record"
*
* @param Request $request
*/
public function getOptions(Request $request)
{
$this->chan = (bool)$request->get('chan');
}
/**
* Default option is just the "don't update CHAN record"
*
* @return string
*/
public function getOptionsForm()
{
return
'<div class="row form-group">' .
'<label class="col-sm-3 col-form-label">' . I18N::translate('Keep the existing “last change” information') . '</label>' .
'<div class="col-sm-9">' .
Bootstrap4::radioButtons('chan', [
0 => I18N::translate('no'),
1 => I18N::translate('yes'),
], ($this->chan ? 1 : 0), true, ['onchange' => 'this.form.submit();']) .
'</div></div>';
}
/**
* Default previewer for plugins with no custom preview.
*
* @param GedcomRecord $record
*
* @return string
*/
public function getActionPreview(GedcomRecord $record)
{
$old_lines = preg_split('/[\n]+/', $record->getGedcom());
$new_lines = preg_split('/[\n]+/', $this->updateRecord($record));
$algorithm = new MyersDiff;
$differences = $algorithm->calculate($old_lines, $new_lines);
$diff_lines = [];
foreach ($differences as $difference) {
switch ($difference[1]) {
case MyersDiff::DELETE:
$diff_lines[] = self::decorateDeletedText($difference[0]);
break;
case MyersDiff::INSERT:
$diff_lines[] = self::decorateInsertedText($difference[0]);
break;
default:
$diff_lines[] = $difference[0];
}
}
return '<pre class="gedcom-data">' . self::createEditLinks(implode("\n", $diff_lines), $record) . '</pre>';
}
/**
* Decorate inserted text
*
* @param string $text
*
* @return string
*/
public static function decorateInsertedText($text)
{
return '<ins>' . $text . '</ins>';
}
/**
* Decorate deleted text
*
* @param string $text
*
* @return string
*/
public static function decorateDeletedText($text)
{
return '<del>' . $text . '</del>';
}
/**
* Converted gedcom links into editable links
*
* @param string $gedrec
* @param GedcomRecord $record
*
* @return string
*/
public static function createEditLinks($gedrec, GedcomRecord $record)
{
return preg_replace(
"/@([^#@\n]+)@/m",
'<a href="' . e(route('edit-raw-record', [
'ged' => $record->getTree()->getName(),
'xref' => $record->getXref(),
])) . '">@\\1@</a>',
$gedrec
);
}
}
|