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

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

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

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

94
    /**
95
     * @var Database[] Array of Database instantiated class
96
97
98
     */
    protected $dbArray = array();

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

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

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

132
        $this->sip = $this->store->getSipInstance();
133

134
135
        $this->link = new Link($this->sip, $this->dbIndexData);

136
        // render mode specific
137
        $this->fillWrap();
138
139

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

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

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

195
196
    abstract public function fillWrap();

197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

    /**
     * @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
     */
    private function buildMultiForm($filter, $modeCollectFe, array $rcJson) {

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

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

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

        // Check for 'id' or '_id' as column name
228
        $idName = isset($parentRecords[0]['_' . F_MULTI_COL_ID]) ? '_' . F_MULTI_COL_ID : F_MULTI_COL_ID;
229
230
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);
        }

        // Per row, iterate over all form elements
        foreach ($parentRecords as $row) {
239

240
            $this->store->setStore($row, STORE_PARENT_RECORD, true);
241

242
243
244
245
246
247
248
249
            $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);
250
251

            // Clean for the next round
252
            $this->feSpecNative = $feTmp;
253
254
            $this->store::unsetStore(STORE_RECORD);

255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
            $rcJson[] = $jsonTmp;
        }

        $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
283
284
     * @throws \CodeException
     * @throws \UserFormException
285
286
287
288
289
290
291
292
293
294
295
296
     */
    private function buildMultiFormTableHead(array $row) {
        $line = '';

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

        // Collect label from FormElements
297
298
299
300
301
302
303
304
305
306
307
308
309
        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>';
310
311
312
313
314
        }

        return $line;
    }

315
    /**
316
     * Builds complete 'form'. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
317
     *
318
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
319
     *
320
321
322
     * @param bool $htmlElementNameIdZero
     * @param array $latestFeSpecNative
     * @return array|string $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all
323
     *                        formElement.dynamicUpdate-yes  values/states
Marc Egger's avatar
Marc Egger committed
324
325
326
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
327
328
329
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
330
331
332
333
334
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
335
     */
336
    public function process($mode, $htmlElementNameIdZero = false, $latestFeSpecNative = array()) {
Carsten  Rose's avatar
Carsten Rose committed
337
338
        $htmlHead = '';
        $htmlTail = '';
339
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
340
341
        $htmlElements = '';
        $json = array();
342

343
        // After action 'afterSave', it's necessary to reinitialize the FeSpecNative
344
345
346
347
        if (!empty($latestFeSpecNative)) {
            $this->feSpecNative = $latestFeSpecNative;
        }

348
349
350
351
352
353
354
        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

356
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
357
358
359
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
        }
360

361
        $filter = $this->getProcessFilter();
362

363
364
        // Form type
        if ($this->formSpec[F_MULTI_SQL] === '') {
365

366
            // Regular Form
367
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
368
            if (!($recordId == '' || is_numeric($recordId))) {
Marc Egger's avatar
Marc Egger committed
369
                throw new \UserFormException(
Marc Egger's avatar
Marc Egger committed
370
                    json_encode([ERROR_MESSAGE_TO_USER => 'Invalid record ID', ERROR_MESSAGE_TO_DEVELOPER => 'Invalid record ID: r="' . $recordId]),
371
                    ERROR_INVALID_VALUE);
372
            }
373

374
            // Build FormElements
375
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
Carsten  Rose's avatar
Carsten Rose committed
376
377

            if ($mode === FORM_SAVE && $recordId != 0) {
378
379
380

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

                // Via 'element-update'
384
                $json[][API_ELEMENT_UPDATE][DIRTY_RECORD_HASH_MD5][API_ELEMENT_ATTRIBUTE]['value'] = $md5;
Carsten  Rose's avatar
Carsten Rose committed
385
            }
386
387
388
389
390
391

        } else {
            // Multi Form
            if ($mode === FORM_LOAD) {
                $htmlElements = $this->buildMultiForm($filter, $modeCollectFe, $json);
            }
392
        }
393
394
395

        // <form>
        if ($mode === FORM_LOAD) {
396
            $htmlT3vars = $this->prepareT3VarsForSave();
397
            $htmlTail = $this->tail();
398
        }
399
        $htmlHidden = $this->buildAdditionalFormElements();
400

401
402
        $htmlSip = $this->buildHiddenSip($json);

403
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlHidden . $htmlElements . $htmlSip . $htmlT3vars . $htmlTail : $json;
404
405
    }

