AbstractBuildForm.php 143 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

9
10
11
namespace qfq;

use qfq;
Carsten  Rose's avatar
Carsten Rose committed
12
13
14
15

//use qfq\Store;
//use qfq\OnArray;
//use qfq\UserFormException;
16

17
18
require_once(__DIR__ . '/store/Store.php');
require_once(__DIR__ . '/Constants.php');
19
20
require_once(__DIR__ . '/Evaluate.php');
require_once(__DIR__ . '/BodytextParser.php');
21
22
23
24
25
26
27
28
require_once(__DIR__ . '/exceptions/DbException.php');
require_once(__DIR__ . '/exceptions/UserFormException.php');
require_once(__DIR__ . '/database/Database.php');
require_once(__DIR__ . '/helper/HelperFormElement.php');
require_once(__DIR__ . '/helper/Support.php');
require_once(__DIR__ . '/helper/OnArray.php');
require_once(__DIR__ . '/helper/Ldap.php');
require_once(__DIR__ . '/report/Link.php');
29
require_once(__DIR__ . '/report/Report.php');
30

31
/**
Carsten  Rose's avatar
Carsten Rose committed
32
33
 * Class AbstractBuildForm
 * @package qfq
34
 */
35
abstract class AbstractBuildForm {
36
37
38
39
40
    protected $formSpec = array();  // copy of the loaded form
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
    protected $buildElementFunctionName = array();
    protected $pattern = array();
41
    protected $wrap = array();
42
    protected $symbol = array();
43
    protected $showDebugInfoFlag = false;
44
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
45

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

48
49
50
51
52
53
54
55
    /**
     * @var Store
     */
    protected $store = null;
    /**
     * @var Evaluate
     */
    protected $evaluate = null;
56
57
58
    /**
     * @var string
     */
59
    private $formId = null;
60
61
62
63
    /**
     * @var Sip
     */
    private $sip = null;
64
65
66
67
68
69
70
71
    /**
     * @var Report
     */
    private $report = null;
    /**
     * @var BodytextParser
     */
    private $bodytextParser = null;
72

73
74
75
76
77
78
79
    /**
     * @var Array of Database instantiated class
     */
    protected $dbArray = array();

    protected $dbIndexData = false;
    protected $dbIndexQfq = false;
Carsten  Rose's avatar
Carsten Rose committed
80

81
82
83
84
85
86
87
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
     */
88
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $db) {
89
90
91
92
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
93
94
95
96
97
        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);

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

100
        $this->sip = $this->store->getSipInstance();
101

102
        // render mode specific
103
        $this->fillWrap();
104
105

        $this->buildElementFunctionName = [
106
            FE_TYPE_CHECKBOX => 'Checkbox',
Carsten  Rose's avatar
Carsten Rose committed
107
            FE_TYPE_DATE => 'DateTime',
108
            FE_TYPE_DATETIME => 'DateTime',
Carsten  Rose's avatar
Carsten Rose committed
109
110
111
112
113
114
115
116
117
            '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',
118
            FE_TYPE_PASSWORD => 'Input',
Carsten  Rose's avatar
Carsten Rose committed
119
120
            FE_TYPE_RADIO => 'Radio',
            FE_TYPE_SELECT => 'Select',
121
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
122
            FE_TYPE_UPLOAD => 'File',
123
            FE_TYPE_ANNOTATE => 'Annotate',
Carsten  Rose's avatar
Carsten Rose committed
124
125
126
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
127
128
        ];

129
        $this->buildRowName = [
130
            FE_TYPE_CHECKBOX => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
131
            FE_TYPE_DATE => 'Native',
132
            FE_TYPE_DATETIME => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
133
134
135
136
137
138
139
140
141
            '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',
142
            FE_TYPE_PASSWORD => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
143
144
            FE_TYPE_RADIO => 'Native',
            FE_TYPE_SELECT => 'Native',
145
            FE_TYPE_SUBRECORD => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
146
            FE_TYPE_UPLOAD => 'Native',
147
            FE_TYPE_ANNOTATE => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
148
149
150
            'fieldset' => 'Fieldset',
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup',
151
152
        ];

