Download.php 10.7 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
13
14
15
16
17
18
 */

namespace qfq;

use TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;

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');
Carsten  Rose's avatar
Carsten Rose committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
require_once(__DIR__ . '/../report/Html2Pdf.php');
//require_once(__DIR__ . '/Link.php');
//require_once(__DIR__ . '/Sendmail.php');
require_once(__DIR__ . '/../exceptions/DownloadException.php');
//require_once(__DIR__ . '/../Evaluate.php');
//require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
//

/**
 * Class Download
 *
 * 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;

61
62
63
64
65
    /**
     * @var string Filename where to write download Information
     */
    private $downloadDebugLog = '';

Carsten  Rose's avatar
Carsten Rose committed
66
67
68
69
70
71
72
73
    /**
     * @param bool|false $phpUnit
     */
    public function __construct($phpUnit = false) {

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

76
        if (Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_DOWNLOAD, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM))) {
77
78
            $this->downloadDebugLog = $this->store->getVar(SYSTEM_SQL_LOG, STORE_SYSTEM);
        }
Carsten  Rose's avatar
Carsten Rose committed
79
80
81
82
83
84
    }

    /**
     * Concatenate all named files to one PDF file. Return name of new full PDF.
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
85
     *
Carsten  Rose's avatar
Carsten Rose committed
86
87
88
89
90
     * @return string  - fileName of concatenated file
     * @throws DownloadException
     */
    private function concatPdfFiles(array $files) {

91
92
93
94
95
96
97
98
99
        switch (count($files)) {
            case 0:
                return '';
            case 1:
                return $files[0];
            default:
                break;
        }

Carsten  Rose's avatar
Carsten Rose committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
        $concatFile = tempnam(sys_get_temp_dir(), DOWNLOAD_FILE_PREFIX);
        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') {
                throw new downloadException("Error concat file $filename. Mimetype 'application/pdf' expected, got: $mimetype", ERROR_DOWNLOAD_UNEXPECTED_MIMETYPE);
            }
        }

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

122
123
124
125
        if ($this->downloadDebugLog != '') {
            Logger::logMessage("Download: $cmd", $this->downloadDebugLog);
        }

Carsten  Rose's avatar
Carsten Rose committed
126
127
128
129
130
131
132
133
134
135
        exec($cmd, $output, $rc);

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

        return $concatFile;
    }

    /**
136
137
     * 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
138
     *
139
140
141
     * @param string $filename
     * @param string $outputFilename
     * @param string $rcMimetype
Carsten  Rose's avatar
Carsten Rose committed
142
     *
143
     * @return string possible updated $outputFilename, according the mimetype.
Carsten  Rose's avatar
Carsten Rose committed
144
     */
