Download.php 20.1 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
2
3
4
5
6
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 4/17/17
 * Time: 11:32 AM
Carsten  Rose's avatar
Carsten Rose committed
7
8
 *
 * Check: CODING.md > Download
Carsten  Rose's avatar
Carsten Rose committed
9
10
11
12
 */

namespace qfq;

13
//use TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;
Carsten  Rose's avatar
Carsten Rose committed
14
15
16
17

require_once(__DIR__ . '/../Constants.php');
require_once(__DIR__ . '/../store/Session.php');
require_once(__DIR__ . '/../store/Store.php');
18
require_once(__DIR__ . '/../store/Sip.php');
Carsten  Rose's avatar
Carsten Rose committed
19
require_once(__DIR__ . '/../helper/OnArray.php');
20
require_once(__DIR__ . '/../helper/OnString.php');
21
require_once(__DIR__ . '/../helper/Logger.php');
22
require_once(__DIR__ . '/../helper/Sanitize.php');
23
require_once(__DIR__ . '/../helper/HelperFile.php');
Carsten  Rose's avatar
Carsten Rose committed
24
require_once(__DIR__ . '/../report/Html2Pdf.php');
25
require_once(__DIR__ . '/Thumbnail.php');
Carsten  Rose's avatar
Carsten Rose committed
26
require_once(__DIR__ . '/Monitor.php');
Carsten  Rose's avatar
Carsten Rose committed
27
require_once(__DIR__ . '/../exceptions/DownloadException.php');
28
29
require_once(__DIR__ . '/Excel.php');
require_once(__DIR__ . '/../helper/DownloadPage.php');
30
require_once(__DIR__ . '/../QuickFormQuery.php');
31

Carsten  Rose's avatar
Carsten Rose committed
32
33
34
35
36
37
38
//require_once(__DIR__ . '/../Evaluate.php');
//require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
//

/**
 * Class Download
 *
39
40
 * Documentation: PROTOCOL.md >> Download
 *
Carsten  Rose's avatar
Carsten Rose committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 * Param: i=1..n
 *   <i>_mode=direct | html2pdf
 *   <i>_id=<pageId>
 *   <i>_<key i>=<value i>
 *
 * @package qfq
 */
class Download {

    /**
     * @var Store
     */
    private $store = null;

    /**
     * @var Session
     */
    private $session = null;

    /**
     * @var Database
     */
    private $db = null;

    /**
     * @var Html2Pdf
     */
    private $html2pdf = null;

70
71
72
73
74
    /**
     * @var string Filename where to write download Information
     */
    private $downloadDebugLog = '';

75
76
77
78
79
    /**
     * @var string DOWNLOAD_OUTPUT_FORMAT_RAW | DOWNLOAD_OUTPUT_FORMAT_JSON
     */
    private $outputFormat = DOWNLOAD_OUTPUT_FORMAT_RAW;

Carsten  Rose's avatar
Carsten Rose committed
80
81
    /**
     * @param bool|false $phpUnit
82
     * @throws CodeException
83
     * @throws DbException
84
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
85
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
86
87
88
89
90
91
     */
    public function __construct($phpUnit = false) {

        $this->session = Session::getInstance($phpUnit);
        $this->store = Store::getInstance('', $phpUnit);
        $this->db = new Database();
92
        $this->html2pdf = new Html2Pdf($this->store->getStore(STORE_SYSTEM), $phpUnit);
93

94
        if (Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_DOWNLOAD, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM))) {
95
96
            $this->downloadDebugLog = $this->store->getVar(SYSTEM_SQL_LOG, STORE_SYSTEM);
        }
