CheckTree::recordLink() - Code Metrics - Inspection of "Rewrite the GEDCOM error check. Fixes: #4255. Fixe..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 356588...e669bb )

by Greg

created 2022-04-14 14:11 UTC

CheckTree::recordLink() A

↳ Parent: CheckTree

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2022 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\Http\RequestHandlers;

use Fisharebest\Webtrees\Elements\AbstractXrefElement;
use Fisharebest\Webtrees\Elements\SubmitterText;
use Fisharebest\Webtrees\Elements\UnknownElement;
use Fisharebest\Webtrees\Elements\XrefFamily;
use Fisharebest\Webtrees\Elements\XrefIndividual;
use Fisharebest\Webtrees\Elements\XrefLocation;
use Fisharebest\Webtrees\Elements\XrefMedia;
use Fisharebest\Webtrees\Elements\XrefNote;
use Fisharebest\Webtrees\Elements\XrefRepository;
use Fisharebest\Webtrees\Elements\XrefSource;
use Fisharebest\Webtrees\Elements\XrefSubmission;
use Fisharebest\Webtrees\Elements\XrefSubmitter;
use Fisharebest\Webtrees\Factories\ElementFactory;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\Header;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Location;
use Fisharebest\Webtrees\Media;
use Fisharebest\Webtrees\Note;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Repository;
use Fisharebest\Webtrees\Services\TimeoutService;
use Fisharebest\Webtrees\Source;
use Fisharebest\Webtrees\Submission;
use Fisharebest\Webtrees\Submitter;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Database\Query\Expression;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

use function array_slice;
use function e;
use function implode;
use function preg_match;
use function route;
use function str_starts_with;
use function strtoupper;
use function substr_count;

/**
 * Check a tree for errors.
 */
class CheckTree implements RequestHandlerInterface
{
    use ViewResponseTrait;

    private Gedcom $gedcom;

    private TimeoutService $timeout_service;

