Save.php 45.9 KB
Newer Older
1
2
3
4
5
6
7
8
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/30/16
 * Time: 7:59 PM
 */

Marc Egger's avatar
Marc Egger committed
9
10
11
namespace IMATHUZH\Qfq\Core;

use IMATHUZH\Qfq\Core\Database\Database;
12
use IMATHUZH\Qfq\Core\Form\FormAction;
13
use IMATHUZH\Qfq\Core\Helper\HelperFile;
Marc Egger's avatar
Marc Egger committed
14
15
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
use IMATHUZH\Qfq\Core\Helper\Logger;
16
use IMATHUZH\Qfq\Core\Helper\OnArray;
Marc Egger's avatar
Marc Egger committed
17
18
use IMATHUZH\Qfq\Core\Helper\Sanitize;
use IMATHUZH\Qfq\Core\Helper\Support;
19
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
Marc Egger's avatar
Marc Egger committed
20
use IMATHUZH\Qfq\Core\Store\Sip;
21
use IMATHUZH\Qfq\Core\Store\Store;
22

23
24
25
26
/**
 * Class Save
 * @package qfq
 */
27
28
29
30
31
class Save {

    private $formSpec = array();  // copy of the loaded form
    private $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    private $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
32
    private $feSpecNativeRaw = array(); // copy of all formElement.class='native' of the loaded form
33
34
35
36
37
38

    /**
     * @var FormAction
     */
    private $formAction = null;

39
40
41
42
    /**
     * @var null|Store
     */
    private $store = null;
Carsten  Rose's avatar
Carsten Rose committed
43
44
45
46

    /**
     * @var Database
     */
47
48
49
50
    private $db = null;

    private $evaluate = null;

51
52
    private $qfqLogFilename = '';

53
54
55
56
    /**
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
57
     * @param array $feSpecNativeRaw
Marc Egger's avatar
Marc Egger committed
58
59
60
61
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
62
     */
63
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $feSpecNativeRaw) {
64

65
66
67
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
68
        $this->feSpecNativeRaw = $feSpecNativeRaw;
69
        $this->store = Store::getInstance();
70
        $this->db = new Database($formSpec[F_DB_INDEX]);
71
        $this->evaluate = new Evaluate($this->store, $this->db);
72
        $this->formAction = new FormAction($formSpec, $this->db);
73
74
75

        $this->qfqLogFilename = $this->store->getVar(SYSTEM_QFQ_LOG, STORE_SYSTEM);

76
77
78
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
79
     * Starts save process. Returns recordId.
80
     *
81
     * @return int
Marc Egger's avatar
Marc Egger committed
82
83
84
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
85
     * @throws \UserReportException
86
87
     */
    public function process() {
88
        $rc = 0;
89

90
        if ($this->formSpec[F_MULTI_SQL] == '') {
91
92
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
            $rc = $this->elements($recordId);
93
94
        } else {
            $rc = $this->saveMultiForm();
95
        }
96
97

        return $rc;
98
99
    }

100
101
102
103
104
105
106
107
108
109
110
    /**
     * @return int|string
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
     */
    private function saveMultiForm() {

        $parentRecords = $this->evaluate->parse($this->formSpec[F_MULTI_SQL], ROW_REGULAR);

111
        // No rows: This must be an error, cause MultiForms must have at least one record.
112
        if (empty($parentRecords)) {
113
114
115
116
            throw new \UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => $this->formSpec[F_MULTI_MSG_NO_RECORD],
                    ERROR_MESSAGE_TO_DEVELOPER => 'Query selects no records: ' . $this->formSpec[F_MULTI_SQL]]),
                ERROR_MISSING_EXPECT_RECORDS);
117
118
119
120
121
122
123
124
125
126
127
128
129
        }

        // Check for 'id' or '_id' as column name
        $idName = isset($parentRecords[0]['_' . F_MULTI_COL_ID]) ? '_' . F_MULTI_COL_ID : F_MULTI_COL_ID;

        // Check that an column 'id' is given
        if (!isset($parentRecords[0][$idName])) {
            throw new \UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'Missing column "_' . F_MULTI_COL_ID . '"', ERROR_MESSAGE_TO_DEVELOPER => $this->formSpec[F_MULTI_SQL]]),
                ERROR_INVALID_OR_MISSING_PARAMETER);
        }

        $fillStoreForm = new FillStoreForm();
130
        $storeVarBase = $this->store->getStore(STORE_VAR);
131
132

        foreach ($parentRecords as $row) {
133
134
135
136

            // Always start with a clean STORE_VAR
            $this->store->setStore($storeVarBase, STORE_VAR, true);

137
            $this->store->setStore($row, STORE_PARENT_RECORD, true);
138
            $this->store->setVar(F_MULTI_COL_ID, $row[$idName], STORE_PARENT_RECORD); // In case '_id' is used, both '_id' and 'id' should be accessible.
139

140
            $record = $this->db->sql('SELECT * FROM `' . $this->formSpec[F_TABLE_NAME] . '` WHERE id=' . $row[$idName], ROW_EXPECT_1);
141
142
            $this->store->setStore($record, STORE_RECORD, true);

143
144
145
146
147
148
149
150
151
152
            // Fake current recordId
            $this->store->setVar(SIP_RECORD_ID, $row[$idName], STORE_SIP);
            $fillStoreForm->process(FORM_SAVE);

            $rc = $this->elements($row[$idName]);
        }

        return $rc;
    }