Carsten  Rose's avatar
Carsten Rose committed
97
98
99
100
101
102
    }

    /**
     * Concatenate all named files to one PDF file. Return name of new full PDF.
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
103
     *
Carsten  Rose's avatar
Carsten Rose committed
104
     * @return string  - fileName of concatenated file
105
     * @throws CodeException
106
     * @throws DownloadException
107
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
108
109
110
     */
    private function concatPdfFiles(array $files) {

111
112
113
        // Remove empty entries. Might happen if there was no upload
        $files = OnArray::removeEmptyElementsFromArray($files);

Carsten  Rose's avatar
Carsten Rose committed
114
        // Check that all files exist and are readable
115
        foreach ($files AS $filename) {
116
            if (!is_readable($filename)) {
117
                throw new DownloadException("Error reading file $filename. Not found or no permission", ERROR_DOWNLOAD_FILE_NOT_READABLE);
118
119
120
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
121
122
123
        if (count($files) === 0) {
            return '';
        }
124

Carsten  Rose's avatar
Carsten Rose committed
125
126
127
128
        // Check that all files are of type 'application/pdf'
        foreach ($files AS $filename) {
            $mimetype = mime_content_type($filename);
            if ($mimetype != 'application/pdf') {
129
                throw new DownloadException("Error concat file $filename. Mimetype 'application/pdf' expected, got: $mimetype", ERROR_DOWNLOAD_UNEXPECTED_MIME_TYPE);
Carsten  Rose's avatar
Carsten Rose committed
130
131
132
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
133
134
135
        if (count($files) == 1) {
            return $files[0];
        }
Carsten  Rose's avatar
Carsten Rose committed
136

Carsten  Rose's avatar
Carsten Rose committed
137
        $files = OnArray::arrayEscapeshellarg($files);
Carsten  Rose's avatar
Carsten Rose committed
138
139
140
141
142
        $inputFiles = implode(' ', $files);
        if (trim($inputFiles) == '') {
            throw new DownloadException('No files to concatenate.', ERROR_DOWNLOAD_NO_FILES);
        }

Carsten  Rose's avatar
Carsten Rose committed
143
144
145
146
147
148
        // Need to create a separate result file, even if it is just a single file (#6929)
        $concatFile = HelperFile::tempnam();
        if (false === $concatFile) {
            throw new DownloadException('Error creating output file.', ERROR_DOWNLOAD_CREATE_NEW_FILE);
        }

149
150
151
//        $cmd = "pdftk $inputFiles cat output $concatFile 2>&1";  # Outdated. Hard to install on Ubuntu 18. Fails for recent PDFs.
//        $cmd = "qpdf --empty --pages $inputFiles -- $concatFile 2>&1"; # Fails to merge identical files, if they contain references.
        $cmd = "pdfunite $inputFiles $concatFile 2>&1"; // Based on poppler. URLs are preserved. Orientation and size are preserved.
Carsten  Rose's avatar
Carsten Rose committed
152

153
154
155
156
        if ($this->downloadDebugLog != '') {
            Logger::logMessage("Download: $cmd", $this->downloadDebugLog);
        }

Carsten  Rose's avatar
Carsten Rose committed
157
158
159
        exec($cmd, $output, $rc);

        if ($rc != 0) {
160
161
162
            throw new DownloadException (json_encode([ERROR_MESSAGE_TO_USER => "Failed to merge PDF file",
                    ERROR_MESSAGE_TO_DEVELOPER => "CMD: " . $cmd . "<br>RC: $rc<br>Output: " . implode("<br>", $output)])
                , ERROR_DOWNLOAD_MERGE_FAILED);
Carsten  Rose's avatar
Carsten Rose committed
163
164
165
166
167
168
        }

        return $concatFile;
    }

    /**
169
170
     * Get the mimetype of $filename and store them in $rcMimetype.
     * Checks if the extension of $outputFilename fit's to the mimetype. If not, append the mimetype extension.
Carsten  Rose's avatar
Carsten Rose committed
171
     *
172
173
174
     * @param string $filename
     * @param string $outputFilename
     * @param string $rcMimetype
Carsten  Rose's avatar
Carsten Rose committed
175
     *
176
     * @return string possible updated $outputFilename, according the mimetype.
Carsten  Rose's avatar
Carsten Rose committed
177
     */
178
    private function targetFilenameExtension($filename, $outputFilename, &$rcMimetype) {
Carsten  Rose's avatar
Carsten Rose committed
179

180
        $rcMimetype = mime_content_type($filename);
181

182
183
184
185
186
187
        return $outputFilename;
    }

    /**
     * Set header type and output $filename. Be careful not to send any additional characters.
     *
188
     * @param $file
189
     * @param $outputFilename
190
     * @throws DownloadException
191
     */
192
    private function outputFile($file, $outputFilename) {
193

194
195
        $json = '';
        $flagJson = ($this->getOutputFormat() === DOWNLOAD_OUTPUT_FORMAT_JSON);
196

197
        $outputFilename = $this->targetFilenameExtension($file, $outputFilename, $mimeType);
198
        $outputFilename = Sanitize::safeFilename($outputFilename); // be sure that there are no problematic chars in the filename. E.g. MacOS X don't like spaces for downloads.
199

200
201
202
203
        if ($flagJson) {
            if (false === ($json = json_encode([JSON_TEXT => file_get_contents($file)]))) {
                throw new DownloadException(json_encode(
                    [ERROR_MESSAGE_TO_USER => 'Error converting to JSON',
Marc Egger's avatar
Marc Egger committed
204
                        ERROR_MESSAGE_TO_DEVELOPER => "json_last_error()=" . json_last_error() . ", File=" . $file]), ERROR_DOWNLOAD_JSON_CONVERT);
205
206
207
208
209
210
211
212
213
            }
            $length = strlen($json);

            $mimeType = 'application/json';
        } else {
            $length = filesize($file);
        }

        header("Content-type: $mimeType");
Carsten  Rose's avatar
Carsten Rose committed
214
        header("Content-Length: $length");
215
        if (!$flagJson) {
216
217
218
219
            // If defined as 'attachment': PDFs are not shown inside the browser (if user configured that). Instead, always a 'save as'-dialog appears (Chrome, FF)
            // header("Content-Disposition: attachment; filename=$outputFilename");
            header("Content-Disposition: inline; filename=\"$outputFilename\"; name=\"$outputFilename\"");
        }
Carsten  Rose's avatar
Carsten Rose committed
220
221
        header("Pragma: no-cache");
        header("Expires: 0");
Carsten  Rose's avatar
Carsten Rose committed
222

223
224
        if ($flagJson) {
            print $json;
225
        } else {
226
            readfile($file);
227
        }
Carsten  Rose's avatar
Carsten Rose committed
228
229
230
    }

    /**
231
     * Interprets $element and fetches corresponding content, either as a file or the content in a variable.
Carsten  Rose's avatar
Carsten Rose committed
232
233
     *
     * @param string $element - U:id=myExport&r=12, u:http://www.nzz.ch/issue?nr=21, f:fileadmin/sample.pdf
Carsten  Rose's avatar
Carsten Rose committed
234
     *
235
     * @param string $downloadMode - DOWNLOAD_MODE_EXCEL | ....
236
     * @param string $rcData - With $downloadMode=DOWNLOAD_MODE_EXCEL, this contains the rendered code from the given T3 page.
Carsten  Rose's avatar
Carsten Rose committed
237
     * @return string filename - already ready or fresh exported. Fresh exported needs to be deleted later.
238
     * @throws CodeException
239
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
240
     * @throws DownloadException
241
     * @throws UserFormException
242
     * @throws UserReportException
243
244
245
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
Carsten  Rose's avatar
Carsten Rose committed
246
     */
247
    private function getElement($element, $downloadMode, &$rcData) {
Carsten  Rose's avatar
Carsten Rose committed
248

249
250
251
252
        $filename = '';
        $rcArgs = array();
        $rcSipEncode = false;

Carsten  Rose's avatar
Carsten Rose committed
253
254
        $arr = explode(':', $element, 2);
        if (count($arr) != 2) {
255
256
            $possibleReason = ($element === '') ? 'If this is a download link, did you forget to include s:1?' : '';
            throw new DownloadException("Missing parameter for '$element'. $possibleReason", ERROR_MISSING_REQUIRED_PARAMETER);
Carsten  Rose's avatar
Carsten Rose committed
257
        }
Carsten  Rose's avatar
Carsten Rose committed
258

Carsten  Rose's avatar
Carsten Rose committed
259
260
        $token = $arr[0];
        $value = $arr[1];
261
262
263
264
265
        if ($token === TOKEN_UID) { // extract uid
            $uidParamsArr = explode('&', $value, 2);
            $uid = $uidParamsArr[0];
            $value = $uidParamsArr[1] ?? ''; // additional params
        }
Carsten  Rose's avatar
Carsten Rose committed
266

Carsten  Rose's avatar
Carsten Rose committed
267
268
269
        switch ($token) {
            case TOKEN_URL:
            case TOKEN_URL_PARAM:
270
            case TOKEN_PAGE:
271
            case TOKEN_UID:
272
273
274
275
276
277
                $urlParam = OnString::splitParam($value, $rcArgs, $rcSipEncode);
                $urlParamString = KeyValueStringParser::unparse($urlParam, '=', '&');
                if ($rcSipEncode) {
                    $sip = new Sip();
                    $urlParamString = $sip->queryStringToSip($urlParamString, RETURN_URL);
                }
278

279
                if ($downloadMode == DOWNLOAD_MODE_EXCEL) {
280
                    if ($token === TOKEN_UID) {
281
                        $rcData = $this->getEvaluatedBodytext($uid, $urlParam);
282
283
284
285
                    } else {
                        $baseUrl = $this->store->getVar(SYSTEM_BASE_URL, STORE_SYSTEM);
                        $rcData = DownloadPage::getContent($urlParamString, $baseUrl);
                    }
286
                } else {
287
288
289
290
291
                    if ($token === TOKEN_UID) {
                        // create tmp html document with bodytext
                        $htmlText = $this->getEvaluatedBodytext($uid, $urlParam);
                        $tmpFilename = HelperFile::tempnam() . '.html';

292
                        $tmpFile = fopen($tmpFilename, "w") or die('Cannot create file:  ' . $tmpFilename);
293
294
295
296
297
                        fwrite($tmpFile, $htmlText);
                        fclose($tmpFile);

                        $rcArgsString = KeyValueStringParser::unparse($rcArgs, '=', '&');
                        $url = Support::mergeUrlComponents('', $tmpFilename, $rcArgsString);
298
299
300
                        $filename = $this->html2pdf->page2pdf($token, $url);
                        HelperFile::cleanTempFiles([$tmpFilename]);

301
                    } else {
302
                        $filename = $this->html2pdf->page2pdf($token, $value);
303
                    }
304
                }
Carsten  Rose's avatar
Carsten Rose committed
305
                break;
Carsten  Rose's avatar
Carsten Rose committed
306

Carsten  Rose's avatar
Carsten Rose committed
307
            case TOKEN_FILE:
308
            case TOKEN_FILE_DEPRECATED:
Carsten  Rose's avatar
Carsten Rose committed
309
310
311
312
313
                $filename = $value;
                break;
            default:
                throw new DownloadException('Unknown token: "' . $token . '"', ERROR_UNKNOWN_TOKEN);
                break;
Carsten  Rose's avatar
Carsten Rose committed
314
315
316
317
318
        }

        return $filename;
    }

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
    /**
     * @param $uid
     * @param array $urlParam
     *
     * @return string
     * @throws CodeException
     * @throws DbException
     * @throws DownloadException
     * @throws UserFormException
     * @throws UserReportException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
     */
    private function getEvaluatedBodyText($uid, $urlParam) {
334
        foreach ($urlParam as $key => $paramValue) {
335
336
337
            $this->store->setVar($key, $paramValue, STORE_SIP);
        }

338
        $dbT3 = $this->store->getVar(SYSTEM_DB_NAME_T3, STORE_SYSTEM);
339
340
341
        $sql = "SELECT bodytext FROM $dbT3.tt_content WHERE uid = ?";
        $tt_content = $this->db->sql($sql, ROW_EXPECT_1, [$uid]);

342
        $qfq = new QuickFormQuery([T3DATA_BODYTEXT => $tt_content[T3DATA_BODYTEXT]], false, false);
343
344
345
346
        return $qfq->process();

    }

Carsten  Rose's avatar
Carsten Rose committed
347
348
349
350
351

    /**
     * Creates a ZIP Files of all given $files
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
352
     *
Carsten  Rose's avatar
Carsten Rose committed
353
354
355
356
357
     * @return string ZIP filename - has to be deleted later.
     * @throws DownloadException
     */
    private function zipFiles(array $files) {

358
        $zipFile = HelperFile::tempnam();
Carsten  Rose's avatar
Carsten Rose committed
359
360
361
362
363
364
        if (false === $zipFile) {
            throw new DownloadException("Error creating output file.", ERROR_DOWNLOAD_CREATE_NEW_FILE);
        }

        $zip = new \ZipArchive();

Carsten  Rose's avatar
Carsten Rose committed
365
        if ($zip->open($zipFile, \ZipArchive::CREATE) !== true) {
Carsten  Rose's avatar
Carsten Rose committed
366
367
368
            throw new DownloadException("Error creating/opening new empty zip file: $zipFile", ERROR_IO_OPEN);
        }

369
        $len = strlen(TMP_FILE_PREFIX);
370
        $ii = 1;
Carsten  Rose's avatar
Carsten Rose committed
371
        foreach ($files AS $filename) {
372
            $localName = substr($filename, strrpos($filename, '/') + 1);
373

374
375
            if (substr($localName, 0, $len) == TMP_FILE_PREFIX) {
                $localName = 'file-' . $ii;
376
377
378
                $ii++;
            }

379
            $zip->addFile($filename, $localName);
Carsten  Rose's avatar
Carsten Rose committed
380
381
382
383
384
385
        }
        $zip->close();

        return $zipFile;
    }

Carsten  Rose's avatar
Carsten Rose committed
386
    /**
387
388
     * $vars[DOWNLOAD_EXPORT_FILENAME] - Optional. '<new filename>'
     * $vars[DOWNLOAD_MODE] - Optional.  file | pdf | excel | thumbnail | monitor - default is a) 'file' in case of only one or b) 'pdf' in case of multiple sources.
Carsten  Rose's avatar
Carsten Rose committed
389
390
391
392
     * HTML to PDF | Excel
     *   <i>_id=<Typo3 pageId>
     *   <i>_<key>=<value i>
     * Direct
393
     *   <i>_file=<filename>
Carsten  Rose's avatar
Carsten Rose committed
394
     *
Carsten  Rose's avatar
Carsten Rose committed
395
     * @param array $vars [ DOWNLOAD_EXPORT_FILENAME, DOWNLOAD_MODE, SIP_DOWNLOAD_PARAMETER ]
Carsten  Rose's avatar
Carsten Rose committed
396
     *
Carsten  Rose's avatar
Carsten Rose committed
397
398
     * @param string $outputMode OUTPUT_MODE_DIRECT | OUTPUT_MODE_FILE | OUTPUT_MODE_COPY_TO_FILE
     * @return string            Filename of the generated file. The filename only points to a real existing filename with  $outputMode=OUTPUT_MODE_FILE | OUTPUT_MODE_COPY_TO_FILE
399
     * @throws CodeException
400
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
401
     * @throws DownloadException
402
403
     * @throws UserFormException
     * @throws UserReportException
404
405
406
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
Carsten  Rose's avatar
Carsten Rose committed
407
     */
408
    private function doElements(array $vars, $outputMode) {
Carsten  Rose's avatar
Carsten Rose committed
409
410
411
412

        $tmpFiles = array();

        $workDir = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
413
        HelperFile::chdir($workDir);
Carsten  Rose's avatar
Carsten Rose committed
414

Carsten  Rose's avatar
Carsten Rose committed
415
        $downloadMode = $vars[DOWNLOAD_MODE];
416

417
        if ($downloadMode == DOWNLOAD_MODE_MONITOR) {
418
            $monitor = new Monitor();
Carsten  Rose's avatar
Carsten Rose committed
419
420

            return $monitor->dump($vars[TOKEN_L_FILE], $vars[TOKEN_L_TAIL], $vars[TOKEN_L_APPEND]);
421
422
        }

423
424
425
426
427
428
429
        if ($downloadMode == DOWNLOAD_MODE_THUMBNAIL) {
            // Fake $vars control array.
            $pathFilenameThumbnail = $this->doThumbnail($vars[SIP_DOWNLOAD_PARAMETER]);
            $downloadMode = DOWNLOAD_MODE_FILE;
            $vars[SIP_DOWNLOAD_PARAMETER] = TOKEN_FILE . ':' . $pathFilenameThumbnail;
        }

Carsten  Rose's avatar
Carsten Rose committed
430
        $elements = explode(PARAM_DELIMITER, $vars[SIP_DOWNLOAD_PARAMETER]);
Carsten  Rose's avatar
Carsten Rose committed
431

432
        // Get all files / content
433
        $tmpData = array();
Carsten  Rose's avatar
Carsten Rose committed
434
        foreach ($elements as $element) {
435
            $data = '';
436
            $tmpFiles[] = $this->getElement($element, $downloadMode, $data);
437
438
            if (!empty($data)) {
                $tmpData[] = $data;
439
            }
Carsten  Rose's avatar
Carsten Rose committed
440
441
        }

Carsten  Rose's avatar
Carsten Rose committed
442
443
444
445
        // Export, Concat File(s)
        switch ($downloadMode) {
            case DOWNLOAD_MODE_ZIP:
                $filename = $this->zipFiles($tmpFiles);
446
447
448
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                }
Carsten  Rose's avatar
Carsten Rose committed
449
450
451
                break;

            case DOWNLOAD_MODE_EXCEL:
452
453
454
455
456
457
458
459
460
                $excel = new Excel();
                $filename = $excel->process($tmpFiles, $tmpData);
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    if (HelperFile::isQfqTemp($filename)) {
                        $vars[DOWNLOAD_EXPORT_FILENAME] = DOWNLOAD_OUTPUT_FILENAME . ".xlsx";
                    } else {
                        $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                    }
                }
Carsten  Rose's avatar
Carsten Rose committed
461
462
                break;

Carsten  Rose's avatar
Carsten Rose committed
463
            case DOWNLOAD_MODE_FILE:
Carsten  Rose's avatar
Carsten Rose committed
464
                $filename = $tmpFiles[0];
465
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
466
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
467
                }
Carsten  Rose's avatar
Carsten Rose committed
468
                break;
Carsten  Rose's avatar
Carsten Rose committed
469
470

            case DOWNLOAD_MODE_PDF:
471

Carsten  Rose's avatar
Carsten Rose committed
472
                $filename = $this->concatPdfFiles($tmpFiles);
473

474
475
476
477
478
479
480
481
482
483
484
485
                // try to find a meaningful filename
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    if (count($tmpFiles) > 1) {
                        $vars[DOWNLOAD_EXPORT_FILENAME] = DOWNLOAD_OUTPUT_FILENAME . ".pdf";
                    } else {
                        if (HelperFile::isQfqTemp($filename)) {
                            $vars[DOWNLOAD_EXPORT_FILENAME] = DOWNLOAD_OUTPUT_FILENAME . ".pdf";
                        } else {
                            $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                        }
                    }
                }
Carsten  Rose's avatar
Carsten Rose committed
486
487
488
489
                break;

            default:
                throw new DownloadException("Unknown downloadMode: $downloadMode", ERROR_UNKNOWN_MODE);
Carsten  Rose's avatar
Carsten Rose committed
490
491
492
                break;
        }

493
494
495
        if ($filename != '' && !file_exists($filename)) {
            throw new DownloadException(json_encode(
                [ERROR_MESSAGE_TO_USER => 'Can\'t read file',
Marc Egger's avatar
Marc Egger committed
496
                    ERROR_MESSAGE_TO_DEVELOPER => "File: $filename"]), ERROR_IO_FILE_EXIST);
497
498
        }

499
500
501
502
503
        switch ($outputMode) {

            case OUTPUT_MODE_FILE:
                break;

Carsten  Rose's avatar
Carsten Rose committed
504
505
506
507
508
            case OUTPUT_MODE_COPY_TO_FILE:
                HelperFile::copy($filename, $vars[DOWNLOAD_EXPORT_FILENAME]);
                HelperFile::cleanTempFiles([$filename]);
                break;

509
            case OUTPUT_MODE_DIRECT:
510
                $this->outputFile($filename, $vars[DOWNLOAD_EXPORT_FILENAME]);
511
                HelperFile::cleanTempFiles([$filename]);
512
                $filename = '';
513
                break;
Carsten  Rose's avatar
Carsten Rose committed
514

515
516
517
518
519
            default:
                throw new CodeException('Unkown mode: ' . $outputMode, ERROR_UNKNOWN_MODE);
        }

        return $filename;
Carsten  Rose's avatar
Carsten Rose committed
520
521
    }

