Save.php 48.3 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
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
15
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
Marc Egger's avatar
Marc Egger committed
16
use IMATHUZH\Qfq\Core\Helper\Logger;
17
use IMATHUZH\Qfq\Core\Helper\OnArray;
Marc Egger's avatar
Marc Egger committed
18
19
use IMATHUZH\Qfq\Core\Helper\Sanitize;
use IMATHUZH\Qfq\Core\Helper\Support;
20
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
Marc Egger's avatar
Marc Egger committed
21
use IMATHUZH\Qfq\Core\Store\Sip;
22
use IMATHUZH\Qfq\Core\Store\Store;
23

24
25
26
27
/**
 * Class Save
 * @package qfq
 */
28
29
30
31
32
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
33
    private $feSpecNativeRaw = array(); // copy of all formElement.class='native' of the loaded form
34
35
36
37
38
39

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

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

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

    private $evaluate = null;

52
53
    private $qfqLogFilename = '';

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

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

Marc Egger's avatar
Marc Egger committed
75
        $this->qfqLogFilename = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM) . '/' . $this->store->getVar(SYSTEM_QFQ_LOG, STORE_SYSTEM);
76

77
78
79
    }

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

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

        return $rc;
99
100
    }

101
102
103
104
105
106
107
108
109
110
111
    /**
     * @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);

112
        // No rows: This must be an error, cause MultiForms must have at least one record.
113
        if (empty($parentRecords)) {
114
115
116
117
            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);
118
119
120
121
122
123
124
125
126
127
128
129
130
        }

        // 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();
131
        $storeVarBase = $this->store->getStore(STORE_VAR);
132
133

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

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

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

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

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

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

        return $rc;
    }

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

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

166
167
168
169
170
171
172
173
            switch ($formElement[FE_TYPE]) {
//                case FE_TYPE_EXTRA:
                case FE_TYPE_NOTE:
                case FE_TYPE_SUBRECORD:
                    continue 2;
                default:
                    break;
            }
174
            $feName = $formElement[FE_NAME];
175
176
177

            // #7705. Skip FE, which are not already expanded. Detect them by '%' (== '%d')
            if (!isset($formValues[$feName]) && false === stripos($feName, '%d') && $this->isMemberOfTemplateGroup($formElement)) {
178
179
180
                $formValues[$feName] = $formElement[FE_VALUE];
            }
        }
Carsten  Rose's avatar
Carsten Rose committed
181

182
183
184
        return $formValues;
    }

185
    /**
186
187
188
189
190
     * 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
191
     * @throws \UserFormException
192
193
194
195
196
     */
    private function isMemberOfTemplateGroup(array $formElement, $depth = 0) {
        $depth++;

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

        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,
    }

    /**
     *
219
     * @param $feName
Carsten  Rose's avatar
Carsten Rose committed
220
     *
221
222
223
224
225
226
227
228
229
230
231
     * @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;
    }

232
    /**
Carsten  Rose's avatar
Carsten Rose committed
233
234
     * 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
235
     *
236
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
237
     *
238
     * @return int    record id (in case of insert, it's different from $recordId)
Marc Egger's avatar
Marc Egger committed
239
240
     * @throws \CodeException
     * @throws \DbException
241
242
     * @throws \UserFormException
     * @throws \UserReportException
243
     */
244
    private function elements($recordId) {
245
246
        $columnCreated = false;
        $columnModified = false;
247
        $realColumnFound = false;
Carsten  Rose's avatar
Carsten Rose committed
248

249
250
251
        $newValues = array();

        $tableColumns = array_keys($this->store->getStore(STORE_TABLE_COLUMN_TYPES));
252
        $formValues = $this->store->getStore(STORE_FORM);
253
        $formValues = $this->createEmptyTemplateGroupElements($formValues);
254
255
256

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

258
            // Never save a predefined 'id': autoincrement values will be given by database..
259
            if ($column === COLUMN_ID) {
260
                continue;
261
            }
262

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
263
264
            // Skip Upload Elements: those will be processed later.
            if ($this->isColumnUploadField($column)) {
265
                $realColumnFound = true;
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
266
267
268
                continue;
            }

269
270
271
272
273
274
275
276
            if ($column === COLUMN_CREATED) {
                $columnCreated = true;
            }

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

277
278
            // Is there a value? Do not forget SIP values. Those do not have necessarily a FormElement.
            if (!isset($formValues[$column])) {
279
                continue;
280
281
            }

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

284
285
286
287
288
289
            // 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);
            }
