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