153
    /**
Carsten  Rose's avatar
Carsten Rose committed
154
155
     * Create empty FormElements based on templateGroups, for those who not already exist.
     *
156
     * @param array $formValues
Carsten  Rose's avatar
Carsten Rose committed
157
     *
158
     * @return array
Marc Egger's avatar
Marc Egger committed
159
     * @throws \UserFormException
160
161
162
163
164
     */
    private function createEmptyTemplateGroupElements(array $formValues) {

        foreach ($this->feSpecNative as $formElement) {

165
166
167
168
169
170
171
172
            switch ($formElement[FE_TYPE]) {
//                case FE_TYPE_EXTRA:
                case FE_TYPE_NOTE:
                case FE_TYPE_SUBRECORD:
                    continue 2;
                default:
                    break;
            }
173
            $feName = $formElement[FE_NAME];
174
            if (!isset($formValues[$feName]) && $this->isMemberOfTemplateGroup($formElement)) {
175
176
177
                $formValues[$feName] = $formElement[FE_VALUE];
            }
        }
Carsten  Rose's avatar
Carsten Rose committed
178

179
180
181
        return $formValues;
    }

182
    /**
183
184
185
186
187
     * Check if the current $formElement is member of a templateGroup.
     *
     * @param array $formElement
     * @param int $depth
     * @return bool
Marc Egger's avatar
Marc Egger committed
188
     * @throws \UserFormException
189
190
191
192
193
     */
    private function isMemberOfTemplateGroup(array $formElement, $depth = 0) {
        $depth++;

        if ($depth > 15) {
Marc Egger's avatar
Marc Egger committed
194
            throw new \UserFormException('FormElement nested too much (in each other - endless?): stop recursion', ERROR_FE_NESTED_TOO_MUCH);
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
        }

        if ($formElement[FE_TYPE] == FE_TYPE_TEMPLATE_GROUP) {
            return true;
        }

        if ($formElement[FE_ID_CONTAINER] == 0) {
            return false;
        }

        // Get the parent element
        $formElementArr = OnArray::filter($this->feSpecNativeRaw, FE_ID, $formElement[FE_ID_CONTAINER]);
        if (isset($formElementArr[0])) {
            return $this->isMemberOfTemplateGroup($formElementArr[0], $depth);
        }

        return false; // This should not be reached,
    }

    /**
     *
216
     * @param $feName
Carsten  Rose's avatar
Carsten Rose committed
217
     *
218
219
220
221
222
223
224
225
226
227
228
     * @return bool
     */
    private function isSetEmptyMeansNull($feName) {

        $fe = OnArray::filter($this->feSpecNative, FE_NAME, $feName);

        $flag = isset($fe[0][FE_EMPTY_MEANS_NULL]) && $fe[0][FE_EMPTY_MEANS_NULL] != '0';

        return $flag;
    }

229
    /**
Carsten  Rose's avatar
Carsten Rose committed
230
231
     * Build an array of all values which should be saved. Values must exist as a 'form value' as well as a regular
     * 'table column'.
Carsten  Rose's avatar
Carsten Rose committed
232
     *
233
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
234
     *
235
     * @return int   record id (in case of insert, it's different from $recordId)
Marc Egger's avatar
Marc Egger committed
236
237
     * @throws \CodeException
     * @throws \DbException
238
239
     * @throws \UserFormException
     * @throws \UserReportException
240
     */
241
    private function elements($recordId) {
242
243
        $columnCreated = false;
        $columnModified = false;
Carsten  Rose's avatar
Carsten Rose committed
244

245
246
247
        $newValues = array();

        $tableColumns = array_keys($this->store->getStore(STORE_TABLE_COLUMN_TYPES));
248
        $formValues = $this->store->getStore(STORE_FORM);
249
        $formValues = $this->createEmptyTemplateGroupElements($formValues);
250
251
252

        // Iterate over all table.columns. Built an assoc array $newValues.
        foreach ($tableColumns AS $column) {
253

254
            // Never save a predefined 'id': autoincrement values will be given by database..
255
            if ($column === COLUMN_ID) {
256
                continue;
257
            }
258

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
259
260
261
262
263
            // Skip Upload Elements: those will be processed later.
            if ($this->isColumnUploadField($column)) {
                continue;
            }

264
265
266
267
268
269
270
271
            if ($column === COLUMN_CREATED) {
                $columnCreated = true;
            }

            if ($column === COLUMN_MODIFIED) {
                $columnModified = true;
            }

272
273
            // Is there a value? Do not forget SIP values. Those do not have necessarily a FormElement.
            if (!isset($formValues[$column])) {
274
                continue;
275
276
            }

277
            $this->store->setVar(SYSTEM_FORM_ELEMENT, "Column: $column", STORE_SYSTEM);
278

279
280
281
282
283
284
            // Check if an empty string has to be converted to null.
            if (isset($formValues[$column]) && $formValues[$column] == '' && $this->isSetEmptyMeansNull($column)) {
                $formValues[$column] = null;
            } else {
                Support::setIfNotSet($formValues, $column);
            }
285
            $newValues[$column] = $formValues[$column];
286

287
288
        }

289
        if ($columnModified && !empty($newValues) && !isset($newValues[COLUMN_MODIFIED])) {
290
291
292
            $newValues[COLUMN_MODIFIED] = date('YmdHis');
        }

293
        if ($recordId == 0) {
294
295
296
            if ($columnCreated && !isset($newValues[COLUMN_CREATED])) {
                $newValues[COLUMN_CREATED] = date('YmdHis');
            }
297
            $rc = $this->insertRecord($this->formSpec[F_TABLE_NAME], $newValues);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
298

299
        } else {
300
301
302
            if (!empty($newValues)) {
                $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
            }
303
304
305
            $rc = $recordId;
        }

306
307
        $this->nativeDoSlave($rc);

308
        return $rc;
309
310
    }

311
312
    /**
     * @param $recordId
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
313
     *
314
315
316
317
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
318
     */
319
320
321
322
323
324
325
326
327
328
329
    private function nativeDoSlave($recordId) {

        foreach ($this->feSpecNative as $fe) {
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM);

            $this->formAction->doSqlBeforeSlaveAfter($fe, $recordId, false);
        }
    }