290
            $newValues[$column] = $formValues[$column];
291
            $realColumnFound = true;
292
293
        }

294
295
        // Only save record if real columns exist.
        if ($realColumnFound) {
296

297
298
            if ($columnModified && !isset($newValues[COLUMN_MODIFIED])) {
                $newValues[COLUMN_MODIFIED] = date('YmdHis');
299
            }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
300

301
302
303
304
305
306
307
            if ($recordId == 0) {
                if ($columnCreated && !isset($newValues[COLUMN_CREATED])) {
                    $newValues[COLUMN_CREATED] = date('YmdHis');
                }
                $recordId = $this->insertRecord($this->formSpec[F_TABLE_NAME], $newValues);

            } else {
308
309
                $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
            }
310
311
        }

312
        $this->nativeDoSlave($recordId);
313

314
        return $recordId;
315
316
    }

317
    /**
318
319
     * Process sqlBefore, sqlInsert|.... for all native FE.
     *
320
     * @param $recordId
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
321
     *
322
323
324
325
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
326
     */
327
328
329
330
331
332
333
334
    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);
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
            $this->typeAheadDoTagGlue($fe);
        }
    }

    /**
     * typeAhead: if given, process Tag or Glue.
     *
     * @param array $fe
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
     */
    private function typeAheadDoTagGlue(array $fe) {

        if (($fe[FE_TYPEAHEAD_TAG] ?? '0') == '0' || (!isset($fe[FE_TYPEAHEAD_GLUE_INSERT]) && !isset($fe[FE_TYPEAHEAD_TAG_INSERT]))) {
            return;
        }

        if (empty($fe[FE_TYPEAHEAD_GLUE_INSERT]) || empty($fe[FE_TYPEAHEAD_GLUE_DELETE])) {
            throw new \UserFormException("Missing 'typeAheadGlueInsert' or 'typeAheadGlueDelete'", ERROR_MISSING_REQUIRED_PARAMETER);
        }

        // Extract assigned tags: last
        $tagLast = KeyValueStringParser::parse($this->evaluate->parse($fe[FE_VALUE], ROW_EXPECT_0_1));

        // Extract assigned tags: new
        $tagNew = KeyValueStringParser::parse($this->store->getVar($fe[FE_NAME], STORE_FORM,
            ($fe[FE_CHECK_TYPE] == SANITIZE_ALLOW_AUTO) ? SANITIZE_ALLOW_ALNUMX : $fe[FE_CHECK_TYPE]));

        // Get all tags who are new
        $result = array_diff_assoc($tagNew, $tagLast);

        // Create glue records
        foreach ($result as $id => $value) {
            $this->store->setVar(VAR_TAG_ID, $id, STORE_VAR);
            $this->store->setVar(VAR_TAG_VALUE, $value, STORE_VAR);
            // Create glue
            $this->evaluate->parse($fe[FE_TYPEAHEAD_GLUE_INSERT]);
        }

        // Get all tags who has been removed
        $result = array_diff_assoc($tagLast, $tagNew);

        // Delete Glue records
        foreach ($result as $id => $value) {
            $this->store->setVar(VAR_TAG_ID, $id, STORE_VAR);
            $this->store->setVar(VAR_TAG_VALUE, $value, STORE_VAR);
            // Delete glue
            $this->evaluate->parse($fe[FE_TYPEAHEAD_GLUE_DELETE]);
385
386
387
        }
    }

388
    /**
389
390
     * Checks if there is a formElement with name '$feName' of type 'upload'
     *
391
392
393
     * @param $feName
     * @return bool
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
394
395
396
    private function isColumnUploadField($feName) {

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

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
401
402
403
404
405
406
        return false;
    }

    /**
     * Insert new record in table $this->formSpec['tableName'].
     *
407
     * @param $tableName
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
408
     * @param array $values
Carsten  Rose's avatar
Carsten Rose committed
409
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
410
     * @return int  last insert id
Marc Egger's avatar
Marc Egger committed
411
412
413
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
414
415
416
417
418
419
420
421
422
423
     */
    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)) . '`';

