Download.php 13.2 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
26
27
28
29
30
31
32
require_once(__DIR__ . '/../exceptions/DownloadException.php');
//require_once(__DIR__ . '/../Evaluate.php');
//require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
//

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

64
65
66
67
68
    /**
     * @var string Filename where to write download Information
     */
    private $downloadDebugLog = '';

Carsten  Rose's avatar
Carsten Rose committed
69
70
    /**
     * @param bool|false $phpUnit
71
     * @throws CodeException
72
     * @throws DbException
73
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
74
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
75
76
77
78
79
80
     */
    public function __construct($phpUnit = false) {

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

83
        if (Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_DOWNLOAD, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM))) {
84
85
            $this->downloadDebugLog = $this->store->getVar(SYSTEM_SQL_LOG, STORE_SYSTEM);
        }
Carsten  Rose's avatar
Carsten Rose committed
86
87
88
89
90
91
    }

    /**
     * Concatenate all named files to one PDF file. Return name of new full PDF.
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
92
     *
Carsten  Rose's avatar
Carsten Rose committed
93
     * @return string  - fileName of concatenated file
94
95
     * @throws UserFormException
     * @throws downloadException
Carsten  Rose's avatar
Carsten Rose committed
96
97
98
     */
    private function concatPdfFiles(array $files) {

99
100
101
        // Remove empty entries. Might happen if there was no upload
        $files = OnArray::removeEmptyElementsFromArray($files);

102
103
104
105
106
107
108
        // Check that all files exist and readable
        foreach ($files AS $filename) {
            if(!is_readable($filename)){
                throw new downloadException("Error reading file $filename. Not found or no permission", ERROR_DOWNLOAD_FILE_NOT_READABLE);
            }
        }

109
110
111
112
113
114
115
116
117
        switch (count($files)) {
            case 0:
                return '';
            case 1:
                return $files[0];
            default:
                break;
        }

118
119

        $concatFile = tempnam(sys_get_temp_dir(), TMP_FILE_PREFIX);
Carsten  Rose's avatar
Carsten Rose committed
120
121
122
123
124
125
126
127
        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') {
128
                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
129
130
131
132
133
134
135
136
137
138
139
140
            }
        }

        $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";

141
142
143
144
        if ($this->downloadDebugLog != '') {
            Logger::logMessage("Download: $cmd", $this->downloadDebugLog);
        }

Carsten  Rose's avatar
Carsten Rose committed
145
146
147
148
149
150
151
152
153
154
        exec($cmd, $output, $rc);

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

        return $concatFile;
    }

    /**
155
156
     * 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
157
     *
158
159
160
     * @param string $filename
     * @param string $outputFilename
     * @param string $rcMimetype
Carsten  Rose's avatar
Carsten Rose committed
161
     *
162
     * @return string possible updated $outputFilename, according the mimetype.
Carsten  Rose's avatar
Carsten Rose committed
163
     */
164
    private function targetFilenameExtension($filename, $outputFilename, &$rcMimetype) {
Carsten  Rose's avatar
Carsten Rose committed
165

166
        $rcMimetype = mime_content_type($filename);
167

168
169
170
171
172
173
        return $outputFilename;
    }

    /**
     * Set header type and output $filename. Be careful not to send any additional characters.
     *
174
     * @param $file
175
176
     * @param $outputFilename
     */
