xref: /webtrees/app/Module/FixNameSlashesAndSpaces.php (revision 24931b29a0237a5f5f1b8620af661ea530451af0) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 <https://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    private DataFixService $data_fix_service;
39
40    /**
41     * @param DataFixService $data_fix_service
42     */
43    public function __construct(DataFixService $data_fix_service)
44    {
45        $this->data_fix_service = $data_fix_service;
46    }
47
48    /**
49     * How should this module be identified in the control panel, etc.?
50     *
51     * @return string
52     */
53    public function title(): string
54    {
55        /* I18N: Name of a module */
56        return I18N::translate('Fix name slashes and spaces');
57    }
58
59    /**
60     * A sentence describing what this module does.
61     *
62     * @return string
63     */
64    public function description(): string
65    {
66        /* I18N: Description of a “Data fix” module */
67        return I18N::translate('Correct NAME records of the form “John/DOE/” or “John /DOE”, as produced by older genealogy programs.');
68    }
69
70    /**
71     * A list of all records that need examining.  This may include records
72     * that do not need updating, if we can't detect this quickly using SQL.
73     *
74     * @param Tree                 $tree
75     * @param array<string,string> $params
76     *
77     * @return Collection<int,string>|null
78     */
79    protected function individualsToFix(Tree $tree, array $params): ?Collection
80    {
81        // No DB querying possible?  Select all.
82        return $this->individualsToFixQuery($tree, $params)
83            ->pluck('i_id');
84    }
85
86    /**
87     * Does a record need updating?
88     *
89     * @param GedcomRecord         $record
90     * @param array<string,string> $params
91     *
92     * @return bool
93     */
94    public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool
95    {
96        $gedcom = $record->gedcom();
97
98        return
99            preg_match('/^(?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*\/[^\/\n]*$/m', $gedcom) ||
100            preg_match('/^(?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*[^\/ ]\//m', $gedcom);
101    }
102
103    /**
104     * Show the changes we would make
105     *
106     * @param GedcomRecord         $record
107     * @param array<string,string> $params
108     *
109     * @return string
110     */
111    public function previewUpdate(GedcomRecord $record, array $params): string
112    {
113        $old = $record->gedcom();
114        $new = $this->updateGedcom($record);
115
116        return $this->data_fix_service->gedcomDiff($record->tree(), $old, $new);
117    }
118
119    /**
120     * Fix a record
121     *
122     * @param GedcomRecord         $record
123     * @param array<string,string> $params
124     *
125     * @return void
126     */
127    public function updateRecord(GedcomRecord $record, array $params): void
128    {
129        $record->updateRecord($this->updateGedcom($record), false);
130    }
131
132    /**
133     * @param GedcomRecord $record
134     *
135     * @return string
136     */
137    private function updateGedcom(GedcomRecord $record): string
138    {
139        $gedcom = $record->gedcom();
140        $gedcom = preg_replace('/^((?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*\/[^\/\n]*)$/m', '$1/', $gedcom);
141
142        return preg_replace('/^((?:1 NAME|2 (?:FONE|ROMN|_MARNM|_AKA|_HEB)) [^\/\n]*[^\/ ])(\/)/m', '$1 $2', $gedcom);
143    }
144}
145