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

namespace qfq;

11
12
13
14
15
require_once(__DIR__ . '/store/Store.php');
require_once(__DIR__ . '/store/Sip.php');
require_once(__DIR__ . '/Constants.php');
require_once(__DIR__ . '/Evaluate.php');
require_once(__DIR__ . '/helper/HelperFile.php');
16
require_once(__DIR__ . '/helper/OnArray.php');
17
18
19
20
21
22
//require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
//require_once(__DIR__ . '/../qfq/exceptions/CodeException.php');
//require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
//require_once(__DIR__ . '/../qfq/Evaluate.php');


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
39
40
    /**
     * @var null|Store
     */
    private $store = null;
    private $db = null;

    private $evaluate = null;

41
42
    private $qfqLogFilename = '';

43
44
45
46
    /**
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
47
     * @param array $feSpecNativeRaw
48
     * @throws CodeException
49
     * @throws DbException
50
     * @throws UserFormException
51
     * @throws UserReportException
52
     */
53
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $feSpecNativeRaw) {
54
55
56
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
57
        $this->feSpecNativeRaw = $feSpecNativeRaw;
58
        $this->store = Store::getInstance();
59
        $this->db = new Database($formSpec[F_DB_INDEX]);
60
        $this->evaluate = new Evaluate($this->store, $this->db);
61
62
63

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

64
65
66
    }

    /**
67
68
     * Starts save process. On succcess, returns forwardmode/page.
     *
69
     * @return int
70
71
     * @throws CodeException
     * @throws DbException
72
     * @throws UserFormException
73
74
     */
    public function process() {
75
        $rc = 0;
76
77
78
79
80

        if ($this->formSpec['multiMode'] !== 'none') {

            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
81
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
82
                $rc = $this->elements($row['_id']);
83
84
            }
        } else {
85
86
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
            $rc = $this->elements($recordId);
87
        }
88
89

        return $rc;
90
91
    }

92
    /**
Carsten  Rose's avatar
Carsten Rose committed
93
94
     * Create empty FormElements based on templateGroups, for those who not already exist.
     *
95
     * @param array $formValues
Carsten  Rose's avatar
Carsten Rose committed
96
     *
97
     * @return array
98
     * @throws UserFormException
99
100
101
102
103
     */
    private function createEmptyTemplateGroupElements(array $formValues) {

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

104
105
106
107
108
109
110
111
            switch ($formElement[FE_TYPE]) {
//                case FE_TYPE_EXTRA:
                case FE_TYPE_NOTE:
                case FE_TYPE_SUBRECORD:
                    continue 2;
                default:
                    break;
            }
112
            $feName = $formElement[FE_NAME];
113
            if (!isset($formValues[$feName]) && $this->isMemberOfTemplateGroup($formElement)) {
114
115
116
                $formValues[$feName] = $formElement[FE_VALUE];
            }
        }
Carsten  Rose's avatar
Carsten Rose committed
117

118
119
120
        return $formValues;
    }

121
    /**
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
     * Check if the current $formElement is member of a templateGroup.
     *
     * @param array $formElement
     * @param int $depth
     * @return bool
     * @throws UserFormException
     */
    private function isMemberOfTemplateGroup(array $formElement, $depth = 0) {
        $depth++;

        if ($depth > 15) {
            throw new UserFormException('FormElement nested too much (in each other - endless?): stop recursion', ERROR_FE_NESTED_TOO_MUCH);
        }

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

    /**
     *
155
     * @param $feName
Carsten  Rose's avatar
Carsten Rose committed
156
     *
157
158
159
160
161
162
163
164
165
166
167
     * @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;
    }

168
    /**
Carsten  Rose's avatar
Carsten Rose committed
169
170
     * 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
171
     *
172
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
173
     *
174
     * @return int   record id (in case of insert, it's different from $recordId)
175
176
     * @throws CodeException
     * @throws DbException
177
     * @throws UserFormException
178
179
     */
    public function elements($recordId) {
180
181
        $columnCreated = false;
        $columnModified = false;
Carsten  Rose's avatar
Carsten Rose committed
182

183
184
185
        $newValues = array();

        $tableColumns = array_keys($this->store->getStore(STORE_TABLE_COLUMN_TYPES));
186
        $formValues = $this->store->getStore(STORE_FORM);
187
        $formValues = $this->createEmptyTemplateGroupElements($formValues);
188
189
190

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

192
            // Never save a predefined 'id': autoincrement values will be given by database..
193
            if ($column === COLUMN_ID) {
194
                continue;
195
            }
196

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
197
198
199
200
201
            // Skip Upload Elements: those will be processed later.
            if ($this->isColumnUploadField($column)) {
                continue;
            }

202
203
204
205
206
207
208
209
            if ($column === COLUMN_CREATED) {
                $columnCreated = true;
            }

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

210
211
            // Is there a value? Do not forget SIP values. Those do not have necessarily a FormElement.
            if (!isset($formValues[$column])) {
212
                continue;
213
214
            }

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

217
218
219
220
221
222
            // 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);
            }
223
            $newValues[$column] = $formValues[$column];
224

225
226
        }

