xref: /webtrees/app/Factories/AbstractGedcomRecordFactory.php (revision 449b311ecf65f677a2595e1e29f712d11ef22f34)

<?php

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

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\DB;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Illuminate\Support\Collection;

use function str_starts_with;

/**
 * Make a GedcomRecord object.
 */
abstract class AbstractGedcomRecordFactory
{
    /**
     * @param Tree $tree
     *
     * @return Collection<array-key,string>
     */
    protected function pendingChanges(Tree $tree): Collection
    {
        // Only editors can see pending changes
        if (!Auth::isEditor($tree)) {
            return new Collection();
        }

        // Caution - this cache can be overwritten by GedcomExportService
        return Registry::cache()
            ->array()
            ->remember(self::class . $tree->id(), static fn (): Collection => DB::table('change')
                ->where('gedcom_id', '=', $tree->id())
                ->where('status', '=', 'pending')
                ->orderBy('change_id')
                ->pluck('new_gedcom', 'xref'));
    }

    /**
     * We may have searched for X123, but found the record for x123.
     *
     * @param string $gedcom
     * @param string $xref
     *
     * @return string
     */
    protected function extractXref(string $gedcom, string $xref): string
    {
        if (preg_match('/^0 @(' . Gedcom::REGEX_XREF . ')@/', $gedcom, $match)) {
            return $match[1];
        }

        if (str_starts_with($gedcom, '0 HEAD')) {
            return 'HEAD';
        }

        return $xref;
    }
}