QuickFormQuery.php 27.5 KB
Newer Older
1
2
3
4
5
6
7
8
<?php
/**
 * Created by PhpStorm.
 * User: ep
 * Date: 12/23/15
 * Time: 6:33 PM
 */

Carsten  Rose's avatar
Carsten Rose committed
9

10
11
namespace qfq;

Carsten  Rose's avatar
Carsten Rose committed
12
use qfq;
13
14
15
16
17
18
19
20
21

//use qfq\Report;

//use qfq\BuildFormPlain;
//use qfq\BuildFormTable;
//use qfq\BuildFormBootstrap;
//use qfq\UserException;
//use qfq\CodeException;
//use qfq\DbException;
22
//use qfq\helper;
23
//use qfq\Store;
Carsten  Rose's avatar
Carsten Rose committed
24

Carsten  Rose's avatar
Carsten Rose committed
25

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
require_once(__DIR__ . '/store/Store.php');
require_once(__DIR__ . '/store/FillStoreForm.php');
require_once(__DIR__ . '/store/Session.php');
require_once(__DIR__ . '/Constants.php');
require_once(__DIR__ . '/Save.php');
require_once(__DIR__ . '/helper/KeyValueStringParser.php');
require_once(__DIR__ . '/helper/HelperFormElement.php');
require_once(__DIR__ . '/exceptions/UserFormException.php');
require_once(__DIR__ . '/exceptions/CodeException.php');
require_once(__DIR__ . '/exceptions/DbException.php');
require_once(__DIR__ . '/exceptions/ErrorHandler.php');
require_once(__DIR__ . '/Database.php');
require_once(__DIR__ . '/Evaluate.php');
require_once(__DIR__ . '/BuildFormPlain.php');
require_once(__DIR__ . '/BuildFormTable.php');
require_once(__DIR__ . '/BuildFormBootstrap.php');
require_once(__DIR__ . '/report/Report.php');
require_once(__DIR__ . '/BodytextParser.php');
require_once(__DIR__ . '/Delete.php');
45
require_once(__DIR__ . '/form/FormAction.php');
46

47
48
49
50
51
52
53
54
55
56
57
58
/*
 * Form will be called
 * a) with a SIP identifier, or
 * b) without a SIP identifier (form setting has to allow this) and will create on the fly a new SIP.
 *
 * The SIP-Store stores:
 *  form=<formname>
 *  r=<record id>  (table.id for a single record form)
 *  keySemId,keySemIduser
 *  <further individual variables>
 */

Carsten  Rose's avatar
Carsten Rose committed
59
/**
60
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
61
62
 * @package qfq
 */
