Save.php 34.7 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
17
18
19
20
21
//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');


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

    private $evaluate = null;

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

    /**
61
62
     * Starts save process. On succcess, returns forwardmode/page.
     *
63
     * @return int
64
65
     * @throws CodeException
     * @throws DbException
66
     * @throws UserFormException
67
68
     */
    public function process() {
69
        $rc = 0;
70
71
72
73
74

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

            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
75
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
76
                $rc = $this->elements($row['_id']);
77
78
            }
        } else {
79
80
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
            $rc = $this->elements($recordId);
81
        }
82
83

        return $rc;
84
85
    }

86
    /**
Carsten  Rose's avatar
Carsten Rose committed
87
88
     * Create empty FormElements based on templateGroups, for those who not already exist.
     *
89
     * @param array $formValues
Carsten  Rose's avatar
Carsten Rose committed
90
     *
91
     * @return array
92
     * @throws UserFormException
93
94
95
96
97
     */
    private function createEmptyTemplateGroupElements(array $formValues) {

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

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

112
113
114
        return $formValues;
    }

115
    /**
116
117
118
119
120
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
     * 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,
    }

    /**
     *
149
     * @param $feName
Carsten  Rose's avatar
Carsten Rose committed
150
     *
151
152
153
154
155
156
157
158
159
160
161
     * @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;
    }

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

177
178
179
        $newValues = array();

        $tableColumns = array_keys($this->store->getStore(STORE_TABLE_COLUMN_TYPES));
180
        $formValues = $this->store->getStore(STORE_FORM);
181
        $formValues = $this->createEmptyTemplateGroupElements($formValues);
182
183
184

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

186
            // Never save a predefined 'id': autoincrement values will be given by database..
187
            if ($column === COLUMN_ID) {
188
                continue;
189
            }
190

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
191
192
193
194
195
            // Skip Upload Elements: those will be processed later.
            if ($this->isColumnUploadField($column)) {
                continue;
            }

196
197
198
199
200
201
202
203
            if ($column === COLUMN_CREATED) {
                $columnCreated = true;
            }

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

204
205
            // Is there a value? Do not forget SIP values. Those do not have necessarily a FormElement.
            if (!isset($formValues[$column])) {
206
                continue;
207
208
            }

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

211
212
213
214
215
216
            // 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);
            }
217
            $newValues[$column] = $formValues[$column];
218

219
220
        }

221
222
223
224
        if ($columnModified && !isset($newValues[COLUMN_MODIFIED])) {
            $newValues[COLUMN_MODIFIED] = date('YmdHis');
        }

225
        if ($recordId == 0) {
226
227
228
            if ($columnCreated && !isset($newValues[COLUMN_CREATED])) {
                $newValues[COLUMN_CREATED] = date('YmdHis');
            }
229
            $rc = $this->insertRecord($this->formSpec[F_TABLE_NAME], $newValues);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
230

231
        } else {
232
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId);
233
234
235
236
            $rc = $recordId;
        }

        return $rc;
237
238
    }

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
239
240
241
242
243
244
    /*
     * Checks if there is a formElement with name '$feName' of type 'upload'
     *
     * @param $feName
     * @return bool
     */
245
246
247
248
    /**
     * @param $feName
     * @return bool
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
249
250
251
252
253
254
    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
255

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
256
257
258
259
260
261
        return false;
    }

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

279
        $sql = "INSERT INTO $tableName ( " . $columnList . " ) VALUES ( " . $paramList . ' )';
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
280
281
282
283
284
285
286
287

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

        return $rc;
    }

    /**
     * @param string $tableName
Carsten  Rose's avatar
Carsten Rose committed
288
289
     * @param array $values
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
290
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
291
292
293
     * @return bool|int     false if $values is empty, else affectedrows
     * @throws CodeException
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
294
     * @throws UserFormException
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
295
296
297
298
299
300
     */
    public function updateRecord($tableName, array $values, $recordId) {

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

301
        if ($recordId === 0) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
302
            throw new CodeException('RecordId=0 - this is not possible for update.', ERROR_RECORDID_0_FORBIDDEN);
303
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
304
305
306
307
308
309
310
311

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

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

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

312
        $sql = substr($sql, 0, strlen($sql) - 2) . " WHERE id = ?";
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
313
314
315
316
317
318
319
        $values[] = $recordId;

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

        return $rc;
    }

