Download.php 15.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
18

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

Carsten  Rose's avatar
Carsten Rose committed
29
30
31
32
33
34
35
//require_once(__DIR__ . '/../Evaluate.php');
//require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
//

/**
 * Class Download
 *
36
37
 * Documentation: PROTOCOL.md >> Download
 *
Carsten  Rose's avatar
Carsten Rose committed
38
39
40
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
 * 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;

67
68
69
70
71
    /**
     * @var string Filename where to write download Information
     */
    private $downloadDebugLog = '';

72
73
74
75
76
    /**
     * @var string DOWNLOAD_OUTPUT_FORMAT_RAW | DOWNLOAD_OUTPUT_FORMAT_JSON
     */
    private $outputFormat = DOWNLOAD_OUTPUT_FORMAT_RAW;

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

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

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

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

107
108
109
        // Remove empty entries. Might happen if there was no upload
        $files = OnArray::removeEmptyElementsFromArray($files);

110
111
        // Check that all files exist and readable
        foreach ($files AS $filename) {
112
            if (!is_readable($filename)) {
113
114
115
116
                throw new downloadException("Error reading file $filename. Not found or no permission", ERROR_DOWNLOAD_FILE_NOT_READABLE);
            }
        }

117
118
119
120
121
122
123
124
125
        switch (count($files)) {
            case 0:
                return '';
            case 1:
                return $files[0];
            default:
                break;
        }

126
        $concatFile = HelperFile::tempnam();
Carsten  Rose's avatar
Carsten Rose committed
127
128
129
130
131
132
133
134
        if (false === $concatFile) {
            throw new DownloadException('Error creating output file.', ERROR_DOWNLOAD_CREATE_NEW_FILE);
        }

        // Check that all files are of type 'application/pdf'
        foreach ($files AS $filename) {
            $mimetype = mime_content_type($filename);
            if ($mimetype != 'application/pdf') {
135
                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
136
137
138
139
140
141
142
143
144
145
146
147
            }
        }

        $files = OnArray::arrayEscapeshellarg($files);

        $inputFiles = implode(' ', $files);
        if (trim($inputFiles) == '') {
            throw new DownloadException('No files to concatenate.', ERROR_DOWNLOAD_NO_FILES);
        }

        $cmd = "pdftk $inputFiles cat output $concatFile";

148
149
150
151
        if ($this->downloadDebugLog != '') {
            Logger::logMessage("Download: $cmd", $this->downloadDebugLog);
        }

Carsten  Rose's avatar
Carsten Rose committed
152
153
154
155
156
157
158
159
160
161
        exec($cmd, $output, $rc);

        if ($rc != 0) {
            throw new DownloadException ("<p>Failed: RC=$rc   $cmd</p>" . implode("<br>", $output));
        }

        return $concatFile;
    }

    /**
162
163
     * 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
164
     *
165
166
167
     * @param string $filename
     * @param string $outputFilename
     * @param string $rcMimetype
Carsten  Rose's avatar
Carsten Rose committed
168
     *
169
     * @return string possible updated $outputFilename, according the mimetype.
Carsten  Rose's avatar
Carsten Rose committed
170
     */
171
    private function targetFilenameExtension($filename, $outputFilename, &$rcMimetype) {
Carsten  Rose's avatar
Carsten Rose committed
172

173
        $rcMimetype = mime_content_type($filename);
174

175
176
177
178
179
180
        return $outputFilename;
    }

    /**
     * Set header type and output $filename. Be careful not to send any additional characters.
     *
181
     * @param $file
182
183
     * @param $outputFilename
     */
184
    private function outputFile($file, $outputFilename) {
185

186
        $length = filesize($file);
187

188
189
        $outputFilename = $this->targetFilenameExtension($file, $outputFilename, $mimetype);
        $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.
190

Carsten  Rose's avatar
Carsten Rose committed
191
192
        header("Content-type: $mimetype");
        header("Content-Length: $length");
193
194
        // 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");
195
        header("Content-Disposition: inline; filename=\"$outputFilename\"; name=\"$outputFilename\"");
Carsten  Rose's avatar
Carsten Rose committed
196
197
        header("Pragma: no-cache");
        header("Expires: 0");
Carsten  Rose's avatar
Carsten Rose committed
198

199
200
201
202
203
        if ($this->getOutputFormat() === DOWNLOAD_OUTPUT_FORMAT_JSON) {
            print json_encode([JSON_TEXT => file_get_contents($file)]);
        } else {
            print file_get_contents($file);
        }
Carsten  Rose's avatar
Carsten Rose committed
204
205
206
    }

    /**
207
     * Interprets $element and fetches corresponding content, either as a file or the content in a variable.
Carsten  Rose's avatar
Carsten Rose committed
208
209
     *
     * @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
210
     *
211
212
     * @param string $downloadMode - DOWNLOAD_MODE_EXCEL | ....
     * @param string $tmpData - With $downloadMod=DOWNLOAD_MODE_EXCEL, this contains the rendered code from the give T3 page.
Carsten  Rose's avatar
Carsten Rose committed
213
     * @return string filename - already ready or fresh exported. Fresh exported needs to be deleted later.
214
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
215
     * @throws DownloadException
216
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
217
     */