406
    /**
407
     * Build the head area of the form.
408
     *
409
     * @param string $mode
410
     * @return string
Marc Egger's avatar
Marc Egger committed
411
412
413
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
414
     */
415
    public function head($mode = FORM_LOAD) {
416
        $html = '';
417

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

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

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

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

428
429
430
        $html .= $this->getFormTag();

        return $html;
431
432
    }

433
    /**
434
435
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of
     * the SIP.
436
     *
437
     * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT
Carsten  Rose's avatar
Carsten Rose committed
438
439
     * @param int $recordId id of form or formElement
     * @param array $param
440
441
442
     *
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:...,
     *                ...]</small>
Marc Egger's avatar
Marc Egger committed
443
444
     * @throws \CodeException
     * @throws \UserFormException
445
     */
446
    public function createFormEditorUrl($form, $recordId, array $param = array()) {
447

448
        if (!$this->showDebugInfoFlag) {
449
450
            return '';
        }
451

452
        $queryStringArray = [
453
            'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM),
454
            'form' => $form,
Carsten  Rose's avatar
Carsten Rose committed
455
            'r' => $recordId,
456
            PARAM_DB_INDEX_DATA => $this->dbIndexQfq,
457
        ];
458
        $queryStringArray = array_merge($queryStringArray, $param);
459

460
        $queryString = Support::arrayToQueryString($queryStringArray);
461

462
463
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
464

465
        return $url;
466
467
468
    }

    /**
469
470
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
Carsten  Rose's avatar
Carsten Rose committed
471
472
     * @param string $item
     * @param string $value
473
     * @param bool|false $flagOmitEmpty
474
     *
475
476
477
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
478
479

        if ($flagOmitEmpty && $value === "") {
480
            return '';
481
482
        }

483
484
485
486
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
487
     * Returns '<form ...>'-tag with various attributes.
488
489
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
490
491
492
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
493
494
     */
    public function getFormTag() {
Carsten  Rose's avatar
Carsten Rose committed
495
        $md5 = '';
496

497
        $attribute = $this->getFormTagAttributes();
498

499
500
        $honeypot = $this->getHoneypotVars();

501
        $md5 = $this->buildInputRecordHashMd5();
Carsten  Rose's avatar
Carsten Rose committed
502
503
504
505
506
507

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

    /**
     * Build MD5 from the current record. Return HTML Input element.
508
     *
509
     * @return string
Marc Egger's avatar
Marc Egger committed
510
511
512
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
Carsten  Rose's avatar
Carsten Rose committed
513
     */
514
    public function buildInputRecordHashMd5() {
515

Carsten  Rose's avatar
Carsten Rose committed
516
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
517
        $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
518
519

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

521
//        $data = "<input id='" . DIRTY_RECORD_HASH_MD5 . "' name='" . DIRTY_RECORD_HASH_MD5 . "' type='text' value='$md5'>";
522
523
524
525
526
527
528
529

        return $data;
    }


    /**
     * @param $tableName
     * @param $recordId
530
     * @param string $primaryKey
531
     *
532
     * @return string
Marc Egger's avatar
Marc Egger committed
533
534
535
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
536
     */
537
    public function buildRecordHashMd5($tableName, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
538
        $record = array();
Carsten  Rose's avatar
Carsten Rose committed
539
540

        if ($recordId != 0) {
541
            $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
542
543
        }

544
        return OnArray::getMd5($record);
545
546
    }

547
548
549
550
    /**
     * Create HTML Input vars to detect bot automatic filling of forms.
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
551
552
     * @throws \CodeException
     * @throws \UserFormException
553
554
555
556
557
558
559
560
561
     */
    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) {
562
563
564
565
            $name = trim($name);
            if ($name === '') {
                continue;
            }
566
567
568
569
570
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
571

Carsten  Rose's avatar
Carsten Rose committed
572

573
574
575
    /**
     * Build an assoc array with standard form attributes.
     *
576
     * @return array
Marc Egger's avatar
Marc Egger committed
577
578
579
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
580
     */
581
    public function getFormTagAttributes() {
582

583
        $attribute['id'] = $this->getFormId();
584
585
586
587
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
588
        $attribute[FE_INPUT_AUTOCOMPLETE] = 'on';
589
        $attribute['enctype'] = $this->getEncType();
590
        $attribute['data-disable-return-key-submit'] = $this->formSpec[F_ENTER_AS_SUBMIT] == '1' ? "false" : "true"; // attribute meaning is inverted
591
592
593
594

        return $attribute;
    }

595
    /**
Carsten  Rose's avatar
Carsten Rose committed
596
597
     * Return a uniq form id
     *
598
599
600
601
602
603
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
604

605
606
607
        return $this->formId;
    }

608
609
610
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
611
612
     * Notice: the SIP will be transferred as POST Parameter.
     *
613
614
615
616
     * @return string
     */
    public function getActionUrl() {

617
        return API_DIR . '/save.php';
618
619
620
621
622
623
624
625
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
Marc Egger's avatar
Marc Egger committed
626
627
628
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
629
630
631
     */
    public function getEncType() {

632
        $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"');
633

634
635
636
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
637

638
    abstract public function getProcessFilter();
639

640
641
642
643
    /**
     * @param array|string $value
     *
     * @return array|string
Marc Egger's avatar
Marc Egger committed
644
645
646
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
647
648
649
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
650
651
652
653
654
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
655
     */
656
657
    private function processReportSyntax($value) {

658
659
660
661
662
663
664
665
666
667
668
        if (is_array($value)) {
            $new = array();

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

            return $new;
        }

669
        $value = trim($value);
670
671
672
673
674
675
676
677
678
        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();
            }

679
            $storeRecord = $this->store->getStore(STORE_RECORD);
680
            $value = $this->report->process($this->bodytextParser->process($value));
681
            $this->store->setStore($storeRecord, STORE_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
682
            $this->store->setVar(SYSTEM_REPORT_FULL_LEVEL, '', STORE_SYSTEM); // debug
683
684
685
686
687
        }

        return $value;
    }

688

689
    /**
690
     * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON.
691
     *
Carsten  Rose's avatar
Carsten Rose committed
692
     * @param int $recordId
693
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
Carsten  Rose's avatar
Carsten Rose committed
694
695
     * @param int $feIdContainer
     * @param array $json
696
     * @param string $modeCollectFe
Carsten  Rose's avatar
Carsten Rose committed
697
     * @param bool $htmlElementNameIdZero
698
     * @param string $storeUseDefault
699
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
700
     * @param bool $flagMulti
701
     *
702
     * @return string
Marc Egger's avatar
Marc Egger committed
703
704
705
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
706
707
708
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
709
710
711
712
713
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
714
     */
715
    public function elements($recordId, $filter, $feIdContainer, array &$json,
716
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false,
717
                             $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD, $flagMulti = false) {
718
        $html = '';
719

720
        // The following 'FormElement.parameter' will never be used during load (fe.type='upload'). FE_PARAMETER has been already expanded.
721
        $skip = [FE_SQL_UPDATE, FE_SQL_INSERT, FE_SQL_DELETE, FE_SQL_AFTER, FE_SQL_BEFORE, FE_PARAMETER, FE_FILL_STORE_VAR, FE_FILE_DOWNLOAD_BUTTON];
722

723
        // get current data record
724
725
        $primaryKey = $this->formSpec[F_PRIMARY_KEY];
        if ($recordId > 0 && $this->store->getVar($primaryKey, STORE_RECORD) === false) {
726
            $tableName = $this->formSpec[F_TABLE_NAME];
727
728
            $row = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM $tableName WHERE $primaryKey = ?", ROW_EXPECT_1,
                array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$primaryKey'='$recordId' from table '" .
729
                $this->formSpec[F_TABLE_NAME] . "'.");
730
            $this->store->setStore($row, STORE_RECORD);
731
        }
732

733
734
        $this->checkAutoFocus();

735
736
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);

737
738
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
739
            $storeUse = $storeUseDefault;
740

741
742
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
743
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
744
745
746
747
            ) {
                continue; // skip this FE
            }