63
class QuickFormQuery {
64

65
    /**
66
     * @var \qfq\Store instantiated class
67
     */
Carsten  Rose's avatar
Carsten Rose committed
68
    protected $store = null;
69

70
71
72
    /**
     * @var Database instantiated class
     */
73
    protected $db = null;
74

75
76
77
78
    /**
     * @var Evaluate instantiated class
     */
    protected $eval = null;
79
80
81
    protected $formSpec = array();
    protected $feSpecAction = array();  // Form Definition: copy of the loaded form
    protected $feSpecNative = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
82

83
84
85
86
    /**
     * @var array
     */
    private $t3data = array(); // FormEelement Definition: all formElement.class='native' of the loaded form
87

88
89
90
    /**
     * @var bool
     */
91
92
    private $phpUnit = false;

93
94
95
96
97
    /**
     * @var Session
     */
    private $session = null;

98
99
100
101
102
103
104
105
106
107
108
    /*
     * TODO:
     *  Preparation: setup logging, database access, record locking
     *  fill stores
     *  Check permission_create / permission_update
     *  Multi: iterate over all records, Single: activate record
     *      Check mode: Load | Save
     *      doActions 'Before'
     *      Do all FormElements
     *      doActions 'After'
     */
109

110
111
112
113
114
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
     * As a result of instantiating of Form, the class Store will initially called the first time and therefore instantiated automatically.
     * Store might throw an exception, in case the URL-passed SIP is invalid.
115
     *
116
117
118
119
120
     * @param array $t3data
     * @param bool $phpUnit
     * @throws CodeException
     * @throws UserFormException
     * @internal param string $bodytext
121
     */
122
123
    public function __construct(array $t3data = array(), $phpUnit = false) {

124
125
        $this->phpUnit = $phpUnit;

126
        mb_internal_encoding("UTF-8");
127

128
129
130
131
132
//        session_name(SESSION_NAME);
//        session_start();

        $this->session = Session::getInstance($phpUnit);

Carsten  Rose's avatar
Carsten Rose committed
133
134
135
136
137
138
139
140
141
142
        // session.cache_expire
        // session.cookie_lifetime
        // session.gc_maxlifetime

//        $arr1['sessionname'] =   session_name();
//        $arr1['session.auto_start']  = ini_get('session.auto_start');
//        $arr1['session.gc_maxlifetime']  = ini_get('session.gc_maxlifetime');
//        $arr1['session.cookie_lifetime']  = ini_get('session.cookie_lifetime');
//        $arr1['session.name']  = ini_get('session.name');

143
        // Refresh the session even if no new data saved.
144
        Session::set('LAST_ACTIVITY', time());
145

146
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
147

148
149
150
151
152
153
154
        if (!isset($t3data[T3DATA_BODYTEXT])) {
            $t3data[T3DATA_BODYTEXT] = '';
        }

        if (!isset($t3data[T3DATA_UID])) {
            $t3data[T3DATA_UID] = 0;
        }
155

156
        $btp = new BodytextParser();
157
        $t3data[T3DATA_BODYTEXT] = $btp->process($t3data[T3DATA_BODYTEXT]);
158

159
160
        $this->t3data = $t3data;

161
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
162
163

        $this->store = Store::getInstance($bodytext, $phpUnit);
164
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
165
166
        $this->db = new Database();
        $this->eval = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
167
168
    }

169
    /**
Carsten  Rose's avatar
Carsten Rose committed
170
     * Returns the defined forwardMode and set $forwardPage (call be reference)
171
     *
172
173
174
175
176
177
178
179
     * @param $forwardPage
     * @return mixed
     */
    public function getForwardMode(&$forwardPage) {
        $forwardPage = $this->formSpec['forwardPage'];
        return $this->formSpec['forwardMode'];
    }

180
    /**
Carsten  Rose's avatar
Carsten Rose committed
181
     * Main entrypoint for display content: a) form and/or b) report
182
     *
183
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
184
     */
185
    public function process() {
186
        $html = '';
187

188
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
189
190
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
191
192
193
        }

        $html .= $this->doForm(FORM_LOAD);
194
        $html .= $this->doReport();
Carsten  Rose's avatar
Carsten Rose committed
195

196
197
198
199
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
        if ($class)
            $html = Support::wrapTag("<div class='$class'>", $html);

200
201
202
203
//        $feUidLoggedIn = isset($GLOBALS["TSFE"]->fe_user->user["uid"]) ? $GLOBALS["TSFE"]->fe_user->user["uid"] : false;
//        $feUidSession = $_SESSION[SESSION_NAME][SESSION_FE_USER_UID];
//        $html .= "<p>feUidLoggedIn: $feUidLoggedIn / feUidSession: $feUidSession</p>";

204
        return $html;
205
206
    }

207
    /**
208
     * Process form.
209
210
211
212
213
     * $mode=
     *   FORM_LOAD: The whole form will be rendered as HTML Code, including the values of all form elements
     *   FORM_UPDATE: States and values of all form elements will be returned as JSON.
     *   FORM_SAVE: The submitted form will be saved. Return Failure or Success as JSON.
     *   FORM_DELETE:
214
     *
215
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
216
     * @return array|string
217
     * @throws CodeException
218
     * @throws UserFormException
219
     */
220
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
221
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
222
        $foundInStore = '';
223

Carsten  Rose's avatar
Carsten Rose committed
224
        // Fill STORE_FORM
225
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
226
227
228
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
229

230
231
        $formName = $this->loadFormSpecification($formMode, $foundInStore);
        if ($formName === false && $formMode !== FORM_DELETE) {
232
            // No form found: do nothing
233
            return '';
234
        }
235

236
237
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
238
            $sipFound = $this->validateForm($foundInStore, $formMode);
