Save.php 42.2 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
            if ($modeUpload == UPLOAD_MODE_DELETEOLD && $pathFileName == '') {
                $pathFileNameTmp = '';  // see '4'
376
377
            } 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
            if ($pathFileNameTmp == '') {
386
387
388
                // 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);
389
390
                $vars[VAR_FILE_SIZE]=0;
                $vars[VAR_FILE_MIME_TYPE]='';
391
392
393
394
395
            } else {
                $vars = HelperFile::getFileStat($pathFileNameTmp);
                $this->store->appendToStore($vars, STORE_VAR);
            }

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

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

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

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

424
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
425

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

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

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

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

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

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

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

474
475
476
477
478
479
480
            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;
            }

481
482
483
            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.
484
485
            }

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

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

497
498
499
500
501
502
503
504
505
506
507
    /**
     *
     * @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);
508
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
509
510
511
            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);
512
513
        }

514
        // Get original pathFileName
515
516
517
        $field = HelperFormElement::AppendFormElementNameImageCut($formElement);
        $pathFileName = $this->store->getVar($field, STORE_SIP);
        if ($pathFileName == '' || !file_exists($pathFileName)) {
518
519
520
            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);
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
554
555
        }

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

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

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

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

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

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

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

610
        // Upload - Take care the necessary target directories exist.
611
612
        $cwd = getcwd();
        $sitePath = $this->store->getVar(SYSTEM_SITE_PATH, STORE_SYSTEM);
613
        if ($cwd === false || $sitePath === false || !HelperFile::chdir($sitePath)) {
614
615
616
            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);
617
        }
618

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

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

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

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

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

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

        return $pathFileName;
    }

    /**
     * @param $formElement
658
     * @param $fileName
659
660
661
662
663
664
665
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     */
    private function doImport($formElement, $fileName) {
666
        $importNamedSheetsOnly = array();
667

668
        Support::setIfNotSet($formElement, FE_IMPORT_TYPE, FE_IMPORT_TYPE_AUTO);
669

670
671
672
673
        if (!empty($formElement[FE_IMPORT_NAMED_SHEETS_ONLY])) {
            $importNamedSheetsOnly = explode(',', $formElement[FE_IMPORT_NAMED_SHEETS_ONLY]);
        }

Carsten  Rose's avatar
Carsten Rose committed
674
        // Check for keywords which needs an explicit given document type.
675
676
677
678
679
680
681
682
683
684
685
        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])) {
                    throw new UserFormException('If ' . $token .
                        ' is given, an explicit document type (like ' . FE_IMPORT_TYPE . '=xlsx) should be set.', ERROR_IMPORT_MISSING_EXPLICIT_TYPE);
                }
            }
        }

686
687
688
689
690
691
692
693
694
695
696
        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);
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713

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

714
715
716
717
718
719
720
721
722
                $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];
723
        $regions = OnArray::trimArray(explode('|', $formElement[FE_IMPORT_REGION] ?? ''));
724
        $columnNames = OnArray::trimArray(explode(',', $formElement[FE_IMPORT_TO_COLUMNS] ?? ''));
725
726
727
728
        $importMode = $formElement[FE_IMPORT_MODE] ?? FE_IMPORT_MODE_APPEND;

        foreach ($regions as $region) {
            // region: tab, startColumn, startRow, endColumn, endRow
729
            $region = OnArray::trimArray(explode(',', $region));
730
731
732
733
734
735
736
737
738
739
740
741
742
743
            $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."
                        );
744
745
                    }
                }
746
747
748
            } catch (\PhpOffice\PhpSpreadsheet\Exception $e) {
                throw new UserFormException($e->getMessage());
            }
749

750
751
752
753
754
755
756
757
758
            // 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];
759
760
                }
            }
761
762
763
764
765
            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];
                }
766
            }
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
            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);
785
                }
786
787
                $columnDefinitionArr[] = "`$columnName`   TEXT       NOT NULL  DEFAULT ''";
                $columnListArr[] = "$columnName";
788
789
            }

790
791
792
793
794
795
796
797
798
799
800
801
802
            // 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;
