AbstractBuildForm.php 159 KB
Newer Older
1
<?php
Carsten  Rose's avatar
Carsten Rose committed
2
3
4
5
6
7
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
Carsten  Rose's avatar
Carsten Rose committed
8

Marc Egger's avatar
Marc Egger committed
9
10
11
namespace IMATHUZH\Qfq\Core;

use IMATHUZH\Qfq\Core\Database\Database;
12
use IMATHUZH\Qfq\Core\Form\Checkbox;
13
use IMATHUZH\Qfq\Core\Helper\HelperFile;
Marc Egger's avatar
Marc Egger committed
14
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
15
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
Marc Egger's avatar
Marc Egger committed
16
17
use IMATHUZH\Qfq\Core\Helper\Ldap;
use IMATHUZH\Qfq\Core\Helper\Logger;
18
use IMATHUZH\Qfq\Core\Helper\OnArray;
19
use IMATHUZH\Qfq\Core\Helper\Path;
Marc Egger's avatar
Marc Egger committed
20
use IMATHUZH\Qfq\Core\Helper\Sanitize;
21
22
use IMATHUZH\Qfq\Core\Helper\Support;
use IMATHUZH\Qfq\Core\Report\Link;
Marc Egger's avatar
Marc Egger committed
23
use IMATHUZH\Qfq\Core\Report\Report;
24
25
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
26

27
/**
Carsten  Rose's avatar
Carsten Rose committed
28
29
 * Class AbstractBuildForm
 * @package qfq
30
 */
31
abstract class AbstractBuildForm {
32
33
34
    /**
     * @var array
     */
35
    protected $formSpec = array();  // copy of the loaded form
36
37
38
    /**
     * @var array
     */
39
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
40
41
42
    /**
     * @var array
     */
43
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
44
45
46
    /**
     * @var array
     */
47
    protected $buildElementFunctionName = array();
48
49
50
    /**
     * @var array
     */
51
    protected $pattern = array();
52
53
54
    /**
     * @var array
     */
55
    protected $wrap = array();
56
57
58
    /**
     * @var array
     */
59
    protected $symbol = array();
60
61
62
    /**
     * @var bool
     */
63
    protected $showDebugInfoFlag = false;
Carsten  Rose's avatar
Carsten Rose committed
64

65
//    protected $feDivClass = array(); // Wrap FormElements in <div class="$feDivClass[type]">
66

67
68
69
70
71
72
73
74
    /**
     * @var Store
     */
    protected $store = null;
    /**
     * @var Evaluate
     */
    protected $evaluate = null;
75
76
77
    /**
     * @var string
     */
78
    private $formId = null;
79
80
81
82
    /**
     * @var Sip
     */
    private $sip = null;
83
84
85
86
    /**
     * @var Link
     */
    protected $link = null;
87
88
89
90
91
92
93
94
    /**
     * @var Report
     */
    private $report = null;
    /**
     * @var BodytextParser
     */
    private $bodytextParser = null;
95

96
    /**
Carsten  Rose's avatar
Carsten Rose committed
97
     * @var Database[] - Array of Database instantiated class
98
99
100
     */
    protected $dbArray = array();

101
102
103
    /**
     * @var bool|mixed
     */
104
    protected $dbIndexData = false;
105
106
107
    /**
     * @var bool|string
     */
108
    protected $dbIndexQfq = false;
Carsten  Rose's avatar
Carsten Rose committed
109

110
111
112
113
114
115
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
116
     * @param array Database $db
Marc Egger's avatar
Marc Egger committed
117
118
119
     * @throws \CodeException
     * @throws \UserFormException
     * @throws \UserReportException
120
     */
121
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $db = null) {
122
123
124
125
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
126
127
//        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexData = $formSpec[F_DB_INDEX];
128
129
130
131
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);

        $this->dbArray = $db;
        $this->evaluate = new Evaluate($this->store, $this->dbArray[$this->dbIndexData]);
132
        $this->showDebugInfoFlag = Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_YES, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM));
133

134
        $this->sip = $this->store->getSipInstance();
135

136
137
        $this->link = new Link($this->sip, $this->dbIndexData);

138
        // render mode specific
139
        $this->fillWrap();
