Save.php 26 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
     * @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)) . '`';

262
        $sql = "INSERT INTO $tableName ( " . $columnList . " ) VALUES ( " . $paramList . ' )';
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
263
264
265
266
267
268
269
270

        $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

            // Upload Type: Simple or Advanced
336
337
338
            // 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.
339
340
341
342
343
                if ($pathFileName !== false) {
                    $newValues[$column] = $pathFileName;
                }
            } else {
                // 'Advanced Upload'
344
                $this->doUploadSlave($formElement, $modeUpload);
345
346
            }
        }
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
347

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

354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
    /**
     * Process all Upload Formelements for the given $recordId. After processing &$formValues will be updated with the
     * final filenames.
     *
     */
    public function processAllImageCutFE() {

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

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

    /**
     *
     * @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);
        }

        // Get original pathfilename
        $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);
    }

443
    /**
444
445
446
     * 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
447
448
     * Check also: doc/CODING.md
     *
Carsten  Rose's avatar
Carsten Rose committed
449
450
451
452
     * @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
453
454
     *                            UPLOAD_MODE_DELETEOLD_NEW
     *
455
     * @return false|string New pathFilename or false on error
456
457
458
459
     * @throws CodeException
     * @throws UserFormException
     * @internal param $recordId
     */
460
461
462
    private function doUpload($formElement, $sipUpload, Sip $sip, &$modeUpload) {
        $flagDelete = false;
        $modeUpload = UPLOAD_MODE_UNCHANGED;
463

464
        // Status information about upload file
465
466
467
468
469
        $statusUpload = $this->store->getVar($sipUpload, STORE_EXTRA);
        if ($statusUpload === false) {
            return false;
        }

470
471
472
473
474
475
476
        // 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);
        }

477
478
        // Delete existing old file.
        if (isset($statusUpload[FILES_FLAG_DELETE]) && $statusUpload[FILES_FLAG_DELETE] == '1') {
Carsten  Rose's avatar
Upload:    
Carsten Rose committed
479
480
            $arr = $sip->getVarsFromSip($sipUpload);
            $oldFile = $arr[EXISTING_PATH_FILE_NAME];
481
482
            if (file_exists($oldFile)) {
                if (!unlink($oldFile)) {
483
                    throw new UserFormException('Unlink file failed: ' . $oldFile, ERROR_IO_UNLINK);
484
485
                }
            }
486
487
488
489
490
491
492
493
            $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;
494
495
        }

496
497
498
499
500
501
502
503
504
505
506
        $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
507
508
509
510
     * Copy uploaded file from temporary location to final location.
     *
     * Check also: doc/CODING.md
     *
511
512
     * @param array $formElement
     * @param array $statusUpload
Carsten  Rose's avatar
Carsten Rose committed
513
     *
514
515
516
517
518
519
520
     * @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
521
        if (!isset($statusUpload[FILES_TMP_NAME]) || $statusUpload[FILES_TMP_NAME] === '') {
522
523
524
525
            // nothing to upload: e.g. user has deleted a previous uploaded file.
            return '';
        }

526
        if (isset($formElement[FE_FILE_DESTINATION])) {
527

528
            // Provide variable 'filename'. Might be substituted in $formElement[FE_PATH_FILE_NAME].
529
            $origFilename = Sanitize::safeFilename($statusUpload[FILES_NAME]);
530
            $pathParts = pathinfo($origFilename);
531
            $this->store->setVar(VAR_FILENAME, $origFilename, STORE_VAR);
532
533
534
535
536
537
            if (isset($pathParts['filename'])) {
                $this->store->setVar(VAR_FILENAME_BASE, $pathParts['filename'], STORE_VAR);
            }
            if (isset($pathParts['extension'])) {
                $this->store->setVar(VAR_FILENAME_EXT, $pathParts['extension'], STORE_VAR);
            }
538

539
            $pathFileName = $this->evaluate->parse($formElement[FE_FILE_DESTINATION]);
540
541
542

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

545
        if ($pathFileName === '') {
546
            throw new UserFormException("Upload failed, no target '" . FE_FILE_DESTINATION . "' specified.", ERROR_NO_TARGET_PATH_FILE_NAME);
547
548
        }

549
        if (file_exists($pathFileName)) {
550
551
552
553
554
555
556
            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);
            }
557
        }
558

559
        Support::mkDirParent($pathFileName);
560

561
562
563
564
        $srcFile = Support::extendFilename($statusUpload[FILES_TMP_NAME], UPLOAD_CACHED);
        if (!rename($srcFile, $pathFileName)) {
            throw new UserFormException("Rename file: '$srcFile' > '$pathFileName'", ERROR_IO_RENAME);
        }
565

566
567
        $this->splitUpload($formElement, $pathFileName);

568
569
        return $pathFileName;
    }
570

571
    /**
Carsten  Rose's avatar
Carsten Rose committed
572
573
574
575
576
577
578
     * 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.
     *
579
580
581
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
     * @param array $formElement
     * @param $pathFileName
     * @throws UserFormException
     */
    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
608
609
610
     * 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.
     *
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
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
     * @param $pathFileNameSrc
     * @param $fileDestinationSplit
     * @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);
    }

677
    /**
678
     * Create/update or delete the slave record.
679
680
     *
     * @param array $fe
681
     * @param $modeUpload
682
683
684
685
     * @return int
     * @throws CodeException
     * @throws UserFormException
     */
686
    private function doUploadSlave(array $fe, $modeUpload) {
687
688
        $sql = '';
        $flagUpdateSlaveId = false;
689
        $flagSlaveDeleted = false;
690

691
        if (!isset($fe[FE_SLAVE_ID])) {
692
693
694
            throw new UserFormException("Missing 'slaveId'-definition", ERROR_MISSING_SLAVE_ID_DEFINITION);
        }

695
        // Get the slaveId
696
        $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
697
698
699
        // Store the slaveId: it's used and replaced in the update statement.
        $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR, true);

700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
        $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);
721
722
        }

723
724
        // If given: fire a sqlBefore query
        $this->evaluate->parse($fe[FE_SQL_BEFORE]);
725
726

        $rc = $this->evaluate->parse($sql);
727
728
729
730
731
        // Check if the slave record has been deleted: if yes, set slaveId=0
        if ($flagSlaveDeleted && $rc > 0) {
            $rc = 0;
            $flagUpdateSlaveId = true;
        }
732
733
734
735
736
737
738
739
740
741
742
743

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