522
523
524
    /**
     * @param string $urlParam
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
525
     * @throws CodeException
526
     * @throws UserFormException
527
528
529
530
531
532
533
534
535
536
     * @throws UserReportException
     */
    private function doThumbnail($urlParam) {

        $thumbnail = new Thumbnail();
        $pathFilenameThumbnail = $thumbnail->process($urlParam, THUMBNAIL_VIA_DOWNLOAD);

        return $pathFilenameThumbnail;
    }

Carsten  Rose's avatar
Carsten Rose committed
537
    /**
538
539
     * Process download as requested in $vars. Output is either directly send to the browser, or a file which has to be deleted later.
     *
540
     * @param string|array $vars - If $config is an array, take it, else get values from STORE_SIP
541
542
     * @param string $outputMode OUTPUT_MODE_DIRECT | OUTPUT_MODE_FILE
     *
Carsten  Rose's avatar
Carsten Rose committed
543
544
     * @return string
     * @throws CodeException
545
     * @throws DbException
546
     * @throws DownloadException
Carsten  Rose's avatar
Carsten Rose committed
547
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
548
     * @throws UserReportException
549
550
551
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
Carsten  Rose's avatar
Carsten Rose committed
552
     */
553
    public function process($vars, $outputMode = OUTPUT_MODE_DIRECT) {
Carsten  Rose's avatar
Carsten Rose committed
554

555
556
557
        if (!is_array($vars)) {
            $vars = $this->store->getStore(STORE_SIP);
        }
558

559
560
        $this->setOutputFormat(empty($vars[DOWNLOAD_OUTPUT_FORMAT]) ? DOWNLOAD_OUTPUT_FORMAT_RAW : $vars[DOWNLOAD_OUTPUT_FORMAT]);

561
        return $this->doElements($vars, $outputMode);
Carsten  Rose's avatar
Carsten Rose committed
562
563
    }

564
565
566
567
568
569
570
571
572
573
574
575
576
    /**
     * @param $outputFormat
     */
    private function setOutputFormat($outputFormat) {
        $this->outputFormat = $outputFormat;
    }

    /**
     * @return string - DOWNLOAD_OUTPUT_FORMAT_RAW | DOWNLOAD_OUTPUT_FORMAT_JSON
     */
    public function getOutputFormat() {
        return $this->outputFormat;
    }
577
}
Carsten  Rose's avatar
Carsten Rose committed
578