140
141

        $this->buildElementFunctionName = [
142
            FE_TYPE_CHECKBOX => 'Checkbox',
Carsten  Rose's avatar
Carsten Rose committed
143
            FE_TYPE_DATE => 'DateTime',
144
            FE_TYPE_DATETIME => 'DateTime',
Carsten  Rose's avatar
Carsten Rose committed
145
146
147
148
149
150
151
152
153
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            FE_TYPE_EXTRA => 'Extra',
            FE_TYPE_TEXT => 'Input',
            FE_TYPE_EDITOR => 'Editor',
            FE_TYPE_TIME => 'DateTime',
            FE_TYPE_NOTE => 'Note',
154
            FE_TYPE_PASSWORD => 'Input',
Carsten  Rose's avatar
Carsten Rose committed
155
156
            FE_TYPE_RADIO => 'Radio',
            FE_TYPE_SELECT => 'Select',
157
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
158
            FE_TYPE_UPLOAD => 'File',
159
            FE_TYPE_ANNOTATE => 'Annotate',
160
            FE_TYPE_IMAGE_CUT => 'ImageCut',
Carsten  Rose's avatar
Carsten Rose committed
161
162
163
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
164
165
        ];

166
        $this->buildRowName = [
167
            FE_TYPE_CHECKBOX => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
168
            FE_TYPE_DATE => 'Native',
169
            FE_TYPE_DATETIME => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
170
171
172
173
174
175
176
177
178
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
            FE_TYPE_EXTRA => 'Native',
            FE_TYPE_TEXT => 'Native',
            FE_TYPE_EDITOR => 'Native',
            FE_TYPE_TIME => 'Native',
            FE_TYPE_NOTE => 'Native',
179
            FE_TYPE_PASSWORD => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
180
181
            FE_TYPE_RADIO => 'Native',
            FE_TYPE_SELECT => 'Native',
182
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
183
            FE_TYPE_UPLOAD => 'Native',
184
            FE_TYPE_ANNOTATE => 'Native',
185
            FE_TYPE_IMAGE_CUT => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
186
187
188
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
189
190
        ];

191
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon " . GLYPH_ICON_EDIT . "'></span>";
192
        $this->symbol[SYMBOL_SHOW] = "<span class='glyphicon " . GLYPH_ICON_SHOW . "'></span>";
193
194
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon " . GLYPH_ICON_NEW . "'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon " . GLYPH_ICON_DELETE . "'></span>";
195
196
    }

197
198
    abstract public function fillWrap();

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

    /**
     * @param $filter
     * @param $modeCollectFe
     * @param array $rcJson
     * @return string
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
     */
