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

Carsten  Rose's avatar
Carsten Rose committed
9

10
11
namespace qfq;

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

//use qfq\Report;

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

Carsten  Rose's avatar
Carsten Rose committed
25

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

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

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

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

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

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

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

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

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

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

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

124
125
        $this->phpUnit = $phpUnit;

126
        mb_internal_encoding("UTF-8");
127

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

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

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

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

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

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

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

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

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

159
160
        $this->t3data = $t3data;

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

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

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

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

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

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

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

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

204
        return $html;
205
206
    }

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

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

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

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

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

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

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

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

            $build = new Delete();

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

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

Carsten  Rose's avatar
#2067    
Carsten Rose committed
284
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
285
        switch ($formMode) {
286
            case FORM_LOAD:
Carsten  Rose's avatar
Carsten Rose committed
287
            case FORM_UPDATE:
288

289
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
290
            $data = $build->process($formMode);
291
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
292
                break;
Carsten  Rose's avatar
Carsten Rose committed
293

294
295
296
297
298
299
300
301
            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;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

401
        $this->formSpec = $formSpec;
402

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

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

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

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

424
425
                break;

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

430
            default:
431
                break;
432
433
        }

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

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

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

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

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

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

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

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

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

        return $form;
    }

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

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

548
        foreach ($keys as $key) {
549

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

558
559
        return $formSpec;
    }
560

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

572
        return $config;
573
574
    }

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

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

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

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

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

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

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

638
639
640
641
642
        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) {
643

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

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

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

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

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

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

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

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

    }

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

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

        return $html;

    }

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

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

723
        return $json;
724
725
    }

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

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

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

        return true;
750
751
    }

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

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

792
}