218
    private function getElement($element, $downloadMode, &$tmpData) {
Carsten  Rose's avatar
Carsten Rose committed
219

220
        $filename='';
Carsten  Rose's avatar
Carsten Rose committed
221
222
223
224
        $arr = explode(':', $element, 2);
        if (count($arr) != 2) {
            throw new DownloadException('Missing parameter for "' . $element . '"', ERROR_MISSING_REQUIRED_PARAMETER);
        }
Carsten  Rose's avatar
Carsten Rose committed
225

Carsten  Rose's avatar
Carsten Rose committed
226
227
        $token = $arr[0];
        $value = $arr[1];
Carsten  Rose's avatar
Carsten Rose committed
228

Carsten  Rose's avatar
Carsten Rose committed
229
230
231
        switch ($token) {
            case TOKEN_URL:
            case TOKEN_URL_PARAM:
232
            case TOKEN_PAGE:
233
234
235
236
237
238
239
                if ($downloadMode == DOWNLOAD_MODE_EXCEL) {

                    $baseUrl = $this->store->getVar(SYSTEM_BASE_URL, STORE_SYSTEM);
                    $tmpData = DownloadPage::getContent($value, $baseUrl);
                } else {
                    $filename = $this->html2pdf->page2pdf($token, $value);
                }
Carsten  Rose's avatar
Carsten Rose committed
240
                break;
Carsten  Rose's avatar
Carsten Rose committed
241

Carsten  Rose's avatar
Carsten Rose committed
242
            case TOKEN_FILE:
243
            case TOKEN_FILE_DEPRECATED:
Carsten  Rose's avatar
Carsten Rose committed
244
245
246
247
248
                $filename = $value;
                break;
            default:
                throw new DownloadException('Unknown token: "' . $token . '"', ERROR_UNKNOWN_TOKEN);
                break;
Carsten  Rose's avatar
Carsten Rose committed
249
250
251
252
253
        }

        return $filename;
    }

Carsten  Rose's avatar
Carsten Rose committed
254
255
256
257
258

    /**
     * Creates a ZIP Files of all given $files
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
259
     *
Carsten  Rose's avatar
Carsten Rose committed
260
261
262
263
264
     * @return string ZIP filename - has to be deleted later.
     * @throws DownloadException
     */
    private function zipFiles(array $files) {

265
        $zipFile = HelperFile::tempnam();
Carsten  Rose's avatar
Carsten Rose committed
266
267
268
269
270
271
        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
272
        if ($zip->open($zipFile, \ZipArchive::CREATE) !== true) {
Carsten  Rose's avatar
Carsten Rose committed
273
274
275
            throw new DownloadException("Error creating/opening new empty zip file: $zipFile", ERROR_IO_OPEN);
        }

276
        $len = strlen(TMP_FILE_PREFIX);
277
        $ii = 1;
Carsten  Rose's avatar
Carsten Rose committed
278
        foreach ($files AS $filename) {
279
            $localName = substr($filename, strrpos($filename, '/') + 1);
280

281
282
            if (substr($localName, 0, $len) == TMP_FILE_PREFIX) {
                $localName = 'file-' . $ii;
283
284
285
                $ii++;
            }

286
            $zip->addFile($filename, $localName);
Carsten  Rose's avatar
Carsten Rose committed
287
288
289
290
291
292
        }
        $zip->close();

        return $zipFile;
    }

Carsten  Rose's avatar
Carsten Rose committed
293
    /**
294
295
     * $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
296
297
298
299
     * HTML to PDF | Excel
     *   <i>_id=<Typo3 pageId>
     *   <i>_<key>=<value i>
     * Direct
300
     *   <i>_file=<filename>
Carsten  Rose's avatar
Carsten Rose committed
301
     *
Carsten  Rose's avatar
Carsten Rose committed
302
     * @param array $vars [ DOWNLOAD_EXPORT_FILENAME, DOWNLOAD_MODE, SIP_DOWNLOAD_PARAMETER ]
Carsten  Rose's avatar
Carsten Rose committed
303
     *
304
305
306
     * @param string $outputMode OUTPUT_MODE_DIRECT | OUTPUT_MODE_FILE
     * @return string            Filename of the generated file. The filename only points to a real existing filename with  $outputMode=OUTPUT_MODE_FILE
     * @throws CodeException
307
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
308
     * @throws DownloadException
309
310
     * @throws UserFormException
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
311
     */
