QuickFormQuery.php 28.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
     * @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:
Carsten  Rose's avatar
Carsten Rose committed
286
            case FORM_UPDATE:
287

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

346
347
348
        if (is_array($data)) {
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
349
        return $data;
350
351
    }

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

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

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

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

381
382
383
384
385
386
387
        // 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);
        }

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

392
        $form = $this->modeCleanFormConfig($mode, $form);
393

394
        $formSpec = $this->eval->parseArray($form);
395
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
396

397
398
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
399
400

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

403
        $this->formSpec = $formSpec;
404

Carsten  Rose's avatar
Carsten Rose committed
405
        // Clear
406
407
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

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

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

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

426
427
                break;

428
429
430
431
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

432
            default:
433
                break;
434
435
        }

436
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
437
438
    }

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

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

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

479
480
481
482
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

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

492
        return $formName;
493
    }
Carsten  Rose's avatar
Carsten Rose committed
494

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

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

        return $form;
    }

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

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

550
        foreach ($keys as $key) {
551

552
553
554
555
556
557
558
            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);
            }
        }
559

560
561
        return $formSpec;
    }
562

563
564
565
566
567
568
569
570
571
    /**
     * 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, '');
572
        Support::setIfNotSet($config, F_BUTTON_ON_CHANGE_CLASS, '');
573

574
        return $config;
575
576
    }

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

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

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

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

        $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
605
606
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
607
                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
608
609
610
            }
        }

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

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

640
641
642
643
644
        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) {
645

646
647
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
648

649
650
651
                if ($name === '') {
                    continue;
                }
652

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

659
        return $sipFound;
660
    }
Carsten  Rose's avatar
Carsten Rose committed
661

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

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

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

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

    }

702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
    /**
     * 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;
    }

726
    /**
727
728
     * Process the SQL Queries from bodytext. Return the output.
     *
729
730
     * @return string
     */
731
    private function doReport() {
732
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
733

734
        $html = $report->process($this->t3data['bodytext']);
735
736
737
738
739

        return $html;

    }

740
    /**
741
742
     * Save the current form.
     *
743
744
745
746
     * @return string
     */
    public function saveForm() {

747
        $json = $this->doForm(FORM_SAVE);
748

749
        return $json;
750
751
    }

Carsten  Rose's avatar
Carsten Rose committed
752
753
754
755
756
757
758
759
760
761
762
763
764
    /**
     * 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;
    }

765
766
767
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
768
     * @return bool
769
770
771
772
     * @throws CodeException
     */
    public function delete() {

773
        $this->doForm(FORM_DELETE);
774
775

        return true;
776
777
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
778
    /**
Carsten  Rose's avatar
Carsten Rose committed
779
780
     * 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
781
782
783
784
785
786
787
788
789
790
791
792
     * @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
793
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
794
795

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
796
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
797
798
799
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
800
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
801
802
803
804
805
806
807
808
809
810
811
812
813
814
                    $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;
815
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
816
817
    }

818
}