153
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon " . GLYPH_ICON_EDIT . "'></span>";
154
        $this->symbol[SYMBOL_SHOW] = "<span class='glyphicon " . GLYPH_ICON_SHOW . "'></span>";
155
156
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon " . GLYPH_ICON_NEW . "'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon " . GLYPH_ICON_DELETE . "'></span>";
157

158
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
159
160
    }

161
162
    abstract public function fillWrap();

163
    /**
164
     * Builds complete 'form'. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
165
     *
166
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
167
168
169
     *
     * @return string|array   $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all
     *                        formElement.dynamicUpdate-yes  values/states
170
171
     * @throws CodeException
     * @throws DbException
172
     * @throws \qfq\UserFormException
173
     */
174
    public function process($mode, $htmlElementNameIdZero = false, $latestFeSpecNative = array()) {
Carsten  Rose's avatar
Carsten Rose committed
175
176
        $htmlHead = '';
        $htmlTail = '';
177
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
178
179
180
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
181
        $flagFabric = false;
182

183
        // After action 'afterSave', it's necessary to reinitialize the FeSpecNative
184
185
186
187
        if (!empty($latestFeSpecNative)) {
            $this->feSpecNative = $latestFeSpecNative;
        }

188
189
190
191
192
193
194
        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

196
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
197
198
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
199
200
201
            if (count(OnArray::filter($this->feSpecNative, FE_TYPE, FE_TYPE_ANNOTATE)) > 0) {
                $flagFabric = true;
            }
Carsten  Rose's avatar
Carsten Rose committed
202
        }
203

204
        $filter = $this->getProcessFilter();
205

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

208
            $parentRecords = $this->dbArray[$this->dbIndexQfq]->sql($this->formSpec['multiSql']);
209
            foreach ($parentRecords as $row) {
210
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
211
                $jsonTmp = array();
212
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
213
                $json[] = $jsonTmp;
214
215
            }
        } else {
216
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
217
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
Carsten  Rose's avatar
Carsten Rose committed
218
219

            if ($mode === FORM_SAVE && $recordId != 0) {
220
221
222
223

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

                // Via 'element-update'
226
                $json[][API_ELEMENT_UPDATE][DIRTY_RECORD_HASH_MD5][API_ELEMENT_ATTRIBUTE]['value'] = $md5;
Carsten  Rose's avatar
Carsten Rose committed
227
            }
228
        }
229
230
231

        // <form>
        if ($mode === FORM_LOAD) {
232
            $htmlT3vars = $this->prepareT3VarsForSave();
233
            $htmlTail = $this->tail($flagFabric);
234
235
            $htmlSubrecords = $this->doSubrecords();
        }
236
        $htmlHidden = $this->buildAdditionalFormElements();
237

238
239
        $htmlSip = $this->buildHiddenSip($json);

240
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlHidden . $htmlElements . $htmlSip . $htmlT3vars . $htmlTail . $htmlSubrecords : $json;
241
242
    }

243
    /**
244
     * Builds the head area of the form.
245
     *
246
     * @return string
247
     */
248
249
    public function head() {
        $html = '';
250

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

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

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

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

261
262
263
        $html .= $this->getFormTag();

        return $html;
264
265
    }

266
    /**
267
268
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of
     * the SIP.
269
     *
270
     * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT
Carsten  Rose's avatar
Carsten Rose committed
271
272
     * @param int $recordId id of form or formElement
     * @param array $param
273
274
275
     *
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:...,
     *                ...]</small>
276
     * @throws CodeException
277
     */
278
    public function createFormEditorUrl($form, $recordId, array $param = array()) {
279

280
        if (!$this->showDebugInfoFlag) {
281
282
            return '';
        }
283

284
        $queryStringArray = [
285
            'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM),
286
            'form' => $form,
Carsten  Rose's avatar
Carsten Rose committed
287
            'r' => $recordId,
288
        ];
289
        $queryStringArray = array_merge($queryStringArray, $param);
290

291
        $queryString = Support::arrayToQueryString($queryStringArray);
292

293
294
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
295

296
        return $url;
297
298
299
    }

    /**
300
301
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
Carsten  Rose's avatar
Carsten Rose committed
302
303
     * @param string $item
     * @param string $value
304
     * @param bool|false $flagOmitEmpty
305
     *
306
307
308
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
309
310

        if ($flagOmitEmpty && $value === "") {
311
            return '';
312
313
        }

314
315
316
317
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
318
     * Returns '<form ...>'-tag with various attributes.
319
320
321
322
     *
     * @return string
     */
    public function getFormTag() {
Carsten  Rose's avatar
Carsten Rose committed
323
        $md5 = '';
324
325
326

        $attribute = $this->getFormTagAtrributes();

327
328
        $honeypot = $this->getHoneypotVars();

329
        $md5 = $this->buildInputRecordHashMd5();
Carsten  Rose's avatar
Carsten Rose committed
330
331
332
333
334
335

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

    /**
     * Build MD5 from the current record. Return HTML Input element.
336
     *
337
     * @param bool $flagWithSpan
338
     *
339
340
341
     * @return string
     * @throws \qfq\CodeException
     * @throws \qfq\DbException
Carsten  Rose's avatar
Carsten Rose committed
342
     */
343
    public function buildInputRecordHashMd5() {
344

Carsten  Rose's avatar
Carsten Rose committed
345
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
346
347
348
        $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId);

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

350
//        $data = "<input id='" . DIRTY_RECORD_HASH_MD5 . "' name='" . DIRTY_RECORD_HASH_MD5 . "' type='text' value='$md5'>";
351
352
353
354
355
356
357
358

        return $data;
    }


    /**
     * @param $tableName
     * @param $recordId
359
     *
360
361
362
363
     * @return string
     * @throws \qfq\CodeException
     * @throws \qfq\DbException
     */
364
    public function buildRecordHashMd5($tableName, $recordId) {
365
        $record = array();
Carsten  Rose's avatar
Carsten Rose committed
366
367

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

371
        return OnArray::getMd5($record);
372
373
    }

374
375
376
377
378
379
380
381
382
383
384
385
386
    /**
     * Create HTML Input vars to detect bot automatic filling of forms.
     *
     * @return string
     */
    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) {
387
388
389
390
            $name = trim($name);
            if ($name === '') {
                continue;
            }
391
392
393
394
395
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
396

Carsten  Rose's avatar
Carsten Rose committed
397

398
399
400
    /**
     * Build an assoc array with standard form attributes.
     *
401
     * @return array
402
403
404
     */
    public function getFormTagAtrributes() {

405
        $attribute['id'] = $this->getFormId();
406
407
408
409
410
411
412
413
414
415
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

416
    /**
Carsten  Rose's avatar
Carsten Rose committed
417
418
     * Return a uniq form id
     *
419
420
421
422
423
424
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
425

426
427
428
        return $this->formId;
    }

429
430
431
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
432
433
     * Notice: the SIP will be transferred as POST Parameter.
     *
434
435
436
437
438
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

439
        return API_DIR . '/save.php';
440
441
442
443
444
445
446
447
448
449
450
451
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
     * @throws DbException
     */
    public function getEncType() {

452
        $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"');
453

454
455
456
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
457

458
    abstract public function getProcessFilter();
459

460
461
462
463
464
465
    /**
     * @param array|string $value
     *
     * @return array|string
     * @throws UserFormException
     */
466
467
    private function processReportSyntax($value) {

468
469
470
471
472
473
474
475
476
477
478
        if (is_array($value)) {
            $new = array();

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

            return $new;
        }

479
480
481
482
483
484
485
486
487
        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();
            }

488
            $storeRecord = $this->store->getStore(STORE_RECORD);
489
            $value = $this->report->process($this->bodytextParser->process($value));
490
            $this->store->setStore(STORE_RECORD, $storeRecord, true);
491
492
493
494
495
496

        }

        return $value;
    }

497
    /**
498
     * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON.
499
     *
Carsten  Rose's avatar
Carsten Rose committed
500
     * @param int $recordId
501
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
Carsten  Rose's avatar
Carsten Rose committed
502
503
     * @param int $feIdContainer
     * @param array $json
504
     * @param string $modeCollectFe
Carsten  Rose's avatar
Carsten Rose committed
505
     * @param bool $htmlElementNameIdZero
506
     * @param string $storeUseDefault
507
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
508
     *
509
     * @return string
510
511
     * @throws CodeException
     * @throws DbException
512
     * @throws \qfq\UserFormException
513
     */
514
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json,
515
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false,
516
                             $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD) {
517
        $html = '';
518

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

522
        // get current data record
523
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
524
            $tableName = $this->formSpec[F_TABLE_NAME];
525
            $row = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM $tableName WHERE id = ?", ROW_EXPECT_1,
526
527
                array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$recordId' from table '" .
                $this->formSpec[F_TABLE_NAME] . "'.");
528
            $this->store->setStore($row, STORE_RECORD);
529
        }
530

531
532
        $this->checkAutoFocus();

533
534
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);

535
536
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
537
            $storeUse = $storeUseDefault;
538

539
540
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
541
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
542
543
544
545
            ) {
                continue; // skip this FE
            }

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

548
549
            $debugStack = array();

550
551
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
552

Carsten  Rose's avatar
Carsten Rose committed
553
554
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
555

556
557
            // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'.
            if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) {
558
                Support::setIfNotSet($fe, FE_SLAVE_ID);
559
560
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
561
562
            }

563
564
565
            $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]);
            $fe[FE_NOTE] = $this->processReportSyntax($fe[FE_NOTE]);

566
            if (isset($fe[FE_FILL_STORE_VAR])) {
567
                $fe[FE_FILL_STORE_VAR] = $this->evaluate->parse($fe[FE_FILL_STORE_VAR]);
568
569
570
571
                $this->store->appendToStore(STORE_VAR, $fe[FE_FILL_STORE_VAR]);
            }


Carsten  Rose's avatar
Carsten Rose committed
572
            // ** evaluate current FormElement **
573
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
574
            $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName);
575

576
            // Some Defaults
577
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
578

579
580
581
582
583
584
//            // Copy global readonly mode.
//            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
//                $fe[FE_MODE] = FE_MODE_READONLY;
//                $fe[FE_MODE_SQL] = '';
//            }

585
            if ($flagOutput === true) {
586
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
587
            }
588

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

592
593
594
            $value = '';
            Support::setIfNotSet($formElement, FE_VALUE);

595
596
597
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
598

599
            $value = $formElement[FE_VALUE];
600

601
            if ($value === '') {
602
603
604
605
                // #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
606
                }
607
608
                // Retrieve value via FSRVD
                $value = $this->store->getVar($name, $storeUse, $formElement[FE_CHECK_TYPE], $foundInStore);
609
610
611
612
            }

            if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) {
                $value = htmlspecialchars_decode($value, ENT_QUOTES);
613
            }
614

615
616
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
617
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
618
619
620
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
621

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

Carsten  Rose's avatar
Carsten Rose committed
625
            $jsonElement = array();
626
            $elementExtra = '';
627
            // Render pure element
628
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
629
630

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
631
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
632
633
634
635
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
636
                // for non-container elements: just add the current json status
637
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
638
639
640
641
642
643
                    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
644
645
                }
            }
646

