fisharebest / webtrees

app/Services/PendingChangesService.php

<?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\Services;

use DateInterval;
use DateTimeImmutable;
use DateTimeZone;
use Fisharebest\Webtrees\Auth;

The type Fisharebest\Webtrees\Auth was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Contracts\TimestampInterface;
use Fisharebest\Webtrees\Contracts\UserInterface;

The type Fisharebest\Webtrees\Contracts\UserInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\DB;

The type Fisharebest\Webtrees\DB was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Exceptions\GedcomErrorException;
use Fisharebest\Webtrees\Family;

The type Fisharebest\Webtrees\Family was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\GedcomRecord;

The type Fisharebest\Webtrees\GedcomRecord was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Header;

The type Fisharebest\Webtrees\Header was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Individual;

The type Fisharebest\Webtrees\Individual was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Location;

The type Fisharebest\Webtrees\Location was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Media;

The type Fisharebest\Webtrees\Media was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Note;

The type Fisharebest\Webtrees\Note was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Repository;

The type Fisharebest\Webtrees\Repository was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Source;

The type Fisharebest\Webtrees\Source was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Submission;

The type Fisharebest\Webtrees\Submission was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Submitter;

The type Fisharebest\Webtrees\Submitter was not found. Maybe you did not declare it correctly or list all dependencies?

use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Query\Builder;
use Illuminate\Database\Query\Expression;
use Illuminate\Support\Collection;

use function addcslashes;
use function preg_match;

/**
 * Manage pending changes
 */
class PendingChangesService
{
    public function __construct(
        private readonly GedcomImportService $gedcom_import_service,
    ) {
    }

    public function pendingChangesExist(Tree|null $tree = null): bool
    {
        $query = DB::table(table: 'change')->where(column: 'status', operator: '=', value: 'pending');

        if ($tree instanceof Tree) {
            $query = $query->where(column: 'tree_id', operator: '=', value: $tree->id());
        }

        return $query->exists();
    }

    /**
     * @return Collection<int,string>
     */
    public function pendingXrefs(Tree $tree): Collection
    {
        return DB::table('change')
            ->where('status', '=', 'pending')
            ->where('gedcom_id', '=', $tree->id())
            ->orderBy('xref')
            ->groupBy(['xref'])
            ->pluck('xref');
    }

    /**
     * @return array<array<object{

The doc comment array<array<object{ at position 4 could not be parsed: Expected '>' at position 4, but found 'object'.

     *     xref:string,
     *     change_id:string,
     *     old_gedcom:string|null,
     *     new_gedcom:string|null,
     *     change_time:TimestampInterface,
     *     record:GedcomRecord,
     *     user_name:string,
     *     real_name:string
     * }>>
     */
    public function pendingChanges(Tree $tree, int $n): array
    {
        $xrefs = $this->pendingXrefs($tree);

        $rows = DB::table('change')
            ->join('user', 'user.user_id', '=', 'change.user_id')
            ->where('status', '=', 'pending')
            ->where('gedcom_id', '=', $tree->id())
            ->whereIn('xref', $xrefs->slice(0, $n))
            ->orderBy('change.change_id')
            ->select(['change.*', 'user.user_name', 'user.real_name'])
            ->get();

        $changes = [];

        $factories = [
            Individual::RECORD_TYPE => Registry::individualFactory(),
            Family::RECORD_TYPE     => Registry::familyFactory(),
            Source::RECORD_TYPE     => Registry::sourceFactory(),
            Repository::RECORD_TYPE => Registry::repositoryFactory(),
            Media::RECORD_TYPE      => Registry::mediaFactory(),
            Note::RECORD_TYPE       => Registry::noteFactory(),
            Submitter::RECORD_TYPE  => Registry::submitterFactory(),
            Submission::RECORD_TYPE => Registry::submissionFactory(),
            Location::RECORD_TYPE   => Registry::locationFactory(),
            Header::RECORD_TYPE     => Registry::headerFactory(),
        ];

        foreach ($rows as $row) {
            $row->change_time = Registry::timestampFactory()->fromString($row->change_time);

            preg_match('/^0 (?:@' . Gedcom::REGEX_XREF . '@ )?(' . Gedcom::REGEX_TAG . ')/', $row->old_gedcom . $row->new_gedcom, $match);

            $factory = $factories[$match[1]] ?? Registry::gedcomRecordFactory();

            $row->record = $factory->new($row->xref, $row->old_gedcom, $row->new_gedcom, $tree);

            $changes[$row->xref][] = $row;
        }

        return $changes;
    }

    public function acceptTree(Tree $tree, int $n): void
    {
        $xrefs = $this->pendingXrefs($tree);

        $changes = DB::table('change')
            ->where('gedcom_id', '=', $tree->id())
            ->where('status', '=', 'pending')
            ->whereIn('xref', $xrefs->slice(0, $n))
            ->orderBy('change_id')
            ->lockForUpdate()
            ->get();

        foreach ($changes as $change) {
            if ($change->new_gedcom === '') {
                // delete
                $this->gedcom_import_service->updateRecord($change->old_gedcom, $tree, true);
            } else {
                // add/update
                $this->gedcom_import_service->updateRecord($change->new_gedcom, $tree, false);
            }

            DB::table('change')
                ->where('change_id', '=', $change->change_id)
                ->update(['status' => 'accepted']);
        }
    }

