ExportGedcomPage.php

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2026 webtrees development team
 *                    <http://webtrees.net>
 *
 * Fancy Research Links (webtrees custom module):
 * Copyright (C) 2022 Carmen Just
 *                    <https://justcarmen.nl>
 *
 * ExtendedImportExport (webtrees custom module):
 * Copyright (C) 2026 Markus Hemprich
 *                    <http://www.familienforschung-hemprich.de>
 *
 * 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/>.
 *
 * 
 * ExtendedImportExport
 *
 * A weebtrees(https://webtrees.net) 2.1 custom module for advanced GEDCOM import, export
 * and filter operations. The module also supports remote downloads/uploads via URL requests.
 * 
 */

declare(strict_types=1);

namespace Jefferson49\Webtrees\Module\ExtendedImportExport;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Encodings\UTF8;
use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\Http\RequestHandlers\HomePage;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Services\AdminService;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\TreeService;
use Fisharebest\Webtrees\Validator;
use Jefferson49\Webtrees\Internationalization\MoreI18N;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

use function e;

/**
 * Import a GEDCOM file into a tree.
 */
class ExportGedcomPage implements RequestHandlerInterface
{
    use ViewResponseTrait;

    private AdminService  $admin_service;
    private ModuleService $module_service;
    private TreeService   $tree_service;


    /**
     * @param AdminService $admin_service
     */
    public function __construct(AdminService $admin_service, ModuleService $module_service, TreeService $tree_service)
    {
        $this->admin_service  = $admin_service;
        $this->module_service = $module_service;
        $this->tree_service   = $tree_service;
    }

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

        /** @var DownloadGedcomWithURL $download_gedcom_with_url */
        $download_gedcom_with_url = $this->module_service->findByName(DownloadGedcomWithURL::activeModuleName());

        $tree_name             = Validator::queryParams($request)->string('tree_name', '');
        $tree                  = $this->tree_service->all()[$tree_name] ?? null;

        $export_clippings_cart = Validator::queryParams($request)->boolean('export_clippings_cart', false);
        $GEDBAS_Id             = Validator::queryParams($request)->string('GEDBAS_Id', '');
        $GEDBAS_description    = Validator::queryParams($request)->string('GEDBAS_description', '');
        $GEDBAS_title          = Validator::queryParams($request)->string('GEDBAS_title', '');
        $gedcom_filter1        = Validator::queryParams($request)->string('gedcom_filter1', MoreI18N::xlate('None'));
        $gedcom_filter2        = Validator::queryParams($request)->string('gedcom_filter2', MoreI18N::xlate('None'));
        $gedcom_filter3        = Validator::queryParams($request)->string('gedcom_filter3', MoreI18N::xlate('None'));
        $filename              = Validator::queryParams($request)->string('filename', $export_clippings_cart ? 'clippings' : ($tree instanceof Tree ? $tree->name() : ''));
        $action                = Validator::queryParams($request)->string('action', DownloadGedcomWithURL::ACTION_DOWNLOAD);
        $format                = Validator::queryParams($request)->string('format', $download_gedcom_with_url->getPreference(DownloadGedcomWithURL::PREF_DEFAULT_EXPORT_FORMAT, 'gedcom'));
        $privacy               = Validator::queryParams($request)->string('privacy', $download_gedcom_with_url->getPreference(DownloadGedcomWithURL::PREF_DEFAULT_PRIVACY_LEVEL, 'visitor'));
        $encoding              = Validator::queryParams($request)->string('encoding', $download_gedcom_with_url->getPreference(DownloadGedcomWithURL::PREF_DEFAULT_ENCODING,  UTF8::NAME));
        $endings               = Validator::queryParams($request)->string('endings', $download_gedcom_with_url->getPreference(DownloadGedcomWithURL::PREF_DEFAULT_ENDING, 'CRLF'));
        $time_stamp            = Validator::queryParams($request)->string('time_stamp', $download_gedcom_with_url->getPreference(DownloadGedcomWithURL::PREF_DEFAULT_TIME_STAMP, DownloadGedcomWithURL::TIME_STAMP_NONE));

        //If current user is no admin, return to the home page
        if (!Auth::isAdmin()) { 
            FlashMessages::addMessage(I18N::translate('Access denied. The user needs to be an administrator.'), 'danger');
            return redirect(route(HomePage::class));
        }

        //If no tree access
        if ($tree === null) {
            FlashMessages::addMessage(I18N::translate('The current user does not have sufficient rights to access trees with the custom module %s.', $download_gedcom_with_url->title()), 'danger');	
            return redirect(route(HomePage::class));
        }

        //Load Gedcom filters
        try {
            DownloadGedcomWithURL::loadGedcomFilterClasses();
        }
        catch (DownloadGedcomWithUrlException $ex) {
            FlashMessages::addMessage($ex->getMessage(), 'danger');
        }       

        $gedcom_filter_list = $download_gedcom_with_url->getGedcomFilterList();

        $title = $export_clippings_cart ? MoreI18N::xlate('Clippings cart') . ' — ' : '';
        $title .= e($tree->title());

        return $this->viewResponse(
            DownloadGedcomWithURL::viewsNamespace() . '::export',
            [
                'title'                 => I18N::translate('Extended GEDCOM Export') . ' — ' . $title,
                'tree'                  => $tree,
                'export_clippings_cart' => $export_clippings_cart,
                'filename'              => $filename,
                'zip_available'         => extension_loaded('zip'),
                'action'                => $action,
                'format'                => $format,
                'privacy'               => $privacy,
                'encoding'              => $encoding,
                'endings'               => $endings,
                'time_stamp'            => $time_stamp,
                'GEDBAS_Id'             => $GEDBAS_Id,
                'GEDBAS_title'          => $GEDBAS_title,
                'GEDBAS_description'    => $GEDBAS_description,
                'gedcom_filter_list'    => $gedcom_filter_list,
                'gedcom_filter1'        => $gedcom_filter1,
                'gedcom_filter2'        => $gedcom_filter2,
                'gedcom_filter3'        => $gedcom_filter3,
            ]
        );
    }
}