330
    /**
331
332
     * Checks if there is a formElement with name '$feName' of type 'upload'
     *
333
334
335
     * @param $feName
     * @return bool
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
336
337
338
    private function isColumnUploadField($feName) {

        foreach ($this->feSpecNative AS $formElement) {
339
            if ($formElement[FE_NAME] === $feName && $formElement[FE_TYPE] == FE_TYPE_UPLOAD)
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
340
341
                return true;
        }
Carsten  Rose's avatar
Carsten Rose committed
342

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
343
344
345
346
347
348
        return false;
    }

    /**
     * Insert new record in table $this->formSpec['tableName'].
     *
349
     * @param $tableName
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
350
     * @param array $values
Carsten  Rose's avatar
Carsten Rose committed
351
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
352
     * @return int  last insert id
Marc Egger's avatar
Marc Egger committed
353
354
355
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
356
357
358
359
360
361
362
363
364
365
     */
    public function insertRecord($tableName, array $values) {

        if (count($values) === 0)
            return 0; // nothing to write, last insert id=0

        $paramList = str_repeat('?, ', count($values));
        $paramList = substr($paramList, 0, strlen($paramList) - 2);
        $columnList = '`' . implode('`, `', array_keys($values)) . '`';

366
        $sql = "INSERT INTO $tableName ( " . $columnList . " ) VALUES ( " . $paramList . ' )';
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
367
368
369
370
371
372
373
374

        $rc = $this->db->sql($sql, ROW_REGULAR, array_values($values));

        return $rc;
    }

    /**
     * @param string $tableName
Carsten  Rose's avatar
Carsten Rose committed
375
376
     * @param array $values
     * @param int $recordId
377
     * @param string $primaryKey
Carsten  Rose's avatar
Carsten Rose committed
378
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
379
     * @return bool|int     false if $values is empty, else affectedrows
Marc Egger's avatar
Marc Egger committed
380
381
382
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
383
     */
