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