217
    private function buildMultiForm($filter, $modeCollectFe, array &$rcJson) {
218
219
220
221
222
223
224
225

        $htmlElements = '';
        $rcJson = array();

        $parentRecords = $this->evaluate->parse($this->formSpec[F_MULTI_SQL], ROW_REGULAR);

        // No rows: nothing to do.
        if (empty($parentRecords)) {
226
            return $this->formSpec[F_MULTI_MSG_NO_RECORD];
227
228
229
        }

        // Check for 'id' or '_id' as column name
230
        $idName = isset($parentRecords[0]['_' . F_MULTI_COL_ID]) ? '_' . F_MULTI_COL_ID : F_MULTI_COL_ID;
231
232
233
234
235
236
237
238

        // Check that an column 'id' is given
        if (!isset($parentRecords[0][$idName])) {
            throw new \UserFormException(
                json_encode([ERROR_MESSAGE_TO_USER => 'Missing column "_' . F_MULTI_COL_ID . '"', ERROR_MESSAGE_TO_DEVELOPER => $this->formSpec[F_MULTI_SQL]]),
                ERROR_INVALID_OR_MISSING_PARAMETER);
        }

239
240
241
242
243
244
245
246
247
248
        // This is a dirty workaround for formSave: clear FORM STORE (already outdated values).
        // Otherwise those outdated values will be taken to fill non primary FE in multiForm (which are garbage).
        // Better solution would be to have FORM_STORE in sync.
        $this->store::unsetStore(STORE_FORM);

        $storeVarBase = $this->evaluate->parse($this->formSpec[FE_FILL_STORE_VAR]);
        if (!is_array($storeVarBase)) {
            $storeVarBase = array();
        }

249
250
        // Per row, iterate over all form elements
        foreach ($parentRecords as $row) {
251
252
            // Always start with a clean STORE_VAR
            $this->store->setStore($storeVarBase, STORE_VAR, true);
253

254
            $this->store->setStore($row, STORE_PARENT_RECORD, true);
255
256
            $this->store->setVar(F_MULTI_COL_ID, $row[$idName], STORE_PARENT_RECORD); // In case '_id' is used, both '_id' and 'id' should be accessible.

257
            $record = $this->dbArray[$this->dbIndexData]->sql('SELECT * FROM `' . $this->formSpec[F_TABLE_NAME] . '` WHERE `id`=' . $row[F_MULTI_COL_ID], ROW_EXPECT_1);
258
            $this->store->setStore($record, STORE_RECORD, true);
259

260
261
262
263
264
265
266
267
            $jsonTmp = array();
            $feTmp = $this->feSpecNative;

            $leftColumns = $this->buildMultiFormLeftColumns($row);
            $rightInputs = $this->elements($row[$idName], $filter, 0, $jsonTmp, $modeCollectFe,
                false, STORE_USE_DEFAULT, FORM_LOAD, true);

            $htmlElements .= Support::wrapTag('<tr>', $leftColumns . $rightInputs);
268
269

            // Clean for the next round
270
            $this->feSpecNative = $feTmp;
271
272
            $this->store::unsetStore(STORE_RECORD);

273
            $rcJson = array_merge($rcJson, $jsonTmp);
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        }

        $tableHead = Support::wrapTag('<tr>', $this->buildMultiFormTableHead($parentRecords[0]));

        return '<table class="table"><thead>' . $tableHead . '</thead><tbody>' . $htmlElements . '</tbody></table>';
    }

    /**
     * @param array $row
     * @return string
     */
    private function buildMultiFormLeftColumns(array $row) {
        $line = '';

        // Collect columns
        foreach ($row as $key => $value) {
            if (($key[0] ?? '') != '_') {
                $line .= "<td>$value</td>";
            }
        }

        return $line;
    }

    /**
     * @param array $row
     * @return string
301
302
     * @throws \CodeException
     * @throws \UserFormException
303
304
305
306
307
308
309
310
311
312
313
314
     */
    private function buildMultiFormTableHead(array $row) {
        $line = '';

        // Collect columns
        foreach ($row as $key => $value) {
            if (($key[0] ?? '') != '_') {
                $line .= "<th>$key</th>";
            }
        }

        // Collect label from FormElements
315
316
317
318
319
320
321
322
323
324
325
326
327
        foreach ($this->feSpecNative as $formElement) {
            $editFeHtml = '';

            // debugStack as Tooltip
            if ($this->showDebugInfoFlag) {
                // Build 'FormElement' Edit symbol
                $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]);
                $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']');
                $icon = Support::wrapTag('<span class="' . GLYPH_ICON . ' ' . GLYPH_ICON_EDIT . '">', '');
                $editFeHtml = ' ' . Support::wrapTag("<a class='hidden " . CLASS_FORM_ELEMENT_EDIT . "' href='$feEditUrl' $titleAttr>", $icon);
            }

            $line .= '<th>' . $formElement[FE_LABEL] . $editFeHtml . '</th>';
328
329
330
331
332
        }

        return $line;
    }

333
    /**
334
     * Builds complete 'form'. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
335
     *
336
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
337
     *
338
339
340
     * @param bool $htmlElementNameIdZero
     * @param array $latestFeSpecNative
     * @return array|string $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all
341
     *                        formElement.dynamicUpdate-yes  values/states
Marc Egger's avatar
Marc Egger committed
342
343
344
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
345
346
347
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
348
349
350
351
352
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
353
     */
354
    public function process($mode, $htmlElementNameIdZero = false, $latestFeSpecNative = array()) {
Carsten  Rose's avatar
Carsten Rose committed
355
356
        $htmlHead = '';
        $htmlTail = '';
357
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
358
359
        $htmlElements = '';
        $json = array();
360

361
        // After action 'afterSave', it's necessary to reinitialize the FeSpecNative
362
363
364
365
        if (!empty($latestFeSpecNative)) {
            $this->feSpecNative = $latestFeSpecNative;
        }

366
367
368
369
370
371
372
        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

        if ($mode === FORM_SAVE) {
            $modeCollectFe = FLAG_ALL;
            $storeUse = STORE_RECORD . STORE_TABLE_DEFAULT;
        }
373

374
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
375
376
377
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
        }
378

379
        $filter = $this->getProcessFilter();
380

381
382
        // Form type
        if ($this->formSpec[F_MULTI_SQL] === '') {
383

384
            // Regular Form
385
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
386
            if (!($recordId == '' || is_numeric($recordId))) {
Marc Egger's avatar
Marc Egger committed
387
                throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
388
                    json_encode([ERROR_MESSAGE_TO_USER => 'Invalid record ID', ERROR_MESSAGE_TO_DEVELOPER => 'Invalid record ID: r="' . $recordId]),
389
                    ERROR_INVALID_VALUE);
390
            }
391

392
            // Build FormElements
393
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
Carsten  Rose's avatar
Carsten Rose committed
394
395

            if ($mode === FORM_SAVE && $recordId != 0) {
396
397
398

                // element-update: with 'value'
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
399
                $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
400
401

                // Via 'element-update'
402
                $json[][API_ELEMENT_UPDATE][DIRTY_RECORD_HASH_MD5][API_ELEMENT_ATTRIBUTE]['value'] = $md5;
Carsten  Rose's avatar
Carsten Rose committed
403
            }
404
405
406

        } else {
            // Multi Form
407
            if ($mode === FORM_LOAD || $mode === FORM_SAVE) {
408
409
                $htmlElements = $this->buildMultiForm($filter, $modeCollectFe, $json);
            }
410
        }
411
412
413

        // <form>
        if ($mode === FORM_LOAD) {
414
            $htmlT3vars = $this->prepareT3VarsForSave();
415
            $htmlTail = $this->tail();
416
        }
417
        $htmlHidden = $this->buildAdditionalFormElements();
418

419
420
        $htmlSip = $this->buildHiddenSip($json);

421
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlHidden . $htmlElements . $htmlSip . $htmlT3vars . $htmlTail : $json;
422
423
    }

424
    /**
425
     * Build the head area of the form.
426
     *
427
     * @param string $mode
428
     * @return string
Marc Egger's avatar
Marc Egger committed
429
430
431
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
432
     */
433
    public function head($mode = FORM_LOAD) {
434
        $html = '';
435

436
        $html .= '<div ' . Support::doAttribute('class', $this->formSpec[F_CLASS], true) . '>'; // main <div class=...> around everything
437

438
439
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
440
        $formEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM, $this->formSpec[F_ID]);
441

442
        $html .= "<p><a " . Support::doAttribute('href', $formEditUrl) . ">Edit</a> <small>[$sipParamString]</small></p>";
443

444
        $html .= $this->wrapItem(WRAP_SETUP_TITLE, $this->formSpec[F_TITLE], true);
445

446
447
448
        $html .= $this->getFormTag();

        return $html;
449
450
    }

451
    /**
452
453
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of
     * the SIP.
454
     *
455
     * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT
Carsten  Rose's avatar
Carsten Rose committed
456
457
     * @param int $recordId id of form or formElement
     * @param array $param
458
459
460
     *
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:...,
     *                ...]</small>
Marc Egger's avatar
Marc Egger committed
461
462
     * @throws \CodeException
     * @throws \UserFormException
463
     */
464
    public function createFormEditorUrl($form, $recordId, array $param = array()) {
465

466
        if (!$this->showDebugInfoFlag) {
467
468
            return '';
        }
469

470
        $queryStringArray = [
471
            'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM),
472
            'form' => $form,
Carsten  Rose's avatar
Carsten Rose committed
473
            'r' => $recordId,
474
            PARAM_DB_INDEX_DATA => $this->dbIndexQfq,
475
        ];
476
        $queryStringArray = array_merge($queryStringArray, $param);
477

478
        $queryString = Support::arrayToQueryString($queryStringArray);
479

480
481
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
482

483
        return $url;
484
485
486
    }

    /**
487
488
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
Carsten  Rose's avatar
Carsten Rose committed
489
490
     * @param string $item
     * @param string $value
491
     * @param bool|false $flagOmitEmpty
492
     *
493
494
495
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
496
497

        if ($flagOmitEmpty && $value === "") {
498
            return '';
499
500
        }

501
502
503
504
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
505
     * Returns '<form ...>'-tag with various attributes.
506
507
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
508
509
510
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
511
512
     */
    public function getFormTag() {
Carsten  Rose's avatar
Carsten Rose committed
513
        $md5 = '';
514

515
        $attribute = $this->getFormTagAttributes();
516

517
518
        $honeypot = $this->getHoneypotVars();

519
        $md5 = $this->buildInputRecordHashMd5();
Carsten  Rose's avatar
Carsten Rose committed
520
521
522
523
524
525

        return '<form ' . OnArray::toString($attribute, '=', ' ', "'") . '>' . $honeypot . $md5;
    }

    /**
     * Build MD5 from the current record. Return HTML Input element.
526
     *
527
     * @return string
Marc Egger's avatar
Marc Egger committed
528
529
530
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Carsten Rose committed
531
     */
