Download.php 13.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
25
26
27
28
29
30
31
32
//require_once(__DIR__ . '/Sendmail.php');
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
75
76
77
78
79
     */
    public function __construct($phpUnit = false) {

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

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

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

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

101
102
103
104
105
106
107
        // 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);
            }
        }

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

117
118

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

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

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

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

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

        return $concatFile;
    }

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

165
        $rcMimetype = mime_content_type($filename);
166

167
168
169
170
171
172
        return $outputFilename;
    }

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

178
        $length = filesize($file);
179

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

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

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

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

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

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

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

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

        return $filename;
    }

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

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

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

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

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

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

        return $zipFile;
    }

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

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

301
302
303
304
305
        if($downloadMode == DOWNLOAD_MODE_MONITOR){
            $monitor = new Monitor();
            return $monitor->tailCustom($vars[TOKEN_L_FILE], $vars[TOKEN_L_TAIL]);
        }

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

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

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

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

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

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

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

361
362
363
364
365
366
        switch ($outputMode) {

            case OUTPUT_MODE_FILE:
                break;

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

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

        return $filename;
Carsten  Rose's avatar
Carsten Rose committed
376
377
    }

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

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

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

414
}
Carsten  Rose's avatar
Carsten Rose committed
415