803
            }
804

805
806
807
808
809
810
811
            // 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);
            }
812
        }
813
814
815
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
816
817
818
819
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
820
821
822
823
     * @param array $formElement
     * @param array $statusUpload
     * @return array|mixed|null|string
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
824
     * @throws DbException
825
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
826
     * @throws UserReportException
827
     */
828
829
    private
    function copyUploadFile(array $formElement, array $statusUpload) {
830
831
        $pathFileName = '';

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
832
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
833
834
835
836
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

837
838
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);

839
        if (isset($formElement[FE_FILE_DESTINATION])) {
840

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

845
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
846
            $pathFileName = Sanitize::safeFilename($pathFileName, false, true); // Dynamically calculated pathFileName might contain invalid characters.
847
848
849

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

852
        if ($pathFileName === '') {
853
            throw new UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
854
855
        }

856
857
858
859
860
861
862
        // 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]);
        }

863
        $overwrite = isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS;
864
        Support::moveFile($srcFile, $pathFileName, $overwrite, $chmodDir);
865

866
        // get chmodFile
867
868
        if (empty($formElement[FE_FILE_CHMOD_FILE])) {
            $chmodFile = false;
869
        } else {
870
            $chmodFile = octdec($formElement[FE_FILE_CHMOD_FILE]);
871
872
        }

873
        $this->autoOrient($formElement, $pathFileName);
874
        HelperFile::chmod($pathFileName, $chmodFile);
875

876
        $this->splitUpload($formElement, $pathFileName, $chmodFile, $statusUpload);
877

878
879
        return $pathFileName;
    }
880

881
882
    /**
     * If fe['autoOrient'] is given and the MimeType corresponds to fe['autoOrientMimeType']: the given {{pathFileName:V}} will be converted.
883
     * ImageMagick 'convert' seems to do a better job than GraficsMagick (Orientation is stable even if multiple times applied).
884
885
886
887
888
889
890
891
     *
     * @param array $formElement
     * @param $pathFileName
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
     */
892
893
    private
    function autoOrient(array $formElement, $pathFileName) {
894
895

        // 'autoOrient' wished?
896
        if (!isset($formElement[FE_FILE_AUTO_ORIENT]) || $formElement[FE_FILE_AUTO_ORIENT] == '0') {
897
898
899
900
            return; // No
        }

        // Upload has matching MimeType?
901
        $mimeTypeList = empty($formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE]) ? 'image/jpeg,image/png,image/tiff' : $formElement[FE_FILE_AUTO_ORIENT_MIME_TYPE];
902
        if (!HelperFile::checkFileType($pathFileName, $pathFileName, $mimeTypeList)) {
903
904
905
906
907
908
909
910
            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
911
912
913
914
        $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);
        }
915
916
    }

917
    /**
Carsten  Rose's avatar
Carsten Rose committed
918
919
920
921
922
923
924
     * 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.
     *
925
     * @param array $formElement
926
927
     * @param string $pathFileName
     * @param int $chmod
928
     * @param array $statusUpload
929
930
     * @throws CodeException
     * @throws DbException
931
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
932
     * @throws UserReportException
933
     */