320
    /**
Carsten  Rose's avatar
Carsten Rose committed
321
322
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
323
324
325
326
327
     * @param $recordId
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
328
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
329
330
331
332
333
334
    public function processAllUploads($recordId) {

        $sip = new Sip(false);
        $newValues = array();

        $formValues = $this->store->getStore(STORE_FORM);
335
        $primaryRecord = $this->store->getStore(STORE_RECORD); // necessary to check if the current formElement exist as a column of the primary table.
336
337
338

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

343
            $formElement = HelperFormElement::initUploadFormElement($formElement);
344
            if (isset($formElement[FE_FILL_STORE_VAR])) {
345
                $this->store->appendToStore($formElement[FE_FILL_STORE_VAR], STORE_VAR);
346
            }
347

348
349
350
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($formElement), STORE_SYSTEM);

351
            $column = $formElement[FE_NAME];
352
            $pathFileName = $this->doUpload($formElement, $formValues[$column], $sip, $modeUpload);
353

354
355
356
357
358
359
360
361
            $pathFileNameTmp = empty($pathFileName) ? $primaryRecord[$column] : $pathFileName;
            // Get latest file information
            $vars = HelperFile::getFileStat($pathFileNameTmp);
            $this->store->appendToStore($vars, STORE_VAR);

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

362
            // Upload Type: Simple or Advanced
363
364
365
            // 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.
366
367
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
368
369
370
371
372
373
374
375

                    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];
                    }
376
377
378
                }
            } else {
                // 'Advanced Upload'
379
                $this->doUploadSlave($formElement, $modeUpload);
380
            }
381
382
383
384

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

385
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
386

387
        // Only used in 'Simple Upload'
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
388
389
390
        if (count($newValues) > 0) {
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId);
        }
391
392
    }

393
    /**
394
395
     * Process all Upload FormElements for the given $recordId.
     * After processing, &$formValues will be updated with the final filename.
396
     *
397
398
     * @throws CodeException
     * @throws UserFormException
399
400
401
402
403
404
405
406
407
408
409
410
411
     */
    public function processAllImageCutFE() {

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

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

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432

    /**
     * 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) {

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

435
436
437
438
439
440
441
            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;
            }

442
443
444
445
446
            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.
            }

447
            if (!$requiredOff && $mode == FE_MODE_REQUIRED && empty($clientValues[$formElement[FE_NAME]])) {
448
                throw new UserFormException("Missing required value: " . $formElement[FE_LABEL], ERROR_REQUIRED_VALUE_EMPTY);
449
450
451
452
453
454
455
456
457
            }

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

458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
    /**
     *
     * @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);
        if ($cwd === false || $sitePath === false || !chdir($sitePath)) {
            throw new UserFormException("getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed.", ERROR_IO_CHDIR);
        }

473
        // Get original pathFileName
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
        $field = HelperFormElement::AppendFormElementNameImageCut($formElement);
        $pathFileName = $this->store->getVar($field, STORE_SIP);
        if ($pathFileName == '' || !file_exists($pathFileName)) {
            throw new UserFormException('Empty file or file not found: ' . $pathFileName, ERROR_IO_FILE_NOT_FOUND);
        }

        // '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)
            ) {
                if (!rename($pathFileName, $pathFileName . $extSave)) {
                    throw new UserFormException("Rename file: '$pathFileName' > '$pathFileName$extSave'", ERROR_IO_RENAME);
                }
            }
        }

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

        if (false === file_put_contents($pathFileName, base64_decode($imageData))) {
            throw new UserFormException("Write new image failed: $pathFileName", ERROR_IO_WRITE);
        }

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

530
    /**
531
532
533
     * 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
534
535
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
536
537
538
539
     * @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
540
541
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
542
     * @return false|string New pathFilename or false on error
543
     * @throws CodeException
544
     * @throws DbException
545
     * @throws UserFormException
546
547
548
     * @throws UserReportException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
549
550
     * @internal param $recordId
     */
551
552
553
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
554

555
        // Status information about upload file
556
557
558
559
560
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

561
562
        if (isset($formElement[FE_IMPORT_TO_TABLE])) {
            // Import
563
            $tmpFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
564
565
            $this->doImport($formElement, $tmpFile);
        }
566

567
568
569
570
571
572
573
        // Upload
        // Take care the necessary target directories exist.
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
        if ($cwd === false || $sitePath === false || !chdir($sitePath)) {
            throw new UserFormException("getcwd() failed or SITE_PATH undefined or chdir('$sitePath') failed.", ERROR_IO_CHDIR);
        }
574

575
576
577
578
579
580
581
        // 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)) {
                if (!unlink($oldFile)) {
                    throw new UserFormException('Unlink file failed: ' . $oldFile, ERROR_IO_UNLINK);
582
                }
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
            }
            $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;
        }

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

        chdir($cwd);

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

        return $pathFileName;
    }

    /**
     * @param $formElement
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     */
    private function doImport($formElement, $fileName) {
        Support::setIfNotSet($formElement, FE_IMPORT_TYPE, FE_IMPORT_TYPE_AUTO);
        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];
        $regions = explode('|', $formElement[FE_IMPORT_REGION] ?? '');
        $columnNames = explode(',', $formElement[FE_IMPORT_TO_COLUMNS]);
        $importMode = $formElement[FE_IMPORT_MODE] ?? FE_IMPORT_MODE_APPEND;

        foreach ($regions as $region) {
            // region: tab, startColumn, startRow, endColumn, endRow
            $region = explode(',', $region);
            $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."
                        );