227
228
229
230
        if ($columnModified && !isset($newValues[COLUMN_MODIFIED])) {
            $newValues[COLUMN_MODIFIED] = date('YmdHis');
        }

231
        if ($recordId == 0) {
232
233
234
            if ($columnCreated && !isset($newValues[COLUMN_CREATED])) {
                $newValues[COLUMN_CREATED] = date('YmdHis');
            }
235
            $rc = $this->insertRecord($this->formSpec[F_TABLE_NAME], $newValues);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
236

237
        } else {
238
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
239
240
241
242
            $rc = $recordId;
        }

        return $rc;
243
244
    }

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
245
246
247
248
249
250
    /*
     * Checks if there is a formElement with name '$feName' of type 'upload'
     *
     * @param $feName
     * @return bool
     */
251
252
253
254
    /**
     * @param $feName
     * @return bool
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
255
256
257
258
259
260
    private function isColumnUploadField($feName) {

        foreach ($this->feSpecNative AS $formElement) {
            if ($formElement[FE_NAME] === $feName && $formElement[FE_TYPE] == 'upload')
                return true;
        }
Carsten  Rose's avatar
Carsten Rose committed
261

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
262
263
264
265
266
267
        return false;
    }

    /**
     * Insert new record in table $this->formSpec['tableName'].
     *
268
     * @param $tableName
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
269
     * @param array $values
Carsten  Rose's avatar
Carsten Rose committed
270
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
271
     * @return int  last insert id
272
     * @throws CodeException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
273
     * @throws DbException
274
     * @throws UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
275
276
277
278
279
280
281
282
283
284
     */
    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)) . '`';

285
        $sql = "INSERT INTO $tableName ( " . $columnList . " ) VALUES ( " . $paramList . ' )';
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
286
287
288
289
290
291
292
293

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

        return $rc;
    }

    /**
     * @param string $tableName
Carsten  Rose's avatar
Carsten Rose committed
294
295
     * @param array $values
     * @param int $recordId
296
     * @param string $primaryKey
Carsten  Rose's avatar
Carsten Rose committed
297
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
298
299
300
     * @return bool|int     false if $values is empty, else affectedrows
     * @throws CodeException
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
301
     * @throws UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
302
     */
303
    public function updateRecord($tableName, array $values, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
304
305
306
307

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

308
        if ($recordId === 0) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
309
            throw new CodeException('RecordId=0 - this is not possible for update.', ERROR_RECORDID_0_FORBIDDEN);
310
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
311
312
313
314
315
316
317
318

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

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

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

319
        $sql = substr($sql, 0, strlen($sql) - 2) . " WHERE $primaryKey = ?";
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
320
321
322
323
324
325
326
        $values[] = $recordId;

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

        return $rc;
    }