647
648
            if ($flagOutput) {
                // debugStack as Tooltip
649
                if ($this->showDebugInfoFlag) {
650
651
652
653
654
                    if (count($debugStack) > 0) {
                        $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack));
                    }

                    // Build 'FormElement' Edit symbol
Carsten  Rose's avatar
Carsten Rose committed
655
                    $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]);
656
657
                    $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']');
                    $icon = Support::wrapTag('<span class="' . GLYPH_ICON . ' ' . GLYPH_ICON_EDIT . '">', '');
658
                    $elementHtml .= Support::wrapTag("<a class='hidden " . CLASS_FORM_ELEMENT_EDIT . "' href='$feEditUrl' $titleAttr>", $icon);
659
                }
660

661
662
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
663

664
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];
665
            }
666
        }
667

668
669
670
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

671
672
673
        return $html;
    }

674
    /**
Carsten  Rose's avatar
Carsten Rose committed
675
676
677
678
679
     * Checks if LDAP search is requested.
     * Yes: prepare configuration and fire the query.
     * No: do nothing.
     *
     * @param array $formElement
680
     *
Carsten  Rose's avatar
Carsten Rose committed
681
682
683
684
685
686
687
688
     * @return array
     * @throws CodeException
     * @throws UserFormException
     */
    private function prepareFillStoreFireLdap(array $formElement) {
        $config = array();

        if (isset($formElement[FE_FILL_STORE_LDAP]) || isset($formElement[FE_TYPEAHEAD_LDAP])) {
689
690
691
            $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,
692
                F_TYPEAHEAD_LDAP_ID_PRINTF, F_LDAP_TIME_LIMIT, F_LDAP_USE_BIND_CREDENTIALS];
693
            $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames);
Carsten  Rose's avatar
Carsten Rose committed
694
695
696
697
698
699
700
        } else {
            return $formElement; // nothing to do.
        }

        if (isset($formElement[FE_FILL_STORE_LDAP])) {

            // Extract necessary elements
701
            $config = OnArray::getArrayItems($formElement, [FE_LDAP_SERVER, FE_LDAP_BASE_DN, FE_LDAP_SEARCH, FE_LDAP_ATTRIBUTES]);
Carsten  Rose's avatar
Carsten Rose committed
702
703
            $config = $this->evaluate->parseArray($config);

704
            if ($formElement[FE_LDAP_USE_BIND_CREDENTIALS] == 1) {
705
706
707
708
                $config[SYSTEM_LDAP_1_RDN] = $this->store->getVar(SYSTEM_LDAP_1_RDN, STORE_SYSTEM);
                $config[SYSTEM_LDAP_1_PASSWORD] = $this->store->getVar(SYSTEM_LDAP_1_PASSWORD, STORE_SYSTEM);
            }

Carsten  Rose's avatar
Carsten Rose committed
709
710
711
712
713
714
715
716
            $ldap = new Ldap();
            $arr = $ldap->process($config, '', MODE_LDAP_SINGLE);
            $this->store->setStore($arr, STORE_LDAP, true);
        }

        return $formElement;
    }