658
659
                    }
                }
660
661
662
            } catch (\PhpOffice\PhpSpreadsheet\Exception $e) {
                throw new UserFormException($e->getMessage());
            }
663

664
665
666
667
668
669
670
671
672
            // 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];
673
674
                }
            }
675
676
677
678
679
            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];
                }
680
            }
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
            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);
699
                }
700
701
                $columnDefinitionArr[] = "`$columnName`   TEXT       NOT NULL  DEFAULT ''";
                $columnListArr[] = "$columnName";
702
703
            }

704
705
706
707
708
709
710
711
712
713
714
715
716
            // 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;
717
            }
718

719
720
721
722
723
724
725
            // 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);
            }
726
        }
727
728
729
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
730
731
732
733
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
734
735
     * @param array $formElement
     * @param array $statusUpload
Carsten  Rose's avatar
Carsten Rose committed
736
     *
737
738
     * @return array|mixed|null|string
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
739
     * @throws DbException
740
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
741
     * @throws UserReportException
742
743
744
     */
    private function copyUploadFile(array $formElement, array $statusUpload) {
        $pathFileName = '';
745
        $vars = array();
746

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
747
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
748
749
750
751
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

752
753
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);

754
        if (isset($formElement[FE_FILE_DESTINATION])) {
755

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

760
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
761
            $pathFileName = Sanitize::safeFilename($pathFileName, false, true); // Dynamically calculated pathFileName might contain invalid characters.
762
763
764

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

767
        if ($pathFileName === '') {
768
            throw new UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
769
770
        }

771
772
        $overwrite = isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS;
        Support::copyFile($srcFile, $pathFileName, $overwrite);
773

774
775
        $this->splitUpload($formElement, $pathFileName);

776
777
        return $pathFileName;
    }
778