327
    /**
Carsten  Rose's avatar
Carsten Rose committed
328
329
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
330
331
332
333
334
335
336
337
     *
     * Constellation: # FILE OLD   FILE NEW     FILESIZE
     *                1 none       none
     *                2 none       new
     *                3 exist      no change
     *                4 delete     none
     *                5 delete     new
     *
338
339
340
341
342
     * @param $recordId
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
343
344
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
345
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
346
347
348
349
    public function processAllUploads($recordId) {

        $sip = new Sip(false);
        $newValues = array();
350
        $vars=array();
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
351
352

        $formValues = $this->store->getStore(STORE_FORM);
353
        $primaryRecord = $this->store->getStore(STORE_RECORD); // necessary to check if the current formElement exist as a column of the primary table.
354
355
356

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

361
362
363
364
            // 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);

365
            $formElement = HelperFormElement::initUploadFormElement($formElement);
366
            if (isset($formElement[FE_FILL_STORE_VAR])) {
367
                $formElement[FE_FILL_STORE_VAR] = $this->evaluate->parse($formElement[FE_FILL_STORE_VAR], ROW_EXPECT_0_1);
368
                $this->store->appendToStore($formElement[FE_FILL_STORE_VAR], STORE_VAR);
369
            }
370

371
            $column = $formElement[FE_NAME];
372
            $pathFileName = $this->doUpload($formElement, $formValues[$column], $sip, $modeUpload);
373

374
375
376
377
            if($modeUpload==UPLOAD_MODE_DELETEOLD && $pathFileName==''){
                $pathFileNameTmp='';  // see '4'
            } else {
                if (empty($pathFileName)) {
378
                    $pathFileNameTmp = $primaryRecord[$column]??''; // see '3'. Attention: in case of Advanced Upload, $primaryRecord[$column] does not exist.
379
380
381
382
383
                } else {
                    $pathFileNameTmp = $pathFileName; // see '1,2,5'
                }
            }

384
            // Get latest file information
385
386
387
388
389
390
391
392
393
            if($pathFileNameTmp=='') {
                // 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);
            } else {
                $vars = HelperFile::getFileStat($pathFileNameTmp);
                $this->store->appendToStore($vars, STORE_VAR);
            }

394
395
396
            // If given: fire a sqlBefore query
            $this->evaluate->parse($formElement[FE_SQL_BEFORE]);

397
            // Upload Type: Simple or Advanced
398
399
400
            // 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.
401
402
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
403
404
405
406
407
408
409
410

                    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];
                    }
411
                }
412
413
            } elseif (isset($formElement[FE_IMPORT_TO_TABLE]) && !isset($formElement[FE_SLAVE_ID])) {
                // Excel import on nonexisting column -> no upload
414
415
            } else {
                // 'Advanced Upload'
416
                $this->doUploadSlave($formElement, $modeUpload);
417
            }
418
419
420
421

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

422
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
423

424
        // Only used in 'Simple Upload'
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
425
        if (count($newValues) > 0) {
426
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId, $this->formSpec[F_PRIMARY_KEY]);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
427
        }
428
429
    }

430
    /**
431
432
     * Process all Upload FormElements for the given $recordId.
     * After processing, &$formValues will be updated with the final filename.
433
     *
434
435
     * @throws CodeException
     * @throws UserFormException
436
437
438
439
440
441
442
443
444
445
446
447
448
     */
    public function processAllImageCutFE() {

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

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

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

    /**
     * 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.
     *
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
     */
    public function checkRequiredHidden() {

        $requiredOff = ($this->store->getVar(F_MODE_GLOBAL, STORE_SIP) == F_MODE_REQUIRED_OFF);

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

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

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

472
473
474
475
476
477
478
            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;
            }

479
480
481
            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.
482
483
            }

484
            if (!$requiredOff && $mode == FE_MODE_REQUIRED && empty($clientValues[$formElement[FE_NAME]])) {
485
                throw new UserFormException("Missing required value: " . $formElement[FE_LABEL], ERROR_REQUIRED_VALUE_EMPTY);
486
487
488
489
490
491
492
493
494
            }

            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);
            }
        }
    }

495
496
497
498
499
500
501
502
503
504
505
    /**
     *
     * @param array $formElement
     * @throws CodeException
     * @throws UserFormException
     */
    private function extractImageDataReplaceFile(array $formElement) {

        // Take care the necessary target directories exist.
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
506
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
507
508
509
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'getcwd() failed or SITE_PATH undefined or chdir() failed', ERROR_MESSAGE_SUPPORT => "getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed."]),
                ERROR_IO_CHDIR);
510
511
        }

512
        // Get original pathFileName