717
718
719
720
721
722
723
    /**
     * Check if there is an explicit 'autofocus' definition in at least one FE.
     * Found: do nothing, it will be rendered at the correct position.
     * Not found: set 'autofocus' on the first FE.
     *
     * Accepted misbehaviour on forms with pills: if there is at least one editable element on the first pill,
     *   the other pills are not checked - independent if there was a definition on the first pill or not.
724
725
     *   Reason: checks happens per pill - if there is no explizit definition on the first pill, take the first
     *   editable element of that pill.
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
     */
    private function checkAutoFocus() {
        static $found = false;
        $idx = false;

        if ($found) {
            return;
        }

        // Search if there is an explicit autofocus definition.
        for ($i = 0; $i < count($this->feSpecNative); ++$i) {
            // Only check native elements which will be shown
            if ($this->feSpecNative[$i][FE_CLASS] == FE_CLASS_NATIVE &&
                ($this->feSpecNative[$i][FE_MODE] == FE_MODE_SHOW || $this->feSpecNative[$i][FE_MODE] == FE_MODE_REQUIRED)
            ) {
                // Check if there is an explicit definition.
                if (isset($this->feSpecNative[$i][FE_AUTOFOCUS])) {
                    if ($this->feSpecNative[$i][FE_AUTOFOCUS] == '' || $this->feSpecNative[$i][FE_AUTOFOCUS] == '1') {
                        $this->feSpecNative[$i][FE_AUTOFOCUS] = '1'; // fix to '=1'
                    } else {
                        unset($this->feSpecNative[$i][FE_AUTOFOCUS]);
                    }
                    $found = true;
749

750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
                    return;
                }

                if ($idx === false) {
                    $idx = $i;
                }
            }
        }

        // No explicit definition found: take the first found editable element.
        if ($idx !== false) {
            $found = true;
            // No explicit definition found: set autofocus.
            $this->feSpecNative[$idx][FE_AUTOFOCUS] = '1';
        }
    }

Carsten  Rose's avatar
Carsten Rose committed
767
768
769
    /**
     *
     */
770
771
    abstract public function fillWrapLabelInputNote($label, $input, $note);

772
    /**
773
774
     * Copy a subset of current STORE_TYPO3 variables to SIP. Set a hidden form field to submit the assigned SIP to
     * save/update.
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
     *
     * @throws CodeException
     * @throws UserFormException
     */
    private function prepareT3VarsForSave() {

        $t3VarsSip = $this->store->copyT3VarsToSip();

        return $this->buildNativeHidden(CLIENT_TYPO3VARS, $t3VarsSip);

    }

    /**
     * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios.
     *
Carsten  Rose's avatar
Carsten Rose committed
790
791
     * @param        $htmlFormElementName
     * @param string $value
792
     *
793
794
     * @return string
     */
795
796
    public function buildNativeHidden($htmlFormElementName, $value) {
        return '<input type="hidden" name="' . $htmlFormElementName . '" value="' . htmlentities($value) . '">';
797
798
    }

Carsten  Rose's avatar
Carsten Rose committed
799
800
801
    /**
     *
     */
802
    abstract public function tail($flagFabric = false);
803

Carsten  Rose's avatar
Carsten Rose committed
804
805
806
    /**
     *
     */
807
808
    abstract public function doSubrecords();

809
810
811
812
813
814
815
816
817
818
819
820
821
822
    /**
     * Get all elements from STORE_ADDITIONAL_FORM_ELEMENTS and return them as a string.
     *
     * @return string
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
    private function buildAdditionalFormElements() {

        $data = $this->store->getStore(STORE_ADDITIONAL_FORM_ELEMENTS);

        return is_array($data) ? implode('', $data) : '';
    }

823
824
825
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
826
     * @param array $json
827
     *
828
829
830
831
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
832
    public function buildHiddenSip(array &$json) {
833

834
        $sipArray = $this->store->getStore(STORE_SIP);
835
836

        // do not include system vars
837
838
839
840
841
842
843
844
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

        $queryString = Support::arrayToQueryString($sipArray);
        $sip = $this->store->getSipInstance();

        $sipValue = $sip->queryStringToSip($queryString, RETURN_SIP);

845
        $json[] = $this->getFormElementForJson(CLIENT_SIP, $sipValue, [FE_MODE => FE_MODE_SHOW]);
846
847
848
849
850

        return $this->buildNativeHidden(CLIENT_SIP, $sipValue);
    }

    /**
851
852
     * Create an array with standard elements for 'mode' (hidden, disabled, required) and add 'form-element',
     * 'value'.
853
854
     * 'Generic Element Update': add via API_ELEMENT_UPDATE 'label' and 'note'.
     * All collected data as array - will be later converted to JSON.
Carsten  Rose's avatar
Carsten Rose committed
855
     *
Carsten  Rose's avatar
Carsten Rose committed
856
     * @param string $htmlFormElementName
857
     * @param string|array $value
Carsten  Rose's avatar
Carsten Rose committed
858
     * @param array $formElement
859
     *
860
861
     * @return array
     */
