AbstractBuildForm.php 156 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__ . '/helper/Sanitize.php');
30
require_once(__DIR__ . '/helper/HelperFile.php');
31
require_once(__DIR__ . '/report/Report.php');
32

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

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

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

102
    /**
103
     * @var Database[] Array of Database instantiated class
104
105
106
     */
    protected $dbArray = array();

107
108
109
    /**
     * @var bool|mixed
     */
110
    protected $dbIndexData = false;
111
112
113
    /**
     * @var bool|string
     */
114
    protected $dbIndexQfq = false;
Carsten  Rose's avatar
Carsten Rose committed
115

116
117
118
119
120
121
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
122
     * @param array $db
123
124
     * @throws CodeException
     * @throws UserFormException
125
     * @throws UserReportException
126
     */
127
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative, array $db = null) {
128
129
130
131
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
132
133
//        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexData = $formSpec[F_DB_INDEX];
134
135
136
137
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);

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

140
        $this->sip = $this->store->getSipInstance();
141

142
143
        $this->link = new Link($this->sip, $this->dbIndexData);

144
        // render mode specific
145
        $this->fillWrap();
146
147

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

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

197
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon " . GLYPH_ICON_EDIT . "'></span>";
198
        $this->symbol[SYMBOL_SHOW] = "<span class='glyphicon " . GLYPH_ICON_SHOW . "'></span>";
199
200
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon " . GLYPH_ICON_NEW . "'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon " . GLYPH_ICON_DELETE . "'></span>";
201
202
    }

203
204
    abstract public function fillWrap();

205
    /**
206
     * Builds complete 'form'. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
207
     *
208
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
209
     *
210
211
212
     * @param bool $htmlElementNameIdZero
     * @param array $latestFeSpecNative
     * @return array|string $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all
213
     *                        formElement.dynamicUpdate-yes  values/states
214
215
     * @throws CodeException
     * @throws DbException
216
     * @throws DownloadException
217
     * @throws UserFormException
218
     * @throws UserReportException
219
220
221
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
222
     */
223
    public function process($mode, $htmlElementNameIdZero = false, $latestFeSpecNative = array()) {
Carsten  Rose's avatar
Carsten Rose committed
224
225
        $htmlHead = '';
        $htmlTail = '';
226
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
227
228
229
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
230

231
        // After action 'afterSave', it's necessary to reinitialize the FeSpecNative
232
233
234
235
        if (!empty($latestFeSpecNative)) {
            $this->feSpecNative = $latestFeSpecNative;
        }

236
237
238
239
240
241
242
        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

244
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
245
246
247
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
        }
248

249
        $filter = $this->getProcessFilter();
250

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

253
            $parentRecords = $this->dbArray[$this->dbIndexQfq]->sql($this->formSpec['multiSql']);
254
            foreach ($parentRecords as $row) {
255
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
256
                $jsonTmp = array();
257
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
258
                $json[] = $jsonTmp;
259
260
            }
        } else {
261
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
262
            if (!($recordId == '' || is_numeric($recordId))) {
263
264
265
266
267
                throw new UserFormException(
                    json_encode([ERROR_MESSAGE_TO_USER => 'Invalid record ID', ERROR_MESSAGE_SUPPORT => 'Invalid record ID: r="' . $recordId]),
                    ERROR_INVALID_VALUE);


268
            }
269
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
Carsten  Rose's avatar
Carsten Rose committed
270
271

            if ($mode === FORM_SAVE && $recordId != 0) {
272
273
274

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

                // Via 'element-update'
278
                $json[][API_ELEMENT_UPDATE][DIRTY_RECORD_HASH_MD5][API_ELEMENT_ATTRIBUTE]['value'] = $md5;
Carsten  Rose's avatar
Carsten Rose committed
279
            }
280
        }
281
282
283

        // <form>
        if ($mode === FORM_LOAD) {
284
            $htmlT3vars = $this->prepareT3VarsForSave();
285
            $htmlTail = $this->tail();
286
287
            $htmlSubrecords = $this->doSubrecords();
        }
288
        $htmlHidden = $this->buildAdditionalFormElements();
289

290
291
        $htmlSip = $this->buildHiddenSip($json);

292
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlHidden . $htmlElements . $htmlSip . $htmlT3vars . $htmlTail . $htmlSubrecords : $json;
293
294
    }

295
    /**
296
     * Builds the head area of the form.
297
     *
298
     * @param string $mode
299
     * @return string
300
     * @throws CodeException
301
     * @throws DbException
302
     * @throws UserFormException
303
     */
304
    public function head($mode = FORM_LOAD) {
305
        $html = '';
306

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

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

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

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

317
318
319
        $html .= $this->getFormTag();

        return $html;
320
321
    }

322
    /**
323
324
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of
     * the SIP.
325
     *
326
     * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT
Carsten  Rose's avatar
Carsten Rose committed
327
328
     * @param int $recordId id of form or formElement
     * @param array $param
329
330
331
     *
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:...,
     *                ...]</small>
332
333
     * @throws CodeException
     * @throws UserFormException
334
     */
335
    public function createFormEditorUrl($form, $recordId, array $param = array()) {
336

337
        if (!$this->showDebugInfoFlag) {
338
339
            return '';
        }
340

341
        $queryStringArray = [
342
            'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM),
343
            'form' => $form,
Carsten  Rose's avatar
Carsten Rose committed
344
            'r' => $recordId,
345
            PARAM_DB_INDEX_DATA => $this->dbIndexQfq,
346
        ];
347
        $queryStringArray = array_merge($queryStringArray, $param);
348

349
        $queryString = Support::arrayToQueryString($queryStringArray);
350

351
352
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
353

354
        return $url;
355
356
357
    }

    /**
358
359
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
Carsten  Rose's avatar
Carsten Rose committed
360
361
     * @param string $item
     * @param string $value
362
     * @param bool|false $flagOmitEmpty
363
     *
364
365
366
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
367
368

        if ($flagOmitEmpty && $value === "") {
369
            return '';
370
371
        }

372
373
374
375
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
376
     * Returns '<form ...>'-tag with various attributes.
377
378
     *
     * @return string
379
380
381
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
382
383
     */
    public function getFormTag() {
Carsten  Rose's avatar
Carsten Rose committed
384
        $md5 = '';
385

386
        $attribute = $this->getFormTagAttributes();
387

388
389
        $honeypot = $this->getHoneypotVars();

390
        $md5 = $this->buildInputRecordHashMd5();
Carsten  Rose's avatar
Carsten Rose committed
391
392
393
394
395
396

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

    /**
     * Build MD5 from the current record. Return HTML Input element.
397
     *
398
     * @return string
399
     * @throws CodeException
400
     * @throws DbException
401
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
402
     */
403
    public function buildInputRecordHashMd5() {
404

Carsten  Rose's avatar
Carsten Rose committed
405
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO);
406
        $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
407
408

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

410
//        $data = "<input id='" . DIRTY_RECORD_HASH_MD5 . "' name='" . DIRTY_RECORD_HASH_MD5 . "' type='text' value='$md5'>";
411
412
413
414
415
416
417
418

        return $data;
    }


    /**
     * @param $tableName
     * @param $recordId
419
     * @param string $primaryKey
420
     *
421
     * @return string
422
423
424
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
425
     */
426
    public function buildRecordHashMd5($tableName, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) {
427
        $record = array();
Carsten  Rose's avatar
Carsten Rose committed
428
429

        if ($recordId != 0) {
430
            $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
431
432
        }

433
        return OnArray::getMd5($record);
434
435
    }

436
437
438
439
    /**
     * Create HTML Input vars to detect bot automatic filling of forms.
     *
     * @return string
440
441
     * @throws CodeException
     * @throws UserFormException
442
443
444
445
446
447
448
449
450
     */
    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) {
451
452
453
454
            $name = trim($name);
            if ($name === '') {
                continue;
            }
455
456
457
458
459
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
460

Carsten  Rose's avatar
Carsten Rose committed
461

462
463
464
    /**
     * Build an assoc array with standard form attributes.
     *
465
     * @return array
466
467
468
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
469
     */
470
    public function getFormTagAttributes() {
471

472
        $attribute['id'] = $this->getFormId();
473
474
475
476
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
477
        $attribute[FE_INPUT_AUTOCOMPLETE] = 'on';
478
        $attribute['enctype'] = $this->getEncType();
479
        $attribute['data-disable-return-key-submit'] = $this->formSpec[F_ENTER_AS_SUBMIT] == '1' ? "false" : "true"; // attribute meaning is inverted
480
481
482
483

        return $attribute;
    }

484
    /**
Carsten  Rose's avatar
Carsten Rose committed
485
486
     * Return a uniq form id
     *
487
488
489
490
491
492
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
493

494
495
496
        return $this->formId;
    }

497
498
499
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
500
501
     * Notice: the SIP will be transferred as POST Parameter.
     *
502
503
504
505
     * @return string
     */
    public function getActionUrl() {

506
        return API_DIR . '/save.php';
507
508
509
510
511
512
513
514
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
515
516
517
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
518
519
520
     */
    public function getEncType() {

521
        $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"');
522

523
524
525
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
526

527
    abstract public function getProcessFilter();
528

529
530
531
532
    /**
     * @param array|string $value
     *
     * @return array|string
533
534
     * @throws CodeException
     * @throws DbException
535
     * @throws DownloadException
536
537
     * @throws UserFormException
     * @throws UserReportException
538
539
540
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
541
     */
542
543
    private function processReportSyntax($value) {

544
545
546
547
548
549
550
551
552
553
554
        if (is_array($value)) {
            $new = array();

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

            return $new;
        }

555
        $value = trim($value);
556
557
558
559
560
561
562
563
564
        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();
            }

565
            $storeRecord = $this->store->getStore(STORE_RECORD);
566
            $value = $this->report->process($this->bodytextParser->process($value));
567
            $this->store->setStore($storeRecord, STORE_RECORD, true);
568
            $this->store->setVar(SYSTEM_REPORT_FULL_LEVEL, '', STORE_SYSTEM);
569
570
571
572
573
        }

        return $value;
    }

574
    /**
575
     * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON.
576
     *
Carsten  Rose's avatar
Carsten Rose committed
577
     * @param int $recordId
578
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
Carsten  Rose's avatar
Carsten Rose committed
579
580
     * @param int $feIdContainer
     * @param array $json
581
     * @param string $modeCollectFe
Carsten  Rose's avatar
Carsten Rose committed
582
     * @param bool $htmlElementNameIdZero
583
     * @param string $storeUseDefault
584
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
585
     *
586
     * @return string
587
588
     * @throws CodeException
     * @throws DbException
589
     * @throws DownloadException
590
591
     * @throws UserFormException
     * @throws UserReportException
592
593
594
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
595
     */
596
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json,
597
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false,
598
                             $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD) {
599
        $html = '';
600

601
        // The following 'FormElement.parameter' will never be used during load (fe.type='upload'). FE_PARAMETER has been already expanded.
602
        $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];
603

604
        // get current data record
605
606
        $primaryKey = $this->formSpec[F_PRIMARY_KEY];
        if ($recordId > 0 && $this->store->getVar($primaryKey, STORE_RECORD) === false) {
607
            $tableName = $this->formSpec[F_TABLE_NAME];
608
609
            $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 '" .
610
                $this->formSpec[F_TABLE_NAME] . "'.");
611
            $this->store->setStore($row, STORE_RECORD);
612
        }
613

614
615
        $this->checkAutoFocus();

616
617
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);

618
619
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
620
            $storeUse = $storeUseDefault;
621

622
623
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
624
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
625
626
627
628
            ) {
                continue; // skip this FE
            }

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

631
632
            $debugStack = array();

633
634
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
635
            $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM);
636

Carsten  Rose's avatar
Carsten Rose committed
637
638
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
639

640
641
            // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'.
            if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) {
642
                Support::setIfNotSet($fe, FE_SLAVE_ID);
643
644
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
645
646
            }

647
648
649
            $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]);
            $fe[FE_NOTE] = $this->processReportSyntax($fe[FE_NOTE]);

650
            if (isset($fe[FE_FILL_STORE_VAR])) {
651
                $fe[FE_FILL_STORE_VAR] = $this->evaluate->parse($fe[FE_FILL_STORE_VAR]);
652
                $this->store->appendToStore($fe[FE_FILL_STORE_VAR], STORE_VAR);
653
654
            }

Carsten  Rose's avatar
Carsten Rose committed
655
            // ** evaluate current FormElement **
656
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
657
            $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName);
658

659
            // Some Defaults
660
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
661