748
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form.
749

750
751
            $debugStack = array();

752
753
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
754
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM);
755

Carsten  Rose's avatar
Carsten Rose committed
756
757
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
758

759
760
761
762
763
764
            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);
            }

765
766
            // If given, slaveId will be copied to STORE_VAR
            if (!empty($fe[FE_SLAVE_ID])) {
767
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_SLAVE_ID, STORE_SYSTEM); // debug
768
769
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
770
771
            }

772
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_VALUE, STORE_SYSTEM); // debug
773
            $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]);
774
775

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

Carsten  Rose's avatar
Carsten Rose committed
778
            // ** evaluate current FormElement **
779
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Some of the columns of current FormElement', STORE_SYSTEM); // debug
780
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
781
            $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Set language', STORE_SYSTEM); // debug
782
            $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName);
783

784
            // Some Defaults
785
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
786

787
788
789
790
791
792
//            // Copy global readonly mode.
//            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
//                $fe[FE_MODE] = FE_MODE_READONLY;
//                $fe[FE_MODE_SQL] = '';
//            }

793
            if ($flagOutput === true && !$flagMulti) {
794
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
795
            }
796

797
798
            Support::setIfNotSet($formElement, FE_VALUE);

799
800
801
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
802

803
            $value = $formElement[FE_VALUE];