862
    private function getFormElementForJson($htmlFormElementName, $value, array $formElement) {
863

864
        $json = $this->getJsonFeMode($formElement[FE_MODE]); // disabled, required
865

866
        $json[API_FORM_UPDATE_FORM_ELEMENT] = $htmlFormElementName;
867
868
869
870
871
872
873

        if (isset($formElement[FE_FLAG_ROW_OPEN_TAG]) && isset($formElement[FE_FLAG_ROW_CLOSE_TAG])) {
            $flagRowUpdate = ($formElement[FE_FLAG_ROW_OPEN_TAG] && $formElement[FE_FLAG_ROW_CLOSE_TAG]);
        } else {
            $flagRowUpdate = true;
        }

874
        // 'value' update via 'form-update' on the full row: only if there is no other FE in that row
875
        if ($flagRowUpdate) {
876
            $json[API_FORM_UPDATE_VALUE] = $value;
877
        }
878

879
880
        if (isset($formElement[FE_LABEL])) {
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_LABEL;
881
882
            $addClass = ($formElement[FE_MODE] == FE_MODE_REQUIRED) ? CSS_REQUIRED : '';
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $this->buildLabel($htmlFormElementName, $formElement[FE_LABEL], $addClass);
883
884
885
886
887
        }

        if (isset($formElement[FE_NOTE])) {
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_NOTE;
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $formElement[FE_NOTE];
888
        }
889

890
        if (isset($formElement[FE_TYPE])) {
891
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_INPUT;
892
893
894
895
896
897
898
899
900
901
902
903

            // For FE.type='note': update the column 'input'
            if ($formElement[FE_TYPE] === FE_TYPE_NOTE) {
                $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $value;
            }

            // Check show/hide: only FE with FE_MODE_SQL given, might change.
            if (!empty($formElement[FE_MODE_SQL])) {
                $class = 'col-md-' . $formElement[FE_BS_INPUT_COLUMNS] . ' ';
                $class .= ($formElement[FE_MODE] == FE_MODE_HIDDEN) ? 'hidden' : '';
                $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['class'] = $class;
            }
904
905

            // #3647
906
907
908
//            if (!$flagRowUpdate) {

            // #4771 - temporary workaround: SELECT in 'multi FE row' won't updated after 'save' or with dynamic update.
909
910
            //TODO #5016 - exception for FE_TYPE_CHECKBOX should be removed ASAP
            if ($formElement[FE_TYPE] != FE_TYPE_SELECT && $formElement[FE_TYPE] != FE_TYPE_UPLOAD && $formElement[FE_TYPE] != FE_TYPE_CHECKBOX) {
911
912
                $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['value'] = $value;
            }
913
914
        }

915
        // Show / Hide the complete FormElement Row.
916
917
918
        if (isset($formElement[FE_HTML_ID])) { // HIDDEN_SIP comes without a real existing FE structure.
            // Activate 'show' or 'hidden' on the current FormElement via JSON 'API_ELEMENT_UPDATE'
            $class = $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_CLASS];
919
            if ($formElement[FE_MODE] == FE_MODE_HIDDEN) {
920
921
922
923
924
925
926
                $class .= ' hidden';
            }

            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_ROW;
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['class'] = $class;
        }

927
928
929
        return $json;
    }

930
931
932
933
    /**
     * Set corresponding JSON attributes readonly/required/disabled, based on $formElement[FE_MODE].
     *
     * @param array $feMode
934
     *
935
936
937
938
939
     * @return array
     * @throws UserFormException
     */
    private function getJsonFeMode($feMode) {

940