384
    public function updateRecord($tableName, array $values, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
385
386
387
388

        if (count($values) === 0)
            return 0; // nothing to write, 0 rows affected

389
        if ($recordId === 0) {
Marc Egger's avatar
Marc Egger committed
390
            throw new \CodeException('RecordId=0 - this is not possible for update.', ERROR_RECORDID_0_FORBIDDEN);
391
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
392
393
394
395
396
397
398
399

        $sql = 'UPDATE `' . $tableName . '` SET ';

        foreach ($values as $column => $value) {

            $sql .= '`' . $column . '` = ?, ';
        }

400
        $sql = substr($sql, 0, strlen($sql) - 2) . " WHERE $primaryKey = ?";
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
401
402
403
404
405
406
407
        $values[] = $recordId;

        $rc = $this->db->sql($sql, ROW_REGULAR, array_values($values));

        return $rc;
    }

408
    /**
Carsten  Rose's avatar
Carsten Rose committed
409
410
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
411
412
413
414
415
416
417
418
     *
     * Constellation: # FILE OLD   FILE NEW     FILESIZE
     *                1 none       none
     *                2 none       new
     *                3 exist      no change
     *                4 delete     none
     *                5 delete     new
     *
419
     * @param $recordId
Marc Egger's avatar
Marc Egger committed
420
421
422
423
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
424
425
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
426
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
427
428
429
430
    public function processAllUploads($recordId) {

        $sip = new Sip(false);
        $newValues = array();
431
        $vars = array();
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
432
433

        $formValues = $this->store->getStore(STORE_FORM);
434
        $primaryRecord = $this->store->getStore(STORE_RECORD); // necessary to check if the current formElement exist as a column of the primary table.
435
436
437

        foreach ($this->feSpecNative AS $formElement) {
            // skip non upload formElements
438
            if ($formElement[FE_TYPE] != FE_TYPE_UPLOAD) {
439
440
441
                continue;
            }

442
443
444
445
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($formElement), STORE_SYSTEM);
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $formElement[FE_ID], STORE_SYSTEM);

446
            $formElement = HelperFormElement::initUploadFormElement($formElement);
447
            if (isset($formElement[FE_FILL_STORE_VAR])) {
448
                $formElement[FE_FILL_STORE_VAR] = $this->evaluate->parse($formElement[FE_FILL_STORE_VAR], ROW_EXPECT_0_1);
449
                $this->store->appendToStore($formElement[FE_FILL_STORE_VAR], STORE_VAR);
450
            }
451

452
            $column = $formElement[FE_NAME];
453
            $pathFileName = $this->doUpload($formElement, ($formValues[$column] ?? ''), $sip, $modeUpload);
454

455
456
            if ($modeUpload == UPLOAD_MODE_DELETEOLD && $pathFileName == '') {
                $pathFileNameTmp = '';  // see '4'
457
458
            } else {
                if (empty($pathFileName)) {
459
                    $pathFileNameTmp = $primaryRecord[$column] ?? ''; // see '3'. Attention: in case of Advanced Upload, $primaryRecord[$column] does not exist.
460
461
462
463
464
                } else {
                    $pathFileNameTmp = $pathFileName; // see '1,2,5'
                }
            }

465
            // Get latest file information
466
            if ($pathFileNameTmp == '') {
467
468
469
                // No new upload and no existing: take care to remove previous upload file statistics.
                $this->store->unsetVar(VAR_FILE_MIME_TYPE, STORE_VAR);
                $this->store->unsetVar(VAR_FILE_SIZE, STORE_VAR);
470
471
                $vars[VAR_FILE_SIZE] = 0;
                $vars[VAR_FILE_MIME_TYPE] = '';
472
473
474
475
476
            } else {
                $vars = HelperFile::getFileStat($pathFileNameTmp);
                $this->store->appendToStore($vars, STORE_VAR);
            }

477
478
479
            // If given: fire a sqlBefore query
            $this->evaluate->parse($formElement[FE_SQL_BEFORE]);

480
            // Upload Type: Simple or Advanced
481
482
483
            // If (isset($primaryRecord[$column])) { - see #5048 - isset does not deal correctly with NULL!
            if (array_key_exists($column, $primaryRecord)) {
                // 'Simple Upload': no special action needed, just process the current (maybe modified) value.
484
485
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
486
487
488
489
490
491
492
493

                    if (isset($primaryRecord[COLUMN_FILE_SIZE])) {
                        $newValues[COLUMN_FILE_SIZE] = $vars[VAR_FILE_SIZE];
                    }

                    if (isset($primaryRecord[COLUMN_MIME_TYPE])) {
                        $newValues[COLUMN_MIME_TYPE] = $vars[VAR_FILE_MIME_TYPE];
                    }
494
                }
495
496
            } elseif (isset($formElement[FE_IMPORT_TO_TABLE]) && !isset($formElement[FE_SLAVE_ID])) {
                // Excel import on nonexisting column -> no upload
497
498
            } else {
                // 'Advanced Upload'
499
                $this->doUploadSlave($formElement, $modeUpload);
500
            }
501
502
503
504

            // If given: fire a sqlAfter query
            $this->evaluate->parse($formElement[FE_SQL_AFTER]);

505
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
506

507
        // Only used in 'Simple Upload'
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
508
        if (count($newValues) > 0) {
509
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
510
        }
511
512
    }

513
    /**
514
515
     * Process all Upload FormElements for the given $recordId.
     * After processing, &$formValues will be updated with the final filename.
516
     *
Marc Egger's avatar
Marc Egger committed
517
518
     * @throws \CodeException
     * @throws \UserFormException
519
520
521
522
523
524
525
526
527
528
529
530
531
     */
    public function processAllImageCutFE() {

        foreach ($this->feSpecNative AS $formElement) {
            // skip non upload formElements
            if ($formElement[FE_TYPE] != FE_TYPE_IMAGE_CUT) {
                continue;
            }

            $this->extractImageDataReplaceFile($formElement);
        }
    }

532
533
534
535
536
537
538
539

    /**
     * Iterates over all FE and checks all 'required' (mode & modeSql) FE.
     * If a required FE is empty, throw an exception.
     * Take care to remove all FE with modeSql='hidden'.
     *
     * Typically, the browser does not allow a submit if a required field is empty.
     *
Marc Egger's avatar
Marc Egger committed
540
541
542
543
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
544
545
546
     */
    public function checkRequiredHidden() {

547
548
549
550
551
        $formModeGlobal = $this->store->getVar(F_MODE_GLOBAL, STORE_SIP . STORE_EMPTY);
        if ($formModeGlobal == '') {
            $formModeGlobal = $this->formSpec[F_MODE_GLOBAL] ?? '';
        }

552
553
554
555
556
557
558
        $reportRequiredFailed = true;
        switch ($formModeGlobal) {
            case F_MODE_REQUIRED_OFF:
            case F_MODE_REQUIRED_OFF_BUT_MARK:
                $reportRequiredFailed = false;
                break;
        }
559
560
561

        $clientValues = $this->store::getStore(STORE_FORM);

562
563
        $flagAllRequiredGiven = 1;

564
565
        foreach ($this->feSpecNative AS $key => $formElement) {

566
567
568
569
570
            // Do not check retype slave FE.
            if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
                continue;
            }

571
572
            $this->store->setVar(SYSTEM_FORM_ELEMENT, "Column: " . $formElement[FE_NAME], STORE_SYSTEM);

573
574
575
576
577
578
579
            if (empty($formElement[FE_MODE_SQL])) {
                $mode = $formElement[FE_MODE];
            } else {
                $mode = $this->evaluate->parse($formElement[FE_MODE_SQL]);
                $this->feSpecNative[$key][FE_MODE_SQL] = $mode;
            }

580
581
582
            if (isset($formElement[FE_ACCEPT_ZERO_AS_REQUIRED]) && $formElement[FE_ACCEPT_ZERO_AS_REQUIRED] != '0' &&
                isset($clientValues[$formElement[FE_NAME]]) && $clientValues[$formElement[FE_NAME]] == '0') {
                $mode = 'fake'; // The next if() should never be true.
583
584
            }

585
586
587
588
589
            if ($mode == FE_MODE_REQUIRED && empty($clientValues[$formElement[FE_NAME]])) {
                $flagAllRequiredGiven = 0;
                if ($reportRequiredFailed) {
                    throw new \UserFormException("Missing required value: " . $formElement[FE_LABEL], ERROR_REQUIRED_VALUE_EMPTY);
                }
590
591
592
593
594
595
596
            }

            if ($mode == FE_MODE_HIDDEN) {
                // Removing the value from the store, forces that the value won't be stored.
                $this->store::unsetVar($formElement[FE_NAME], STORE_FORM);
            }
        }
597
598
599

        // Save 'allRequiredGiven in STORE_VAR
        $this->store::setVar(VAR_ALL_REQUIRED_GIVEN, $flagAllRequiredGiven, STORE_VAR, true);
600
601
    }

602
603
604
    /**
     *
     * @param array $formElement
Marc Egger's avatar
Marc Egger committed
605
606
     * @throws \CodeException
     * @throws \UserFormException
607
608
609
610
611
612
     */
    private function extractImageDataReplaceFile(array $formElement) {

        // Take care the necessary target directories exist.
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
613
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
Marc Egger's avatar
Marc Egger committed
614
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
615
                json_encode([ERROR_MESSAGE_TO_USER => 'getcwd() failed or SITE_PATH undefined or chdir() failed', ERROR_MESSAGE_TO_DEVELOPER => "getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed."]),
616
                ERROR_IO_CHDIR);
617
618
        }