513
514
515
        $field = HelperFormElement::AppendFormElementNameImageCut($formElement);
        $pathFileName = $this->store->getVar($field, STORE_SIP);
        if ($pathFileName == '' || !file_exists($pathFileName)) {
516
517
518
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'Empty file or file not found', ERROR_MESSAGE_SUPPORT => 'Empty file or file not found: ' . $pathFileName]),
                ERROR_IO_FILE_NOT_FOUND);
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
        }

        // '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)
            ) {
554
                HelperFile::rename($pathFileName, $pathFileName . $extSave);
555
556
557
558
559
560
561
562
            }
        }

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

        if (false === file_put_contents($pathFileName, base64_decode($imageData))) {
563
564
565
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'Write new image failed', ERROR_MESSAGE_SUPPORT => "Write new image failed: $pathFileName"]),
                ERROR_IO_WRITE);
566
567
568
569
570
        }

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

571
    /**
572
573
574
     * 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
575
576
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
577
578
579
580
     * @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
581
582
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
583
     * @return false|string New pathFilename or false on error
584
     * @throws CodeException
585
     * @throws DbException
586
     * @throws UserFormException
587
588
589
     * @throws UserReportException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
590
591
     * @internal param $recordId
     */
592
593
594
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
595

596
        // Status information about upload file
597
598
599
600
601
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

602
        if (isset($formElement[FE_IMPORT_TO_TABLE]) && isset($statusUpload[FILES_TMP_NAME])) {
603
            // Import
604
            $tmpFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
605
606
            $this->doImport($formElement, $tmpFile);
        }
607

608
        // Upload - Take care the necessary target directories exist.
609
610
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
611
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
612
613
614
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'getcwd() failed or SITE_PATH undefined or chdir() failed', ERROR_MESSAGE_SUPPORT => "getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed."]),
                ERROR_IO_CHDIR);
615
        }
616

617
618
619
620
621
        // 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)) {
622
                //TODO: it might be possible to delete a file, which is referenced by another record - a check would be nice.
623
                HelperFile::unlink($oldFile, $this->qfqLogFilename);
624
625
626
627
628
629
630
631
632
633
634
            }
            $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;
        }

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

637
        // skip uploading the file, if this is an import without a specified file destination
638
639
        if (!isset($formElement[FE_IMPORT_TO_TABLE]) || isset($formElement[FE_FILE_DESTINATION])) {
            $pathFileName = $this->copyUploadFile($formElement, $statusUpload);
640
641
642
643

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

646
        HelperFile::chdir($cwd);
647
648
649
650
651
652
653
654
655

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

        return $pathFileName;
    }

    /**
     * @param $formElement
656
     * @param $fileName
657
658
659
660
661
662
663
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     */
    private function doImport($formElement, $fileName) {
664

665
        Support::setIfNotSet($formElement, FE_IMPORT_TYPE, FE_IMPORT_TYPE_AUTO);
666

667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
        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);
                $spreadsheet = $reader->load($fileName);
                break;

            default:
                throw new UserFormException("Unknown Excel import type: '" . $formElement[FE_IMPORT_TYPE] . "'.",
                    ERROR_UNKNOWN_EXCEL_IMPORT_TYPE);
        }

        $tableName = $formElement[FE_IMPORT_TO_TABLE];
687
688
        $regions = OnArray::trimArray(explode('|', $formElement[FE_IMPORT_REGION] ?? ''));
        $columnNames = OnArray::trimArray(explode(',', $formElement[FE_IMPORT_TO_COLUMNS]));
689
690
691
692
        $importMode = $formElement[FE_IMPORT_MODE] ?? FE_IMPORT_MODE_APPEND;

        foreach ($regions as $region) {
            // region: tab, startColumn, startRow, endColumn, endRow
693
            $region = OnArray::trimArray(explode(',', $region));
694
695
696
697
698
699
700
701
702
703
704
705
706
707
            $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."
                        );
708
709
                    }
                }
710
711
712
            } catch (\PhpOffice\PhpSpreadsheet\Exception $e) {
                throw new UserFormException($e->getMessage());
            }
713

714
715
716
717
718
719
720
721
722
            // 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];
723
724
                }
            }
725
726
727
728
729
            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];
                }
730
            }
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
            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);
749
                }