239
240

        } else {
241
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
242
243
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
244
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
245
246
247
248
249
250
            }
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
251
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT);
252
253
        // For 'new' record always create a new Browser TAB-uniq (for this current form, nowhere else used) SIP.
        // With such a Browser TAB-uniq SIP, multiple Browser TABs and following repeated NEWs are easily implemented.
254
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId == 0)) {
255
256
            $this->store->createSipAfterFormLoad($formName);
        }
257

258
259
260
261
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

262
        if ($formMode === FORM_DELETE) {
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

            $build = new Delete();

        } else {
            $this->store->fillStoreTableDefaultColumnType($this->formSpec[F_TABLE_NAME]);

            switch ($this->formSpec['render']) {
                case 'plain':
                    $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                case 'table':
                    $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                case 'bootstrap':
                    $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                default:
                    throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
            }
282
283
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
284
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
285
        switch ($formMode) {
286
            case FORM_LOAD:
Carsten  Rose's avatar
Carsten Rose committed
287
            case FORM_UPDATE:
288
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
289
            $data = $build->process($formMode);
290
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
291
                break;
Carsten  Rose's avatar
Carsten Rose committed
292

293
294
295
296
297
298
299
300
            case FORM_DELETE:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_DELETE);

                $build->process($this->formSpec[F_TABLE_NAME], $recordId);

                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_DELETE);
                break;

301
            case FORM_SAVE:
302
303
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

304
                // Action: Before
305
306
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

307
                // If an old record exist: load it. Necessary to delete uploaded files which should be overwritten.
308
                $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_RECORD);
309

310
                // SAVE
311
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
312
313
                $rc = $save->process();

314
                // Reload fresh saved record and fill STORE_RECORD with it.
315
                $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
316

Carsten  Rose's avatar
Upload:    
Carsten Rose committed
317
318
                $save->processAllUploads($rc);

319
                // Action: After
320
321
322
                $modified = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($modified) {
                    // Reload fresh saved record and fill STORE_RECORD with it.
323
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
324
                }
325

326
327
328
329
                $htmlElementNameIdZero = false;
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
330
                    // After insert: a new SIP for the new record id is required.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
331
                    $this->newRecordUpdateSip($rc);
332
333
                    $htmlElementNameIdZero = true;
                }
334

335
                // Action: Sendmail
336
                $formAction->elements($rc, $this->feSpecAction, FE_TYPE_SENDMAIL);
337

338
                // Retrieve FE Values as JSON
339
                $data = $build->process($formMode, $htmlElementNameIdZero);
340
                break;
Carsten  Rose's avatar
Carsten Rose committed
341

342
343
344
345
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

Carsten  Rose's avatar
Carsten Rose committed
346
        return $data;
347
348
    }

349
    /**
350
     * Load form. Evaluates form. Load FormElements.
351
     *
Carsten  Rose's avatar
Carsten Rose committed
352
     * After processing:
353
354
355
356
     * Loaded Form is in  $this->formSpec
     * Loaded 'action' FormElements are in $this->feSpecAction
     * Loaded 'native' FormElements are in $this->feSpecNative
     *
Carsten  Rose's avatar
Carsten Rose committed
357
358
359
360
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
361
     * @throws DbException
362
     * @throws UserFormException
363
     */
Carsten  Rose's avatar
Carsten Rose committed
364
    private function loadFormSpecification($mode, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
365

366
        // formName
Carsten  Rose's avatar
Carsten Rose committed
367
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
368
369
            return false;
        }
370

371
372
373
374
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

375
        // Preparation for Log, Debug
376
        $this->store->setVar(SYSTEM_FORM, $formName, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
377

378
379
380
381
382
383
384
        // Check if there is a recordId specified in Bodytext - as variable or query.
        $rTmp = $this->store->getVar(CLIENT_RECORD_ID, STORE_TYPO3, SANITIZE_ALLOW_ALL);
        if (false !== $rTmp && !is_int($rTmp)) {
            $rTmp = $this->eval->parse($rTmp);
            $this->store->setVar(CLIENT_RECORD_ID, $rTmp, STORE_TYPO3);
        }

385
        // Load form
386
        $form = $this->db->sql("SELECT * FROM Form AS f WHERE f." . F_NAME . " LIKE ? AND f.deleted='no'", ROW_EXPECT_1,
387
            [$formName], 'Form not found or multiple forms with the same name.');
388

389
        $form = $this->modeCleanFormConfig($mode, $form);
390

391
392
        $formSpec = $this->eval->parseArray($form);
        HelperFormElement::explodeParameter($formSpec);
393

394
395
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
396
397

        // Set F_FINAL_DELETE_FORM
398
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
399

400
        $this->formSpec = $formSpec;
401

Carsten  Rose's avatar
Carsten Rose committed
402
        // Clear
403
404
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

405
        // FE: Action
406
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
407
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction);
408
409

        // FE: Native & Container
410
411
412
        // "SELECT *, ? AS 'nestedInFieldSet' FROM FormElement AS fe WHERE fe.formId = ? AND fe.deleted = 'no' AND FIND_IN_SET(fe.class, ? ) AND fe.feIdContainer = ? AND fe.enabled='yes' ORDER BY fe.ord, fe.id";
        switch ($mode) {
            case FORM_LOAD:
413
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
414
415
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER,
                    ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
416
417
418
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
419
            case FORM_UPDATE:
420
421
422
            $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER,
                ['no', $this->formSpec["id"], 'native'], $this->formSpec);

423
424
                break;

425
426
427
428
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

429
            default:
430
                break;
431
432
        }

433
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
434
435
    }

Carsten  Rose's avatar
Carsten Rose committed
436
    /**
437
438
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
439
440
441
442
443
444
445
446
447
448
449
450
     * FORM_LOAD:
     *   Specified in T3 body text with form=<formname>            Returned Store:Typo3
     *   Specified in T3 body text with form={{form}} ':FSRD'      Returned Store:SIP
     *   Specified in T3 body text with form={{form:C:ALNUMX}}     Returned Store:Client
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:S0}} }}
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:C0:DIGIT}} }}
     *   Specified in SIP
     *
     * FORM_SAVE:
     *   Specified in SIP
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
451
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
452
     * @param string $foundInStore
453
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
454
     * @throws CodeException
455
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
456
     */
457
    public function getFormName($mode, &$foundInStore = '') {
458
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
459

Carsten  Rose's avatar
Carsten Rose committed
460
461
462
463
464
465
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
466
467
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
468
469
470
471
472
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

473
474
        $storeFormName = $this->store->getVar(SIP_FORM, $store, '', $foundInStore);
        $formName = $this->eval->parse($storeFormName, 0, $dummy, $foundInStore);
Carsten  Rose's avatar
Carsten Rose committed
475

476
477
478
479
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

480
        // If the formname is '': no formname name.
481
        if ($formName === '' || $foundInStore === '')
482
483
484
485
486
487
            return false;

        // If the formname is surrounded by single ticks: the token (typically 'form') has not been replaced by a value.
        if ($formName[0] === "'" && $formName[strlen($formName) - 1] === "'") {
            return false;
        }
488

489
        return $formName;
490
    }
Carsten  Rose's avatar
Carsten Rose committed
491

492
493
494
495
496
497
498
499
    /**
     * Depending on $mode various formSpec fields might be adjusted.
     * E.g.: the form title is not important during a delete.
     *
     * @param $mode
     * @param array $form
     * @return array
     */
500
    private function modeCleanFormConfig($mode, array $form) {
501
502
503
504
505
506
507
508
509
510
511
512

        switch ($mode) {
            case FORM_DELETE:
                $form[F_TITLE] = '';
                break;
            default:
                break;
        }

        return $form;
    }

513
    /**
514
515
516
517
518
519
     * The named $keys will be synced between STORE_SYSTEM and $formSpec (both directions).
     * The per form definition has precedence over STORE_SYSTEM.
     * STORE_SYSTEM if filled with the default values (config.qfq.ini or if note exist than QFQ hardcoded)
     * Copying the 'Form' definition back to the system store helps to access the values
     * by '{{ ...:Y}}' (system store). E.g. the value of bs-*-columns might be displayed as placeholder in the
     * corresponding inputfield.
520
     *
521
522
523
     * @param array $formSpec
     * @return array
     */
