QuickFormQuery.php 27.3 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) === '1') {
189
190
191
192
            $html .= Support::appendTooltip('', $this->t3data['bodytext']);
        }

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

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

199
200
201
202
//        $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>";

203
        return $html;
204
205
    }

206
    /**
207
     * Process form.
208
209
210
211
212
     * $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:
213
     *
214
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
215
     * @return array|string
216
     * @throws CodeException
217
     * @throws UserFormException
218
     */
219
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
220
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
221
        $foundInStore = '';
222

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

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

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

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

Carsten  Rose's avatar
#2067    
Carsten Rose committed
250
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT);
251
252
        // 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.
253
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId == 0)) {
254
255
            $this->store->createSipAfterFormLoad($formName);
        }
256

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

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

            $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);
            }
281
282
        }

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

292
293
294
295
296
297
298
299
            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;

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

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

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

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

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

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

318
                // Action: After
319
320
321
                $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.
322
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
323
                }
324

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

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

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

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

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

348
    /**
349
     * Load form. Evaluates form. Load FormElements.
350
     *
Carsten  Rose's avatar
Carsten Rose committed
351
     * After processing:
352
353
354
355
     * 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
356
357
358
359
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
360
     * @throws DbException
361
     * @throws UserFormException
362
     */
Carsten  Rose's avatar
Carsten Rose committed
363
    private function loadFormSpecification($mode, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
364

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

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

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

377
378
379
380
381
382
383
        // 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);
        }

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

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

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

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

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

399
        $this->formSpec = $formSpec;
400

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

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

        // FE: Native & Container
409
410
411
        // "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:
412
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
413
414
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER,
                    ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
415
416
417
                break;

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

422
423
                break;

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

428
            default:
429
                break;
430
431
        }

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

Carsten  Rose's avatar
Carsten Rose committed
435
    /**
436
437
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
438
439
440
441
442
443
444
445
446
447
448
449
     * 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
450
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
451
     * @param string $foundInStore
452
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
453
     * @throws CodeException
454
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
455
     */
456
    public function getFormName($mode, &$foundInStore = '') {
457
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
458

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

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

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

479
        // If the formname is '': no formname name.
480
        if ($formName === '' || $foundInStore === '')
481
482
483
484
485
486
            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;
        }
487

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

491
492
493
494
495
496
497
498
    /**
     * 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
     */
499
    private function modeCleanFormConfig($mode, array $form) {
500
501
502
503
504
505
506
507
508
509
510
511

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

        return $form;
    }

512
    /**
513
514
515
516
517
518
     * 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.
519
     *
520
521
522
     * @param array $formSpec
     * @return array
     */
523
524
525
526
527
528
529
530
531
532
533
534
    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,
535
            F_BUTTON_ON_CHANGE_CLASS,
536
537
538
539
540
541
542
543
544
        ];

        // 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]);
            }
        }
545

546
        foreach ($keys as $key) {
547

548
549
550
551
552
553
554
            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);
            }
        }
555

556
557
        return $formSpec;
    }
558

559
560
561
562
563
564
565
566
567
    /**
     * 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, '');
568
        Support::setIfNotSet($config, F_BUTTON_ON_CHANGE_CLASS, '');
569

570
        return $config;
571
572
    }

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

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

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

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

        $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
601
602
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
603
                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
604
605
606
            }
        }

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

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

636
637
638
639
640
        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) {
641

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

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

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

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

658
    /**
659
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
660
     *
661
662
663
     * @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
664
665
666
667
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
668
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
669
670
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
671
            $this->store->setStore($record, $store, true);
672
673
674
        }
    }

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

        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
690
        $sipArray[SIP_RECORD_ID] = $recordId;
691
        $this->store->setStore($sipArray, STORE_SIP, true);
692

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

    }

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

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

        return $html;

    }

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

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

721
        return $json;
722
723
    }

Carsten  Rose's avatar
Carsten Rose committed
724
725
726
727
728
729
730
731
732
733
734
735
736
    /**
     * 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;
    }

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

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

        return true;
748
749
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
750
    /**
Carsten  Rose's avatar
Carsten Rose committed
751
752
     * 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
753
754
755
756
757
758
759
760
761
762
763
764
     * @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
765
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
766
767

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
768
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
769
770
771
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
772
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
                    $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;
787
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
788
789
    }

790
}