312
    private function doElements(array $vars, $outputMode) {
Carsten  Rose's avatar
Carsten Rose committed
313
314
315
316
317
318
319
320

        $tmpFiles = array();

        $workDir = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
        if (!chdir($workDir)) {
            throw new DownloadException ("Error chdir($workDir)", ERROR_IO_CHDIR);
        }

Carsten  Rose's avatar
Carsten Rose committed
321
        $downloadMode = $vars[DOWNLOAD_MODE];
322

323
        if ($downloadMode == DOWNLOAD_MODE_MONITOR) {
324
            $monitor = new Monitor();
Carsten  Rose's avatar
Carsten Rose committed
325
326

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

329
330
331
332
333
334
335
        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
336
        $elements = explode(PARAM_DELIMITER, $vars[SIP_DOWNLOAD_PARAMETER]);
Carsten  Rose's avatar
Carsten Rose committed
337

338
339
        // Get all files / content
        $tmpData=array();
Carsten  Rose's avatar
Carsten Rose committed
340
        foreach ($elements as $element) {
341
342
343
344
345
            $data='';
            $tmpFiles[] = $this->getElement($element, $downloadMode, $data);
            if(!empty($data)){
                $tmpData[]=$data;
            }
Carsten  Rose's avatar
Carsten Rose committed
346
347
        }

Carsten  Rose's avatar
Carsten Rose committed
348
349
350
351
        // Export, Concat File(s)
        switch ($downloadMode) {
            case DOWNLOAD_MODE_ZIP:
                $filename = $this->zipFiles($tmpFiles);
352
353
354
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                }
Carsten  Rose's avatar
Carsten Rose committed
355
356
357
                break;

            case DOWNLOAD_MODE_EXCEL:
358
359
360
361
362
363
364
365
366
                $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
367
368
                break;

Carsten  Rose's avatar
Carsten Rose committed
369
            case DOWNLOAD_MODE_FILE:
Carsten  Rose's avatar
Carsten Rose committed
370
                $filename = $tmpFiles[0];
371
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
372
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
373
                }
Carsten  Rose's avatar
Carsten Rose committed
374
                break;
Carsten  Rose's avatar
Carsten Rose committed
375
376

            case DOWNLOAD_MODE_PDF:
377

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

380
381
382
383
384
385
386
387
388
389
390
391
                // 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
392
393
394
395
                break;

            default:
                throw new DownloadException("Unknown downloadMode: $downloadMode", ERROR_UNKNOWN_MODE);
Carsten  Rose's avatar
Carsten Rose committed
396
397
398
                break;
        }

399
400
401
402
403
404
        switch ($outputMode) {

            case OUTPUT_MODE_FILE:
                break;

            case OUTPUT_MODE_DIRECT:
405
                $this->outputFile($filename, $vars[DOWNLOAD_EXPORT_FILENAME]);
406
                HelperFile::cleanTempFiles([$filename]);
407
                $filename = '';
408
                break;
Carsten  Rose's avatar
Carsten Rose committed
409

410
411
412
413
414
            default:
                throw new CodeException('Unkown mode: ' . $outputMode, ERROR_UNKNOWN_MODE);
        }

        return $filename;
Carsten  Rose's avatar
Carsten Rose committed
415
416
    }

417
418
419
    /**
     * @param string $urlParam
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
420
     * @throws CodeException
421
     * @throws UserFormException
422
423
424
425
426
427
428
429
430
431
     * @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
432
    /**
433
434
435
436
437
     * Process download as requested in $vars. Output is either directly send to the browser, or a file which has to be deleted later.
     *
     * @param string|array $vars If $config is not an array, get values from STORE_SIP. If $config is an array, take it.
     * @param string $outputMode OUTPUT_MODE_DIRECT | OUTPUT_MODE_FILE
     *
Carsten  Rose's avatar
Carsten Rose committed
438
439
     * @return string
     * @throws CodeException
440
     * @throws DbException
441
     * @throws DownloadException
Carsten  Rose's avatar
Carsten Rose committed
442
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
443
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
444
     */
445
    public function process($vars, $outputMode = OUTPUT_MODE_DIRECT) {
Carsten  Rose's avatar
Carsten Rose committed
446

447
448
449
        if (!is_array($vars)) {
            $vars = $this->store->getStore(STORE_SIP);
        }
450

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

453
        return $this->doElements($vars, $outputMode);
Carsten  Rose's avatar
Carsten Rose committed
454
455
    }

456
457
458
459
460
461
462
463
464
465
466
467
468
    /**
     * @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;
    }
469
}
Carsten  Rose's avatar
Carsten Rose committed
470