QuickFormQuery.php 29 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
     * @param array $t3data
     * @param bool $phpUnit
     * @throws CodeException
     * @throws UserFormException
120
     */
121
122
    public function __construct(array $t3data = array(), $phpUnit = false) {

123
124
        $this->phpUnit = $phpUnit;

125
        mb_internal_encoding("UTF-8");
126

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

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

Carsten  Rose's avatar
Carsten Rose committed
132
133
134
135
136
137
138
139
140
141
        // 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');

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

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

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

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

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

158
159
        $this->t3data = $t3data;

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

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

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

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

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

        $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:
286
287
288
289
290
291
292
293
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
                $data = $build->process($formMode);
                $data = Support::wrapTag("<div class='" . 'col-md-' . $this->formSpec[F_BS_COLUMNS] . "'>", $data);
                $data = Support::wrapTag("<div class='row'>", $data);

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

Carsten  Rose's avatar
Carsten Rose committed
294
            case FORM_UPDATE:
295

296
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
297
298
                // data['form-update']=....
                $data = $build->process($formMode);
299
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
300
                break;
Carsten  Rose's avatar
Carsten Rose committed
301

302
303
304
305
306
307
308
309
            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;

310
            case FORM_SAVE:
311
312
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

313
                // Action: Before
314
315
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

319
                // SAVE
320
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
321
322
                $rc = $save->process();

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

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

328
                // Action: After
329
330
331
                $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.
332
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
333
                }
334

335
336
337
338
                $htmlElementNameIdZero = false;
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
339
                    // After insert: a new SIP for the new record id is required.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
340
                    $this->newRecordUpdateSip($rc);
341
342
                    $htmlElementNameIdZero = true;
                }
343

344
                // Action: Sendmail
345
                $formAction->elements($rc, $this->feSpecAction, FE_TYPE_SENDMAIL);
346

347
                // Retrieve FE Values as JSON
348
                // $data['form-update']=...
349
                $data = $build->process($formMode, $htmlElementNameIdZero);
350
                break;
Carsten  Rose's avatar
Carsten Rose committed
351

352
353
354
355
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

356
        if (is_array($data)) {
357
            // $data['element-update']=...
358
359
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
360
        return $data;
361
362
    }

363
    /**
364
     * Load form. Evaluates form. Load FormElements.
365
     *
Carsten  Rose's avatar
Carsten Rose committed
366
     * After processing:
367
368
369
370
     * 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
371
372
373
374
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
375
     * @throws DbException
376
     * @throws UserFormException
377
     */
Carsten  Rose's avatar
Carsten Rose committed
378
    private function loadFormSpecification($mode, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
379

380
        // formName
Carsten  Rose's avatar
Carsten Rose committed
381
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
382
383
            return false;
        }
384

385
386
387
388
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

392
393
394
395
396
397
398
        // 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);
        }

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

403
        $form = $this->modeCleanFormConfig($mode, $form);
404

405
        $formSpec = $this->eval->parseArray($form);
406
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
407

408
409
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
410
411

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

414
        $this->formSpec = $formSpec;
415

Carsten  Rose's avatar
Carsten Rose committed
416
        // Clear
417
418
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

419
        // FE: Action
420
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
421
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
422
423

        // FE: Native & Container
424
425
426
        // "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:
427
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
428
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
429
430
431
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
432
            case FORM_UPDATE:
433
434
//                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
            $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
435
436
                break;

437
438
439
440
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

441
            default:
442
                break;
443
444
        }

445
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
446
447
    }

Carsten  Rose's avatar
Carsten Rose committed
448
    /**
449
450
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
451
452
453
454
455
456
457
458
459
460
461
462
     * 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
463
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
464
     * @param string $foundInStore
465
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
466
     * @throws CodeException
467
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
468
     */
469
    public function getFormName($mode, &$foundInStore = '') {
470
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
471

Carsten  Rose's avatar
Carsten Rose committed
472
473
474
475
476
477
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
478
479
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
480
481
482
483
484
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

488
489
490
491
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

492
        // If the formname is '': no formname name.
493
        if ($formName === '' || $foundInStore === '')
494
495
496
497
498
499
            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;
        }
500

501
        return $formName;
502
    }
Carsten  Rose's avatar
Carsten Rose committed
503

504
505
506
507
508
509
510
511
    /**
     * 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
     */
512
    private function modeCleanFormConfig($mode, array $form) {
513
514
515
516
517
518
519
520
521
522
523
524

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

        return $form;
    }

525
    /**
526
527
528
529
530
531
     * 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.
532
     *
533
534
535
     * @param array $formSpec
     * @return array
     */