619
        // Get original pathFileName
620
621
622
        $field = HelperFormElement::AppendFormElementNameImageCut($formElement);
        $pathFileName = $this->store->getVar($field, STORE_SIP);
        if ($pathFileName == '' || !file_exists($pathFileName)) {
Marc Egger's avatar
Marc Egger committed
623
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
624
                json_encode([ERROR_MESSAGE_TO_USER => 'Empty file or file not found', ERROR_MESSAGE_TO_DEVELOPER => 'Empty file or file not found: ' . $pathFileName]),
625
                ERROR_IO_FILE_NOT_FOUND);
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
        }

        // 'data:image/png;base64,AAAFBfj42Pj4...';
        $data = $this->store->getVar($formElement[FE_NAME], STORE_FORM, SANITIZE_ALLOW_ALLBUT);
        // Replace data by pathFileName (that is stored in DB).
        $this->store->setVar($formElement[FE_NAME], $pathFileName, STORE_FORM, true);

        if ($data == '') {
            return; // Nothing to do
        }

        // Split base64 encoded image: 'data:image/png;base64,AAAFBfj42Pj4...'
        list($type, $imageData) = explode(';', $data, 2); // $type= 'data:image/png;', $imageData='base64,AAAFBfj42Pj4...'
        list(, $extension) = explode('/', $type); // $type='png'
        list(, $imageData) = explode(',', $imageData); // $imageData='AAAFBfj42Pj4...'

        // If undefined: set default. BTW: Defined and empty means "no original".
        if (!isset($formElement[FE_IMAGE_CUT_KEEP_ORIGINAL])) {
            $formElement[FE_IMAGE_CUT_KEEP_ORIGINAL] = FE_IMAGE_CUT_ORIGINAL_EXTENSION;
        }
        $extSave = $formElement[FE_IMAGE_CUT_KEEP_ORIGINAL];

        $pathParts = pathinfo($pathFileName);
        // Keep the original file?
        if ($extSave != '') {

            // In case the leading '.' is missing.
            if ($extSave[0] != ".") {
                $extSave = '.' . $extSave;
            }

            // Check if there is already an original - don't create an additional one.
            if (!file_exists($pathFileName . $extSave) &&
                !file_exists($pathParts['dirname'] . $pathParts['filename'] . $extSave)
            ) {
661
                HelperFile::rename($pathFileName, $pathFileName . $extSave);
662
663
664
665
666
667
668
669
            }
        }

        if ($extension != $pathParts['extension']) {
            $pathFileName .= "." . $extension;
        }

        if (false === file_put_contents($pathFileName, base64_decode($imageData))) {
Marc Egger's avatar
Marc Egger committed
670
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
671
                json_encode([ERROR_MESSAGE_TO_USER => 'Write new image failed', ERROR_MESSAGE_TO_DEVELOPER => "Write new image failed: $pathFileName"]),
672
                ERROR_IO_WRITE);
673
674
675
676
677
        }

        $this->store->setVar($formElement[FE_NAME], $pathFileName, STORE_FORM, true);
    }

678
    /**
679
680
681
     * Process upload for the given Formelement. If necessary, delete a previous uploaded file.
     * Calculate the final path/filename and move the file to the new location.
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
682
683
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
684
685
686
687
     * @param array $formElement FormElement 'upload'
     * @param string $sipUpload SIP
     * @param Sip $sip
     * @param string $modeUpload UPLOAD_MODE_UNCHANGED | UPLOAD_MODE_NEW | UPLOAD_MODE_DELETEOLD |
Carsten  Rose's avatar
Carsten Rose committed
688
689
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
690
     * @return false|string New pathFilename or false on error
Marc Egger's avatar
Marc Egger committed
691
692
693
694
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
695
696
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
697
698
     * @internal param $recordId
     */
699
700
701
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
702

703
        // Status information about upload file
704
705
706
707
708
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

709
        if (isset($formElement[FE_IMPORT_TO_TABLE]) && isset($statusUpload[FILES_TMP_NAME])) {
710
            // Import
711
            $tmpFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
712
713
            $this->doImport($formElement, $tmpFile);
        }
714

715
        // Upload - Take care the necessary target directories exist.
716
717
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
718
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
Marc Egger's avatar
Marc Egger committed
719
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
720
                json_encode([ERROR_MESSAGE_TO_USER => 'getcwd() failed or SITE_PATH undefined or chdir() failed', ERROR_MESSAGE_TO_DEVELOPER => "getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed."]),
721
                ERROR_IO_CHDIR);
722
        }
723

724
725
726
727
728
        // Delete existing old file.
        if (isset($statusUpload[FILES_FLAG_DELETE]) && $statusUpload[FILES_FLAG_DELETE] == '1') {
            $arr = $sip->getVarsFromSip($sipUpload);
            $oldFile = $arr[EXISTING_PATH_FILE_NAME];
            if (file_exists($oldFile)) {
729
                //TODO: it might be possible to delete a file, which is referenced by another record - a check would be nice.
730
                HelperFile::unlink($oldFile, $this->qfqLogFilename);
731
732
733
734
735
736
737
738
739
740
741
            }
            $flagDelete = ($oldFile != '');
        }

        // Set $modeUpload
        if (isset($statusUpload[FILES_TMP_NAME]) && $statusUpload[FILES_TMP_NAME] != '') {
            $modeUpload = $flagDelete ? UPLOAD_MODE_DELETEOLD_NEW : UPLOAD_MODE_NEW;
        } else {
            $modeUpload = $flagDelete ? UPLOAD_MODE_DELETEOLD : UPLOAD_MODE_UNCHANGED;
        }

742
743
        Logger::logMessageWithPrefix(UPLOAD_LOG_PREFIX . ': modeUpload= ' . $modeUpload, $this->qfqLogFilename);

744
        // skip uploading the file, if this is an import without a specified file destination
745
746
        if (!isset($formElement[FE_IMPORT_TO_TABLE]) || isset($formElement[FE_FILE_DESTINATION])) {
            $pathFileName = $this->copyUploadFile($formElement, $statusUpload);
747
748
749
750

            $msg = UPLOAD_LOG_PREFIX . ': ';
            $msg .= ($pathFileName == '') ? 'Remove old upload / no new upload' : 'File "' . $statusUpload[FILES_TMP_NAME] . '" >> "' . $pathFileName . '"';
            Logger::logMessageWithPrefix($msg, $this->qfqLogFilename);
751
752
        }

753
        HelperFile::chdir($cwd);
754
755
756
757
758
759
760
761
762

        // Delete current used uniq SIP
        $this->store->setVar($sipUpload, array(), STORE_EXTRA);

        return $pathFileName;
    }

    /**
     * @param $formElement
763
     * @param $fileName
Marc Egger's avatar
Marc Egger committed
764
765
766
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
767
768
769
770
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     */
    private function doImport($formElement, $fileName) {
771
        $importNamedSheetsOnly = array();
772

773
        Support::setIfNotSet($formElement, FE_IMPORT_TYPE, FE_IMPORT_TYPE_AUTO);
774

775
776
777
778
        if (!empty($formElement[FE_IMPORT_NAMED_SHEETS_ONLY])) {
            $importNamedSheetsOnly = explode(',', $formElement[FE_IMPORT_NAMED_SHEETS_ONLY]);
        }

Carsten  Rose's avatar
Carsten Rose committed
779
        // Check for keywords which needs an explicit given document type.
780
781
782
783
784
        if ($formElement[FE_IMPORT_TYPE] === FE_IMPORT_TYPE_AUTO) {

            $list = [FE_IMPORT_LIST_SHEET_NAMES, FE_IMPORT_READ_DATA_ONLY, FE_IMPORT_LIST_SHEET_NAMES];
            foreach ($list as $token) {
                if (isset($formElement[$token])) {
Marc Egger's avatar
Marc Egger committed
785
                    throw new \UserFormException('If ' . $token .
786
787
788
789
790
                        ' is given, an explicit document type (like ' . FE_IMPORT_TYPE . '=xlsx) should be set.', ERROR_IMPORT_MISSING_EXPLICIT_TYPE);
                }
            }
        }

791
792
793
794
795
796
797
798
799
800
801
        switch ($formElement[FE_IMPORT_TYPE]) {
            case FE_IMPORT_TYPE_AUTO:
                $spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load($fileName);
                break;

            case FE_IMPORT_TYPE_XLS:
            case FE_IMPORT_TYPE_XLSX:
            case FE_IMPORT_TYPE_CSV:
            case FE_IMPORT_TYPE_ODS:
                $inputFileType = ucfirst($formElement[FE_IMPORT_TYPE]);
                $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
802
803
804
805
806
807
808
809
810
811
812
813
814

                // setReadDataOnly
                if (($formElement[FE_IMPORT_READ_DATA_ONLY] ?? '0') != '0') {
                    $reader->setReadDataOnly(true);
                }

                // setLoadSheetsOnly
                if (!empty ($importNamedSheetsOnly)) {
                    $reader->setLoadSheetsOnly($importNamedSheetsOnly);
                }

                if (($formElement[FE_IMPORT_LIST_SHEET_NAMES] ?? '0') != '0') {
                    $sheetNames = $reader->listWorksheetNames($fileName);
Marc Egger's avatar
Marc Egger committed
815
                    throw new \UserFormException("Worksheets: " . implode(', ', $sheetNames),
816
817
818
                        ERROR_IMPORT_LIST_SHEET_NAMES);
                }

819
820
821
822
                $spreadsheet = $reader->load($fileName);
                break;

            default:
Marc Egger's avatar
Marc Egger committed
823
                throw new \UserFormException("Unknown Excel import type: '" . $formElement[FE_IMPORT_TYPE] . "'.",
824
825
826
827
                    ERROR_UNKNOWN_EXCEL_IMPORT_TYPE);
        }

        $tableName = $formElement[FE_IMPORT_TO_TABLE];
828
        $regions = OnArray::trimArray(explode('|', $formElement[FE_IMPORT_REGION] ?? ''));
829
        $columnNames = OnArray::trimArray(explode(',', $formElement[FE_IMPORT_TO_COLUMNS] ?? ''));
830
831
832
833
        $importMode = $formElement[FE_IMPORT_MODE] ?? FE_IMPORT_MODE_APPEND;

        foreach ($regions as $region) {
            // region: tab, startColumn, startRow, endColumn, endRow
834
            $region = OnArray::trimArray(explode(',', $region));
835
836
837
838
839
840
841
842
843
844
845
846
847
848
            $tab = 1;
            if (!empty($region[0])) {
                $tab = $region[0];
            }

            try {
                if (is_numeric($tab)) {
                    $worksheet = $spreadsheet->getSheet($tab - 1); // 0-based
                } else {
                    $worksheet = $spreadsheet->getSheetByName($tab);
                    if ($worksheet === null) {
                        throw new \PhpOffice\PhpSpreadsheet\Exception(
                            "No sheet with the name '$tab' could be found."
                        );
849
850
                    }
                }
851
            } catch (\PhpOffice\PhpSpreadsheet\Exception $e) {
Marc Egger's avatar
Marc Egger committed
852
                throw new \UserFormException($e->getMessage());
853
            }
854

855
856
857
858
859
860
861
862
863
            // Set up requested region
            $columnStart = '1';
            $columnEnd = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::columnIndexFromString($worksheet->getHighestColumn());
            $rowStart = 1;
            $rowEnd = $worksheet->getHighestRow();
            if (!empty($region[1])) { // startColumn
                if (!is_numeric($region[1])) $region[1] = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::columnIndexFromString($region[1]);
                if ($region[1] >= $columnStart && $region[1] <= $columnEnd) {
                    $columnStart = $region[1];
864
865
                }
            }
866
867
868
869
870
            if (!empty($region[3])) { // endColumn
                if (!is_numeric($region[3])) $region[3] = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::columnIndexFromString($region[3]);
                if ($region[3] >= $columnStart && $region[3] <= $columnEnd) {
                    $columnEnd = $region[3];
                }
871
            }
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
            if (!empty($region[2]) && $region[2] >= $rowStart && $region[2] <= $rowEnd) {
                $rowStart = $region[2];
            }
            if (!empty($region[4]) && $region[4] >= $rowStart && $region[4] <= $rowEnd) {
                $rowEnd = $region[4];
            }
            // Read the specified region
            $rangeStr = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($columnStart) . $rowStart . ':' .
                \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($columnEnd) . $rowEnd;
            $worksheetData = $worksheet->rangeToArray($rangeStr, '', true, false);

            $columnDefinitionArr = [];
            $columnListArr = [];
            for ($column = $columnStart; $column <= $columnEnd; ++$column) {
                if (!empty($columnNames[$column - $columnStart])) {
                    $columnName = $columnNames[$column - $columnStart];
                } else {
                    $columnName = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($column);
890
                }
891
892
                $columnDefinitionArr[] = "`$columnName`   TEXT       NOT NULL  DEFAULT ''";
                $columnListArr[] = "$columnName";
893
894
            }

895
896
897
898
899
900
901
902
903
904
905
906
907
            // SQL time!
            $createTableSql = "CREATE TABLE IF NOT EXISTS `$tableName` (" .
                "`id`        INT(11)    NOT NULL  AUTO_INCREMENT," .
                implode(', ', $columnDefinitionArr) . ',' .
                "`modified`  TIMESTAMP  NOT NULL  DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP," .
                "`created`   DATETIME   NOT NULL  DEFAULT CURRENT_TIMESTAMP," .
                "PRIMARY KEY (`id`) )" .
                "ENGINE = InnoDB  DEFAULT CHARSET = utf8 AUTO_INCREMENT = 0;";
            $this->db->sql($createTableSql);

            if ($importMode === FE_IMPORT_MODE_REPLACE) {
                $this->db->sql("TRUNCATE $tableName");
                $importMode = FE_IMPORT_MODE_APPEND;
908
            }
909

910
911
912
913
914
915
916
            // Import the data
            foreach ($worksheetData AS $rowIndex => $row) {
                $columnList = implode(',', $columnListArr);
                $paramPlaceholders = str_repeat('?,', count($worksheetData[0]) - 1) . '?';
                $insertSql = "INSERT INTO `$tableName` ($columnList) VALUES ($paramPlaceholders)";
                $this->db->sql($insertSql, ROW_REGULAR, $row);
            }
917
        }
918
919
920
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
921
922
923
924
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
925
926
927
     * @param array $formElement
     * @param array $statusUpload
     * @return array|mixed|null|string
Marc Egger's avatar
Marc Egger committed
928
929
930
931
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
932
     */
933
    private function copyUploadFile(array $formElement, array $statusUpload) {
934
935
        $pathFileName = '';

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
936
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
937
938
939
940
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

941
942
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);

943
        if (isset($formElement[FE_FILE_DESTINATION])) {
944

945
            // Provide variable 'filename'. Might be substituted in $formElement[FE_PATH_FILE_NAME].
946
            $origFilename = Sanitize::safeFilename($statusUpload[FILES_NAME]);
947
            $this->store->appendToStore(HelperFile::pathinfo($origFilename), STORE_VAR);
948

949
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
950
            $pathFileName = Sanitize::safeFilename($pathFileName, false, true); // Dynamically calculated pathFileName might contain invalid characters.
951
952
953

            // Saved in store for later use during 'Advanced Upload'-post processing
            $this->store->setVar(VAR_FILE_DESTINATION, $pathFileName, STORE_VAR);
954
955
        }

956
        if ($pathFileName === '') {
Marc Egger's avatar
Marc Egger committed
957
            throw new \UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
958
959
        }

960
961
962
963
964
965
966
        // If given, get chmodDir. Needs to be prefixed with a 0 (=octal) - it should not be quoted! Symbolic mode is not allowed. E.g.: 0660, or 01777
        if (empty($formElement[FE_FILE_CHMOD_DIR])) {
            $chmodDir = false;
        } else {
            $chmodDir = octdec($formElement[FE_FILE_CHMOD_DIR]);
        }

967
        $overwrite = isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS;
968
        Support::moveFile($srcFile, $pathFileName, $overwrite, $chmodDir);
969

970
        // get chmodFile
971
972
        if (empty($formElement[FE_FILE_CHMOD_FILE])) {
            $chmodFile = false;
973
        } else {
974
            $chmodFile = octdec($formElement[FE_FILE_CHMOD_FILE]);
975
976
        }

977
        $this->autoOrient($formElement, $pathFileName);
978
        HelperFile::chmod($pathFileName, $chmodFile);
979

980
        $this->splitUpload($formElement, $pathFileName, $chmodFile, $statusUpload);
981

982
983
        return $pathFileName;
    }
