Download.php 12.5 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
72
     * @throws CodeException
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
73
74
75
76
77
78
     */
    public function __construct($phpUnit = false) {

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

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

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

97
98
99
100
101
102
103
104
105
        switch (count($files)) {
            case 0:
                return '';
            case 1:
                return $files[0];
            default:
                break;
        }

106
107

        $concatFile = tempnam(sys_get_temp_dir(), TMP_FILE_PREFIX);
Carsten  Rose's avatar
Carsten Rose committed
108
109
110
111
112
113
114
115
        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') {
116
                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
117
118
119
120
121
122
123
124
125
126
127
128
            }
        }

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

129
130
131
132
        if ($this->downloadDebugLog != '') {
            Logger::logMessage("Download: $cmd", $this->downloadDebugLog);
        }

Carsten  Rose's avatar
Carsten Rose committed
133
134
135
136
137
138
139
140
141
142
        exec($cmd, $output, $rc);

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

        return $concatFile;
    }

    /**
143
144
     * 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
145
     *
146
147
148
     * @param string $filename
     * @param string $outputFilename
     * @param string $rcMimetype
Carsten  Rose's avatar
Carsten Rose committed
149
     *
150
     * @return string possible updated $outputFilename, according the mimetype.
Carsten  Rose's avatar
Carsten Rose committed
151
     */
152
    private function targetFilenameExtension($filename, $outputFilename, &$rcMimetype) {
Carsten  Rose's avatar
Carsten Rose committed
153

154
        $rcMimetype = mime_content_type($filename);
155

156
157
158
159
160
161
        return $outputFilename;
    }

    /**
     * Set header type and output $filename. Be careful not to send any additional characters.
     *
162
     * @param $file
163
164
     * @param $outputFilename
     */
