UidParser - Code Metrics - Inspection of "UID References in notes and text" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#5145)

unknown
created 2025-05-24 00:31 UTC
UidParser A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	135
Duplicated Lines	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
wmc	17
eloc	55
c	2
b	0
f	0
dl	0
loc	135
rs	10
4 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getMatchDefinition()	5	1
C	parse()	75	12
A	firstMatchingUidRecord()	11	3
<?php

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

use Fisharebest\Webtrees\Auth;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\GedcomRecord;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Services\GedcomImportService;
use Fisharebest\Webtrees\Services\TreeService;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Services\SearchService;
filter:
    dependency_paths: ["lib/*"]
use League\CommonMark\Parser\Inline\InlineParserInterface;
use League\CommonMark\Parser\Inline\InlineParserMatch;
use League\CommonMark\Parser\InlineParserContext;
use Illuminate\Support\Collection;

/**
 * Convert UIDs within markdown text to links
 */
class UidParser implements InlineParserInterface
{
    private Tree $tree;
    private SearchService $search_service;

    /**
     * @param Tree $tree Match UIDs in this tree
     */
    public function __construct(Tree $tree)
    {
        $this->tree = $tree;
        $this->search_service = new SearchService(new TreeService(new GedcomImportService($this->tree)));
        $this->search_service = new SearchService(new TreeService(/** @scrutinizer ignore-call */ new GedcomImportService($this->tree)));
    }

    /**
     * We are only interested in text that begins with '@'.
     *
     * @return InlineParserMatch
     */
    public function getMatchDefinition(): InlineParserMatch
    {
        #This one permits escaping a # sign inside the text to be shown in the link and is ungreedy
        # so there can be more than one reference in one line
        return InlineParserMatch::regex('#(' . Gedcom::REGEX_UID . ')(?::(.+?[^\\\]))?#');

        // TESTED IN PHP 7.4
        //
        // #                  literal # (start ancor)
        // (                  start 1st capturing group
        // Gedcom::REGEX_UID  regex to match an UID
        // )                  end 1st capturing group
        // (?:                begin 1st non-capturing group
        //   :                a literal :
        //   (                start 2nd capturing group (without first :)
        //     .+?            any character one or more times NON GREEDY
        //     [^\\\]         any character that is not a \
        //   )                end 2nd capturing group
        // )                  end 1st non-capturing group
        // ?                  1st non-capturing group can be there or not
        // #                  literal # (end ancor)
    }

    private function firstMatchingUidRecord(String $pUid, Collection $pCollection): ?Object
    {
        foreach ($pCollection as $recTmp) {
            $regexTmp = '/\n1 _?UID ' . $pUid . '(:?\n|$)/';
            if (preg_match($regexTmp, $recTmp->gedcom())) {
                return $recTmp;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            }
        }

        return null;
    }

    /**
     * @param InlineParserContext $inlineContext
     *
     * @return bool
     */
    public function parse(InlineParserContext $inlineContext): bool
    {
        $cursor = $inlineContext->getCursor();
        $subm = $inlineContext->getSubMatches();
        $uid = [$subm[0]];
        $firstFoundRecord = null;

        if (isset($subm[1])) {
            #Unescape character's #

            #NOTE: It should use only one \\, but it's using two because it get's escaped again in the regex processing.
            $linkText = preg_replace("/\\\\#/", "#", $subm[1]);
        } else {
            $linkText = '';
        }

        // Do the search
        $result = new Collection();


        // Log search requests for visitors
        if (Auth::id() === null) {
            Log::addSearchLog('General: ' . $query, $search_trees->all());

        }

        $result = $this->search_service->searchIndividuals([$this->tree], $uid);
        $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        if ($firstFoundRecord === null) {

            $result = $this->search_service->searchFamilies([$this->tree], $uid);
            $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

            if ($firstFoundRecord === null) {

                $result = $this->search_service->searchFamilyNames([$this->tree], $uid);
                $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                if ($firstFoundRecord === null) {

                    $result = $this->search_service->searchRepositories([$this->tree], $uid);
                    $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                    if ($firstFoundRecord === null) {

                        $result = $this->search_service->searchSources([$this->tree], $uid);
                        $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                        if ($firstFoundRecord === null) {

                            $result = $this->search_service->searchNotes([$this->tree], $uid);
                            $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                            if ($firstFoundRecord === null) {

                                $result = $this->search_service->searchLocations([$this->tree], $uid);
                                $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                                if ($firstFoundRecord === null) {

                                    $result = $this->search_service->searchMedia([$this->tree], $uid);
                                    $firstFoundRecord = $this->firstMatchingUidRecord($uid[0], $result);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                                }
                            }
                        }
                    }
                }
            }
        }

        if ($firstFoundRecord === null) {

            return false;
        } else {
            $record = $firstFoundRecord;

            if ($record instanceof GedcomRecord) {
                $cursor->advanceBy($inlineContext->getFullMatchLength());

                $inlineContext->getContainer()->appendChild(new UidNode($record, $linkText));

                return true;
            }

            return false;
        }
    }
}

fisharebest / webtrees

Pull Request — main (#5145)

UidParser A

Complexity

Size/Duplication

Importance

4 Methods

Duplication Side-by-Side

Filter issues like