524
525
526
527
528
529
530
531
532
533
534
535
    private function syncSystemFormConfig(array $formSpec) {

        $keys = [F_BS_LABEL_COLUMNS,
            F_BS_INPUT_COLUMNS,
            F_BS_NOTE_COLUMNS,
            F_FE_DATA_PATTERN_ERROR,
            F_FE_DATA_REQUIRED_ERROR,
            F_FE_DATA_MATCH_ERROR,
            F_FE_DATA_ERROR,
            F_CLASS,
            F_CLASS_PILL,
            F_CLASS_BODY,
536
            F_BUTTON_ON_CHANGE_CLASS,
537
538
539
540
541
542
543
544
545
        ];

        // By definition: existing vars which are empty, means: EMPTY - do not use any default!
        // But: if these variables are table columns, they always exist. For those: empty value means 'not set' - unset those.
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS] as $key) {
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
546

547
        foreach ($keys as $key) {
548

549
550
551
552
553
554
555
            if (isset($formSpec[$key])) {
                $this->store->setVar($key, $formSpec[$key], STORE_SYSTEM);
            } else {
                // if not found set ''
                $formSpec[$key] = $this->store->getVar($key, STORE_SYSTEM . STORE_EMPTY);
            }
        }
556

557
558
        return $formSpec;
    }
559

560
561
562
563
564
565
566
567
568
    /**
     * Set form parameter which are expected to exist.
     *
     * @param array $config
     * @return array
     */
    private function initForm(array $config) {
        Support::setIfNotSet($config, F_EXTRA_DELETE_FORM, '');
        Support::setIfNotSet($config, F_SUBMIT_BUTTON_TEXT, '');
569
        Support::setIfNotSet($config, F_BUTTON_ON_CHANGE_CLASS, '');
570

571
        return $config;
572
573
    }

574
    /**
Carsten  Rose's avatar
Carsten Rose committed
575
     * Check if loading of the given form is permitted. If not, throw an exception.
576
     *
Carsten  Rose's avatar
Carsten Rose committed
577
578
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
579
     * @throws CodeException
580
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
581
     * @internal param $foundInStore
582
     */
583
    private function validateForm($formNameFoundInStore, $formMode) {
584
585

        // Retrieve record_id either from SIP (prefered) or via URL
586
        $r = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT, '', $recordIdFoundInStore);
587

Carsten  Rose's avatar
Carsten Rose committed
588
        // Set missing 'r'.
589
        if ($r === false) {
590
591
592
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
593
594
        }

Carsten  Rose's avatar
Carsten Rose committed
595
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
596
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
597
598
599
600
601

        $feUserLoggedIn = isset($GLOBALS["TSFE"]->fe_user->user["uid"]) && $GLOBALS["TSFE"]->fe_user->user["uid"] > 0;

        $sipFound = $this->store->getVar(SIP_SIP, STORE_SIP) !== false;

Carsten  Rose's avatar
Carsten Rose committed
602
603
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
604
                throw new UserFormException("SIP exist but FORM or RECORD_ID are given by CLIENT.", ERROR_SIP_EXIST_BUT_OTHER_PARAM_GIVEN_BY_CLIENT);
Carsten  Rose's avatar
Carsten Rose committed
605
606
607
            }
        }

608
        switch ($permitMode) {
609
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
610
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
611
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
612
613
614
615
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
616
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
617
618
619
620
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
621
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
622
623
624
625
626
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
627
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
628
            default:
629
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
630
        }
Carsten  Rose's avatar
Carsten Rose committed
631

Carsten  Rose's avatar
Carsten Rose committed
632
        // Form Definition valid?
633
        if ($this->formSpec['multiMode'] !== 'none' && $this->formSpec['multiSql'] === '') {
634
            throw new UserFormException("MultiMode selected, but MultiSQL missing", ERROR_MULTI_SQL_MISSING);
Carsten  Rose's avatar
Carsten Rose committed
635
636
        }

637
638
639
640
641
        if ($formMode !== FORM_DELETE) {
            $sipArray = $this->store->getStore(STORE_SIP);
            // Check: requiredParameter: '' or 'form' or 'form,grId' or 'form #formname for form,grId'
            $param = explode(',', $this->formSpec[F_REQUIRED_PARAMETER]);
            foreach ($param AS $name) {
642

643
644
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
645

646
647
648
                if ($name === '') {
                    continue;
                }
649

650
651
652
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
653
654
655
            }
        }