424
        $sql = "INSERT INTO `$tableName` ( " . $columnList . " ) VALUES ( " . $paramList . ' )';
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
425
426
427
428
429
430
431
432

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

        return $rc;
    }

    /**
     * @param string $tableName
Carsten  Rose's avatar
Carsten Rose committed
433
434
     * @param array $values
     * @param int $recordId
435
     * @param string $primaryKey
Carsten  Rose's avatar
Carsten Rose committed
436
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
437
     * @return bool|int     false if $values is empty, else affectedrows
Marc Egger's avatar
Marc Egger committed
438
439
440
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
441
     */
442
    public function updateRecord($tableName, array $values, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
443
444
445
446

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

447
        if ($recordId === 0) {
Marc Egger's avatar
Marc Egger committed
448
            throw new \CodeException('RecordId=0 - this is not possible for update.', ERROR_RECORDID_0_FORBIDDEN);
449
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
450
451
452
453
454
455
456
457

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

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

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

458
        $sql = substr($sql, 0, strlen($sql) - 2) . " WHERE $primaryKey = ?";
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
459
460
461
462
463
464
465
        $values[] = $recordId;

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

        return $rc;
    }

466
    /**
Carsten  Rose's avatar
Carsten Rose committed
467
468
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
469
470
471
472
473
474
475
476
     *
     * Constellation: # FILE OLD   FILE NEW     FILESIZE
     *                1 none       none
     *                2 none       new
     *                3 exist      no change
     *                4 delete     none
     *                5 delete     new
     *
477
     * @param $recordId
Marc Egger's avatar
Marc Egger committed
478
479
480
481
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
482
483
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
484
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
485
486
487
488
    public function processAllUploads($recordId) {

        $sip = new Sip(false);
        $newValues = array();
489
        $vars = array();
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
490
491

        $formValues = $this->store->getStore(STORE_FORM);
492
        $primaryRecord = $this->store->getStore(STORE_RECORD); // necessary to check if the current formElement exist as a column of the primary table.
493
494
495

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

500
501
502
503
            // 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);

504
            $formElement = HelperFormElement::initUploadFormElement($formElement);
505
            if (isset($formElement[FE_FILL_STORE_VAR])) {
506
                $formElement[FE_FILL_STORE_VAR] = $this->evaluate->parse($formElement[FE_FILL_STORE_VAR], ROW_EXPECT_0_1);
507
                $this->store->appendToStore($formElement[FE_FILL_STORE_VAR], STORE_VAR);
508
            }
509

510
            $column = $formElement[FE_NAME];
511
            $pathFileName = $this->doUpload($formElement, ($formValues[$column] ?? ''), $sip, $modeUpload);
512

513
514
            if ($modeUpload == UPLOAD_MODE_DELETEOLD && $pathFileName == '') {
                $pathFileNameTmp = '';  // see '4'
515
516
            } else {
                if (empty($pathFileName)) {
517
                    $pathFileNameTmp = $primaryRecord[$column] ?? ''; // see '3'. Attention: in case of Advanced Upload, $primaryRecord[$column] does not exist.
518
519
520
521
522
                } else {
                    $pathFileNameTmp = $pathFileName; // see '1,2,5'
                }
            }

523
            // Get latest file information
524
            if ($pathFileNameTmp == '') {
525
526
527
                // 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);
528
529
                $vars[VAR_FILE_SIZE] = 0;
                $vars[VAR_FILE_MIME_TYPE] = '';
530
531
532
533
534
            } else {
                $vars = HelperFile::getFileStat($pathFileNameTmp);
                $this->store->appendToStore($vars, STORE_VAR);
            }

535
536
537
            // If given: fire a sqlBefore query
            $this->evaluate->parse($formElement[FE_SQL_BEFORE]);

538
            // Upload Type: Simple or Advanced
539
540
541
            // 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.
542
543
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
544
545
546
547
548
549
550
551

                    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];
                    }
552
                }
553
554
            } elseif (isset($formElement[FE_IMPORT_TO_TABLE]) && !isset($formElement[FE_SLAVE_ID])) {
                // Excel import on nonexisting column -> no upload
555
556
            } else {
                // 'Advanced Upload'
557
                $this->doUploadSlave($formElement, $modeUpload);
558
            }
559
560
561
562

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

563
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
564

565
        // Only used in 'Simple Upload'
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
566
        if (count($newValues) > 0) {
567
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
568
        }
569
570
    }

571
    /**
572
573
     * Process all Upload FormElements for the given $recordId.
     * After processing, &$formValues will be updated with the final filename.
574
     *
Marc Egger's avatar
Marc Egger committed
575
576
     * @throws \CodeException
     * @throws \UserFormException
577
578
579
580
581
582
583
584
585
586
587
588
589
     */
    public function processAllImageCutFE() {

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

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

590
591
592
593
594
595
596
597

    /**
     * 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
598
599
600
601
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
602
603
604
     */
    public function checkRequiredHidden() {

605
        $formModeGlobal = Support::getFormModeGlobal($this->formSpec[F_MODE_GLOBAL] ?? '');
606
        $reportRequiredFailed = true;
607

608
609
610
611
612
613
        switch ($formModeGlobal) {
            case F_MODE_REQUIRED_OFF:
            case F_MODE_REQUIRED_OFF_BUT_MARK:
                $reportRequiredFailed = false;
                break;
        }
614
615
616

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

617
618
        $flagAllRequiredGiven = 1;

619
620
        foreach ($this->feSpecNative AS $key => $formElement) {

621
622
623
624
625
            // Do not check retype slave FE.
            if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
                continue;
            }

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

628
629
630
631
632
            // Normalize FE_MODE
            $mode = Support::handleEscapeSpaceComment($formElement[FE_MODE_SQL]);
            $mode = empty($mode) ? $formElement[FE_MODE] : $this->evaluate->parse($mode);
            $this->feSpecNative[$key][FE_MODE] = $formElement[FE_MODE] = $mode;
            $this->feSpecNative[$key][FE_MODE_SQL] = $formElement[FE_MODE_SQL] = '';
633

634
635
636
            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.
637
638
            }

639
640
641
642
643
            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);
                }
