xref: /webtrees/app/Http/RequestHandlers/ImportGedcomAction.php (revision 8f8787974040d069eb8daff5e2b4af725c6bd747)
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\Exceptions\FileUploadException;
23use Fisharebest\Webtrees\FlashMessages;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Registry;
26use Fisharebest\Webtrees\Services\TreeService;
27use Fisharebest\Webtrees\Validator;
28use League\Flysystem\FilesystemException;
29use League\Flysystem\UnableToReadFile;
30use Psr\Http\Message\ResponseInterface;
31use Psr\Http\Message\ServerRequestInterface;
32use Psr\Http\Message\StreamFactoryInterface;
33use Psr\Http\Server\RequestHandlerInterface;
34
35use function basename;
36use function redirect;
37use function route;
38
39use const UPLOAD_ERR_OK;
40
41/**
42 * Import a GEDCOM file into a tree.
43 */
44class ImportGedcomAction implements RequestHandlerInterface
45{
46    private StreamFactoryInterface $stream_factory;
47
48    private TreeService $tree_service;
49
50    public function __construct(StreamFactoryInterface $stream_factory, TreeService $tree_service)
51    {
52        $this->tree_service   = $tree_service;
53        $this->stream_factory = $stream_factory;
54    }
55
56    /**
57     * @param ServerRequestInterface $request
58     *
59     * @return ResponseInterface
60     * @throws FilesystemException
61     * @throws UnableToReadFile
62     */
63    public function handle(ServerRequestInterface $request): ResponseInterface
64    {
65        $tree = Validator::attributes($request)->tree();
66
67        $data_filesystem = Registry::filesystem()->data();
68
69        $params             = (array) $request->getParsedBody();
70        $source             = $params['source'];
71        $keep_media         = (bool) ($params['keep_media'] ?? false);
72        $WORD_WRAPPED_NOTES = (bool) ($params['WORD_WRAPPED_NOTES'] ?? false);
73        $GEDCOM_MEDIA_PATH  = $params['GEDCOM_MEDIA_PATH'];
74        $encoding           = $params['encoding'] ?? '';
75
76        // Save these choices as defaults
77        $tree->setPreference('keep_media', $keep_media ? '1' : '0');
78        $tree->setPreference('WORD_WRAPPED_NOTES', $WORD_WRAPPED_NOTES ? '1' : '0');
79        $tree->setPreference('GEDCOM_MEDIA_PATH', $GEDCOM_MEDIA_PATH);
80
81        if ($source === 'client') {
82            $upload = $request->getUploadedFiles()['tree_name'] ?? null;
83
84            if ($upload === null || $upload->getError() !== UPLOAD_ERR_OK) {
85                throw new FileUploadException($upload);
86            }
87
88            $this->tree_service->importGedcomFile($tree, $upload->getStream(), basename($upload->getClientFilename()), $encoding);
89        }
90
91        if ($source === 'server') {
92            $basename = basename($params['tree_name'] ?? '');
93
94            if ($basename) {
95                $resource = $data_filesystem->readStream($basename);
96                $stream   = $this->stream_factory->createStreamFromResource($resource);
97                $this->tree_service->importGedcomFile($tree, $stream, $basename, $encoding);
98            } else {
99                FlashMessages::addMessage(I18N::translate('No GEDCOM file was received.'), 'danger');
100            }
101        }
102
103        $url = route(ManageTrees::class, ['tree' => $tree->name()]);
104
105        return redirect($url);
106    }
107}
108