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

namespace qfq;

require_once(__DIR__ . '/../qfq/store/Store.php');
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
12
require_once(__DIR__ . '/../qfq/store/Sip.php');
13
14
15
16
17
18
19
20
21
22
23
24
25
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/Evaluate.php');
//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');


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
26
    private $feSpecNativeRaw = array(); // copy of all formElement.class='native' of the loaded form
27
28
29
30
31
32
33
34
35
36
37
38
    /**
     * @var null|Store
     */
    private $store = null;
    private $db = null;

    private $evaluate = null;

    /**
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
39
     * @param array $feSpecNativeRaw
40
     */
41
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $feSpecNativeRaw) {
42
43
44
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
45
        $this->feSpecNativeRaw = $feSpecNativeRaw;
46
47
48
49
50
51
        $this->store = Store::getInstance();
        $this->db = new Database();
        $this->evaluate = new Evaluate($this->store, $this->db);
    }

    /**
52
53
     * Starts save process. On succcess, returns forwardmode/page.
     *
54
     * @return int
55
56
     * @throws CodeException
     * @throws DbException
57
     * @throws UserFormException
58
59
     */
    public function process() {
60
        $rc = 0;
61
62
63
64
65

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

            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
66
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
67
                $rc = $this->elements($row['_id']);
68
69
            }
        } else {
70
71
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
            $rc = $this->elements($recordId);
72
        }
73
74

        return $rc;
75
76
    }

77
    /**
Carsten  Rose's avatar
Carsten Rose committed
78
79
     * Create empty FormElements based on templateGroups, for those who not already exist.
     *
80
     * @param array $formValues
Carsten  Rose's avatar
Carsten Rose committed
81
     *
82
83
84
85
86
87
     * @return array
     */
    private function createEmptyTemplateGroupElements(array $formValues) {

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

88
89
90
91
92
93
94
95
            switch ($formElement[FE_TYPE]) {
//                case FE_TYPE_EXTRA:
                case FE_TYPE_NOTE:
                case FE_TYPE_SUBRECORD:
                    continue 2;
                default:
                    break;
            }
96
            $feName = $formElement[FE_NAME];
97
            if (!isset($formValues[$feName]) && $this->isMemberOfTemplateGroup($formElement)) {
98
99
100
                $formValues[$feName] = $formElement[FE_VALUE];
            }
        }
Carsten  Rose's avatar
Carsten Rose committed
101

102
103
104
        return $formValues;
    }

105
    /**
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
     * 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,
    }

    /**
     *
139
     * @param $feName
Carsten  Rose's avatar
Carsten Rose committed
140
     *
141
142
143
144
145
146
147
148
149
150
151
     * @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;
    }

152
    /**
Carsten  Rose's avatar
Carsten Rose committed
153
154
     * 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
155
     *
156
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
157
     *
158
     * @return int   record id (in case of insert, it's different from $recordId)
159
160
     * @throws CodeException
     * @throws DbException
161
     * @throws UserFormException
162
163
     */
    public function elements($recordId) {
164
165
        $columnCreated = false;
        $columnModified = false;
Carsten  Rose's avatar
Carsten Rose committed
166

167
168
169
        $newValues = array();

        $tableColumns = array_keys($this->store->getStore(STORE_TABLE_COLUMN_TYPES));
170
        $formValues = $this->store->getStore(STORE_FORM);
171
        $formValues = $this->createEmptyTemplateGroupElements($formValues);
172
173
174

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

176
            // Never save a predefined 'id': autoincrement values will be given by database..
177
            if ($column === COLUMN_ID) {
178
                continue;
179
            }
180

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
181
182
183
184
185
            // Skip Upload Elements: those will be processed later.
            if ($this->isColumnUploadField($column)) {
                continue;
            }

186
187
188
189
190
191
192
193
            if ($column === COLUMN_CREATED) {
                $columnCreated = true;
            }

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

194
195
            // Is there a value? Do not forget SIP values. Those do not have necessarily a FormElement.
            if (!isset($formValues[$column])) {
196
                continue;
197
198
            }

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

201
202
203
204
205
206
            // 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);
            }
207
            $newValues[$column] = $formValues[$column];