177
    private function outputFile($file, $outputFilename) {
178

179
        $length = filesize($file);
180

181
182
        $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.
183

Carsten  Rose's avatar
Carsten Rose committed
184
185
        header("Content-type: $mimetype");
        header("Content-Length: $length");
186
187
        // 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");
188
        header("Content-Disposition: inline; filename=\"$outputFilename\"; name=\"$outputFilename\"");
Carsten  Rose's avatar
Carsten Rose committed
189
190
        header("Pragma: no-cache");
        header("Expires: 0");
Carsten  Rose's avatar
Carsten Rose committed
191

192
        print file_get_contents($file);
Carsten  Rose's avatar
Carsten Rose committed
193
194
195
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
196
197
198
     * Interprets $element and fetches corresponding content as file.
     *
     * @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
199
     *
Carsten  Rose's avatar
Carsten Rose committed
200
     * @return string filename - already ready or fresh exported. Fresh exported needs to be deleted later.
Carsten  Rose's avatar
Carsten Rose committed
201
202
203
     * @throws DownloadException
     * @throws \exception
     */
Carsten  Rose's avatar
Carsten Rose committed
204
    private function getElement($element) {
Carsten  Rose's avatar
Carsten Rose committed
205

Carsten  Rose's avatar
Carsten Rose committed
206
207
208
209
        $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
210

Carsten  Rose's avatar
Carsten Rose committed
211
212
        $token = $arr[0];
        $value = $arr[1];
Carsten  Rose's avatar
Carsten Rose committed
213

Carsten  Rose's avatar
Carsten Rose committed
214
215
216
        switch ($token) {
            case TOKEN_URL:
            case TOKEN_URL_PARAM:
217
            case TOKEN_PAGE:
Carsten  Rose's avatar
Carsten Rose committed
218
219
                $filename = $this->html2pdf->page2pdf($token, $value);
                break;
Carsten  Rose's avatar
Carsten Rose committed
220

Carsten  Rose's avatar
Carsten Rose committed
221
            case TOKEN_FILE:
222
            case TOKEN_FILE_DEPRECATED:
Carsten  Rose's avatar
Carsten Rose committed
223
224
225
226
227
                $filename = $value;
                break;
            default:
                throw new DownloadException('Unknown token: "' . $token . '"', ERROR_UNKNOWN_TOKEN);
                break;
Carsten  Rose's avatar
Carsten Rose committed
228
229
230
231
232
        }

        return $filename;
    }

Carsten  Rose's avatar
Carsten Rose committed
233
234
235
236
237

    /**
     * Creates a ZIP Files of all given $files
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
238
     *
Carsten  Rose's avatar
Carsten Rose committed
239
240
241
242
243
     * @return string ZIP filename - has to be deleted later.
     * @throws DownloadException
     */
    private function zipFiles(array $files) {

244
        $zipFile = tempnam(sys_get_temp_dir(), TMP_FILE_PREFIX);
Carsten  Rose's avatar
Carsten Rose committed
245
246
247
248
249
250
        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
251
        if ($zip->open($zipFile, \ZipArchive::CREATE) !== true) {
Carsten  Rose's avatar
Carsten Rose committed
252
253
254
            throw new DownloadException("Error creating/opening new empty zip file: $zipFile", ERROR_IO_OPEN);
        }

255
        $len = strlen(TMP_FILE_PREFIX);
256
        $ii = 1;
Carsten  Rose's avatar
Carsten Rose committed
257
        foreach ($files AS $filename) {
258
259
            $localname = substr($filename, strrpos($filename, '/') + 1);

260
            if (substr($localname, 0, $len) == TMP_FILE_PREFIX) {
261
262
263
                $localname = 'file-' . $ii;
                $ii++;
            }
264
//            $localname = $this->targetFilenameExtension($filename, $localname, $mimetype);
265

Carsten  Rose's avatar
Carsten Rose committed
266
267
268
269
270
271
272
            $zip->addFile($filename, $localname);
        }
        $zip->close();

        return $zipFile;
    }

Carsten  Rose's avatar
Carsten Rose committed
273
274
    /**
     * exportFilename=<new filename>
275
     * mode=file | pdf | excel | thumbnail | monitor - default is 'file' in case of only one or 'pdf' in case of multiple sources.
Carsten  Rose's avatar
Carsten Rose committed
276
277
278
279
     * HTML to PDF | Excel
     *   <i>_id=<Typo3 pageId>
     *   <i>_<key>=<value i>
     * Direct
280
     *   <i>_file=<filename>
Carsten  Rose's avatar
Carsten Rose committed
281
     *
Carsten  Rose's avatar
Carsten Rose committed
282
     * @param array $vars [ DOWNLOAD_EXPORT_FILENAME, DOWNLOAD_MODE, SIP_DOWNLOAD_PARAMETER ]
Carsten  Rose's avatar
Carsten Rose committed
283
     *
284
285
286
     * @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
Carsten  Rose's avatar
Carsten Rose committed
287
     * @throws DownloadException
288
289
     * @throws UserFormException
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
290
     */
291
    private function doElements(array $vars, $outputMode) {
Carsten  Rose's avatar
Carsten Rose committed
292
293
294
295
296
297
298
299

        $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
300
        $downloadMode = $vars[DOWNLOAD_MODE];
301

302
303
        if($downloadMode == DOWNLOAD_MODE_MONITOR){
            $monitor = new Monitor();
Carsten  Rose's avatar
Carsten Rose committed
304
305

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

308
309
310
311
312
313
314
        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
315
        $elements = explode(PARAM_DELIMITER, $vars[SIP_DOWNLOAD_PARAMETER]);
Carsten  Rose's avatar
Carsten Rose committed
316

Carsten  Rose's avatar
Carsten Rose committed
317
        // Get all files
Carsten  Rose's avatar
Carsten Rose committed
318
        foreach ($elements as $element) {
Carsten  Rose's avatar
Carsten Rose committed
319
            $tmpFiles[] = $this->getElement($element);
Carsten  Rose's avatar
Carsten Rose committed
320
321
        }

Carsten  Rose's avatar
Carsten Rose committed
322
323
324
325
        // Export, Concat File(s)
        switch ($downloadMode) {
            case DOWNLOAD_MODE_ZIP:
                $filename = $this->zipFiles($tmpFiles);
326
327
328
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                }
Carsten  Rose's avatar
Carsten Rose committed
329
330
331
332
                break;

            case DOWNLOAD_MODE_EXCEL:
                throw new DownloadException("Not implemented: $downloadMode", ERROR_NOT_IMPLEMENTED);
Carsten  Rose's avatar
Carsten Rose committed
333
334
                break;

Carsten  Rose's avatar
Carsten Rose committed
335
            case DOWNLOAD_MODE_FILE:
Carsten  Rose's avatar
Carsten Rose committed
336
                $filename = $tmpFiles[0];
337
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
338
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
339
                }
Carsten  Rose's avatar
Carsten Rose committed
340
                break;
Carsten  Rose's avatar
Carsten Rose committed
341
342

            case DOWNLOAD_MODE_PDF:
Carsten  Rose's avatar
Carsten Rose committed
343
                $filename = $this->concatPdfFiles($tmpFiles);
344
345
346
347
348
349
350
351
352
353
354
355
                // 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
356
357
358
359
                break;

            default:
                throw new DownloadException("Unknown downloadMode: $downloadMode", ERROR_UNKNOWN_MODE);
Carsten  Rose's avatar
Carsten Rose committed
360
361
362
                break;
        }

363
364
365
366
367
368
        switch ($outputMode) {

            case OUTPUT_MODE_FILE:
                break;

            case OUTPUT_MODE_DIRECT:
369
                $this->outputFile($filename, $vars[DOWNLOAD_EXPORT_FILENAME]);
370
371
                HelperFile::cleanTempFiles([$filename]);
                break;
Carsten  Rose's avatar
Carsten Rose committed
372

373
374
375
376
377
            default:
                throw new CodeException('Unkown mode: ' . $outputMode, ERROR_UNKNOWN_MODE);
        }

        return $filename;
Carsten  Rose's avatar
Carsten Rose committed
378
379
    }

380
381
382
    /**
     * @param string $urlParam
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
383
     * @throws CodeException
384
     * @throws UserFormException
385
386
387
388
389
390
391
392
393
394
     * @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
395
    /**
396
397
398
399
400
     * 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
401
402
     * @return string
     * @throws CodeException
403
     * @throws DownloadException
Carsten  Rose's avatar
Carsten Rose committed
404
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
405
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
406
     */
407
    public function process($vars, $outputMode = OUTPUT_MODE_DIRECT) {
Carsten  Rose's avatar
Carsten Rose committed
408

409
410
411
        if (!is_array($vars)) {
            $vars = $this->store->getStore(STORE_SIP);
        }
412

413
        return $this->doElements($vars, $outputMode);
Carsten  Rose's avatar
Carsten Rose committed
414
415
    }

416
}
Carsten  Rose's avatar
Carsten Rose committed
417