536
537
    private function syncSystemFormConfig(array $formSpec) {

538
539
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
540
541
542
543
544
545
546
547
548
            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,
549
            F_BUTTON_ON_CHANGE_CLASS,
550
551
552
553
554
555
556
557
558
        ];

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

560
        foreach ($keys as $key) {
561

562
563
564
565
566
567
568
            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);
            }
        }
569

570
571
        return $formSpec;
    }
572

573
574
575
576
577
578
579
580
581
    /**
     * 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, '');
582
        Support::setIfNotSet($config, F_BUTTON_ON_CHANGE_CLASS, '');
583

584
        return $config;
585
586
    }

587
    /**
Carsten  Rose's avatar
Carsten Rose committed
588
     * Check if loading of the given form is permitted. If not, throw an exception.
589
     *
Carsten  Rose's avatar
Carsten Rose committed
590
591
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
592
     * @throws CodeException
593
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
594
     * @internal param $foundInStore
595
     */
596
    private function validateForm($formNameFoundInStore, $formMode) {
597
598

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

Carsten  Rose's avatar
Carsten Rose committed
601
        // Set missing 'r'.
602
        if ($r === false) {
603
604
605
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
606
607
        }

Carsten  Rose's avatar
Carsten Rose committed
608
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
609
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
610
611
612
613
614

        $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
615
616
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
617
                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
618
619
620
            }
        }

621
        switch ($permitMode) {
622
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
623
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
624
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
625
626
627
628
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
629
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
630
631
632
633
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
634
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
635
636
637
638
639
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
640
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
641
            default:
642
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
643
        }
Carsten  Rose's avatar
Carsten Rose committed
644

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

650
651
652
653
654
        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) {
655

656
657
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
658

659
660
661
                if ($name === '') {
                    continue;
                }
662

663
664
665
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
666
667
668
            }
        }

669
        return $sipFound;
670
    }
Carsten  Rose's avatar
Carsten Rose committed
671

672
    /**
673
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
674
     *
675
676
677
     * @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
678
679
680
681
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
682
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
683
684
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
685
            $this->store->setStore($record, $store, true);
686
687
688
        }
    }

689
    /**
Carsten  Rose's avatar
Carsten Rose committed
690
691
     * Update current SIP Store with new $recordId and update SESSION store.
     *
692
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
693
694
     * @throws CodeException
     * @throws UserFormException
695
     */
Carsten  Rose's avatar
#2067    
Carsten Rose committed
696
697
698
    private function newRecordUpdateSip($recordId) {
        // Update current SIP store with new RecordID
        $sipArray = $this->store->getStore(STORE_SIP);
Carsten  Rose's avatar
Carsten Rose committed
699
700
701
702
703

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

Carsten  Rose's avatar
#2067    
Carsten Rose committed
707
708
        // Update SIP urlparam
        store::getSipInstance()->updateSipToSession($sipArray);
709
710
711

    }

712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
    /**
     * Searches the whole array $dataArray on the second level for API_ELEMENT_UPDATE.
     * All found elements collect under $collect[API_ELEMENT_UPDATE]... . Leave the rest unchanged.
     *
     * @param array $dataArray
     * @return array to build JSON
     */
    private function groupElementUpdateEntries(array $dataArray) {
        $collect = array();

        foreach ($dataArray as $data) {

            if (isset($data[API_ELEMENT_UPDATE])) {
                foreach ($data[API_ELEMENT_UPDATE] as $key => $item) {
                    $collect[API_ELEMENT_UPDATE][$key] = $item;
                }
                unset($data[API_ELEMENT_UPDATE]);
            }
            $collect[] = $data;
        }

        return $collect;
    }

736
    /**
737
738
     * Process the SQL Queries from bodytext. Return the output.
     *
739
740
     * @return string
     */
741
    private function doReport() {
742
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
743

744
        $html = $report->process($this->t3data['bodytext']);
745
746
747
748
749

        return $html;

    }

750
    /**
751
752
     * Save the current form.
     *
753
754
755
756
     * @return string
     */
    public function saveForm() {

757
        $json = $this->doForm(FORM_SAVE);
758

759
        return $json;
760
761
    }

Carsten  Rose's avatar
Carsten Rose committed
762
763
764
765
766
767
768
769
770
771
772
773
774
    /**
     * 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;
    }

775
776
777
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
778
     * @return bool
779
780
781
782
     * @throws CodeException
     */
    public function delete() {

783
        $this->doForm(FORM_DELETE);
784
785

        return true;
786
787
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
788
    /**
Carsten  Rose's avatar
Carsten Rose committed
789
790
     * 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
791
792
793
794
795
796
797
798
799
800
801
802
     * @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
803
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
804
805

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
806
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
807
808
809
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
810
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
811
812
813
814
815
816
817
818
819
820
821
822
823
824
                    $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;
825
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
826
827
    }

828
}