644
645
646
647
648
649
650
            }

            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);
            }
        }
651
652
653

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

656
657
658
    /**
     *
     * @param array $formElement
Marc Egger's avatar
Marc Egger committed
659
660
     * @throws \CodeException
     * @throws \UserFormException
661
662
663
664
665
666
     */
    private function extractImageDataReplaceFile(array $formElement) {

        // Take care the necessary target directories exist.
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
667
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
Marc Egger's avatar
Marc Egger committed
668
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
669
                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."]),
670
                ERROR_IO_CHDIR);
671
672
        }

673
        // Get original pathFileName
674
675
676
        $field = HelperFormElement::AppendFormElementNameImageCut($formElement);
        $pathFileName = $this->store->getVar($field, STORE_SIP);
        if ($pathFileName == '' || !file_exists($pathFileName)) {
Marc Egger's avatar
Marc Egger committed
677
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
678
                json_encode([ERROR_MESSAGE_TO_USER => 'Empty file or file not found', ERROR_MESSAGE_TO_DEVELOPER => 'Empty file or file not found: ' . $pathFileName]),
679
                ERROR_IO_FILE_NOT_FOUND);
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
        }

        // '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)
            ) {
715
                HelperFile::rename($pathFileName, $pathFileName . $extSave);
716
717
718
719
720
721
722
723
            }
        }

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

        if (false === file_put_contents($pathFileName, base64_decode($imageData))) {
Marc Egger's avatar
Marc Egger committed
724
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
725
                json_encode([ERROR_MESSAGE_TO_USER => 'Write new image failed', ERROR_MESSAGE_TO_DEVELOPER => "Write new image failed: $pathFileName"]),
726
                ERROR_IO_WRITE);
727
728
729
730
731
        }

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

732
    /**
733
734
735
     * 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
736
737
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
738
739
740
741
     * @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
742
743
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
744
     * @return false|string New pathFilename or false on error
Marc Egger's avatar
Marc Egger committed
745
746
747
748
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
749
750
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
751
752
     * @internal param $recordId
     */
753
754
755
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
756

757
        // Status information about upload file
758
759
760
761
762
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