984

985
986
    /**
     * If fe['autoOrient'] is given and the MimeType corresponds to fe['autoOrientMimeType']: the given {{pathFileName:V}} will be converted.
987
     * ImageMagick 'convert' seems to do a better job than GraficsMagick (Orientation is stable even if multiple times applied).
988
989
990
     *
     * @param array $formElement
     * @param $pathFileName
Marc Egger's avatar
Marc Egger committed
991
992
993
994
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
995
     */
996
    private function autoOrient(array $formElement, $pathFileName) {
997
998

        // 'autoOrient' wished?
999
        if (!isset($formElement[FE_FILE_AUTO_ORIENT]) || $formElement[FE_FILE_AUTO_ORIENT] == '0') {
1000
1001
1002
1003
            return; // No
        }

        // Upload has matching MimeType?
1004
        $mimeTypeList = empty($formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE]) ? 'image/jpeg,image/png,image/tiff' : $formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE];
1005
        if (!HelperFile::checkFileType($pathFileName, $pathFileName, $mimeTypeList)) {
1006
1007
1008
1009
1010
1011
1012
1013
            return;
        }

        // Get 'autoOrient' command
        $cmd = empty($formElement[FE_FILE_AUTO_ORIENT_CMD]) ? FE_FILE_AUTO_ORIENT_CMD_DEFAULT : $formElement[FE_FILE_AUTO_ORIENT_CMD];
        $cmd = $this->evaluate->parse($cmd);

        // Do 'autoOrient' command
