xref: /webtrees/app/Http/RequestHandlers/ExportGedcomServer.php (revision 774eb6bada09fdd46a086fd31e84fd157a6351c4)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fisharebest\Webtrees\FlashMessages;
23use Fisharebest\Webtrees\Html;
24use Fisharebest\Webtrees\Http\ViewResponseTrait;
25use Fisharebest\Webtrees\I18N;
26use Fisharebest\Webtrees\Registry;
27use Fisharebest\Webtrees\Services\GedcomExportService;
28use Fisharebest\Webtrees\Validator;
29use League\Flysystem\FilesystemException;
30use League\Flysystem\UnableToWriteFile;
31use Psr\Http\Message\ResponseInterface;
32use Psr\Http\Message\ServerRequestInterface;
33use Psr\Http\Server\RequestHandlerInterface;
34
35use function fclose;
36use function pathinfo;
37use function redirect;
38use function route;
39use function strtolower;
40
41use const PATHINFO_EXTENSION;
42
43/**
44 * Save a GEDCOM file on the server.
45 */
46class ExportGedcomServer implements RequestHandlerInterface
47{
48    use ViewResponseTrait;
49
50    private GedcomExportService $gedcom_export_service;
51
52    /**
53     * @param GedcomExportService $gedcom_export_service
54     */
55    public function __construct(GedcomExportService $gedcom_export_service)
56    {
57        $this->gedcom_export_service = $gedcom_export_service;
58    }
59
60    /**
61     * @param ServerRequestInterface $request
62     *
63     * @return ResponseInterface
64     */
65    public function handle(ServerRequestInterface $request): ResponseInterface
66    {
67        $tree = Validator::attributes($request)->tree();
68
69        $data_filesystem = Registry::filesystem()->data();
70
71        $filename = Validator::parsedBody($request)->string('filename');
72
73        // Force a ".ged" suffix
74        if (strtolower(pathinfo($filename, PATHINFO_EXTENSION)) !== 'ged') {
75            $filename .= '.ged';
76        }
77
78        try {
79            $resource = $this->gedcom_export_service->export($tree, true);
80            $data_filesystem->writeStream($filename, $resource);
81            fclose($resource);
82
83            /* I18N: %s is a filename */
84            FlashMessages::addMessage(I18N::translate('The family tree has been exported to %s.', Html::filename($filename)), 'success');
85        } catch (FilesystemException | UnableToWriteFile $ex) {
86            FlashMessages::addMessage(
87                I18N::translate('The file %s could not be created.', Html::filename($filename)) . '<hr><samp dir="ltr">' . $ex->getMessage() . '</samp>',
88                'danger'
89            );
90        }
91
92        $url = route(ManageTrees::class, ['tree' => $tree->name()]);
93
94        return redirect($url);
95    }
96}
97