763
        if (isset($formElement[FE_IMPORT_TO_TABLE]) && isset($statusUpload[FILES_TMP_NAME])) {
764
            // Import
765
            $tmpFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
766
767
            $this->doImport($formElement, $tmpFile);
        }
768

769
        // Upload - Take care the necessary target directories exist.
770
771
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
772
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
Marc Egger's avatar
Marc Egger committed
773
            throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
774
                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."]),
775
                ERROR_IO_CHDIR);
776
        }
777

778
779
780
781
782
        // 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)) {
783
                //TODO: it might be possible to delete a file, which is referenced by another record - a check would be nice.
784
                HelperFile::unlink($oldFile, $this->qfqLogFilename);
785
786
787
788
789
790
791
792
793
794
795
            }
            $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;
        }

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

798
        // skip uploading the file, if this is an import without a specified file destination
799
800
        if (!isset($formElement[FE_IMPORT_TO_TABLE]) || isset($formElement[FE_FILE_DESTINATION])) {
            $pathFileName = $this->copyUploadFile($formElement, $statusUpload);
801
802
803
804

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

807
        HelperFile::chdir($cwd);
808
809
810
811
812
813
814
815
816

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

        return $pathFileName;
    }

    /**
     * @param $formElement
817
     * @param $fileName
Marc Egger's avatar
Marc Egger committed
818
819
820
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
821
822
823
824
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     */
    private function doImport($formElement, $fileName) {
825
        $importNamedSheetsOnly = array();
826

827
        Support::setIfNotSet($formElement, FE_IMPORT_TYPE, FE_IMPORT_TYPE_AUTO);
828

829
830
831
832
        if (!empty($formElement[FE_IMPORT_NAMED_SHEETS_ONLY])) {
            $importNamedSheetsOnly = explode(',', $formElement[FE_IMPORT_NAMED_SHEETS_ONLY]);
        }

Carsten  Rose's avatar
Carsten Rose committed
833
        // Check for keywords which needs an explicit given document type.
834
835
836
837
838
        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
839
                    throw new \UserFormException('If ' . $token .
840
841
842
843
844
                        ' is given, an explicit document type (like ' . FE_IMPORT_TYPE . '=xlsx) should be set.', ERROR_IMPORT_MISSING_EXPLICIT_TYPE);
                }
            }
        }

845
846
847
848
849
850
851
852
853
854
855
        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);
856
857
858
859
860
861
862
863
864
865
866
867
868

                // 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
869
                    throw new \UserFormException("Worksheets: " . implode(', ', $sheetNames),
870
871
872
                        ERROR_IMPORT_LIST_SHEET_NAMES);
                }

873
874
875
876
                $spreadsheet = $reader->load($fileName);
                break;

            default:
Marc Egger's avatar
Marc Egger committed
877
                throw new \UserFormException("Unknown Excel import type: '" . $formElement[FE_IMPORT_TYPE] . "'.",
878
879
880
881
                    ERROR_UNKNOWN_EXCEL_IMPORT_TYPE);
        }

        $tableName = $formElement[FE_IMPORT_TO_TABLE];
882
        $regions = OnArray::trimArray(explode('|', $formElement[FE_IMPORT_REGION] ?? ''));
883
        $columnNames = OnArray::trimArray(explode(',', $formElement[FE_IMPORT_TO_COLUMNS] ?? ''));
884
885
886
887
        $importMode = $formElement[FE_IMPORT_MODE] ?? FE_IMPORT_MODE_APPEND;

        foreach ($regions as $region) {
            // region: tab, startColumn, startRow, endColumn, endRow
888
            $region = OnArray::trimArray(explode(',', $region));
889
890
891
892
893
894
895
896
897
898
899
900
901
902
            $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."
                        );
903
904
                    }
                }
905
            } catch (\PhpOffice\PhpSpreadsheet\Exception $e) {
Marc Egger's avatar
Marc Egger committed
906
                throw new \UserFormException($e->getMessage());
907
            }
908

909
910
911
912
913
914
915
916
917
            // 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];
918
919
                }
            }
920
921
922
923
924
            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];
                }
925
            }
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
            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);
944
                }