804

805
            if ($value === '') {
806
807
808
809
                // #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
810
                }
811
812
813
814

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

815
                // Retrieve value via FSRVD
816
                $sanitizeClass = ($mode == FORM_UPDATE) ? SANITIZE_ALLOW_ALL : $formElement[FE_CHECK_TYPE];
817
                $value = $this->store->getVar($name, $storeUse, $sanitizeClass, $foundInStore);
818
819
820
            }

            if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) {
821
822
//                $value = htmlspecialchars_decode($value, ENT_QUOTES);
                $value = Support::htmlEntityEncodeDecode(MODE_DECODE, $value);
823
            }
824

825
826
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
827
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
828
829
830
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
831

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

Carsten  Rose's avatar
Carsten Rose committed
835
            $jsonElement = array();
836
            $elementExtra = '';
837
            // Render pure element
838
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
839
840

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
841
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
842
843
844
845
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
846
                // for non-container elements: just add the current json status
847
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
848
849
850
851
852
853
                    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
854
855
                }
            }
856

857
858
            if ($flagOutput) {
                // debugStack as Tooltip
859
860
                if ($this->showDebugInfoFlag) {

861
862
863
864
                    if (count($debugStack) > 0) {
                        $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack));
                    }

865
866
867
868
869
870
871
                    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);
                    }
872
                }
873

874
875
876
                // Construct Marshaller Name: buildRow...
                $tmpName = $flagMulti ? 'MultiElement' : $this->buildRowName[$formElement[FE_TYPE]];
                $buildRowName = 'buildRow' . $tmpName;
877

878
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];
879
            }
880
        }
881

882
883
        $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, '', STORE_SYSTEM); // debug

884
885
886
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

887
888
889
        return $html;
    }

890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
    /**
     * @param array $formElement
     * @param $elementHtml
     *
     * @return string
     */
    public function buildRowMultiElement(array $formElement, $elementHtml) {

        $before = ($formElement[FE_HTML_BEFORE] == '') ? '<td>' : $formElement[FE_HTML_BEFORE];
        $after = ($formElement[FE_HTML_AFTER] == '') ? '</td>' : $formElement[FE_HTML_AFTER];

        return $before . $elementHtml . $after;
    }


905
    /**
Carsten  Rose's avatar
Carsten Rose committed
906
907
908
909
910
     * Checks if LDAP search is requested.
     * Yes: prepare configuration and fire the query.
     * No: do nothing.
     *
     * @param array $formElement
911
     *
Carsten  Rose's avatar
Carsten Rose committed
912
     * @return array
Marc Egger's avatar
Marc Egger committed
913
914
915
916
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Carsten Rose committed
917
918
919
920
     */
    private function prepareFillStoreFireLdap(array $formElement) {

        if (isset($formElement[FE_FILL_STORE_LDAP]) || isset($formElement[FE_TYPEAHEAD_LDAP])) {
921
922
923
            $keyNames = [F_LDAP_SERVER, F_LDAP_BASE_DN, F_LDAP_ATTRIBUTES,
                F_LDAP_SEARCH, F_TYPEAHEAD_LDAP_SEARCH, F_TYPEAHEAD_LDAP_SEARCH_PER_TOKEN, F_TYPEAHEAD_LDAP_SEARCH_PREFETCH,
                F_TYPEAHEAD_LIMIT, F_TYPEAHEAD_MINLENGTH, F_TYPEAHEAD_LDAP_VALUE_PRINTF,
924
                F_TYPEAHEAD_LDAP_ID_PRINTF, F_LDAP_TIME_LIMIT, F_LDAP_USE_BIND_CREDENTIALS];
925
            $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames);