xref: /webtrees/app/Module/FixNameSlashesAndSpaces.php (revision e172383b8d1dc462218f743b1e04ca6a5babd14e) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2020 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\GedcomRecord;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Services\DataFixService;
25use Fisharebest\Webtrees\Tree;
26use Illuminate\Support\Collection;
27
28use function preg_match;
29use function preg_replace;
30
31/**
32 * Class FixNameSlashesAndSpaces
33 */
34class FixNameSlashesAndSpaces extends AbstractModule implements ModuleDataFixInterface
35{
36    use ModuleDataFixTrait;
37
38    /** @var DataFixService */
39    private $data_fix_service;
40
41    /**
42     * FixMissingDeaths constructor.
43     *
44     * @param DataFixService $data_fix_service
45     */
46    public function __construct(DataFixService $data_fix_service)
47    {
48        $this->data_fix_service = $data_fix_service;
49    }
50
51    /**
52     * How should this module be identified in the control panel, etc.?
53     *
54     * @return string
55     */
56    public function title(): string
57    {
58        /* I18N: Name of a module */
59        return I18N::translate('Fix name slashes and spaces');
60    }
61
62    /**
63     * A sentence describing what this module does.
64     *
65     * @return string
66     */
67    public function description(): string
68    {
69        /* I18N: Description of a “Data fix” module */
70        return I18N::translate('Correct NAME records of the form “John/DOE/” or “John /DOE”, as produced by older genealogy programs.');
71    }
72
73    /**
74     * A list of all records that need examining.  This may include records
75     * that do not need updating, if we can't detect this quickly using SQL.
76     *
77     * @param Tree                 $tree
78     * @param array<string,string> $params
79     *
80     * @return Collection<string>|null
81     */
82    protected function individualsToFix(Tree $tree, array $params): ?Collection
83    {
84        // No DB querying possible?  Select all.
85        return $this->individualsToFixQuery($tree, $params)
86            ->pluck('i_id');
87    }
88
89    /**
90     * Does a record need updating?
91     *
92     * @param GedcomRecord         $record
93     * @param array<string,string> $params
94     *
95     * @return bool
96     */
97    public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
98    {
99        $gedcom = $record->gedcom();
100
101        return
102            preg_match('/^(?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*\/[^\/\n]*$/m', $gedcom) ||
103            preg_match('/^(?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*[^\/ ]\//m', $gedcom);
104    }
105
106    /**
107     * Show the changes we would make
108     *
109     * @param GedcomRecord         $record
110     * @param array<string,string> $params
111     *
112     * @return string
113     */
114    public function previewUpdate(GedcomRecord $record, array $params): string
115    {
116        $old = $record->gedcom();
117        $new = $this->updateGedcom($record);
118
119        return $this->data_fix_service->gedcomDiff($record->tree(), $old, $new);
120    }
121
122    /**
123     * Fix a record
124     *
125     * @param GedcomRecord         $record
126     * @param array<string,string> $params
127     *
128     * @return void
129     */
130    public function updateRecord(GedcomRecord $record, array $params): void
131    {
132        $record->updateRecord($this->updateGedcom($record), false);
133    }
134
135    /**
136     * @param GedcomRecord $record
137     *
138     * @return string
139     */
140    private function updateGedcom(GedcomRecord $record): string
141    {
142        return preg_replace([
143            '/^((?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*\/[^\/\n]*)$/m',
144            '/^((?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*[^\/ ])(\/)/m',
145        ], [
146            '$1/',
147            '$1 $2',
148        ], $record->gedcom());
149    }
150}
151