208

209
210
        }

211
212
213
214
        if ($columnModified && !isset($newValues[COLUMN_MODIFIED])) {
            $newValues[COLUMN_MODIFIED] = date('YmdHis');
        }

215
        if ($recordId == 0) {
216
217
218
            if ($columnCreated && !isset($newValues[COLUMN_CREATED])) {
                $newValues[COLUMN_CREATED] = date('YmdHis');
            }
219
            $rc = $this->insertRecord($this->formSpec[F_TABLE_NAME], $newValues);
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
220

221
        } else {
222
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId);
223
224
225
226
            $rc = $recordId;
        }

        return $rc;
227
228
    }

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
229
230
231
232
233
234
235
236
237
238
239
240
    /*
     * Checks if there is a formElement with name '$feName' of type 'upload'
     *
     * @param $feName
     * @return bool
     */
    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
241

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
242
243
244
245
246
247
248
        return false;
    }

    /**
     * Insert new record in table $this->formSpec['tableName'].
     *
     * @param array $values
Carsten  Rose's avatar
Carsten Rose committed
249
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
     * @return int  last insert id
     * @throws DbException
     */
    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)) . '`';

        $sql = 'INSERT INTO ' . $tableName . ' ( ' . $columnList . ' ) VALUES ( ' . $paramList . ' )';

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

        return $rc;
    }

    /**
     * @param string $tableName
Carsten  Rose's avatar
Carsten Rose committed
271
272
     * @param array $values
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
273
     *
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
274
275
276
277
278
279
280
281
282
     * @return bool|int     false if $values is empty, else affectedrows
     * @throws CodeException
     * @throws DbException
     */
    public function updateRecord($tableName, array $values, $recordId) {

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

283
        if ($recordId === 0) {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
284
            throw new CodeException('RecordId=0 - this is not possible for update.', ERROR_RECORDID_0_FORBIDDEN);
285
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

//        $paramList = str_repeat('?, ', count($values));
//        $paramList = substr($paramList, 0, strlen($paramList) - 2);

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

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

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

        $sql = substr($sql, 0, strlen($sql) - 2) . ' WHERE id = ?';
        $values[] = $recordId;

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

        return $rc;
    }

305
    /**
Carsten  Rose's avatar
Carsten Rose committed
306
307
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
308
309
     *
     */
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
310
311
312
313
314
315
    public function processAllUploads($recordId) {

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

        $formValues = $this->store->getStore(STORE_FORM);
316
        $primaryRecord = $this->store->getStore(STORE_RECORD); // necessary to check if the current formElement exist as a column of the primary table.
317
318
319

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

324
            $formElement = HelperFormElement::initUploadFormElement($formElement);
325
            if (isset($formElement[FE_FILL_STORE_VAR])) {
326
                $this->store->appendToStore($formElement[FE_FILL_STORE_VAR], STORE_VAR);
327
            }
328

329
330
331
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($formElement), STORE_SYSTEM);

332
            $column = $formElement[FE_NAME];
333
            $pathFileName = $this->doUpload($formElement, $formValues[$column], $sip, $modeUpload);
334
335
336
337
338
339
340
341
342

            // Upload Type: Simple or Advanced
            if (isset($primaryRecord[$column])) {
                // 'Simple Upload': no special action needed, just process the current (maybe modifired) value.
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
                }
            } else {
                // 'Advanced Upload'
343
                $this->doUploadSlave($formElement, $modeUpload);
344
345
            }
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
346

347
        // Only used in 'Simple Upload'
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
348
349
350
        if (count($newValues) > 0) {
            $this->updateRecord($this->formSpec[F_TABLE_NAME], $newValues, $recordId);
        }
351
352
353
    }

    /**
354
355
356
     * 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
357
358
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
359
360
361
362
     * @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
363
364
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
365
     * @return false|string New pathFilename or false on error
366
367
368
369
     * @throws CodeException
     * @throws UserFormException
     * @internal param $recordId
     */
370
371
372
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
373

374
        // Status information about upload file
375
376
377
378
379
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

380
381
382
383
384
385
386
        // 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);
        }