532
    public function buildInputRecordHashMd5() {
533

Carsten  Rose's avatar
Carsten Rose committed
534
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
535
        $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
536
537

        $data = "<input id='" . DIRTY_RECORD_HASH_MD5 . "' name='" . DIRTY_RECORD_HASH_MD5 . "' type='hidden' value='$md5'>";
538

539
//        $data = "<input id='" . DIRTY_RECORD_HASH_MD5 . "' name='" . DIRTY_RECORD_HASH_MD5 . "' type='text' value='$md5'>";
540
541
542
543
544
545
546
547

        return $data;
    }


    /**
     * @param $tableName
     * @param $recordId
548
     * @param string $primaryKey
549
     *
550
     * @return string
Marc Egger's avatar
Marc Egger committed
551
552
553
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
554
     */
555
    public function buildRecordHashMd5($tableName, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
556
        $record = array();
Carsten  Rose's avatar
Carsten Rose committed
557
558

        if ($recordId != 0) {
559
            $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to load not found.");
Carsten  Rose's avatar
Carsten Rose committed
560
561
        }

562
        return OnArray::getMd5($record);
563
564
    }

565
566
567
568
    /**
     * Create HTML Input vars to detect bot automatic filling of forms.
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
569
570
     * @throws \CodeException
     * @throws \UserFormException
571
572
573
574
575
576
577
578
579
     */
    public function getHoneypotVars() {
        $html = '';

        $vars = $this->store->getVar(SYSTEM_SECURITY_VARS_HONEYPOT, STORE_SYSTEM);

        // Iterate over all fake vars
        $arr = explode(',', $vars);
        foreach ($arr as $name) {
580
581
582
583
            $name = trim($name);
            if ($name === '') {
                continue;
            }
584
585
586
587
588
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
589

Carsten  Rose's avatar
Carsten Rose committed
590

591
592
593
    /**
     * Build an assoc array with standard form attributes.
     *
594
     * @return array
Marc Egger's avatar
Marc Egger committed
595
596
597
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
598
     */
599
    public function getFormTagAttributes() {
600

601
        $attribute['id'] = $this->getFormId();
602
603
604
605
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
606
        $attribute[FE_INPUT_AUTOCOMPLETE] = 'on';
607
        $attribute['enctype'] = $this->getEncType();
608
        $attribute['data-disable-return-key-submit'] = $this->formSpec[F_ENTER_AS_SUBMIT] == '1' ? "false" : "true"; // attribute meaning is inverted
609
        $attribute['data-activate-first-required-tab'] = $this->formSpec[F_ACTIVATE_FIRST_REQUIRED_TAB] == '1' ? "true" : "false"; // attribute meaning is inverted
610
611
612
613

        return $attribute;
    }

614
    /**
Carsten  Rose's avatar
Carsten Rose committed
615
616
     * Return a uniq form id
     *
617
618
619
620
621
622
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
623

624
625
626
        return $this->formId;
    }

627
628
629
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
630
631
     * Notice: the SIP will be transferred as POST Parameter.
     *
632
633
634
635
     * @return string
     */
    public function getActionUrl() {

636
        return Path::cwdToApi(API_SAVE_PHP);
637
638
639
640
641
642
643
644
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
645
646
647
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
648
649
650
     */
    public function getEncType() {

651
        $result = $this->dbArray[$this->dbIndexQfq]->sql("SELECT id FROM FormElement AS fe WHERE fe.formId=? AND fe.type='upload' LIMIT 1", ROW_REGULAR, [$this->formSpec['id']], 'Look for Formelement.type="upload"');
652

653
654
655
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
656

657
    abstract public function getProcessFilter();
658

659
660
661
662
    /**
     * @param array|string $value
     *
     * @return array|string
Marc Egger's avatar
Marc Egger committed
663
664
665
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
666
667
668
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
669
670
671
672
673
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
674
     */
675
676
    private function processReportSyntax($value) {

677
678
679
680
681
682
683
684
685
686
687
        if (is_array($value)) {
            $new = array();

            //might happen for e.g Template Groups
            foreach ($value as $item) {
                $new[] = $this->processReportSyntax($item);
            }

            return $new;
        }

688
        $value = trim($value);
689
690
691
692
693
694
695
696
697
        if (substr($value, 0, 8) == SHEBANG_REPORT) {
            if ($this->report === null) {
                $this->report = new Report(array(), $this->evaluate, false);
            }

            if ($this->bodytextParser === null) {
                $this->bodytextParser = new BodytextParser();
            }

698
            $storeRecord = $this->store->getStore(STORE_RECORD);
699
            $value = $this->report->process($this->bodytextParser->process($value));
700
            $this->store->setStore($storeRecord, STORE_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
701
            $this->store->setVar(SYSTEM_REPORT_FULL_LEVEL, '', STORE_SYSTEM); // debug
702
703
704
705
706
        }

        return $value;
    }

707

708
    /**
709
     * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON.
710
     *
Carsten  Rose's avatar
Carsten Rose committed
711
     * @param int $recordId
712
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
Carsten  Rose's avatar
Carsten Rose committed
713
714
     * @param int $feIdContainer
     * @param array $json
715
     * @param string $modeCollectFe
Carsten  Rose's avatar
Carsten Rose committed
716
     * @param bool $htmlElementNameIdZero
717
     * @param string $storeUseDefault
718
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
719
     * @param bool $flagMulti
720
     *
721
     * @return string
Marc Egger's avatar
Marc Egger committed
722
723
724
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
725
726
727
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
728
729
730
731
732
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
733
     */
734
    public function elements($recordId, $filter, $feIdContainer, array &$json,
735
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false,
736
                             $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD, $flagMulti = false) {
737
        $html = '';
738

739
        // The following 'FormElement.parameter' will never be used during load (fe.type='upload'). FE_PARAMETER has been already expanded.
740
        $skip = [FE_SQL_UPDATE, FE_SQL_INSERT, FE_SQL_DELETE, FE_SQL_AFTER, FE_SQL_BEFORE, FE_PARAMETER,
741
742
            FE_FILL_STORE_VAR, FE_FILE_DOWNLOAD_BUTTON, FE_TYPEAHEAD_GLUE_INSERT, FE_TYPEAHEAD_GLUE_DELETE,
            FE_TYPEAHEAD_TAG_INSERT, FE_TYPEAHEAD_INITIAL_SUGGESTION];
743

744
        // get current data record
745
746
        $primaryKey = $this->formSpec[F_PRIMARY_KEY];
        if ($recordId > 0 && $this->store->getVar($primaryKey, STORE_RECORD) === false) {
747
            $tableName = $this->formSpec[F_TABLE_NAME];
748
            $row = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey` = ?", ROW_EXPECT_1,
749
                array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$primaryKey'='$recordId' from table '" .
750
                $this->formSpec[F_TABLE_NAME] . "'.");
751
            $this->store->setStore($row, STORE_RECORD);
752
        }
753

754
755
        $this->checkAutoFocus();

756
757
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);

758
759
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
760
            $storeUse = $storeUseDefault;
761

762
763
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
764
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
765
766
767
768
            ) {
                continue; // skip this FE
            }

769
770
771
772
            // #7705. Dirty fix: 'form_save and fresh created tg element can't be updated, cause the HTML id is unknown: skip those.
            if ($mode == FORM_SAVE && false != stripos($fe[FE_NAME], '%d')) {
                continue; // skip this FE
            }
773
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form.
774

775
776
            $debugStack = array();

777
778
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
779
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM);
780

Carsten  Rose's avatar
Carsten Rose committed
781
782
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
783

784
785
786
787
788
789
            if (isset($fe[FE_FILL_STORE_VAR])) {
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_FILL_STORE_VAR, STORE_SYSTEM); // debug
                $fe[FE_FILL_STORE_VAR] = $this->evaluate->parse($fe[FE_FILL_STORE_VAR], ROW_EXPECT_0_1);
                $this->store->appendToStore($fe[FE_FILL_STORE_VAR], STORE_VAR);
            }

790
791
            // If given, slaveId will be copied to STORE_VAR
            if (!empty($fe[FE_SLAVE_ID])) {
792
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_SLAVE_ID, STORE_SYSTEM); // debug
793
794
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
795
796
            }

797
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_VALUE, STORE_SYSTEM); // debug
798
            $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]);
799
800

            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_NOTE, STORE_SYSTEM); // debug
801
802
            $fe[FE_NOTE] = $this->processReportSyntax($fe[FE_NOTE]);

Carsten  Rose's avatar
Carsten Rose committed
803
            // ** evaluate current FormElement **
804
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Some of the columns of current FormElement', STORE_SYSTEM); // debug
805
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
806
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Set language', STORE_SYSTEM); // debug
807
            $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName);
808

809
            // Some Defaults
810
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
811

812
813
814
815
816
817
//            // Copy global readonly mode.
//            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
//                $fe[FE_MODE] = FE_MODE_READONLY;
//                $fe[FE_MODE_SQL] = '';
//            }

818
            if ($flagOutput === true && !$flagMulti) {
819
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
820
            }
821

822
823
            Support::setIfNotSet($formElement, FE_VALUE);

824
825
826
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
827

828
            $value = $formElement[FE_VALUE];
829

830
            if ($value === '') {
831
832
833
834
                // #2064 / Only take the default, if the FE is a real tablecolumn.
                // #3426 / Dynamic Update: Inputs loose the new content and shows the old value.
                if ($storeUse == STORE_USE_DEFAULT && $this->store->getVar($formElement[FE_NAME], STORE_TABLE_COLUMN_TYPES) === false) {
                    $storeUse = str_replace(STORE_TABLE_DEFAULT, '', $storeUse); // Remove STORE_DEFAULT
835
                }
836
837
838
839

                // In case the current element is a 'RETYPE' element: take the element name of the source FormElement. Needed to retrieve the default value later.
                $name = (isset($formElement[FE_RETYPE_SOURCE_NAME])) ? $formElement[FE_RETYPE_SOURCE_NAME] : $formElement[FE_NAME];

840
                // Retrieve value via FSRVD
841
                $sanitizeClass = ($mode == FORM_UPDATE) ? SANITIZE_ALLOW_ALL : $formElement[FE_CHECK_TYPE];
842
                $value = $this->store->getVar($name, $storeUse, $sanitizeClass, $foundInStore);
843
844
845
            }

            if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) {
846
847
//                $value = htmlspecialchars_decode($value, ENT_QUOTES);
                $value = Support::htmlEntityEncodeDecode(MODE_DECODE, $value);
848
            }
849

850
851
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
852
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
853
854
855
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
856

Carsten  Rose's avatar
Carsten Rose committed
857
            // Construct Marshaller Name: buildElement
858
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement[FE_TYPE]];
859

Carsten  Rose's avatar
Carsten Rose committed
860
            $jsonElement = array();
861
            $elementExtra = '';
862
            // Render pure element
863
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
864
865

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
866
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
867
868
869
870
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
871
                // for non-container elements: just add the current json status
872
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
873
874
875
876
877
878
                    if (isset($jsonElement[0]) && is_array($jsonElement[0])) {
                        // Checkboxes are delivered as array of arrays: unnest them and append them to the existing json array.
                        $json = array_merge($json, $jsonElement);
                    } else {
                        $json[] = $jsonElement;
                    }
Carsten  Rose's avatar
Carsten Rose committed
879
880
                }
            }
881

882
883
            if ($flagOutput) {
                // debugStack as Tooltip
884
885
                if ($this->showDebugInfoFlag) {

886
887
888
889
                    if (count($debugStack) > 0) {
                        $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack));
                    }

890
891
892
893
894
895
896
                    if (!$flagMulti) {
                        // Build 'FormElement' Edit symbol. MultiForms: Edit symbol is in thead.
                        $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]);
                        $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']');
                        $icon = Support::wrapTag('<span class="' . GLYPH_ICON . ' ' . GLYPH_ICON_EDIT . '">', '');
                        $elementHtml .= Support::wrapTag("<a class='hidden " . CLASS_FORM_ELEMENT_EDIT . "' href='$feEditUrl' $titleAttr>", $icon);
                    }
897
                }
898

899
900
901
                // Construct Marshaller Name: buildRow...
                $tmpName = $flagMulti ? 'MultiElement' : $this->buildRowName[$formElement[FE_TYPE]];
                $buildRowName = 'buildRow' . $tmpName;
902

903
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];