AbstractBuildForm.php 160 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\Form\FormAsFile;
14
use IMATHUZH\Qfq\Core\Form\TypeAhead;
15
use IMATHUZH\Qfq\Core\Helper\HelperFile;
Marc Egger's avatar
Marc Egger committed
16
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
17
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
Marc Egger's avatar
Marc Egger committed
18
19
use IMATHUZH\Qfq\Core\Helper\Ldap;
use IMATHUZH\Qfq\Core\Helper\Logger;
20
use IMATHUZH\Qfq\Core\Helper\OnArray;
21
use IMATHUZH\Qfq\Core\Helper\Path;
Marc Egger's avatar
Marc Egger committed
22
use IMATHUZH\Qfq\Core\Helper\Sanitize;
23
24
use IMATHUZH\Qfq\Core\Helper\Support;
use IMATHUZH\Qfq\Core\Report\Link;
Marc Egger's avatar
Marc Egger committed
25
use IMATHUZH\Qfq\Core\Report\Report;
26
27
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
28

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

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

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

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

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

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

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

136
        $this->sip = $this->store->getSipInstance();
137

138
139
        $this->link = new Link($this->sip, $this->dbIndexData);

140
        // render mode specific
141
        $this->fillWrap();
142
143

        $this->buildElementFunctionName = [
144
            FE_TYPE_CHECKBOX => 'Checkbox',
Carsten  Rose's avatar
Carsten Rose committed
145
            FE_TYPE_DATE => 'DateTime',
146
            FE_TYPE_DATETIME => 'DateTime',
Carsten  Rose's avatar
Carsten Rose committed
147
148
149
150
151
152
153
154
155
            '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',
156
            FE_TYPE_PASSWORD => 'Input',
Carsten  Rose's avatar
Carsten Rose committed
157
158
            FE_TYPE_RADIO => 'Radio',
            FE_TYPE_SELECT => 'Select',
159
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
160
            FE_TYPE_UPLOAD => 'File',
161
            FE_TYPE_ANNOTATE => 'Annotate',
162
            FE_TYPE_IMAGE_CUT => 'ImageCut',
Carsten  Rose's avatar
Carsten Rose committed
163
164
165
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
166
167
        ];

168
        $this->buildRowName = [
169
            FE_TYPE_CHECKBOX => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
170
            FE_TYPE_DATE => 'Native',
171
            FE_TYPE_DATETIME => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
172
173
174
175
176
177
178
179
180
            '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',
181
            FE_TYPE_PASSWORD => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
182
183
            FE_TYPE_RADIO => 'Native',
            FE_TYPE_SELECT => 'Native',
184
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
185
            FE_TYPE_UPLOAD => 'Native',
186
            FE_TYPE_ANNOTATE => 'Native',
187
            FE_TYPE_IMAGE_CUT => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
188
189
190
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
191
192
        ];

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

199
200
    abstract public function fillWrap();

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

    /**
     * @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
     */
219
    private function buildMultiForm($filter, $modeCollectFe, array &$rcJson) {
220
221
222
223
224
225
226
227

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

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

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

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

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

241
242
243
244
245
246
247
248
249
250
        // 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();
        }

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

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

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

262
263
264
265
266
267
268
269
            $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);
270
271

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

275
            $rcJson = array_merge($rcJson, $jsonTmp);
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
301
302
        }

        $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
303
304
     * @throws \CodeException
     * @throws \UserFormException
305
306
307
308
309
310
311
312
313
314
315
316
     */
    private function buildMultiFormTableHead(array $row) {
        $line = '';

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

        // Collect label from FormElements
317
318
319
320
321
322
323
324
325
326
327
328
329
        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>';
330
331
332
333
334
        }

        return $line;
    }

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

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

368
369
370
371
372
373
374
        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

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

381
        $filter = $this->getProcessFilter();
382

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

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

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

            if ($mode === FORM_SAVE && $recordId != 0) {
398
399
400

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

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

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

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

421
422
        $htmlSip = $this->buildHiddenSip($json);

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

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

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

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

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

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

448
449
450
        $html .= $this->getFormTag();

        return $html;
451
452
    }

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

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

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

480
        $queryString = Support::arrayToQueryString($queryStringArray);
481

482
483
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
484

485
        return $url;
486
487
488
    }

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

        if ($flagOmitEmpty && $value === "") {
500
            return '';
501
502
        }

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

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

517
        $attribute = $this->getFormTagAttributes();
518

519
520
        $honeypot = $this->getHoneypotVars();

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

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

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

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

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

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

        return $data;
    }


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

        if ($recordId != 0) {
561
            $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to load not found. "
562
                . (FEATURE_FORM_FILE_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
563
564
565
566
567
        }

        if (isset($record[F_FILE_STATS])) {
            // why: The column "fileStats" in the Form table is modified when a form is exported to a file but nothing else changes.
            unset($record[F_FILE_STATS]);
Carsten  Rose's avatar
Carsten Rose committed
568
569
        }

570
        return OnArray::getMd5($record);
571
572
    }

573
574
575
576
    /**
     * Create HTML Input vars to detect bot automatic filling of forms.
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
577
578
     * @throws \CodeException
     * @throws \UserFormException
579
580
581
582
583
584
585
586
587
     */
    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) {
588
589
590
591
            $name = trim($name);
            if ($name === '') {
                continue;
            }
592
593
594
595
596
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
597

Carsten  Rose's avatar
Carsten Rose committed
598

599
600
601
    /**
     * Build an assoc array with standard form attributes.
     *
602
     * @return array
Marc Egger's avatar
Marc Egger committed
603
604
605
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
606
     */
607
    public function getFormTagAttributes() {
608

609
        $attribute['id'] = $this->getFormId();
610
611
612
613
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
614
        $attribute[FE_INPUT_AUTOCOMPLETE] = 'on';
615
        $attribute['enctype'] = $this->getEncType();
616
        $attribute['data-disable-return-key-submit'] = $this->formSpec[F_ENTER_AS_SUBMIT] == '1' ? "false" : "true"; // attribute meaning is inverted
617
        $attribute['data-activate-first-required-tab'] = $this->formSpec[F_ACTIVATE_FIRST_REQUIRED_TAB] == '1' ? "true" : "false"; // attribute meaning is inverted
618
619
620
621

        return $attribute;
    }

622
    /**
Carsten  Rose's avatar
Carsten Rose committed
623
624
     * Return a uniq form id
     *
625
626
627
628
629
630
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
631

632
633
634
        return $this->formId;
    }

635
636
637
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
638
639
     * Notice: the SIP will be transferred as POST Parameter.
     *
640
641
642
643
     * @return string
     */
    public function getActionUrl() {

Marc Egger's avatar
Marc Egger committed
644
        return Path::appToApi(API_SAVE_PHP);
645
646
647
648
649
650
651
652
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
653
654
655
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
656
657
658
     */
    public function getEncType() {

659
        $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"');
660

661
662
663
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
664

665
666
667
    /**
     * @return mixed
     */
668
    abstract public function getProcessFilter();
669

670
671
672
673
    /**
     * @param array|string $value
     *
     * @return array|string
Marc Egger's avatar
Marc Egger committed
674
675
676
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
677
678
679
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
680
681
682
683
684
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
685
     */
686
687
    private function processReportSyntax($value) {

688
689
690
691
692
693
694
695
696
697
698
        if (is_array($value)) {
            $new = array();

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

            return $new;
        }

699
        $value = trim($value);
700
701
702
703
704
705
706
707
708
        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();
            }

709
            $storeRecord = $this->store->getStore(STORE_RECORD);
710
            $value = $this->report->process($this->bodytextParser->process($value));
711
            $this->store->setStore($storeRecord, STORE_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
712
            $this->store->setVar(SYSTEM_REPORT_FULL_LEVEL, '', STORE_SYSTEM); // debug
713
714
715
716
717
        }

        return $value;
    }

718

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

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

755
        // get current data record
756
757
        $primaryKey = $this->formSpec[F_PRIMARY_KEY];
        if ($recordId > 0 && $this->store->getVar($primaryKey, STORE_RECORD) === false) {
758
            $tableName = $this->formSpec[F_TABLE_NAME];
759
            $row = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey` = ?", ROW_EXPECT_1,
760
                array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$primaryKey'='$recordId' from table '" .
761
                $this->formSpec[F_TABLE_NAME] . "'.");
762
            $this->store->setStore($row, STORE_RECORD);
763
        }
764

765
766
        $this->checkAutoFocus();

767
768
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);

769
770
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
771
            $storeUse = $storeUseDefault;
772

773
774
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
775
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
776
777
778
779
            ) {
                continue; // skip this FE
            }

780
781
782
783
            // #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
            }
784
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form.
785

786
787
            $debugStack = array();

788
789
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
790
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM);
791

Carsten  Rose's avatar
Carsten Rose committed
792
793
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
794

795
796
797
798
799
800
            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);
            }

801
802
            // If given, slaveId will be copied to STORE_VAR
            if (!empty($fe[FE_SLAVE_ID])) {
803
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_SLAVE_ID, STORE_SYSTEM); // debug
804
805
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
806
807
            }

808
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_VALUE, STORE_SYSTEM); // debug
809
            $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]);
810
811

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

Carsten  Rose's avatar
Carsten Rose committed
814
            // ** evaluate current FormElement **
815
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Some of the columns of current FormElement', STORE_SYSTEM); // debug
816
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
817
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Set language', STORE_SYSTEM); // debug
818
            $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName);
819

820
            // Some Defaults
821
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
822

823
824
825
826
827
828
//            // Copy global readonly mode.
//            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
//                $fe[FE_MODE] = FE_MODE_READONLY;
//                $fe[FE_MODE_SQL] = '';
//            }

829
            if ($flagOutput === true && !$flagMulti) {
830
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
831
            }
832

833
834
            Support::setIfNotSet($formElement, FE_VALUE);

835
836
837
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
838

839
            $value = $formElement[FE_VALUE];
840

841
            if ($value === '') {
842
843
844
845
                // #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
846
                }
847
848
849
850

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

851
                // Retrieve value via FSRVD
852
                $sanitizeClass = ($mode == FORM_UPDATE) ? SANITIZE_ALLOW_ALL : $formElement[FE_CHECK_TYPE];
853
                $value = $this->store->getVar($name, $storeUse, $sanitizeClass, $foundInStore);
854
855
856
857
858
859

                // For typeAhead fields: perform prefetch to display description instead of key (#5444)
                if ($mode == FORM_SAVE && isset($fe[FE_TYPEAHEAD_SQL_PREFETCH])) {
                    $config = [FE_TYPEAHEAD_SQL_PREFETCH => $fe[FE_TYPEAHEAD_SQL_PREFETCH]];
                    $value = TypeAhead::typeAheadSqlPrefetch($config, $value, $this->dbArray[$this->dbIndexData]);
                }
860
861
862
            }

            if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) {
863
864
//                $value = htmlspecialchars_decode($value, ENT_QUOTES);
                $value = Support::htmlEntityEncodeDecode(MODE_DECODE, $value);
865
            }
866

867
868
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
869
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
870
871
872
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
873

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

Carsten  Rose's avatar
Carsten Rose committed
877
            $jsonElement = array();
878
            $elementExtra = '';
879
            // Render pure element
880
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
881
882

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
883
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
884
885
886
887
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
888
                // for non-container elements: just add the current json status
889
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
890
891
892
893
894
895
                    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
896
897
                }
            }
898

899
900
            if ($flagOutput) {
                // debugStack as Tooltip
901
902
                if ($this->showDebugInfoFlag) {

903
904
905
906
                    if (count($debugStack) > 0) {
                        $elementHtml .= Support::doTooltip($formElement