750
751
                $columnDefinitionArr[] = "`$columnName`   TEXT       NOT NULL  DEFAULT ''";
                $columnListArr[] = "$columnName";
752
753
            }

754
755
756
757
758
759
760
761
762
763
764
765
766
            // 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;
767
            }
768

769
770
771
772
773
774
775
            // 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);
            }
776
        }
777
778
779
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
780
781
782
783
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
784
785
786
787
     * @param array $formElement
     * @param array $statusUpload
     * @return array|mixed|null|string
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
788
     * @throws DbException
789
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
790
     * @throws UserReportException
791
792
793
794
     */
    private function copyUploadFile(array $formElement, array $statusUpload) {
        $pathFileName = '';

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
795
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
796
797
798
799
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

800
801
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);

802
        if (isset($formElement[FE_FILE_DESTINATION])) {
803

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

808
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
809
            $pathFileName = Sanitize::safeFilename($pathFileName, false, true); // Dynamically calculated pathFileName might contain invalid characters.
810
811
812

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

815
        if ($pathFileName === '') {
816
            throw new UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
817
818
        }

819
820
821
822
823
824
825
        // 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]);
        }

826
        $overwrite = isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS;
827
        Support::moveFile($srcFile, $pathFileName, $overwrite, $chmodDir);
828

829
        // get chmodFile
830
831
        if (empty($formElement[FE_FILE_CHMOD_FILE])) {
            $chmodFile = false;
832
        } else {
833
            $chmodFile = octdec($formElement[FE_FILE_CHMOD_FILE]);
834
835
        }

836
        $this->autoOrient($formElement, $pathFileName);
837
        HelperFile::chmod($pathFileName, $chmodFile);
838

839
        $this->splitUpload($formElement, $pathFileName, $chmodFile, $statusUpload);
840

841
842
        return $pathFileName;
    }
843

844
845
    /**
     * If fe['autoOrient'] is given and the MimeType corresponds to fe['autoOrientMimeType']: the given {{pathFileName:V}} will be converted.
846
     * ImageMagick 'convert' seems to do a better job than GraficsMagick (Orientation is stable even if multiple times applied).
847
848
849
850
851
852
853
854
     *
     * @param array $formElement
     * @param $pathFileName
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
     */
855
    private function autoOrient(array $formElement, $pathFileName) {
856
857

        // 'autoOrient' wished?
858
        if (!isset($formElement[FE_FILE_AUTO_ORIENT]) || $formElement[FE_FILE_AUTO_ORIENT] == '0') {
859
860
861
862
            return; // No
        }

        // Upload has matching MimeType?
863
        $mimeTypeList = empty($formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE]) ? 'image/jpeg,image/png,image/tiff' : $formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE];
864
        if (!HelperFile::checkFileType($pathFileName, $pathFileName, $mimeTypeList)) {
865
866
867
868
869
870
871
872
            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
873
874
875
876
        $output = Support::qfqExec($cmd, $rc);
        if ($rc != 0) {
            throw new UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'copy failed', ERROR_MESSAGE_SUPPORT => "[cmd=$cmd]$output"]), ERROR_IO_COPY);
        }
877
878
    }

879
    /**
Carsten  Rose's avatar
Carsten Rose committed
880
881
882
883
884
885
886
     * 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.
     *
887
     * @param array $formElement
888
889
     * @param string $pathFileName
     * @param int $chmod
890
     * @param array $statusUpload
891
892
     * @throws CodeException
     * @throws DbException
893
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
894
     * @throws UserReportException
895
     */