    /**
     * @param Gedcom         $gedcom
     * @param TimeoutService $timeout_service
     */
    public function __construct(Gedcom $gedcom, TimeoutService $timeout_service)
    {
        $this->gedcom          = $gedcom;
        $this->timeout_service = $timeout_service;
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $this->layout = 'layouts/administration';

        $tree    = Validator::attributes($request)->tree();
        $skip_to = Validator::queryParams($request)->string('skip_to', '');

        // We need to work with raw GEDCOM data, as we are looking for errors
        // which may prevent the GedcomRecord objects from working.

        $q1 = DB::table('individuals')
            ->where('i_file', '=', $tree->id())
            ->select(['i_id AS xref', 'i_gedcom AS gedcom', new Expression("'INDI' AS type")]);
        $q2 = DB::table('families')
            ->where('f_file', '=', $tree->id())
            ->select(['f_id AS xref', 'f_gedcom AS gedcom', new Expression("'FAM' AS type")]);
        $q3 = DB::table('media')
            ->where('m_file', '=', $tree->id())
            ->select(['m_id AS xref', 'm_gedcom AS gedcom', new Expression("'OBJE' AS type")]);
        $q4 = DB::table('sources')
            ->where('s_file', '=', $tree->id())
            ->select(['s_id AS xref', 's_gedcom AS gedcom', new Expression("'SOUR' AS type")]);
        $q5 = DB::table('other')
            ->where('o_file', '=', $tree->id())
            ->select(['o_id AS xref', 'o_gedcom AS gedcom', 'o_type']);
        $q6 = DB::table('change')
            ->where('gedcom_id', '=', $tree->id())
            ->where('status', '=', 'pending')
            ->orderBy('change_id')
            ->select(['xref', 'new_gedcom AS gedcom', new Expression("'' AS type")]);

        $rows = $q1
            ->unionAll($q2)
            ->unionAll($q3)
            ->unionAll($q4)
            ->unionAll($q5)
            ->unionAll($q6)
            ->get()
            ->map(static function (object $row): object {
                // Extract type for pending record
                if ($row->type === '' && preg_match('/^0 @[^@]*@ ([_A-Z0-9]+)/', $row->gedcom, $match) === 1) {
                    $row->type = $match[1];
                }

                return $row;
            });

        $records = [];
        $xrefs   = [];

        foreach ($rows as $row) {
            if ($row->gedcom !== '') {
                // existing or updated record
                $records[$row->xref] = $row;
            } else {
                // deleted record
                unset($records[$row->xref]);
            }

            $xrefs[strtoupper($row->xref)] = $row->xref;
        }

        unset($rows);

        $errors   = [];
        $warnings = [];

        $element_factory = new ElementFactory();
        $this->gedcom->registerTags($element_factory, false);

        foreach ($records as $record) {
            // If we are nearly out of time, then stop processing here
            if ($skip_to === $record->xref) {
                $skip_to = '';
            } elseif ($skip_to !== '') {
                continue;
            } elseif ($this->timeout_service->isTimeNearlyUp()) {
                $skip_to = $record->xref;
                break;
            }

            $lines = explode("\n", $record->gedcom);
            array_shift($lines);

            $last_level = 0;
            $hierarchy  = [$record->type];

            foreach ($lines as $line_number => $line) {
                if (preg_match('/^(\d+) (\w+) ?(.*)/', $line, $match) !== 1) {
                    $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, I18N::translate('Invalid GEDCOM record'));
                    break;
                }

                $level = (int) $match[1];
                if ($level > $last_level + 1) {
                    $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, I18N::translate('Invalid GEDCOM line number'));
                    break;
                }

                $tag               = $match[2];
                $value             = $match[3];
                $hierarchy[$level] = $tag;
                $full_tag          = implode(':', array_slice($hierarchy, 0, 1 + $level));
                $element           = Registry::elementFactory()->make($full_tag);
                $last_level        = $level;

                if ($tag === 'CONT') {
                    $element = new SubmitterText('CONT');
                }

                if ($element instanceof UnknownElement) {
                    if (str_starts_with($tag, '_')) {
                        $message    = I18N::translate('Custom GEDCOM tags are discouraged. Try to use only standard GEDCOM tags.');
                        $warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                    } else {
                        $message  = I18N::translate('Invalid GEDCOM tag.') . ' ' . $full_tag;
                        $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                    }
                } elseif ($element instanceof AbstractXrefElement) {
                    if (preg_match('/@(' . Gedcom::REGEX_XREF . ')@/', $value, $match) === 1) {
                        $xref1  = $match[1];
                        $xref2  = $xrefs[strtoupper($xref1)] ?? null;
                        $linked = $records[$xref2] ?? null;

                        if ($linked === null) {
                            $message  = I18N::translate('%s does not exist.', e($xref1));
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefFamily && $linked->type !== Family::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Family::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefIndividual && $linked->type !== Individual::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Individual::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefMedia && $linked->type !== Media::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Media::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefNote && $linked->type !== Note::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Note::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefSource && $linked->type !== Source::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Source::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefRepository && $linked->type !== Repository::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Repository::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefSubmitter && $linked->type !== Submitter::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Submitter::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefSubmission && $linked->type !== Submission::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Submission::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($element instanceof XrefLocation && $linked->type !== Location::RECORD_TYPE) {
                            $message  = $this->linkErrorMessage($tree, $xref1, $linked->type, Location::RECORD_TYPE);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif (($full_tag === 'FAM:HUSB' || $full_tag === 'FAM:WIFE') && !str_contains($linked->gedcom, "\n1 FAMS @" . $record->xref . '@')) {
                            $link1    = $this->recordLink($tree, $linked->xref);
                            $link2    = $this->recordLink($tree, $record->xref);
                            $message  = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($full_tag === 'FAM:CHIL' && !str_contains($linked->gedcom, "\n1 FAMC @" . $record->xref . '@')) {
                            $link1    = $this->recordLink($tree, $linked->xref);
                            $link2    = $this->recordLink($tree, $record->xref);
                            $message  = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($full_tag === 'INDI:FAMC' && !str_contains($linked->gedcom, "\n1 CHIL @" . $record->xref . '@')) {
                            $link1    = $this->recordLink($tree, $linked->xref);
                            $link2    = $this->recordLink($tree, $record->xref);
                            $message  = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($full_tag === 'INDI:FAMS' && !str_contains($linked->gedcom, "\n1 HUSB @" . $record->xref . '@') && !str_contains($linked->gedcom, "\n1 WIFE @" . $record->xref . '@')) {
                            $link1    = $this->recordLink($tree, $linked->xref);
                            $link2    = $this->recordLink($tree, $record->xref);
                            $message  = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
                            $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        } elseif ($xref1 !== $xref2) {
                            $message    = I18N::translate('%1$s does not exist. Did you mean %2$s?', e($xref1), e($xref2));
                            $warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                        }
                    } elseif ($tag === 'SOUR') {
                        $message  = I18N::translate('Inline-source records are discouraged.');
                        $warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                    } else {
                        $message  = I18N::translate('Invalid GEDCOM value');
                        $errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                    }
                } elseif ($element->canonical($value) !== $value) {
                    $expected   = e($element->canonical($value));
                    $actual     = strtr(e($value), ["\t" => '&rarr;']);
                    $message    = I18N::translate('“%1$s” should be “%2$s”.', $actual, $expected);
                    $warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
                }
            }

            if ($record->type === Family::RECORD_TYPE) {
                if (substr_count($record->gedcom, "\n1 HUSB @") > 1) {
                    $message  = I18N::translate('%s occurs too many times.', 'FAM:HUSB');
                    $errors[] = $this->recordError($tree, $record->type, $record->xref, $message);
                }
                if (substr_count($record->gedcom, "\n1 WIFE @") > 1) {
                    $message  = I18N::translate('%s occurs too many times.', 'FAM:WIFE');
                    $errors[] = $this->recordError($tree, $record->type, $record->xref, $message);
                }
            }
        }

        $title = I18N::translate('Check for errors') . ' — ' . e($tree->title());

        if ($skip_to === '') {
            $more_url = '';
        } else {
            $more_url = route(self::class, ['tree' => $tree->name(), 'skip_to' => $skip_to]);
        }

        return $this->viewResponse('admin/trees-check', [
            'errors'   => $errors,
            'more_url' => $more_url,
            'title'    => $title,
            'tree'     => $tree,
            'warnings' => $warnings,
        ]);
    }

    /**
     * @param string $type
     *
     * @return string
     */
    private function recordType(string $type): string
    {
        $types = [
            Family::RECORD_TYPE     => I18N::translate('Family'),
            Header::RECORD_TYPE     => I18N::translate('Header'),
            Individual::RECORD_TYPE => I18N::translate('Individual'),
            Location::RECORD_TYPE   => I18N::translate('Location'),
            Media::RECORD_TYPE      => I18N::translate('Media object'),
            Note::RECORD_TYPE       => I18N::translate('Note'),
            Repository::RECORD_TYPE => I18N::translate('Repository'),
            Source::RECORD_TYPE     => I18N::translate('Source'),
            Submission::RECORD_TYPE => I18N::translate('Submission'),
            Submitter::RECORD_TYPE  => I18N::translate('Submitter'),
        ];

        return $types[$type] ?? e($type);
    }

    /**
     * @param Tree   $tree
     * @param string $xref
     *
     * @return string
     */
    private function recordLink(Tree $tree, string $xref): string
    {
        $url = route(GedcomRecordPage::class, ['xref' => $xref, 'tree' => $tree->name()]);

        return '<a href="' . e($url) . '">' . e($xref) . '</a>';
    }

    /**
     * Format a link to a record.
     *
     * @param Tree   $tree
     * @param string $type
     * @param string $xref
     * @param int    $line_number
     * @param string $line
     * @param string $message
     *
     * @return string
     */
    private function lineError(Tree $tree, string $type, string $xref, int $line_number, string $line, string $message): string
    {
        return
            I18N::translate('%1$s: %2$s', $this->recordType($type), $this->recordLink($tree, $xref)) .
            ' — ' .
            I18N::translate('%1$s: %2$s', I18N::translate('Line number'), I18N::number($line_number)) .
            ' — ' .
            '<code>' . e($line) . '</code>' .
            '<br>' . $message;
    }

    /**
     * Format a link to a record.
     *
     * @param Tree   $tree
     * @param string $type
     * @param string $xref
     * @param string $message
     *
     * @return string
     */
    private function recordError(Tree $tree, string $type, string $xref, string $message): string
    {
        return I18N::translate('%1$s: %2$s', $this->recordType($type), $this->recordLink($tree, $xref)) . ' — ' . $message;
    }

    /**
     * @param Tree   $tree
     * @param string $xref
     * @param string $type1
     * @param string $type2
     *
     * @return string
     */
    private function linkErrorMessage(Tree $tree, string $xref, string $type1, string $type2): string
    {
        $link  = $this->recordLink($tree, $xref);
        $type1 = $this->recordType($type1);
        $type2 = $this->recordType($type2);

        return I18N::translate('%1$s is a %2$s but a %3$s is expected.', $link, $type1, $type2);
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2022 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
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22			use Fisharebest\Webtrees\Elements\AbstractXrefElement;
23			use Fisharebest\Webtrees\Elements\SubmitterText;
24			use Fisharebest\Webtrees\Elements\UnknownElement;
25			use Fisharebest\Webtrees\Elements\XrefFamily;
26			use Fisharebest\Webtrees\Elements\XrefIndividual;
27			use Fisharebest\Webtrees\Elements\XrefLocation;
28			use Fisharebest\Webtrees\Elements\XrefMedia;
29			use Fisharebest\Webtrees\Elements\XrefNote;
30			use Fisharebest\Webtrees\Elements\XrefRepository;
31			use Fisharebest\Webtrees\Elements\XrefSource;
32			use Fisharebest\Webtrees\Elements\XrefSubmission;
33			use Fisharebest\Webtrees\Elements\XrefSubmitter;
34			use Fisharebest\Webtrees\Factories\ElementFactory;
35			use Fisharebest\Webtrees\Family;
36			use Fisharebest\Webtrees\Gedcom;
37			use Fisharebest\Webtrees\Header;
38			use Fisharebest\Webtrees\Http\ViewResponseTrait;
39			use Fisharebest\Webtrees\I18N;
40			use Fisharebest\Webtrees\Individual;
41			use Fisharebest\Webtrees\Location;
42			use Fisharebest\Webtrees\Media;
43			use Fisharebest\Webtrees\Note;
44			use Fisharebest\Webtrees\Registry;
45			use Fisharebest\Webtrees\Repository;
46			use Fisharebest\Webtrees\Services\TimeoutService;
47			use Fisharebest\Webtrees\Source;
48			use Fisharebest\Webtrees\Submission;
49			use Fisharebest\Webtrees\Submitter;
50			use Fisharebest\Webtrees\Tree;
51			use Fisharebest\Webtrees\Validator;
52			use Illuminate\Database\Capsule\Manager as DB;
53			use Illuminate\Database\Query\Expression;
54			use Psr\Http\Message\ResponseInterface;
55			use Psr\Http\Message\ServerRequestInterface;
56			use Psr\Http\Server\RequestHandlerInterface;
57
58			use function array_slice;
59			use function e;
60			use function implode;
61			use function preg_match;
62			use function route;
63			use function str_starts_with;
64			use function strtoupper;
65			use function substr_count;
66
67			/**
68			* Check a tree for errors.
69			*/
70			class CheckTree implements RequestHandlerInterface
71			{
72			use ViewResponseTrait;
73
74			private Gedcom $gedcom;
75
76			private TimeoutService $timeout_service;
77
78			/**
79			* @param Gedcom $gedcom
80			* @param TimeoutService $timeout_service
81			*/
82			public function __construct(Gedcom $gedcom, TimeoutService $timeout_service)
83			{
84			$this->gedcom = $gedcom;
85			$this->timeout_service = $timeout_service;
86			}
87
88			/**
89			* @param ServerRequestInterface $request
90			*
91			* @return ResponseInterface
92			*/
93			public function handle(ServerRequestInterface $request): ResponseInterface
94			{
95			$this->layout = 'layouts/administration';
96
97			$tree = Validator::attributes($request)->tree();
98			$skip_to = Validator::queryParams($request)->string('skip_to', '');
99
100			// We need to work with raw GEDCOM data, as we are looking for errors
101			// which may prevent the GedcomRecord objects from working.
102
103			$q1 = DB::table('individuals')
104			->where('i_file', '=', $tree->id())
105			->select(['i_id AS xref', 'i_gedcom AS gedcom', new Expression("'INDI' AS type")]);
106			$q2 = DB::table('families')
107			->where('f_file', '=', $tree->id())
108			->select(['f_id AS xref', 'f_gedcom AS gedcom', new Expression("'FAM' AS type")]);
109			$q3 = DB::table('media')
110			->where('m_file', '=', $tree->id())
111			->select(['m_id AS xref', 'm_gedcom AS gedcom', new Expression("'OBJE' AS type")]);
112			$q4 = DB::table('sources')
113			->where('s_file', '=', $tree->id())
114			->select(['s_id AS xref', 's_gedcom AS gedcom', new Expression("'SOUR' AS type")]);
115			$q5 = DB::table('other')
116			->where('o_file', '=', $tree->id())
117			->select(['o_id AS xref', 'o_gedcom AS gedcom', 'o_type']);
118			$q6 = DB::table('change')
119			->where('gedcom_id', '=', $tree->id())
120			->where('status', '=', 'pending')
121			->orderBy('change_id')
122			->select(['xref', 'new_gedcom AS gedcom', new Expression("'' AS type")]);
123
124			$rows = $q1
125			->unionAll($q2)
126			->unionAll($q3)
127			->unionAll($q4)
128			->unionAll($q5)
129			->unionAll($q6)
130			->get()
131			->map(static function (object $row): object {
132			// Extract type for pending record
133			if ($row->type === '' && preg_match('/^0 @[^@]*@ ([_A-Z0-9]+)/', $row->gedcom, $match) === 1) {
134			$row->type = $match[1];
135			}
136
137			return $row;
138			});
139
140			$records = [];
141			$xrefs = [];
142
143			foreach ($rows as $row) {
144			if ($row->gedcom !== '') {
145			// existing or updated record
146			$records[$row->xref] = $row;
147			} else {
148			// deleted record
149			unset($records[$row->xref]);
150			}
151
152			$xrefs[strtoupper($row->xref)] = $row->xref;
153			}
154
155			unset($rows);
156
157			$errors = [];
158			$warnings = [];
159
160			$element_factory = new ElementFactory();
161			$this->gedcom->registerTags($element_factory, false);
162
163			foreach ($records as $record) {
164			// If we are nearly out of time, then stop processing here
165			if ($skip_to === $record->xref) {
166			$skip_to = '';
167			} elseif ($skip_to !== '') {
168			continue;
169			} elseif ($this->timeout_service->isTimeNearlyUp()) {
170			$skip_to = $record->xref;
171			break;
172			}
173
174			$lines = explode("\n", $record->gedcom);
175			array_shift($lines);
176
177			$last_level = 0;
178			$hierarchy = [$record->type];
179
180			foreach ($lines as $line_number => $line) {
181			if (preg_match('/^(\d+) (\w+) ?(.*)/', $line, $match) !== 1) {
182			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, I18N::translate('Invalid GEDCOM record'));
183			break;
184			}
185
186			$level = (int) $match[1];
187			if ($level > $last_level + 1) {
188			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, I18N::translate('Invalid GEDCOM line number'));
189			break;
190			}
191
192			$tag = $match[2];
193			$value = $match[3];
194			$hierarchy[$level] = $tag;
195			$full_tag = implode(':', array_slice($hierarchy, 0, 1 + $level));
196			$element = Registry::elementFactory()->make($full_tag);
197			$last_level = $level;
198
199			if ($tag === 'CONT') {
200			$element = new SubmitterText('CONT');
201			}
202
203			if ($element instanceof UnknownElement) {
204			if (str_starts_with($tag, '_')) {
205			$message = I18N::translate('Custom GEDCOM tags are discouraged. Try to use only standard GEDCOM tags.');
206			$warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
207			} else {
208			$message = I18N::translate('Invalid GEDCOM tag.') . ' ' . $full_tag;
209			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
210			}
211			} elseif ($element instanceof AbstractXrefElement) {
212			if (preg_match('/@(' . Gedcom::REGEX_XREF . ')@/', $value, $match) === 1) {
213			$xref1 = $match[1];
214			$xref2 = $xrefs[strtoupper($xref1)] ?? null;
215			$linked = $records[$xref2] ?? null;
216
217			if ($linked === null) {
218			$message = I18N::translate('%s does not exist.', e($xref1));
219			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
220			} elseif ($element instanceof XrefFamily && $linked->type !== Family::RECORD_TYPE) {
221			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Family::RECORD_TYPE);
222			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
223			} elseif ($element instanceof XrefIndividual && $linked->type !== Individual::RECORD_TYPE) {
224			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Individual::RECORD_TYPE);
225			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
226			} elseif ($element instanceof XrefMedia && $linked->type !== Media::RECORD_TYPE) {
227			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Media::RECORD_TYPE);
228			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
229			} elseif ($element instanceof XrefNote && $linked->type !== Note::RECORD_TYPE) {
230			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Note::RECORD_TYPE);
231			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
232			} elseif ($element instanceof XrefSource && $linked->type !== Source::RECORD_TYPE) {
233			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Source::RECORD_TYPE);
234			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
235			} elseif ($element instanceof XrefRepository && $linked->type !== Repository::RECORD_TYPE) {
236			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Repository::RECORD_TYPE);
237			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
238			} elseif ($element instanceof XrefSubmitter && $linked->type !== Submitter::RECORD_TYPE) {
239			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Submitter::RECORD_TYPE);
240			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
241			} elseif ($element instanceof XrefSubmission && $linked->type !== Submission::RECORD_TYPE) {
242			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Submission::RECORD_TYPE);
243			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
244			} elseif ($element instanceof XrefLocation && $linked->type !== Location::RECORD_TYPE) {
245			$message = $this->linkErrorMessage($tree, $xref1, $linked->type, Location::RECORD_TYPE);
246			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
247			} elseif (($full_tag === 'FAM:HUSB' \|\| $full_tag === 'FAM:WIFE') && !str_contains($linked->gedcom, "\n1 FAMS @" . $record->xref . '@')) {
248			$link1 = $this->recordLink($tree, $linked->xref);
249			$link2 = $this->recordLink($tree, $record->xref);
250			$message = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
251			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
252			} elseif ($full_tag === 'FAM:CHIL' && !str_contains($linked->gedcom, "\n1 FAMC @" . $record->xref . '@')) {
253			$link1 = $this->recordLink($tree, $linked->xref);
254			$link2 = $this->recordLink($tree, $record->xref);
255			$message = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
256			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
257			} elseif ($full_tag === 'INDI:FAMC' && !str_contains($linked->gedcom, "\n1 CHIL @" . $record->xref . '@')) {
258			$link1 = $this->recordLink($tree, $linked->xref);
259			$link2 = $this->recordLink($tree, $record->xref);
260			$message = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
261			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
262			} elseif ($full_tag === 'INDI:FAMS' && !str_contains($linked->gedcom, "\n1 HUSB @" . $record->xref . '@') && !str_contains($linked->gedcom, "\n1 WIFE @" . $record->xref . '@')) {
263			$link1 = $this->recordLink($tree, $linked->xref);
264			$link2 = $this->recordLink($tree, $record->xref);
265			$message = I18N::translate('%1$s does not have a link back to %2$s.', $link1, $link2);
266			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
267			} elseif ($xref1 !== $xref2) {
268			$message = I18N::translate('%1$s does not exist. Did you mean %2$s?', e($xref1), e($xref2));
269			$warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
270			}
271			} elseif ($tag === 'SOUR') {
272			$message = I18N::translate('Inline-source records are discouraged.');
273			$warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
274			} else {
275			$message = I18N::translate('Invalid GEDCOM value');
276			$errors[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
277			}
278			} elseif ($element->canonical($value) !== $value) {
279			$expected = e($element->canonical($value));
280			$actual = strtr(e($value), ["\t" => '→']);
281			$message = I18N::translate('“%1$s” should be “%2$s”.', $actual, $expected);
282			$warnings[] = $this->lineError($tree, $record->type, $record->xref, $line_number, $line, $message);
283			}
284			}
285
286			if ($record->type === Family::RECORD_TYPE) {
287			if (substr_count($record->gedcom, "\n1 HUSB @") > 1) {
288			$message = I18N::translate('%s occurs too many times.', 'FAM:HUSB');
289			$errors[] = $this->recordError($tree, $record->type, $record->xref, $message);
290			}
291			if (substr_count($record->gedcom, "\n1 WIFE @") > 1) {
292			$message = I18N::translate('%s occurs too many times.', 'FAM:WIFE');
293			$errors[] = $this->recordError($tree, $record->type, $record->xref, $message);
294			}
295			}
296			}
297
298			$title = I18N::translate('Check for errors') . ' — ' . e($tree->title());
299
300			if ($skip_to === '') {
301			$more_url = '';
302			} else {
303			$more_url = route(self::class, ['tree' => $tree->name(), 'skip_to' => $skip_to]);
304			}
305
306			return $this->viewResponse('admin/trees-check', [
307			'errors' => $errors,
308			'more_url' => $more_url,
309			'title' => $title,
310			'tree' => $tree,
311			'warnings' => $warnings,
312			]);
313			}
314
315			/**
316			* @param string $type
317			*
318			* @return string
319			*/
320			private function recordType(string $type): string
321			{
322			$types = [
323			Family::RECORD_TYPE => I18N::translate('Family'),
324			Header::RECORD_TYPE => I18N::translate('Header'),
325			Individual::RECORD_TYPE => I18N::translate('Individual'),
326			Location::RECORD_TYPE => I18N::translate('Location'),
327			Media::RECORD_TYPE => I18N::translate('Media object'),
328			Note::RECORD_TYPE => I18N::translate('Note'),
329			Repository::RECORD_TYPE => I18N::translate('Repository'),
330			Source::RECORD_TYPE => I18N::translate('Source'),
331			Submission::RECORD_TYPE => I18N::translate('Submission'),
332			Submitter::RECORD_TYPE => I18N::translate('Submitter'),
333			];
334
335			return $types[$type] ?? e($type);
336			}
337
338			/**
339			* @param Tree $tree
340			* @param string $xref
341			*
342			* @return string
343			*/
344			private function recordLink(Tree $tree, string $xref): string
345			{
346			$url = route(GedcomRecordPage::class, ['xref' => $xref, 'tree' => $tree->name()]);
347
348			return '<a href="' . e($url) . '">' . e($xref) . '</a>';
349			}
350
351			/**
352			* Format a link to a record.
353			*
354			* @param Tree $tree
355			* @param string $type
356			* @param string $xref
357			* @param int $line_number
358			* @param string $line
359			* @param string $message
360			*
361			* @return string
362			*/
363			private function lineError(Tree $tree, string $type, string $xref, int $line_number, string $line, string $message): string
364			{
365			return
366			I18N::translate('%1$s: %2$s', $this->recordType($type), $this->recordLink($tree, $xref)) .
367			' — ' .
368			I18N::translate('%1$s: %2$s', I18N::translate('Line number'), I18N::number($line_number)) .
369			' — ' .
370			'<code>' . e($line) . '</code>' .
371			'<br>' . $message;
372			}
373
374			/**
375			* Format a link to a record.
376			*
377			* @param Tree $tree
378			* @param string $type
379			* @param string $xref
380			* @param string $message
381			*
382			* @return string
383			*/
384			private function recordError(Tree $tree, string $type, string $xref, string $message): string
385			{
386			return I18N::translate('%1$s: %2$s', $this->recordType($type), $this->recordLink($tree, $xref)) . ' — ' . $message;
387			}
388
389			/**
390			* @param Tree $tree
391			* @param string $xref
392			* @param string $type1
393			* @param string $type2
394			*
395			* @return string
396			*/
397			private function linkErrorMessage(Tree $tree, string $xref, string $type1, string $type2): string
398			{
399			$link = $this->recordLink($tree, $xref);
400			$type1 = $this->recordType($type1);
401			$type2 = $this->recordType($type2);
402
403			return I18N::translate('%1$s is a %2$s but a %3$s is expected.', $link, $type1, $type2);
404			}
405			}
406

fisharebest / webtrees

Push — main ( 356588...e669bb )

CheckTree::recordLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like