xref: /webtrees/app/Http/RequestHandlers/ImportGedcomAction.php (revision 9dbe88c8839f889b89677b4a4ac4452b2a00d557)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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    /**
51     * @param StreamFactoryInterface $stream_factory
52     * @param TreeService            $tree_service
53     */
54    public function __construct(StreamFactoryInterface $stream_factory, TreeService $tree_service)
55    {
56        $this->tree_service   = $tree_service;
57        $this->stream_factory = $stream_factory;
58    }
59
60    /**
61     * @param ServerRequestInterface $request
62     *
63     * @return ResponseInterface
64     * @throws FilesystemException
65     * @throws UnableToReadFile
66     */
67    public function handle(ServerRequestInterface $request): ResponseInterface
68    {
69        $tree = Validator::attributes($request)->tree();
70
71        $data_filesystem = Registry::filesystem()->data();
72
73        $params             = (array) $request->getParsedBody();
74        $source             = $params['source'];
75        $keep_media         = (bool) ($params['keep_media'] ?? false);
76        $WORD_WRAPPED_NOTES = (bool) ($params['WORD_WRAPPED_NOTES'] ?? false);
77        $GEDCOM_MEDIA_PATH  = $params['GEDCOM_MEDIA_PATH'];
78        $encoding           = $params['encoding'] ?? '';
79
80        // Save these choices as defaults
81        $tree->setPreference('keep_media', $keep_media ? '1' : '0');
82        $tree->setPreference('WORD_WRAPPED_NOTES', $WORD_WRAPPED_NOTES ? '1' : '0');
83        $tree->setPreference('GEDCOM_MEDIA_PATH', $GEDCOM_MEDIA_PATH);
84
85        if ($source === 'client') {
86            $upload = $request->getUploadedFiles()['tree_name'] ?? null;
87
88            if ($upload === null || $upload->getError() !== UPLOAD_ERR_OK) {
89                throw new FileUploadException($upload);
90            }
91
92            $this->tree_service->importGedcomFile($tree, $upload->getStream(), basename($upload->getClientFilename()), $encoding);
93        }
94
95        if ($source === 'server') {
96            $basename = basename($params['tree_name'] ?? '');
97
98            if ($basename) {
99                $resource = $data_filesystem->readStream($basename);
100                $stream   = $this->stream_factory->createStreamFromResource($resource);
101                $this->tree_service->importGedcomFile($tree, $stream, $basename, $encoding);
102            } else {
103                FlashMessages::addMessage(I18N::translate('No GEDCOM file was received.'), 'danger');
104            }
105        }
106
107        $url = route(ManageTrees::class, ['tree' => $tree->name()]);
108
109        return redirect($url);
110    }
111}
112