934
935
    private
    function splitUpload(array $formElement, $pathFileName, $chmod, array $statusUpload) {
936

937
        if (empty($formElement[FE_FILE_SPLIT]) || $statusUpload[FILES_TYPE] != MIME_TYPE_SPLIT_CAPABLE) {
938
939
940
941
            return;
        }

        $fileDestinationSplit = $this->evaluate->parse($formElement[FE_FILE_DESTINATION_SPLIT]);
942
        $fileSplitType = $this->evaluate->parse($formElement[FE_FILE_SPLIT]);
943
        $fileSplitTypeOptions = $this->evaluate->parse($formElement[FE_FILE_SPLIT_OPTIONS]);
944
945
946
947
948
949
        $fileSplitTableName = $this->evaluate->parse($formElement[FE_FILE_SPLIT_TABLE_NAME]);

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

950
951
952
        if ($fileDestinationSplit == '') {
            $ext = ($fileSplitType == FE_FILE_SPLIT_SVG) ? '.%02d.svg' : '.jpg';
            $fileDestinationSplit = $pathFileName . '.split/split' . $ext;
953
954
        }

Carsten  Rose's avatar
Carsten Rose committed
955
        HelperFile::mkDirParent($fileDestinationSplit);
956
957
958
959
960
961
962

        // Save CWD
        $cwd = getcwd();

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

965
        HelperFile::chdir($tempDir);
966
967
968
969
970
971
972
973
974
975

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

976
977
978
979
980
        switch ($fileSplitType) {
            case FE_FILE_SPLIT_SVG:
                $cmd = 'pdf2svg "' . $newSrc . '" "' . $fileNameDest . '" all';
                break;
            case FE_FILE_SPLIT_JPEG:
981
982
983
984
                if ($fileSplitTypeOptions == '') {
                    $fileSplitTypeOptions = FE_FILE_SPLIT_OPTIONS_JPEG;
                }
                $cmd = "convert $fileSplitTypeOptions '$newSrc' '$fileNameDest'";
985
986
987
988
989
                break;
            default:
                throw new UserFormException("Unknown 'fileSplit' type: " . $formElement[FE_FILE_SPLIT], ERROR_UNKNOWN_TOKEN);
        }

990
        // Split PDF
991
992
        $output = Support::qfqExec($cmd, $rc);
        if ($rc != 0) {
993
994
            throw new UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'pdf2svg failed', ERROR_MESSAGE_SUPPORT => "[$cwd][cmd=$cmd]$output"]),
995
                ERROR_PDF2SVG);
996
        }
997

998
999
1000
1001
1002
1003
1004
        // 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);
        }

1005
1006
1007
1008
1009
        $xId = $this->store->getVar(COLUMN_ID, STORE_RECORD);

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

1010
1011
        // IM 'convert' will produce files <file>-1.jpg <file>-10.jpg ... - bring them in natural sort order
        natsort($files);
1012
1013
1014

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

        // 1) Move split files to final location. 2) Created records to reference each split file.
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
        foreach ($files as $file) {

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

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

1030
1031
            Support::moveFile($file, Support::joinPath($cwd, $fileDestination), true);
            HelperFile::chmod($fileDestination, $chmod);
1032
1033

            // Insert records.
1034
            $this->db->sql($sql, ROW_REGULAR, [$fileSplitTableName, $xId, $fileDestination]);
1035
1036
1037
        }

        // Pop directory
1038
        HelperFile::chdir($cwd);
1039
1040

        // Remove duplicated source
1041
1042
        HelperFile::unlink($newSrc);

1043
        // Remove empty directory
1044
        HelperFile::rmdir($tempDir);
1045
1046
    }

1047
    /**
1048
     * Create/update or delete the slave record.
1049
1050
     *
     * @param array $fe
1051
     * @param $modeUpload
1052
1053
     * @return int
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
1054
     * @throws DbException
1055
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
1056
     * @throws UserReportException
1057
     */
1058
1059
    private
    function doUploadSlave(array $fe, $modeUpload) {
1060
1061
        $sql = '';
        $flagUpdateSlaveId = false;
1062
        $flagSlaveDeleted = false;
1063

1064
        if (!isset($fe[FE_SLAVE_ID])) {
1065
1066
1067
            throw new UserFormException("Missing 'slaveId'-definition", ERROR_MISSING_SLAVE_ID_DEFINITION);
        }

1068
        // Get the slaveId
1069
        $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
1070
1071
1072
        // Store the slaveId: it's used and replaced in the update statement.
        $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR, true);

1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
        $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);
1094
1095
1096
        }

        $rc = $this->evaluate->parse($sql);
1097
1098
1099
1100
1101
        // Check if the slave record has been deleted: if yes, set slaveId=0
        if ($flagSlaveDeleted && $rc > 0) {
            $rc = 0;
            $flagUpdateSlaveId = true;
        }
1102
1103
1104
1105
1106
1107
1108
1109
1110

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