fisharebest / webtrees

app/Http/RequestHandlers/DataFixPage.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\Http\RequestHandlers;

use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\I18N;

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

use Fisharebest\Webtrees\Module\ModuleDataFixInterface;
use Fisharebest\Webtrees\Services\ModuleService;

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

use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

use function e;
use function redirect;
use function route;

/**
 * Run a data-fix.
 */
class DataFixPage implements RequestHandlerInterface
{
    use ViewResponseTrait;

    private ModuleService $module_service;

    /**
     * @param ModuleService $module_service
     */
    public function __construct(ModuleService $module_service)
    {
        $this->module_service = $module_service;
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $tree = Validator::attributes($request)->tree();

        $data_fixes = $this->module_service->findByInterface(ModuleDataFixInterface::class, false, true);

        if ($data_fixes->isEmpty()) {
            return redirect(route('control-panel'));
        }

        $data_fix = Validator::attributes($request)->string('data_fix', '');
        $module   = $this->module_service->findByName($data_fix);

        $this->layout = 'layouts/administration';

        if ($module instanceof ModuleDataFixInterface) {
            $title       = $module->title() . ' — ' . e($tree->title());
            $page_url    = route(self::class, ['data_fix' => $data_fix, 'tree' => $tree->name()]);
            $pending_url = route(PendingChanges::class, ['tree' => $tree->name(), 'url' => $page_url]);

            return $this->viewResponse('admin/data-fix-page', [
                'data_fix'    => $module,
                'title'       => $title,
                'tree'        => $tree,
                'pending_url' => $pending_url,
            ]);
        }

        $title = I18N::translate('Data fixes') . ' — ' . e($tree->title());

        return $this->viewResponse('admin/data-fix-select', [
            'title'      => $title,
            'data_fixes' => $data_fixes,
            'tree'       => $tree,
        ]);
    }
}