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