779
    /**
Carsten  Rose's avatar
Carsten Rose committed
780
781
782
783
784
785
786
     * 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.
     *
787
788
     * @param array $formElement
     * @param $pathFileName
789
790
     * @throws CodeException
     * @throws DbException
791
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
792
     * @throws UserReportException
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
     */
    private function splitUpload(array $formElement, $pathFileName) {

        if (empty($formElement[FE_FILE_SPLIT]) || empty($formElement[FE_FILE_DESTINATION_SPLIT])) {
            return;
        }

        $fileDestinationSplit = $this->evaluate->parse($formElement[FE_FILE_DESTINATION_SPLIT]);
        $fileSplit = $this->evaluate->parse($formElement[FE_FILE_SPLIT]);
        $fileSplitTableName = $this->evaluate->parse($formElement[FE_FILE_SPLIT_TABLE_NAME]);

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

        // Filetype testen: nur Dateien splitten die man auch wirklich entpacken kann
        switch ($fileSplit) {
            case FE_FILE_SPLIT_SVG:
                $this->splitSvg($pathFileName, $fileDestinationSplit, $fileSplitTableName);
                break;
            default:
                throw new UserFormException("Unknown 'fileSplit' type: " . $formElement[FE_FILE_SPLIT], ERROR_UNKNOWN_TOKEN);
        }
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
819
820
821
     * Split's the PDF file $pathFileNameSrc in several SVG-file, one per page.
     * For every created file, a record in table 'Split' is created, storing the pathFileName to the individual file.
     *
822
823
     * @param $pathFileNameSrc
     * @param $fileDestinationSplit
824
     * @param $fileSplitTableName
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    private function splitSvg($pathFileNameSrc, $fileDestinationSplit, $fileSplitTableName) {

        Support::mkDirParent($fileDestinationSplit);

        // Save CWD
        $cwd = getcwd();

        // Create temporary directory
        $tempDir = Support::createTempDir();
        $newSrc = $tempDir . DIRECTORY_SEPARATOR . QFQ_TEMP_SOURCE;
        $rc = copy($pathFileNameSrc, $newSrc);

        $rc = chdir($tempDir);

        // 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'];

        // Split PDF
        $rc = exec('pdf2svg "' . $newSrc . '" "' . $fileNameDest . '" all');

        // Array of created filenames.
        $files = scandir('.');

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

        foreach ($files as $file) {

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

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

            $rc = rename($file, Support::joinPath($cwd, $fileDestination));

            // Insert records.
            $this->db->sql($sql, ROW_REGULAR, [$fileSplitTableName, $this->store->getVar(COLUMN_ID, STORE_RECORD), $fileDestination]);
        }

        // Pop directory
        $rc = chdir($cwd);

        // Remove duplicated source
        $rc = unlink($newSrc);
        // Remove empty directory
        $rc = rmdir($tempDir);
    }

889
    /**
890
     * Create/update or delete the slave record.
891
892
     *
     * @param array $fe
893
     * @param $modeUpload
894
895
     * @return int
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
896
     * @throws DbException
897
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
898
     * @throws UserReportException
899
     */
900
    private function doUploadSlave(array $fe, $modeUpload) {
901
902
        $sql = '';
        $flagUpdateSlaveId = false;
903
        $flagSlaveDeleted = false;
904

905
        if (!isset($fe[FE_SLAVE_ID])) {
906
907
908
            throw new UserFormException("Missing 'slaveId'-definition", ERROR_MISSING_SLAVE_ID_DEFINITION);
        }

909
        // Get the slaveId
910
        $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
911
912
913
        // Store the slaveId: it's used and replaced in the update statement.
        $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR, true);

914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
        $mode = ($slaveId == '0') ? 'I' : 'U'; // I=Insert, U=Update
        $mode .= ($modeUpload == UPLOAD_MODE_NEW || $modeUpload == UPLOAD_MODE_DELETEOLD_NEW) ? 'N' : ''; // N=New File, '' if no new file.
        $mode .= ($modeUpload == UPLOAD_MODE_DELETEOLD) ? 'D' : ''; // Delete slave record only if there is no new and not 'unchanged'.
        switch ($mode) {
            case 'IN':
                $sql = $fe[FE_SQL_INSERT];
                $flagUpdateSlaveId = true;
                break;
            case 'UN':
                $sql = $fe[FE_SQL_UPDATE];
                break;
            case 'I':
            case 'U':
                $sql = ''; // no old file and no new file.
                break;
            case 'UD':
                $sql = $fe[FE_SQL_DELETE];
                $flagSlaveDeleted = true;
                break;
            default:
                throw new CodeException('Unknown mode: ' . $mode, ERROR_UNKNOWN_MODE);
935
936
937
        }

        $rc = $this->evaluate->parse($sql);
938
939
940
941
942
        // Check if the slave record has been deleted: if yes, set slaveId=0
        if ($flagSlaveDeleted && $rc > 0) {
            $rc = 0;
            $flagUpdateSlaveId = true;
        }
943
944
945
946
947
948
949
950
951

        if ($flagUpdateSlaveId) {
            // Store the slaveId: it's used and replaced in the update statement.
            $this->store->setVar(VAR_SLAVE_ID, $rc, STORE_VAR, true);
            $slaveId = $rc;
        }

        return $slaveId;
    }
952
}