896
    private function splitUpload(array $formElement, $pathFileName, $chmod, array $statusUpload) {
897

898
        if (empty($formElement[FE_FILE_SPLIT]) || $statusUpload[FILES_TYPE] != MIME_TYPE_SPLIT_CAPABLE) {
899
900
901
902
            return;
        }

        $fileDestinationSplit = $this->evaluate->parse($formElement[FE_FILE_DESTINATION_SPLIT]);
903
        $fileSplitType = $this->evaluate->parse($formElement[FE_FILE_SPLIT]);
904
        $fileSplitTypeOptions = $this->evaluate->parse($formElement[FE_FILE_SPLIT_OPTIONS]);
905
906
907
908
909
910
        $fileSplitTableName = $this->evaluate->parse($formElement[FE_FILE_SPLIT_TABLE_NAME]);

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

911
912
913
        if ($fileDestinationSplit == '') {
            $ext = ($fileSplitType == FE_FILE_SPLIT_SVG) ? '.%02d.svg' : '.jpg';
            $fileDestinationSplit = $pathFileName . '.split/split' . $ext;
914
915
        }

Carsten  Rose's avatar
Carsten Rose committed
916
        HelperFile::mkDirParent($fileDestinationSplit);
917
918
919
920
921
922
923

        // Save CWD
        $cwd = getcwd();

        // Create temporary directory
        $tempDir = Support::createTempDir();
        $newSrc = $tempDir . DIRECTORY_SEPARATOR . QFQ_TEMP_SOURCE;
924
        HelperFile::copy($pathFileName, $newSrc);
925

926
        HelperFile::chdir($tempDir);
927
928
929
930
931
932
933
934
935
936

        // Split destination.
        $pathParts = pathinfo($fileDestinationSplit);
        if (empty($pathParts['filename']) || empty($pathParts['basename'])) {
            throw new UserFormException('Missing filename in ' . FE_FILE_DESTINATION_SPLIT, ERROR_MISSING_FILE_NAME);
        }

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

937
938
939
940
941
        switch ($fileSplitType) {
            case FE_FILE_SPLIT_SVG:
                $cmd = 'pdf2svg "' . $newSrc . '" "' . $fileNameDest . '" all';
                break;
            case FE_FILE_SPLIT_JPEG:
942
943
944
945
                if ($fileSplitTypeOptions == '') {
                    $fileSplitTypeOptions = FE_FILE_SPLIT_OPTIONS_JPEG;
                }
                $cmd = "convert $fileSplitTypeOptions '$newSrc' '$fileNameDest'";
946
947
948
949
950
                break;
            default:
                throw new UserFormException("Unknown 'fileSplit' type: " . $formElement[FE_FILE_SPLIT], ERROR_UNKNOWN_TOKEN);
        }

951
        // Split PDF
952
953
        $output = Support::qfqExec($cmd, $rc);
        if ($rc != 0) {
954
955
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'pdf2svg failed', ERROR_MESSAGE_SUPPORT => "[$cwd][cmd=$cmd]$output"]),
956
                ERROR_PDF2SVG);
957
        }
958

959
960
961
962
963
964
965
        // Array of created file names.
        if (false === ($files = scandir('.'))) {
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'Splitted files not found', ERROR_MESSAGE_SUPPORT => "[cwd=$cwd] scandir(.)" . HelperFile::errorGetLastAsString()]),
                ERROR_PDF2JPEG);
        }

966
967
968
969
970
        $xId = $this->store->getVar(COLUMN_ID, STORE_RECORD);

        // Clean optional existing old split records and files from further uploads.
        $this->db->deleteSplitFileAndRecord($xId, $fileSplitTableName);

971
972
        // IM 'convert' will produce files <file>-1.jpg <file>-10.jpg ... - bring them in natural sort order
        natsort($files);
973
974
975

        // Create DB records according to the extracted filenames.
        $tableName = TABLE_NAME_SPLIT;
976
977
978
        $sql = "INSERT INTO $tableName (`tableName`, `xId`, `pathFilename`) VALUES (?,?,?)";

        // 1) Move split files to final location. 2) Created records to reference each split file.
979
980
981
982
983
984
985
986
987
988
989
990
        foreach ($files as $file) {

            if ($file == '.' || $file == '..' || $file == QFQ_TEMP_SOURCE) {
                continue;
            }

            if (!empty($pathParts['dirname'])) {
                $fileDestination = $pathParts['dirname'] . '/' . $file;
            } else {
                $fileDestination = $file;
            }

991
992
            Support::moveFile($file, Support::joinPath($cwd, $fileDestination), true);
            HelperFile::chmod($fileDestination, $chmod);
993
994

            // Insert records.
995
            $this->db->sql($sql, ROW_REGULAR, [$fileSplitTableName, $xId, $fileDestination]);
996
997
998
        }

        // Pop directory
999
        HelperFile::chdir($cwd);
1000