145
    private function targetFilenameExtension($filename, $outputFilename, &$rcMimetype) {
Carsten  Rose's avatar
Carsten Rose committed
146

147
        $rcMimetype = mime_content_type($filename);
148
149

        // In case there is a wrong filenameextension on the outputFilename: extend it.
150
        $ext = '.' . substr($rcMimetype, strrpos($rcMimetype, '/') + 1); // very very dirty way of getting an extension - only valid for a limited set of mimetypes
151
152
153
154
        $len = strlen($ext);
        if (substr($outputFilename, 0 - $len) != $ext) {
            $outputFilename .= $ext;
        }
Carsten  Rose's avatar
Carsten Rose committed
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
168
169
        $length = filesize($file);
        $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.
170

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

179
        print file_get_contents($file);
Carsten  Rose's avatar
Carsten Rose committed
180
181
182
183
184
185
186
187
    }

    /**
     * Iterate over array $files. Delete all named files which exist in DOWNLOAD_TMP_DIR.
     *
     * @param array $files
     */
    private function cleanTempFiles(array $files) {
188
189
190
191
192

        if ($this->downloadDebugLog != '') {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
193
194
195
196
197
198
199
200
201
202
203
        $prefix = sys_get_temp_dir() . '/' . DOWNLOAD_FILE_PREFIX;
        $len = strlen($prefix);

        foreach ($files as $file) {
            if (substr($file, 0, $len) == $prefix) {
                unlink($file);
            }
        }
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
204
205
206
     * 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
207
     *
Carsten  Rose's avatar
Carsten Rose committed
208
     * @return string filename - already ready or fresh exported. Fresh exported needs to be deleted later.
Carsten  Rose's avatar
Carsten Rose committed
209
210
211
     * @throws DownloadException
     * @throws \exception
     */
Carsten  Rose's avatar
Carsten Rose committed
212
    private function getElement($element) {
Carsten  Rose's avatar
Carsten Rose committed
213

Carsten  Rose's avatar
Carsten Rose committed
214
215
216
217
        $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
218

Carsten  Rose's avatar
Carsten Rose committed
219
220
        $token = $arr[0];
        $value = $arr[1];
Carsten  Rose's avatar
Carsten Rose committed
221

Carsten  Rose's avatar
Carsten Rose committed
222
223
224
225
226
        switch ($token) {
            case TOKEN_URL:
            case TOKEN_URL_PARAM:
                $filename = $this->html2pdf->page2pdf($token, $value);
                break;
Carsten  Rose's avatar
Carsten Rose committed
227

Carsten  Rose's avatar
Carsten Rose committed
228
229
230
231
232
233
            case TOKEN_FILE:
                $filename = $value;
                break;
            default:
                throw new DownloadException('Unknown token: "' . $token . '"', ERROR_UNKNOWN_TOKEN);
                break;
Carsten  Rose's avatar
Carsten Rose committed
234
235
236
237
238
        }

        return $filename;
    }

Carsten  Rose's avatar
Carsten Rose committed
239
240
241
242
243

    /**
     * Creates a ZIP Files of all given $files
     *
     * @param array $files
Carsten  Rose's avatar
Carsten Rose committed
244
     *
Carsten  Rose's avatar
Carsten Rose committed
245
246
247
248
249
250
251
252
253
254
255
256
     * @return string ZIP filename - has to be deleted later.
     * @throws DownloadException
     */
    private function zipFiles(array $files) {

        $zipFile = tempnam(sys_get_temp_dir(), DOWNLOAD_FILE_PREFIX);
        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
257
        if ($zip->open($zipFile, \ZipArchive::CREATE) !== true) {
Carsten  Rose's avatar
Carsten Rose committed
258
259
260
            throw new DownloadException("Error creating/opening new empty zip file: $zipFile", ERROR_IO_OPEN);
        }

261
262
        $len = strlen(DOWNLOAD_FILE_PREFIX);
        $ii = 1;
Carsten  Rose's avatar
Carsten Rose committed
263
        foreach ($files AS $filename) {
264
265
266
267
268
269
270
271
            $localname = substr($filename, strrpos($filename, '/') + 1);

            if (substr($localname, 0, $len) == DOWNLOAD_FILE_PREFIX) {
                $localname = 'file-' . $ii;
                $ii++;
            }
            $localname = $this->targetFilenameExtension($filename, $localname, $mimetype);

Carsten  Rose's avatar
Carsten Rose committed
272
273
274
275
276
277
278
            $zip->addFile($filename, $localname);
        }
        $zip->close();

        return $zipFile;
    }

Carsten  Rose's avatar
Carsten Rose committed
279
280
281
282
283
284
285
286
287
    /**
     * 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
     * <i>_file=<filename>
     *
Carsten  Rose's avatar
Carsten Rose committed
288
     * @param array $vars [ DOWNLOAD_EXPORT_FILENAME, DOWNLOAD_MODE, SIP_DOWNLOAD_PARAMETER ]
Carsten  Rose's avatar
Carsten Rose committed
289
     *
Carsten  Rose's avatar
Carsten Rose committed
290
291
     * @throws DownloadException
     */
Carsten  Rose's avatar
Carsten Rose committed
292
    private function doElements(array $vars) {
Carsten  Rose's avatar
Carsten Rose committed
293
294
295
296
297
298
299
300

        $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
301
302
        $downloadMode = $vars[DOWNLOAD_MODE];
        $elements = explode(PARAM_DELIMITER, $vars[SIP_DOWNLOAD_PARAMETER]);
Carsten  Rose's avatar
Carsten Rose committed
303

Carsten  Rose's avatar
Carsten Rose committed
304
        // Get all files
Carsten  Rose's avatar
Carsten Rose committed
305
        foreach ($elements as $element) {
Carsten  Rose's avatar
Carsten Rose committed
306
            $tmpFiles[] = $this->getElement($element);
Carsten  Rose's avatar
Carsten Rose committed
307
308
        }

Carsten  Rose's avatar
Carsten Rose committed
309
310
311
312
313
314
315
316
        // Export, Concat File(s)
        switch ($downloadMode) {
            case DOWNLOAD_MODE_ZIP:
                $filename = $this->zipFiles($tmpFiles);
                break;

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

Carsten  Rose's avatar
Carsten Rose committed
319
            case DOWNLOAD_MODE_FILE:
Carsten  Rose's avatar
Carsten Rose committed
320
                $filename = $tmpFiles[0];
321
322
323
                if (empty($vars[DOWNLOAD_EXPORT_FILENAME])) {
                    $vars[DOWNLOAD_EXPORT_FILENAME] = substr($filename, strpos($filename, '/'));
                }
Carsten  Rose's avatar
Carsten Rose committed
324
                break;
Carsten  Rose's avatar
Carsten Rose committed
325
326

            case DOWNLOAD_MODE_PDF:
Carsten  Rose's avatar
Carsten Rose committed
327
                $filename = $this->concatPdfFiles($tmpFiles);
Carsten  Rose's avatar
Carsten Rose committed
328
329
330
331
                break;

            default:
                throw new DownloadException("Unknown downloadMode: $downloadMode", ERROR_UNKNOWN_MODE);
Carsten  Rose's avatar
Carsten Rose committed
332
333
334
                break;
        }

335
336
        $exportFilename = empty($vars[DOWNLOAD_EXPORT_FILENAME]) ? DOWNLOAD_OUTPUT_PDF : $vars[DOWNLOAD_EXPORT_FILENAME];

Carsten  Rose's avatar
Carsten Rose committed
337
338
339
340
341
342
343
344
345
346
347
348
349
350
        $this->outputFile($filename, $exportFilename);

        $tmpFiles[] = $filename;
        $this->cleanTempFiles($tmpFiles);
    }

    /**
     * @return string
     * @throws CodeException
     * @throws UserFormException
     */
    public function process() {

        $vars = $this->store->getStore(STORE_SIP);
351

Carsten  Rose's avatar
Carsten Rose committed
352
        $this->doElements($vars);
Carsten  Rose's avatar
Carsten Rose committed
353
354
355
356
357
    }
}