165
    private function outputFile($file, $outputFilename) {
166

167
        $length = filesize($file);
168

169
170
        $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.
171

Carsten  Rose's avatar
Carsten Rose committed
172
173
        header("Content-type: $mimetype");
        header("Content-Length: $length");
174
175
        // 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");
176
        header("Content-Disposition: inline; filename=\"$outputFilename\"; name=\"$outputFilename\"");
Carsten  Rose's avatar
Carsten Rose committed
177
178
        header("Pragma: no-cache");
        header("Expires: 0");
Carsten  Rose's avatar
Carsten Rose committed
179

180
        print file_get_contents($file);
Carsten  Rose's avatar
Carsten Rose committed
181
182
183
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
184
185
186
     * 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
187
     *
Carsten  Rose's avatar
Carsten Rose committed
188
     * @return string filename - already ready or fresh exported. Fresh exported needs to be deleted later.
Carsten  Rose's avatar
Carsten Rose committed
189
190
191
     * @throws DownloadException
     * @throws \exception
     */
Carsten  Rose's avatar
Carsten Rose committed
192
    private function getElement($element) {
Carsten  Rose's avatar
Carsten Rose committed
193

Carsten  Rose's avatar
Carsten Rose committed
194
195
196
197
        $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
198

Carsten  Rose's avatar
Carsten Rose committed
199
200
        $token = $arr[0];
        $value = $arr[1];
Carsten  Rose's avatar
Carsten Rose committed
201

Carsten  Rose's avatar
Carsten Rose committed
202
203
204
        switch ($token) {
            case TOKEN_URL:
            case TOKEN_URL_PARAM:
205
            case TOKEN_PAGE:
Carsten  Rose's avatar
Carsten Rose committed
206
207
                $filename = $this->html2pdf->page2pdf($token, $value);
                break;
Carsten  Rose's avatar
Carsten Rose committed
208

Carsten  Rose's avatar
Carsten Rose committed
209
            case TOKEN_FILE:
210
            case TOKEN_FILE_DEPRECATED:
Carsten  Rose's avatar
Carsten Rose committed
211
212
213
214
215
                $filename = $value;
                break;
            default:
                throw new DownloadException('Unknown token: "' . $token . '"', ERROR_UNKNOWN_TOKEN);
                break;
Carsten  Rose's avatar
Carsten Rose committed
216
217
218
219
220
        }

        return $filename;
    }

Carsten  Rose's avatar
Carsten Rose committed
221
222
223
224
225

    /**
     * Creates a ZIP Files of all given $files
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
226
     *
Carsten  Rose's avatar
Carsten Rose committed
227
228
229
230
231
     * @return string ZIP filename - has to be deleted later.
     * @throws DownloadException
     */
    private function zipFiles(array $files) {

232
        $zipFile = tempnam(sys_get_temp_dir(), TMP_FILE_PREFIX);
Carsten  Rose's avatar
Carsten Rose committed
233
234
235
236
237
238
        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
239
        if ($zip->open($zipFile, \ZipArchive::CREATE) !== true) {
Carsten  Rose's avatar
Carsten Rose committed
240
241
242
            throw new DownloadException("Error creating/opening new empty zip file: $zipFile", ERROR_IO_OPEN);
        }

243
        $len = strlen(TMP_FILE_PREFIX);
244
        $ii = 1;
Carsten  Rose's avatar
Carsten Rose committed
245
        foreach ($files AS $filename) {
246
247
            $localname = substr($filename, strrpos($filename, '/') + 1);

248
            if (substr($localname, 0, $len) == TMP_FILE_PREFIX) {
249
250
251
                $localname = 'file-' . $ii;
                $ii++;
            }
252
//            $localname = $this->targetFilenameExtension($filename, $localname, $mimetype);
253

Carsten  Rose's avatar
Carsten Rose committed
254
255
256
257
258
259
260
            $zip->addFile($filename, $localname);
        }
        $zip->close();

        return $zipFile;
    }

Carsten  Rose's avatar
Carsten Rose committed
261
262
263
264
265
266
267
    /**
     * exportFilename=<new filename>
     * mode=file | pdf | excel - default is 'file' in case of only one or 'pdf' in case of multiple sources.
     * HTML to PDF | Excel
     *   <i>_id=<Typo3 pageId>
     *   <i>_<key>=<value i>
     * Direct
268
     *   <i>_file=<filename>
Carsten  Rose's avatar
Carsten Rose committed
269
     *
Carsten  Rose's avatar
Carsten Rose committed
270
     * @param array $vars [ DOWNLOAD_EXPORT_FILENAME, DOWNLOAD_MODE, SIP_DOWNLOAD_PARAMETER ]
Carsten  Rose's avatar
Carsten Rose committed
271
     *
272
273
274
     * @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
275
     * @throws DownloadException
276
277
     * @throws UserFormException
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
278
     */
279
    private function doElements(array $vars, $outputMode) {
Carsten  Rose's avatar
Carsten Rose committed
280
281
282
283
284
285
286
287

        $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
288
        $downloadMode = $vars[DOWNLOAD_MODE];
289
290
291
292
293
294
295
296

        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
297
        $elements = explode(PARAM_DELIMITER, $vars[SIP_DOWNLOAD_PARAMETER]);
Carsten  Rose's avatar
Carsten Rose committed
298

Carsten  Rose's avatar
Carsten Rose committed
299
        // Get all files
Carsten  Rose's avatar
Carsten Rose committed
300
        foreach ($elements as $element) {
Carsten  Rose's avatar
Carsten Rose committed
301
            $tmpFiles[] = $this->getElement($element);
Carsten  Rose's avatar
Carsten Rose committed
302
303
        }

Carsten  Rose's avatar
Carsten Rose committed
304
305
306
307
        // Export, Concat File(s)
        switch ($downloadMode) {
            case DOWNLOAD_MODE_ZIP:
                $filename = $this->zipFiles($tmpFiles);
308
309
310
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
                }
Carsten  Rose's avatar
Carsten Rose committed
311
312
313
314
                break;

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

Carsten  Rose's avatar
Carsten Rose committed
317
            case DOWNLOAD_MODE_FILE:
Carsten  Rose's avatar
Carsten Rose committed
318
                $filename = $tmpFiles[0];
319
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
320
                    $vars[DOWNLOAD_EXPORT_FILENAME] = basename($filename);
321
                }
Carsten  Rose's avatar
Carsten Rose committed
322
                break;
Carsten  Rose's avatar
Carsten Rose committed
323
324

            case DOWNLOAD_MODE_PDF:
Carsten  Rose's avatar
Carsten Rose committed
325
                $filename = $this->concatPdfFiles($tmpFiles);
326
327
328
329
330
331
332
333
334
335
336
337
                // 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
338
339
340
341
                break;

            default:
                throw new DownloadException("Unknown downloadMode: $downloadMode", ERROR_UNKNOWN_MODE);
Carsten  Rose's avatar
Carsten Rose committed
342
343
344
                break;
        }

345
346
347
348
349
350
        switch ($outputMode) {

            case OUTPUT_MODE_FILE:
                break;

            case OUTPUT_MODE_DIRECT:
351
                $this->outputFile($filename, $vars[DOWNLOAD_EXPORT_FILENAME]);
352
353
                HelperFile::cleanTempFiles([$filename]);
                break;
Carsten  Rose's avatar
Carsten Rose committed
354

355
356
357
358
359
            default:
                throw new CodeException('Unkown mode: ' . $outputMode, ERROR_UNKNOWN_MODE);
        }

        return $filename;
Carsten  Rose's avatar
Carsten Rose committed
360
361
    }

362
363
364
    /**
     * @param string $urlParam
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
365
     * @throws CodeException
366
     * @throws UserFormException
367
368
369
370
371
372
373
374
375
376
     * @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
377
    /**
378
379
380
381
382
     * 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
383
384
     * @return string
     * @throws CodeException
385
     * @throws DownloadException
Carsten  Rose's avatar
Carsten Rose committed
386
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
387
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
388
     */
389
    public function process($vars, $outputMode = OUTPUT_MODE_DIRECT) {
Carsten  Rose's avatar
Carsten Rose committed
390

391
392
393
        if (!is_array($vars)) {
            $vars = $this->store->getStore(STORE_SIP);
        }
394

395
        return $this->doElements($vars, $outputMode);
Carsten  Rose's avatar
Carsten Rose committed
396
397
    }

398
}
Carsten  Rose's avatar
Carsten Rose committed
399