    public function acceptRecord(GedcomRecord $record): void
    {
        $changes = DB::table('change')
            ->where('gedcom_id', '=', $record->tree()->id())
            ->where('xref', '=', $record->xref())
            ->where('status', '=', 'pending')
            ->orderBy('change_id')
            ->lockForUpdate()
            ->get();

        foreach ($changes as $change) {
            if ($change->new_gedcom === '') {
                // delete
                $this->gedcom_import_service->updateRecord($change->old_gedcom, $record->tree(), true);
            } else {
                // add/update
                $this->gedcom_import_service->updateRecord($change->new_gedcom, $record->tree(), false);
            }

            DB::table('change')
                ->where('change_id', '=', $change->change_id)
                ->update(['status' => 'accepted']);
        }
    }

    public function acceptChange(GedcomRecord $record, string $change_id): void
    {
        $changes = DB::table('change')
            ->where('gedcom_id', '=', $record->tree()->id())
            ->where('xref', '=', $record->xref())
            ->where('change_id', '<=', $change_id)
            ->where('status', '=', 'pending')
            ->orderBy('change_id')
            ->get();

        foreach ($changes as $change) {
            if ($change->new_gedcom === '') {
                // delete
                $this->gedcom_import_service->updateRecord($change->old_gedcom, $record->tree(), true);
            } else {
                // add/update
                $this->gedcom_import_service->updateRecord($change->new_gedcom, $record->tree(), false);
            }

            DB::table('change')
                ->where('change_id', '=', $change->change_id)
                ->update(['status' => 'accepted']);
        }
    }

    public function rejectTree(Tree $tree): void
    {
        DB::table('change')
            ->where('gedcom_id', '=', $tree->id())
            ->where('status', '=', 'pending')
            ->update(['status' => 'rejected']);
    }

    public function rejectChange(GedcomRecord $record, string $change_id): void
    {
        DB::table('change')
            ->where('gedcom_id', '=', $record->tree()->id())
            ->where('xref', '=', $record->xref())
            ->where('change_id', '>=', $change_id)
            ->where('status', '=', 'pending')
            ->update(['status' => 'rejected']);
    }

    public function rejectRecord(GedcomRecord $record): void
    {
        DB::table('change')
            ->where('gedcom_id', '=', $record->tree()->id())
            ->where('xref', '=', $record->xref())
            ->where('status', '=', 'pending')
            ->update(['status' => 'rejected']);
    }

    /**
     * @param array<string,string> $params
     */
    public function changesQuery(array $params): Builder
    {
        $tree     = $params['tree'];
        $from     = $params['from'] ?? '';
        $to       = $params['to'] ?? '';
        $type     = $params['type'] ?? '';
        $oldged   = $params['oldged'] ?? '';
        $newged   = $params['newged'] ?? '';
        $xref     = $params['xref'] ?? '';
        $username = $params['username'] ?? '';

        $query = DB::table('change')
            ->leftJoin('user', 'user.user_id', '=', 'change.user_id')
            ->join('gedcom', 'gedcom.gedcom_id', '=', 'change.gedcom_id')
            ->select(['change.*', new Expression("COALESCE(user_name, '<none>') AS user_name"), 'gedcom_name'])

'COALESCE(user_name, '<none>') AS user_name' of type string is incompatible with the type Illuminate\Database\Query\TValue expected by parameter $value of Illuminate\Database\Query\Expression::__construct().

            ->where('gedcom_name', '=', $tree);

        $tz  = new DateTimeZone(Auth::user()->getPreference(UserInterface::PREF_TIME_ZONE, 'UTC'));
        $utc = new DateTimeZone('UTC');

        if ($from !== '') {
            $from_time = DateTimeImmutable::createFromFormat('!Y-m-d', $from, $tz)
                ->setTimezone($utc)
                ->format('Y-m-d H:i:s');

            $query->where('change_time', '>=', $from_time);
        }

        if ($to !== '') {
            // before end of the day
            $to_time = DateTimeImmutable::createFromFormat('!Y-m-d', $to, $tz)
                ->add(new DateInterval('P1D'))
                ->setTimezone($utc)
                ->format('Y-m-d H:i:s');

            $query->where('change_time', '<', $to_time);
        }

        if ($type !== '') {
            $query->where('status', '=', $type);
        }

        if ($oldged !== '') {
            $query->where('old_gedcom', 'LIKE', '%' . addcslashes($oldged, '\\%_') . '%');
        }
        if ($newged !== '') {
            $query->where('new_gedcom', 'LIKE', '%' . addcslashes($newged, '\\%_') . '%');
        }

        if ($xref !== '') {
            $query->where('xref', '=', $xref);
        }

        if ($username !== '') {
            $query->where('user_name', 'LIKE', '%' . addcslashes($username, '\\%_') . '%');
        }

        return $query;
    }
}