945
946
                $columnDefinitionArr[] = "`$columnName`   TEXT       NOT NULL  DEFAULT ''";
                $columnListArr[] = "$columnName";
947
948
            }

949
950
951
952
953
954
955
956
957
958
959
960
961
            // 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;
962
            }
963

964
965
            // Import the data
            foreach ($worksheetData AS $rowIndex => $row) {
966
                $columnList = '`' . implode('`,`', $columnListArr) . '`';
967
968
969
970
                $paramPlaceholders = str_repeat('?,', count($worksheetData[0]) - 1) . '?';
                $insertSql = "INSERT INTO `$tableName` ($columnList) VALUES ($paramPlaceholders)";
                $this->db->sql($insertSql, ROW_REGULAR, $row);
            }
971
        }
972
973
974
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
975
976
977
978
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
979
980
981
     * @param array $formElement
     * @param array $statusUpload
     * @return array|mixed|null|string
Marc Egger's avatar
Marc Egger committed
982
983
984
985
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
986
     */
987
    private function copyUploadFile(array $formElement, array $statusUpload) {
988
989
        $pathFileName = '';

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
990
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
991
992
993
994
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

995
996
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);

997
        if (isset($formElement[FE_FILE_DESTINATION])) {
998

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

1003
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
1004
            $pathFileName = Sanitize::safeFilename($pathFileName, false, true); // Dynamically calculated pathFileName might contain invalid characters.
1005
1006
1007

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

1010
        if ($pathFileName === '') {
Marc Egger's avatar
Marc Egger committed
1011
            throw new \UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
1012
1013
        }

1014
1015
1016
1017
1018
1019
1020
        // 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]);
        }

1021
        $overwrite = isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS;
1022
        Support::moveFile($srcFile, $pathFileName, $overwrite, $chmodDir);
1023

1024
        // get chmodFile
1025
1026
        if (empty($formElement[FE_FILE_CHMOD_FILE])) {
            $chmodFile = false;
1027
        } else {
1028
            $chmodFile = octdec($formElement[FE_FILE_CHMOD_FILE]);
1029
1030
        }

1031
        $this->autoOrient($formElement, $pathFileName);
1032
        HelperFile::chmod($pathFileName, $chmodFile);
1033

1034
        $this->splitUpload($formElement, $pathFileName, $chmodFile, $statusUpload);
1035

1036
1037
        return $pathFileName;
    }
1038

1039
1040
    /**
     * If fe['autoOrient'] is given and the MimeType corresponds to fe['autoOrientMimeType']: the given {{pathFileName:V}} will be converted.
1041
     * ImageMagick 'convert' seems to do a better job than GraficsMagick (Orientation is stable even if multiple times applied).
1042
1043
1044
     *
     * @param array $formElement
     * @param $pathFileName
Marc Egger's avatar
Marc Egger committed
1045
1046
1047
1048
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
1049
     */
1050
    private function autoOrient(array $formElement, $pathFileName) {
1051
1052

        // 'autoOrient' wished?
1053
        if (!isset($formElement[FE_FILE_AUTO_ORIENT]) || $formElement[FE_FILE_AUTO_ORIENT] == '0') {
1054
1055
1056
1057
            return; // No
        }

        // Upload has matching MimeType?
1058
        $mimeTypeList = empty($formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE]) ? 'image/jpeg,image/png,image/tiff' : $formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE];
1059
        if (!HelperFile::checkFileType($pathFileName, $pathFileName, $mimeTypeList)) {
1060
1061
1062
1063
1064
1065
1066
1067
            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
1068
1069
        $output = Support::qfqExec($cmd, $rc);
        if ($rc != 0) {
Marc Egger's avatar
Marc Egger committed
1070
            throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'copy failed', ERROR_MESSAGE_TO_DEVELOPER => "[cmd=$cmd]$output"]), ERROR_IO_COPY);
1071
        }
1072
1073
    }

1074
    /**
Carsten  Rose's avatar
Carsten Rose committed
1075
1076
1077
1078
1079
1080
1081
     * 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.
     *
1082
     * @param array $formElement
1083
1084
     * @param string $pathFileName
     * @param int $chmod
1085
     * @param array $statusUpload
Marc Egger's avatar
Marc Egger committed
1086
1087
1088
1089
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException