AbstractBuildForm.php 131 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
19
20
21
22
23
24
25
26
require_once(__DIR__ . '/store/Store.php');
require_once(__DIR__ . '/Constants.php');
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');
27

28
/**
Carsten  Rose's avatar
Carsten Rose committed
29
30
 * Class AbstractBuildForm
 * @package qfq
31
 */
32
abstract class AbstractBuildForm {
33
34
35
36
37
    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();
38
    protected $wrap = array();
39
    protected $symbol = array();
40
    protected $showDebugInfoFlag = false;
41
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
42

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

45
46
47
48
49
50
51
52
    /**
     * @var Store
     */
    protected $store = null;
    /**
     * @var Evaluate
     */
    protected $evaluate = null;
53
54
55
    /**
     * @var string
     */
56
    private $formId = null;
57
58
59
60
61
    /**
     * @var Sip
     */
    private $sip = null;

62
63
64
65
66
67
68
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
     */
69
70
71
72
73
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
74
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
75
        $this->evaluate = new Evaluate($this->store, $this->db);
76
        $this->showDebugInfoFlag = Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_YES, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM));
77

78
        $this->sip = $this->store->getSipInstance();
79

80
        // render mode specific
81
        $this->fillWrap();
82
83

        $this->buildElementFunctionName = [
84
85
86
            FE_TYPE_CHECKBOX => 'Checkbox',
            FE_TYPE_DATE => 'DateTime',
            FE_TYPE_DATETIME => 'DateTime',
87
88
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
89
90
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
91
            FE_TYPE_EXTRA => 'Extra',
92
93
94
95
96
97
98
99
100
            FE_TYPE_TEXT => 'Input',
            FE_TYPE_EDITOR => 'Editor',
            FE_TYPE_TIME => 'DateTime',
            FE_TYPE_NOTE => 'Note',
            FE_TYPE_PASSWORD => 'Input',
            FE_TYPE_RADIO => 'Radio',
            FE_TYPE_SELECT => 'Select',
            FE_TYPE_SUBRECORD => 'Subrecord',
            FE_TYPE_UPLOAD => 'File',
101
            'fieldset' => 'Fieldset',
102
103
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup'
104
105
        ];

106
        $this->buildRowName = [
107
108
109
            FE_TYPE_CHECKBOX => 'Native',
            FE_TYPE_DATE => 'Native',
            FE_TYPE_DATETIME => 'Native',
110
111
112
113
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
114
            FE_TYPE_EXTRA => 'Native',
115
116
117
118
119
120
121
122
123
            FE_TYPE_TEXT => 'Native',
            FE_TYPE_EDITOR => 'Native',
            FE_TYPE_TIME => 'Native',
            FE_TYPE_NOTE => 'Native',
            FE_TYPE_PASSWORD => 'Native',
            FE_TYPE_RADIO => 'Native',
            FE_TYPE_SELECT => 'Native',
            FE_TYPE_SUBRECORD => 'Subrecord',
            FE_TYPE_UPLOAD => 'Native',
124
            'fieldset' => 'Fieldset',
125
126
            'pill' => 'Pill',
            'templateGroup' => 'TemplateGroup'
127
128
        ];

129
130
131
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon " . GLYPH_ICON_EDIT . "'></span>";
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon " . GLYPH_ICON_NEW . "'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon " . GLYPH_ICON_DELETE . "'></span>";
132

133
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
134
135
    }

136
137
    abstract public function fillWrap();

138
    /**
139
     * Builds complete 'form'. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
140
     *
141
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
Carsten  Rose's avatar
Carsten Rose committed
142
     * @return string|array   $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all formElement.dynamicUpdate-yes  values/states
143
144
     * @throws CodeException
     * @throws DbException
145
     * @throws \qfq\UserFormException
146
     */
147
    public function process($mode, $htmlElementNameIdZero = false) {
Carsten  Rose's avatar
Carsten Rose committed
148
149
        $htmlHead = '';
        $htmlTail = '';
150
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
151
152
153
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
154
155
156
157
158
159
160
161

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

163
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
164
165
166
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
        }
167

168
        $filter = $this->getProcessFilter();
169

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

172
173
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
174
                $this->store->setStore($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
175
                $jsonTmp = array();
176
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
177
                $json[] = $jsonTmp;
178
179
            }
        } else {
180
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
181
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
182
        }
183
184
185

        // <form>
        if ($mode === FORM_LOAD) {
186
            $htmlT3vars = $this->prepareT3VarsForSave();
187
188
189
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }
190
        $htmlHidden = $this->buildAdditionalFormElements();
191

192
193
        $htmlSip = $this->buildHiddenSip($json);

194
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlHidden . $htmlElements . $htmlSip . $htmlT3vars . $htmlTail . $htmlSubrecords : $json;
195
196
    }

197
    /**
198
     * Builds the head area of the form.
199
     *
200
     * @return string
201
     */
202
203
    public function head() {
        $html = '';
204

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

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

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

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

215
216
217
        $html .= $this->getFormTag();

        return $html;
218
219
    }

220
    /**
221
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
222
     *
223
224
225
     * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT
     * @param int $recordId id of form or formElement
     * @param array $param
226
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
227
     * @throws CodeException
228
     */
229
    public function createFormEditorUrl($form, $recordId, array $param = array()) {
230

231
        if (!$this->showDebugInfoFlag) {
232
233
            return '';
        }
234

235
        $queryStringArray = [
236
            'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM),
237
238
            'form' => $form,
            'r' => $recordId
239
        ];
240
        $queryStringArray = array_merge($queryStringArray, $param);
241

242
        $queryString = Support::arrayToQueryString($queryStringArray);
243

244
245
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
246

247
        return $url;
248
249
250
    }

    /**
251
252
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
253
254
255
256
257
258
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
259
260

        if ($flagOmitEmpty && $value === "") {
261
            return '';
262
263
        }

264
265
266
267
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
268
     * Returns '<form ...>'-tag with various attributes.
269
270
271
272
273
274
275
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

276
277
278
        $honeypot = $this->getHoneypotVars();

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

281
282
283
284
285
286
287
288
289
290
291
292
293
    /**
     * 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) {
294
295
296
297
            $name = trim($name);
            if ($name === '') {
                continue;
            }
298
299
300
301
302
            $html .= "<input name='$name' type='hidden' value='' readonly>";
        }

        return $html;
    }
303

304
305
306
    /**
     * Build an assoc array with standard form attributes.
     *
307
     * @return array
308
309
310
     */
    public function getFormTagAtrributes() {

311
        $attribute['id'] = $this->getFormId();
312
313
314
315
316
317
318
319
320
321
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

322
    /**
Carsten  Rose's avatar
Carsten Rose committed
323
324
     * Return a uniq form id
     *
325
326
327
328
329
330
331
332
333
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

334
335
336
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
337
338
     * Notice: the SIP will be transferred as POST Parameter.
     *
339
340
341
342
343
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

344
        return API_DIR . '/save.php';
345
346
347
348
349
350
351
352
353
354
355
356
    }

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

357
        $result = $this->db->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"');
358
359
360
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
361

362
    abstract public function getProcessFilter();
363
364

    /**
365
     * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON.
366
     *
367
     * @param $recordId
368
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
369
     * @param int $feIdContainer
370
371
372
     * @param array $json
     * @param string $modeCollectFe
     * @param bool $htmlElementNameIdZero
373
     * @param string $storeUseDefault
374
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
375
     * @return string
376
377
     * @throws CodeException
     * @throws DbException
378
     * @throws \qfq\UserFormException
379
     */
380
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json,
381
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false,
382
                             $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD) {
383
        $html = '';
384

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

388
        // get current data record
389
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
390
391
392
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec[F_TABLE_NAME] . " WHERE id = ?", ROW_EXPECT_1,
                array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$recordId' from table '" .
                $this->formSpec[F_TABLE_NAME] . "'.");
393
            $this->store->setStore($row, STORE_RECORD);
394
        }
395

396
397
        $this->checkAutoFocus();

398
399
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
400
            $storeUse = $storeUseDefault;
401

402
403
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
404
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
405
406
407
408
            ) {
                continue; // skip this FE
            }

Carsten  Rose's avatar
Carsten Rose committed
409
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form
410

411
412
            $debugStack = array();

Carsten  Rose's avatar
Carsten Rose committed
413
414
415
416
417
418
            // Copy global readonly mode.
            if ($this->formSpec[F_MODE] == F_MODE_READONLY) {
                $fe[FE_MODE] = FE_MODE_READONLY;
                $fe[FE_MODE_SQL] = '';
            }

419
420
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
421

Carsten  Rose's avatar
Carsten Rose committed
422
423
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
424

425
426
            // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'.
            if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) {
427
                Support::setIfNotSet($fe, FE_SLAVE_ID);
428
429
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
430
431
            }

Carsten  Rose's avatar
Carsten Rose committed
432
            // ** evaluate current FormElement **
433
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
434

435
            // Some Defaults
436
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
437

438
            if ($flagOutput === true) {
439
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
440
            }
441

442
443
            //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];
444

445
446
447
            $value = '';
            Support::setIfNotSet($formElement, FE_VALUE);

448
449
450
            if (is_array($formElement[FE_VALUE])) {
                $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : '';
            }
451

452
            $value = $formElement[FE_VALUE];
453

454
            if ($value === '') {
455
456
457
458
                // #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
459
                }
460
461
                // Retrieve value via FSRVD
                $value = $this->store->getVar($name, $storeUse, $formElement[FE_CHECK_TYPE], $foundInStore);
462
463
464
465
            }

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

468
469
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
470
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId);
471
472
473
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID],
                ($htmlElementNameIdZero) ? 0 : $recordId,
                $formElement[FE_TG_INDEX]);
474

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

Carsten  Rose's avatar
Carsten Rose committed
478
            $jsonElement = array();
479
            $elementExtra = '';
480
            // Render pure element
481
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
482
483

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
484
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
485
486
487
488
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
489
                // for non-container elements: just add the current json status
490
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
491
492
493
494
495
496
                    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
497
498
                }
            }
499

500
501
            if ($flagOutput) {
                // debugStack as Tooltip
502
                if ($this->showDebugInfoFlag) {
503
504
505
506
507
                    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
508
                    $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]);
509
510
                    $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']');
                    $icon = Support::wrapTag('<span class="' . GLYPH_ICON . ' ' . GLYPH_ICON_EDIT . '">', '');
511
                    $elementHtml .= Support::wrapTag("<a class='hidden " . CLASS_FORM_ELEMENT_EDIT . "' href='$feEditUrl' $titleAttr>", $icon);
512
                }
513

514
515
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
516

517
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];
518
            }
519
        }
520

521
522
523
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

524
525
526
        return $html;
    }

527
    /**
Carsten  Rose's avatar
Carsten Rose committed
528
529
530
531
532
533
534
535
536
537
538
539
540
     * Checks if LDAP search is requested.
     * Yes: prepare configuration and fire the query.
     * No: do nothing.
     *
     * @param array $formElement
     * @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])) {
541
542
543
            $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,
544
                F_TYPEAHEAD_LDAP_ID_PRINTF, F_LDAP_TIME_LIMIT, F_LDAP_USE_BIND_CREDENTIALS];
545
            $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames);
Carsten  Rose's avatar
Carsten Rose committed
546
547
548
549
550
551
552
        } else {
            return $formElement; // nothing to do.
        }

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

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

556
            if ($formElement[FE_LDAP_USE_BIND_CREDENTIALS] == 1) {
557
558
559
560
                $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
561
562
563
564
565
566
567
568
            $ldap = new Ldap();
            $arr = $ldap->process($config, '', MODE_LDAP_SINGLE);
            $this->store->setStore($arr, STORE_LDAP, true);
        }

        return $formElement;
    }

569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    /**
     * 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.
     *   Reason: checks happens per pill - if there is no explizit definition on the first pill, take the first editable
     *           element of that pill.
     */
    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;
                    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';
        }
    }

618
619
    abstract public function fillWrapLabelInputNote($label, $input, $note);

620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    /**
     * Copy a subset of current STORE_TYPO3 variables to SIP. Set a hidden form field to submit the assigned SIP to save/update.
     *
     * @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.
     *
637
     * @param $htmlFormElementName
638
639
640
     * @param $value
     * @return string
     */
641
642
    public function buildNativeHidden($htmlFormElementName, $value) {
        return '<input type="hidden" name="' . $htmlFormElementName . '" value="' . htmlentities($value) . '">';
643
644
    }

645
646
647
648
    abstract public function tail();

    abstract public function doSubrecords();

649
650
651
652
653
654
655
656
657
658
659
660
661
662
    /**
     * 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) : '';
    }

663
664
665
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
666
     * @param array $json
667
668
669
670
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
671
    public function buildHiddenSip(array &$json) {
672

673
        $sipArray = $this->store->getStore(STORE_SIP);
674
675

        // do not include system vars
676
677
678
679
680
681
682
683
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

684
        $json[] = $this->getFormElementForJson(CLIENT_SIP, $sipValue, [FE_MODE => FE_MODE_SHOW]);
685
686
687
688
689

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

    /**
690
691
692
     * Create an array with standard elements for 'mode' (hidden, disabled, required) and add 'form-element', 'value'.
     * '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
693
     *
694
     * @param string $htmlFormElementName
695
     * @param string|array $value
696
     * @param array $formElement
697
698
     * @return array
     */
699
    private function getFormElementForJson($htmlFormElementName, $value, array $formElement) {
700

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

703
        $json['form-element'] = $htmlFormElementName;
704
705
706
707
708
709
710
711
712
713
714

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

        // 'value' update via 'form-update' on the full row: only if there is no other FE that row
        if ($flagRowUpdate) {
            $json['value'] = $value;
        }
715

716
717
        if (isset($formElement[FE_LABEL])) {
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_LABEL;
718
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $this->buildLabel($htmlFormElementName, $formElement[FE_LABEL]);
719
720
721
722
723
        }

        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];
724
        }
725

726
        if (isset($formElement[FE_TYPE])) {
727
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_INPUT;
728
729
730
731
732
733
734
735
736
737
738
739

            // 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;
            }
740
741
742
743
744

            // #3647
            if (!$flagRowUpdate) {
                $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['value'] = $value;
            }
745
746
        }

747
        // Show / Hide the complete FormElement Row.
748
749
750
        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];
751
            if ($formElement[FE_MODE] == FE_MODE_HIDDEN) {
752
753
754
755
756
757
758
                $class .= ' hidden';
            }

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

759
760
761
        return $json;
    }

762
763
764
765
766
767
768
769
770
    /**
     * Set corresponding JSON attributes readonly/required/disabled, based on $formElement[FE_MODE].
     *
     * @param array $feMode
     * @return array
     * @throws UserFormException
     */
    private function getJsonFeMode($feMode) {

771
        $this->getFeMode($feMode, $dummy, $disabled, $required);
772

773
        return [API_JSON_DISABLED => $disabled === 'yes', API_JSON_REQUIRED => $required === 'yes'];
774
775
776
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
777
778
     * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'.
     *
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
     * @param $feMode
     * @param $hidden
     * @param $disabled
     * @param $required
     * @throws \qfq\UserFormException
     */
    private function getFeMode($feMode, &$hidden, &$disabled, &$required) {
        $hidden = 'no';
        $disabled = 'no';
        $required = 'no';

        switch ($feMode) {
            case FE_MODE_SHOW:
                break;
            case FE_MODE_REQUIRED:
                $required = 'yes';
                break;
            case FE_MODE_READONLY:
797
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
798
799
800
801
802
803
804
805
806
807
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

808
809
810
811
812
    /**
     * Builds a label, typically for an html-'<input>'-element.
     *
     * @param string $htmlFormElementName
     * @param string $label
813
     * @param string $addClass
814
815
     * @return string
     */
816
    public function buildLabel($htmlFormElementName, $label, $addClass = '') {
817
        $attributes = Support::doAttribute('for', $htmlFormElementName);
818
        $attributes .= Support::doAttribute('class', ['control-label', $addClass]);
819
820
821
822
823
824

        $html = Support::wrapTag("<label $attributes>", $label);

        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
825
826
827
828
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
829
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
830
831
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
832

833
834
835
        $urlParam = $this->store->getNonSystemSipParam();
        $urlParam[SIP_RECORD_ID] = 0;
        $urlParam[SIP_FORM] = $this->formSpec[F_NAME];
836
837

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
838
839
840
841
842

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

        $url = $sip->queryStringToSip(OnArray::toString($urlParam));

843
        if ($this->showDebugInfoFlag) {
844
            //TODO: missing decoding of SIP
845
846
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
847
848
849
850

        return $url;
    }

851
    abstract public function buildRowPill(array $formElement, $elementHtml);
852

853
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
854

855
856
    abstract public function buildRowTemplateGroup(array $formElement, $elementHtml);

857
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
858

859
860
    /**
     * Builds HTML 'input' element.
861
     * Format: <input name="$htmlFormElementName" <type="email|input|password|url" [autocomplete="autocomplete"] [autofocus="autofocus"]
862
     *           [maxlength="$maxLength"] [placeholder="$placeholder"] [size="$size"] [min="$min"] [max="$max"]
Carsten  Rose's avatar
Carsten Rose committed
863
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
864
865
     *
     * @param array $formElement
866
867
     * @param string $htmlFormElementName
     * @param string $value
868
     * @param array $json Return updates in this array - will be later converted to JSON.
869
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
870
     * @return string complete rendered HTML input element.
871
     * @throws \qfq\UserFormException
872
     */
873
    public function buildInput(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) {
874
        $textarea = '';
875
        $attribute = '';
876
        $class = 'form-control';
877
        $elementCharacterCount = '';
878

879
880
881
882
883
884
885
        $typeAheadUrlParam = $this->typeAheadBuildParam($formElement);
        if ($typeAheadUrlParam != '') {
            $class .= ' ' . CLASS_TYPEAHEAD;
            $dataSip = $this->sip->queryStringToSip($typeAheadUrlParam, RETURN_SIP);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_SIP, $dataSip);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_LIMIT, $formElement[FE_TYPEAHEAD_LIMIT]);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_MINLENGTH, $formElement[FE_TYPEAHEAD_MINLENGTH]);
886
887
888
            if (isset($formElement[FE_TYPEAHEAD_PEDANTIC])) {
                $attribute .= Support::doAttribute(DATA_TYPEAHEAD_PEDANTIC, 'true');
            }
889
        }
890

891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
        if (isset($formElement[FE_CHARACTER_COUNT_WRAP])) {
            $class .= ' ' . CLASS_CHARACTER_COUNT;
            $attribute .= Support::doAttribute(DATA_CHARACTER_COUNT_ID, $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_CHARACTER_COUNT);
            $attributeCC = Support::doAttribute('id', $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_CHARACTER_COUNT);

            $classCC = ($formElement[FE_CHARACTER_COUNT_WRAP] == '') ? Support::doAttribute('class', 'qfq-cc-style') : '';
            $elementCharacterCount = "<span $attributeCC $classCC></span>";

            if ($formElement[FE_CHARACTER_COUNT_WRAP] != '') {
                $arr = explode('|', $formElement[FE_CHARACTER_COUNT_WRAP], 2);
                $arr[] = '';
                $arr[] = ''; //skip check that at least 2 elements exist
                $elementCharacterCount = $arr[0] . $elementCharacterCount . $arr[1];
            }
        }

907
908
        $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]);
        $attribute .= Support::doAttribute('name', $htmlFormElementName);