662
663
664
665
666
667
//            // Copy global readonly mode.
//            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
//                $fe[FE_MODE] = FE_MODE_READONLY;
//                $fe[FE_MODE_SQL] = '';
//            }

668
            if ($flagOutput === true) {
669
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
670
            }
671

672
673
            //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];
674

675
676
677
            $value = '';
            Support::setIfNotSet($formElement, FE_VALUE);

678
679
680
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
681

682
            $value = $formElement[FE_VALUE];
683

684
            if ($value === '') {
685
686
687
688
                // #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
689
                }
690
691
                // Retrieve value via FSRVD
                $value = $this->store->getVar($name, $storeUse, $formElement[FE_CHECK_TYPE], $foundInStore);
692
693
694
            }

            if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) {
695
696
//                $value = htmlspecialchars_decode($value, ENT_QUOTES);
                $value = Support::htmlEntityEncodeDecode(MODE_DECODE, $value);
697
            }
698

699
700
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
701
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
702
703
704
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
705

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

Carsten  Rose's avatar
Carsten Rose committed
709
            $jsonElement = array();
710
            $elementExtra = '';
711
            // Render pure element
712
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
713
714

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
715
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
716
717
718
719
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
720
                // for non-container elements: just add the current json status
721
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
722
723
724
725
726
727
                    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
728
729
                }
            }
730

731
732
            if ($flagOutput) {
                // debugStack as Tooltip
733
                if ($this->showDebugInfoFlag) {
734
735
736
737
738
                    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
739
                    $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]);
740
741
                    $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']');
                    $icon = Support::wrapTag('<span class="' . GLYPH_ICON . ' ' . GLYPH_ICON_EDIT . '">', '');
742
                    $elementHtml .= Support::wrapTag("<a class='hidden " . CLASS_FORM_ELEMENT_EDIT . "' href='$feEditUrl' $titleAttr>", $icon);
743
                }
744

745
746
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
747

748
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];
749
            }
750
        }
751

752
753
754
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

755
756
757
        return $html;
    }

758
    /**
Carsten  Rose's avatar
Carsten Rose committed
759
760
761
762
763
     * Checks if LDAP search is requested.
     * Yes: prepare configuration and fire the query.
     * No: do nothing.
     *
     * @param array $formElement
764
     *
Carsten  Rose's avatar
Carsten Rose committed
765
     * @return array
766
767
768
769
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
770
771
772
773
     */
    private function prepareFillStoreFireLdap(array $formElement) {

        if (isset($formElement[FE_FILL_STORE_LDAP]) || isset($formElement[FE_TYPEAHEAD_LDAP])) {
774
775
776
            $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,
777
                F_TYPEAHEAD_LDAP_ID_PRINTF, F_LDAP_TIME_LIMIT, F_LDAP_USE_BIND_CREDENTIALS];
778
            $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames);
Carsten  Rose's avatar
Carsten Rose committed
779
780
781
782
783
784
785
        } else {
            return $formElement; // nothing to do.
        }

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

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

789
            if ($formElement[FE_LDAP_USE_BIND_CREDENTIALS] == 1) {
790
791
792
793
                $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
794
795
796
797
798
799
800
801
            $ldap = new Ldap();
            $arr = $ldap->process($config, '', MODE_LDAP_SINGLE);
            $this->store->setStore($arr, STORE_LDAP, true);
        }

        return $formElement;
    }

802
803
804
805
806
807
808
    /**
     * 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.
809
810
     *   Reason: checks happens per pill - if there is no explizit definition on the first pill, take the first
     *   editable element of that pill.
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
     */
    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;
834

835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
                    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
852
    /**
853
854
855
856
     * @param $label
     * @param $input
     * @param $note
     * @return
Carsten  Rose's avatar
Carsten Rose committed
857
     */
858
859
    abstract public function fillWrapLabelInputNote($label, $input, $note);

860
    /**
861
862
     * Copy a subset of current STORE_TYPO3 variables to SIP. Set a hidden form field to submit the assigned SIP to
     * save/update.
863
     *
Carsten  Rose's avatar
Carsten Rose committed
864
     * @return string
865
866
     * @throws CodeException
     * @throws UserFormException
867
868
869
870
871
872
873
874
875
876
877
878
     */
    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
879
880
     * @param        $htmlFormElementName
     * @param string $value