1014
1015
        $output = Support::qfqExec($cmd, $rc);
        if ($rc != 0) {
Marc Egger's avatar
Marc Egger committed
1016
            throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'copy failed', ERROR_MESSAGE_TO_DEVELOPER => "[cmd=$cmd]$output"]), ERROR_IO_COPY);
1017
        }
1018
1019
    }

1020
    /**
Carsten  Rose's avatar
Carsten Rose committed
1021
1022
1023
1024
1025
1026
1027
     * Check's if the file $pathFileName should be splitted in one file per page. If no: do nothing and return.
     * The only possible split target file format is 'svg': fileSplit=svg.
     * The splitted files will be saved under fileDestinationSplit=some/path/to/file.%02d.svg. A printf style token,
     * like '%02d', is needed to create distinguished filename's. See 'man pdf2svg' for further details.
     * For every created file, a record in table 'Split' is created (see splitSvg() ), storing the pathFileName of the
     * current page/file.
     *
1028
     * @param array $formElement
1029
1030
     * @param string $pathFileName
     * @param int $chmod
1031
     * @param array $statusUpload
Marc Egger's avatar
Marc Egger committed
1032
1033
1034
1035
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
1036
     */
1037
    private function splitUpload(array $formElement, $pathFileName, $chmod, array $statusUpload) {
1038

1039

1040
1041
1042
1043
1044
1045
1046
1047
1048
        // Should the file be split?
        if (empty($formElement[FE_FILE_SPLIT])) {
            return;
        }

        // Is it technically possible to split the file?
        // BTW: the $statusUpload['type'] delivers 'octetstream' for PDF files who do not have the extension '.pdf' - therefore get mimetype again.
        $mime = HelperFile::getMimeType($pathFileName);
        if (false === strpos($mime, MIME_TYPE_SPLIT_CAPABLE) && $statusUpload[FILES_TYPE] != MIME_TYPE_SPLIT_CAPABLE) {
1049
1050
1051
            return;
        }

1052
1053
1054
1055
        $fileDestinationSplit = $this->evaluate->parse($formElement[FE_FILE_DESTINATION_SPLIT] ?? '');
        $fileSplitType = $this->evaluate->parse($formElement[FE_FILE_SPLIT] ?? '');
        $fileSplitTypeOptions = $this->evaluate->parse($formElement[FE_FILE_SPLIT_OPTIONS] ?? '');
        $fileSplitTableName = $this->evaluate->parse($formElement[FE_FILE_SPLIT_TABLE_NAME] ?? '');
1056
1057
1058
1059
1060

        if (empty($fileSplitTableName)) {
            $fileSplitTableName = $this->formSpec[F_TABLE_NAME];
        }

1061
1062
1063
        if ($fileDestinationSplit == '') {
            $ext = ($fileSplitType == FE_FILE_SPLIT_SVG) ? '.%02d.svg' : '.jpg';
            $fileDestinationSplit = $pathFileName . '.split/split' . $ext;
1064
1065
        }

Carsten  Rose's avatar
Carsten Rose committed
1066
        HelperFile::mkDirParent($fileDestinationSplit);
1067
1068
1069
1070
1071

        // Save CWD
        $cwd = getcwd();

        // Create temporary directory
1072
        $tempDir = HelperFile::mktempdir();
1073
        $newSrc = $tempDir . DIRECTORY_SEPARATOR . QFQ_TEMP_SOURCE;
1074
        HelperFile::copy($pathFileName, $newSrc);
1075
1076
1077
1078

        // Split destination.
        $pathParts = pathinfo($fileDestinationSplit);
        if (empty($pathParts['filename']) || empty($pathParts['basename'])) {
Marc Egger's avatar
Marc Egger committed
1079
            throw new \UserFormException('Missing filename in ' . FE_FILE_DESTINATION_SPLIT, ERROR_MISSING_FILE_NAME);
1080
1081
1082
1083
1084
        }

        // Extract filename from destination directory.
        $fileNameDest = $pathParts['basename'];

1085
1086
1087
1088
1089
        switch ($fileSplitType) {
            case FE_FILE_SPLIT_SVG:
                $cmd = 'pdf2svg "' . $newSrc . '" "' . $fileNameDest . '" all';
                break;
            case FE_FILE_SPLIT_JPEG:
1090
1091
1092
1093
                if ($fileSplitTypeOptions == '') {
                    $fileSplitTypeOptions = FE_FILE_SPLIT_OPTIONS_JPEG;
                }
                $cmd = "convert $fileSplitTypeOptions '$newSrc' '$fileNameDest'";
1094
1095
                break;
            default:
Marc Egger's avatar
Marc Egger committed
1096
                throw new \UserFormException("Unknown 'fileSplit' type: " . $formElement[FE_FILE_SPLIT], ERROR_UNKNOWN_TOKEN);
1097
1098
        }

1099
        // Split PDF
1100
        HelperFile::chdir($tempDir);