387
388
        // Delete existing old file.
        if (isset($statusUpload[FILES_FLAG_DELETE]) && $statusUpload[FILES_FLAG_DELETE] == '1') {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
389
390
            $arr = $sip->getVarsFromSip($sipUpload);
            $oldFile = $arr[EXISTING_PATH_FILE_NAME];
391
392
            if (file_exists($oldFile)) {
                if (!unlink($oldFile)) {
393
                    throw new UserFormException('Unlink file failed: ' . $oldFile, ERROR_IO_UNLINK);
394
395
                }
            }
396
397
398
399
400
401
402
403
            $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;
404
405
        }

406
407
408
409
410
411
412
413
414
415
416
        $pathFileName = $this->copyUploadFile($formElement, $statusUpload);

        chdir($cwd);

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

        return $pathFileName;
    }

    /**
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
417
418
419
420
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
421
422
     * @param array $formElement
     * @param array $statusUpload
Carsten  Rose's avatar
Carsten Rose committed
423
     *
424
425
426
427
428
429
430
     * @return array|mixed|null|string
     * @throws CodeException
     * @throws UserFormException
     */
    private function copyUploadFile(array $formElement, array $statusUpload) {
        $pathFileName = '';

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
431
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
432
433
434
435
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

436
        if (isset($formElement[FE_FILE_DESTINATION])) {
437

438
            // Provide variable 'filename'. Might be substituted in $formElement[FE_PATH_FILE_NAME].
439
            $origFilename = Sanitize::safeFilename($statusUpload[FILES_NAME]);
440
            $this->store->setVar(VAR_FILENAME, $origFilename, STORE_VAR);
441

442
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
443
444
445

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

448
        if ($pathFileName === '') {
449
            throw new UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
450
451
        }

452
        if (file_exists($pathFileName)) {
453
454
455
456
457
458
459
            if (isset($formElement[FE_FILE_REPLACE_MODE]) && $formElement[FE_FILE_REPLACE_MODE] == FE_FILE_REPLACE_MODE_ALWAYS) {
                if (!unlink($pathFileName)) {
                    throw new UserFormException('Copy upload failed - file exist and unlink() failed: ' . $pathFileName, ERROR_IO_UNLINK);
                }
            } else {
                throw new UserFormException('Copy upload failed - file already exist: ' . $pathFileName, ERROR_IO_FILE_EXIST);
            }
460
        }
461

462
        Support::mkDirParent($pathFileName);
463

464
465
466
467
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
        if (!rename($srcFile, $pathFileName)) {
            throw new UserFormException("Rename file: '$srcFile' > '$pathFileName'", ERROR_IO_RENAME);
        }
468

469
470
        return $pathFileName;
    }
471

472
    /**
473
     * Create/update or delete the slave record.
474
475
     *
     * @param array $fe
Carsten  Rose's avatar
Carsten Rose committed
476
     * @param bool $flagNewUpload
Carsten  Rose's avatar
Carsten Rose committed
477
     *
478
479
480
481
     * @return int
     * @throws CodeException
     * @throws UserFormException
     */
482
    private function doUploadSlave(array $fe, $modeUpload) {
483
484
        $sql = '';
        $flagUpdateSlaveId = false;
485
        $flagSlaveDeleted = false;
486

487
        if (!isset($fe[FE_SLAVE_ID])) {
488
489
490
            throw new UserFormException("Missing 'slaveId'-definition", ERROR_MISSING_SLAVE_ID_DEFINITION);
        }

491
        // Get the slaveId
492
        $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
493
494
495
        // Store the slaveId: it's used and replaced in the update statement.
        $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR, true);

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
        $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);
517
518
        }

519
520
        // If given: fire a sqlBefore query
        $this->evaluate->parse($fe[FE_SQL_BEFORE]);
521
522

        $rc = $this->evaluate->parse($sql);
523
524
525
526
527
        // Check if the slave record has been deleted: if yes, set slaveId=0
        if ($flagSlaveDeleted && $rc > 0) {
            $rc = 0;
            $flagUpdateSlaveId = true;
        }
528
529
530
531
532
533
534
535
536
537
538
539

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

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

        return $slaveId;
    }
540
}