xref: /webtrees/app/Http/RequestHandlers/ExportGedcomServer.php (revision 2ebcf907ed34213f816592af04e6c160335d6311) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Tree;
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 assert;
36use function fclose;
37use function pathinfo;
38use function redirect;
39use function route;
40use function strtolower;
41
42use const PATHINFO_EXTENSION;
43
44/**
45 * Save a GEDCOM file on the server.
46 */
47class ExportGedcomServer implements RequestHandlerInterface
48{
49    use ViewResponseTrait;
50
51    private GedcomExportService $gedcom_export_service;
52
53    /**
54     * ExportGedcomServer constructor.
55     *
56     * @param GedcomExportService $gedcom_export_service
57     */
58    public function __construct(GedcomExportService $gedcom_export_service)
59    {
60        $this->gedcom_export_service = $gedcom_export_service;
61    }
62
63    /**
64     * @param ServerRequestInterface $request
65     *
66     * @return ResponseInterface
67     */
68    public function handle(ServerRequestInterface $request): ResponseInterface
69    {
70        $tree = $request->getAttribute('tree');
71        assert($tree instanceof Tree);
72
73        $data_filesystem = Registry::filesystem()->data();
74
75        $params = (array) $request->getParsedBody();
76
77        $filename = $params['filename'] ?? $tree->name();
78
79        // Force a ".ged" suffix
80        if (strtolower(pathinfo($filename, PATHINFO_EXTENSION)) !== 'ged') {
81            $filename .= '.ged';
82        }
83
84        try {
85            $resource = $this->gedcom_export_service->export($tree, true);
86            $data_filesystem->writeStream($filename, $resource);
87            fclose($resource);
88
89            /* I18N: %s is a filename */
90            FlashMessages::addMessage(I18N::translate('The family tree has been exported to %s.', Html::filename($filename)), 'success');
91        } catch (FilesystemException | UnableToWriteFile $ex) {
92            FlashMessages::addMessage(
93                I18N::translate('The file %s could not be created.', Html::filename($filename)) . '<hr><samp dir="ltr">' . $ex->getMessage() . '</samp>',
94                'danger'
95            );
96        }
97
98        $url = route(ManageTrees::class, ['tree' => $tree->name()]);
99
100        return redirect($url);
101    }
102}
103