909
        $attribute .= Support::doAttribute('class', $class);
910

911

912
        if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
913
914
            $htmlFormElementNamePrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementName);
            $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementNamePrimary) . ']');
915
916
        }

917
918
919
920
921
922
923
924
925
926
927
        $this->adjustMaxLength($formElement);

        if ($formElement[FE_MAX_LENGTH] > 0 && $value !== '') {
            // crop string only if it's not empty (substr returns false on empty strings)
            $value = substr($value, 0, $formElement[FE_MAX_LENGTH]);
        }
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
        if ($formElement[FE_MAX_LENGTH] > 0) {
            $attribute .= Support::doAttribute('maxlength', $formElement[FE_MAX_LENGTH], false);
        }

928
        // Check for input type 'textarea'.
929
        $colsRows = explode(',', $formElement[FE_SIZE], 2);
930
        $flagTextarea = (count($colsRows) === 2);
931

932
933
934
        if ($formElement[FE_HIDE_ZERO] != '0' && $value == '0') {
            $value = '';
        }
935
936
//        $formElement = HelperFormElement::prepareExtraButton($formElement, !$flagTextarea, $extraButton);
        $formElement = HelperFormElement::prepareExtraButton($formElement, !$flagTextarea);
937
        if ($flagTextarea) {
938
            // <textarea>
939
940
            $htmlTag = '<textarea';

941
942
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
943
            $textarea = htmlentities($value) . '</textarea>';
944
        } else {
Carsten  Rose's avatar
Carsten Rose committed
945
            $htmlTag = '<input';
946
            $attribute .= $this->getAttributeList($formElement, ['type', 'size']);
947
            $attribute .= Support::doAttribute('value', htmlentities($value), false);
Carsten  Rose's avatar
Carsten Rose committed
948
        }
949

950
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
951
        $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]);
952
        $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : '');
953
        $attribute .= Support::doAttribute('title', $formElement[FE_TOOLTIP]);
954
        $attribute .= $this->getInputCheckPattern($formElement[FE_CHECK_TYPE], $formElement[FE_CHECK_PATTERN]);
955

956
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE], false);
957

958
        $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement);
Carsten  Rose's avatar
Carsten Rose committed
959

960
        $input = "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
961

962
        if ($formElement[FE_TMP_EXTRA_BUTTON_HTML] !== '') {
963