xref: /webtrees/app/Http/RequestHandlers/ReportGenerate.php (revision 1558ebe91cf8aee21751e57fb864e4b0813c3468) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fig\Http\Message\StatusCodeInterface;
23use Fisharebest\Webtrees\Auth;
24use Fisharebest\Webtrees\Contracts\UserInterface;
25use Fisharebest\Webtrees\Factory;
26use Fisharebest\Webtrees\Http\ViewResponseTrait;
27use Fisharebest\Webtrees\I18N;
28use Fisharebest\Webtrees\Module\ModuleReportInterface;
29use Fisharebest\Webtrees\Report\HtmlRenderer;
30use Fisharebest\Webtrees\Report\PdfRenderer;
31use Fisharebest\Webtrees\Report\ReportParserGenerate;
32use Fisharebest\Webtrees\Services\ModuleService;
33use Fisharebest\Webtrees\Tree;
34use Psr\Http\Message\ResponseInterface;
35use Psr\Http\Message\ServerRequestInterface;
36use Psr\Http\Server\RequestHandlerInterface;
37
38use function addcslashes;
39use function assert;
40use function ob_get_clean;
41use function ob_start;
42use function redirect;
43use function response;
44use function route;
45
46/**
47 * Show all available reports.
48 */
49class ReportGenerate implements RequestHandlerInterface
50{
51    use ViewResponseTrait;
52
53    /**
54     * @var ModuleService
55     */
56    private $module_service;
57
58    /**
59     * ReportEngineController constructor.
60     *
61     * @param ModuleService $module_service
62     */
63    public function __construct(ModuleService $module_service)
64    {
65        $this->module_service = $module_service;
66    }
67
68    /**
69     * A list of available reports.
70     *
71     * @param ServerRequestInterface $request
72     *
73     * @return ResponseInterface
74     */
75    public function handle(ServerRequestInterface $request): ResponseInterface
76    {
77        $tree = $request->getAttribute('tree');
78        assert($tree instanceof Tree);
79
80        $user = $request->getAttribute('user');
81        assert($user instanceof UserInterface);
82
83        $data_filesystem = Factory::filesystem()->data();
84
85        $report = $request->getAttribute('report');
86        $module = $this->module_service->findByName($report);
87
88        if (!$module instanceof ModuleReportInterface) {
89            return redirect(route(ReportListPage::class, ['tree' => $tree->name()]));
90        }
91
92        Auth::checkComponentAccess($module, ModuleReportInterface::class, $tree, $user);
93
94        $varnames  = $request->getQueryParams()['varnames'] ?? [];
95        $vars      = $request->getQueryParams()['vars'] ?? [];
96        $variables = [];
97
98        foreach ($varnames as $name) {
99            $variables[$name]['id'] = $vars[$name] ?? '';
100        }
101
102        $xml_filename = $module->resourcesFolder() . $module->xmlFilename();
103
104        $format      = $request->getQueryParams()['format'] ?? '';
105        $destination = $request->getQueryParams()['destination'] ?? '';
106
107        $user->setPreference('default-report-destination', $destination);
108        $user->setPreference('default-report-format', $format);
109
110        switch ($format) {
111            default:
112            case 'HTML':
113                ob_start();
114                new ReportParserGenerate($xml_filename, new HtmlRenderer(), $variables, $tree, $data_filesystem);
115                $html = ob_get_clean();
116
117                $this->layout = 'layouts/report';
118
119                $response = $this->viewResponse('report-page', [
120                    'content' => $html,
121                    'title'   => I18N::translate('Report'),
122                ]);
123
124                if ($destination === 'download') {
125                    $response = $response->withHeader('Content-Disposition', 'attachment; filename="' . addcslashes($report, '"') . '.html"');
126                }
127
128                return $response;
129
130            case 'PDF':
131                ob_start();
132                new ReportParserGenerate($xml_filename, new PdfRenderer(), $variables, $tree, $data_filesystem);
133                $pdf = ob_get_clean();
134
135                $headers = ['Content-Type' => 'application/pdf'];
136
137                if ($destination === 'download') {
138                    $headers['Content-Disposition'] = 'attachment; filename="' . addcslashes($report, '"') . '.pdf"';
139                }
140
141                return response($pdf, StatusCodeInterface::STATUS_OK, $headers);
142        }
143    }
144}
145