656
        return $sipFound;
657
    }
Carsten  Rose's avatar
Carsten Rose committed
658

659
    /**
660
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
661
     *
662
663
664
     * @param string $table tablename from where to load record wiht $recordId
     * @param string $recordId record ID of current record
     * @param string $store name of store where to save the record
665
666
667
668
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
669
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
670
671
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
672
            $this->store->setStore($record, $store, true);
673
674
675
        }
    }

676
    /**
Carsten  Rose's avatar
Carsten Rose committed
677
678
     * Update current SIP Store with new $recordId and update SESSION store.
     *
679
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
680
681
     * @throws CodeException
     * @throws UserFormException
682
     */
Carsten  Rose's avatar
#2067    
Carsten Rose committed
683
684
685
    private function newRecordUpdateSip($recordId) {
        // Update current SIP store with new RecordID
        $sipArray = $this->store->getStore(STORE_SIP);
Carsten  Rose's avatar
Carsten Rose committed
686
687
688
689
690

        if (isset($sipArray[SIP_RECORD_ID]) && $sipArray[SIP_RECORD_ID] > 0) {
            throw new CodeException('Attemp to overwrite existing record id: SIP(otf)=' . $sipArray[SIP_SIP] . " existing_r=" . $sipArray[SIP_RECORD_ID] . " new_r=" . $recordId, ERROR_OVERWRITE_RECORD_ID);
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
691
        $sipArray[SIP_RECORD_ID] = $recordId;
692
        $this->store->setStore($sipArray, STORE_SIP, true);
693

Carsten  Rose's avatar
#2067    
Carsten Rose committed
694
695
        // Update SIP urlparam
        store::getSipInstance()->updateSipToSession($sipArray);
696
697
698

    }

699
    /**
700
701
     * Process the SQL Queries from bodytext. Return the output.
     *
702
703
     * @return string
     */
704
    private function doReport() {
705
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
706

707
        $html = $report->process($this->t3data['bodytext']);
708
709
710
711
712

        return $html;

    }

713
    /**
714
715
     * Save the current form.
     *
716
717
718
719
     * @return string
     */
    public function saveForm() {

720
        $json = $this->doForm(FORM_SAVE);
721

722
        return $json;
723
724
    }

Carsten  Rose's avatar
Carsten Rose committed
725
726
727
728
729
730
731
732
733
734
735
736
737
    /**
     * Update FormElements and form values. Receives the current form values via POST.
     *
     * @return array
     * @throws CodeException
     */
    public function updateForm() {

        $json = $this->doForm(FORM_UPDATE);

        return $json;
    }

738
739
740
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
741
     * @return bool
742
743
744
745
     * @throws CodeException
     */
    public function delete() {

746
        $this->doForm(FORM_DELETE);
747
748

        return true;
749
750
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
751
    /**
Carsten  Rose's avatar
Carsten Rose committed
752
753
     * Based on the given SIP, create a new uniqe SIP by copying the relevant old params and taking the new recordId..
     *
Carsten  Rose's avatar
#2067    
Carsten Rose committed
754
755
756
757
758
759
760
761
762
763
764
765
     * @param $sipArray
     * @param $recordId
     */
    private function newRecordCreateSip($sipArray, $recordId) {

        $tmpParam = array();

        foreach ($sipArray as $key => $value) {
            switch ($key) {
                case SIP_SIP:
                case SIP_URLPARAM:
                case SIP_TABLE:
Carsten  Rose's avatar
Carsten Rose committed
766
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
767
768

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
769
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
770
771
772
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
773
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
774
775
776
777
778
779
780
781
782
783
784
785
786
787
                    $tmpParam[$key] = $value;
                    break;
            }
        }

        // Construct fake urlparam
        $tmpUrlparam = OnArray::toString($tmpParam);

        // Create a SIP which has never been passed by URL - further processing might expect this to exist.
        $sip = store::getSipInstance()->queryStringToSip($tmpUrlparam, RETURN_SIP);
        $this->store->setVar(CLIENT_SIP, $sip, STORE_CLIENT);

        // Overwrite SIP Store
        $tmpParam[SIP_SIP] = $sip;
788
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
789
790
    }

791
}