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
     * @param string $bodytext
117
     */
118
119
    public function __construct(array $t3data = array(), $phpUnit = false) {

120
121
        $this->phpUnit = $phpUnit;

122
        mb_internal_encoding("UTF-8");
123

124
125
126
127
128
//        session_name(SESSION_NAME);
//        session_start();

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

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

139
        // Refresh the session even if no new data saved.
140
        Session::set('LAST_ACTIVITY', time());
141

142
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
143

144
145
146
147
148
149
150
        if (!isset($t3data[T3DATA_BODYTEXT])) {
            $t3data[T3DATA_BODYTEXT] = '';
        }

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

152
        $btp = new BodytextParser();
153
        $t3data[T3DATA_BODYTEXT] = $btp->process($t3data[T3DATA_BODYTEXT]);
154

155
156
        $this->t3data = $t3data;

157
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
158
159

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

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

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

184
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === '1') {
185
186
187
188
            $html .= Support::appendTooltip('', $this->t3data['bodytext']);
        }

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

191
192
193
194
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
        if ($class)
            $html = Support::wrapTag("<div class='$class'>", $html);

195
196
197
198
//        $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>";

199
        return $html;
200
201
    }

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

Carsten  Rose's avatar
Carsten Rose committed
219
        // Fill STORE_FORM
220
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
221
222
223
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
224

225
226
        $formName = $this->loadFormSpecification($formMode, $foundInStore);
        if ($formName === false && $formMode !== FORM_DELETE) {
227
            // No form found: do nothing
228
            return '';
229
        }
230

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

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

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

253
        if ($formMode === FORM_DELETE) {
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272

            $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);
            }
273
274
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
275
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
276
        switch ($formMode) {
277
            case FORM_LOAD:
Carsten  Rose's avatar
Carsten Rose committed
278
            case FORM_UPDATE:
279
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
Carsten  Rose's avatar
Carsten Rose committed
280

281
            $data = $build->process($formMode);
282
283

                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
284
                break;
Carsten  Rose's avatar
Carsten Rose committed
285

286
287
288
289
290
291
292
293
            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;

294
            case FORM_SAVE:
295
296
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

297
                // Action: Before
298
299
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

300
                // If an old record exist: load it. Necessary to delete uploaded files which should be overwritten.
301
                $this->fillStoreRecord($this->formSpec[F_TABLE_NAME], $recordId);
302

303
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
304
305
                $rc = $save->process();

306
                // Reload fresh saved record and fill STORE_RECORD with it.
307
                $this->fillStoreRecord($this->formSpec[F_TABLE_NAME], $rc);
308

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

311
                // Action: After
312
313
314
315
316
                $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.
                    $this->fillStoreRecord($this->formSpec[F_TABLE_NAME], $rc);
                }
317

318
319
320
321
                $htmlElementNameIdZero = false;
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
322
                    // After insert: a new SIP for the new record id is required.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
323
                    $this->newRecordUpdateSip($rc);
324
325
                    $htmlElementNameIdZero = true;
                }
326

327
                // Action: Sendmail
328
                $formAction->elements($rc, $this->feSpecAction, FE_TYPE_SENDMAIL);
329

330
                // Retrieve FE Values as JSON
331
                $data = $build->process($formMode, $htmlElementNameIdZero);
332
                break;
Carsten  Rose's avatar
Carsten Rose committed
333

334
335
336
337
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

Carsten  Rose's avatar
Carsten Rose committed
338
        return $data;
339
340
    }

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

358
        // formName
Carsten  Rose's avatar
Carsten Rose committed
359
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
360
361
            return false;
        }
362

363
364
365
366
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

370
371
372
373
374
375
376
        // 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);
        }

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

381
        $form = $this->modeCleanFormConfig($mode, $form);
382

383
384
        $formSpec = $this->eval->parseArray($form);
        HelperFormElement::explodeParameter($formSpec);
385

386
        $formSpec = $this->setFormDefault($formSpec);
387
388

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

391
        $this->formSpec = $formSpec;
392

Carsten  Rose's avatar
Carsten Rose committed
393
        // Clear
394
395
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

396
        // FE: Action
397
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
398
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction);
399
400

        // FE: Native & Container
401
402
403
        // "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:
404
405
                $this->feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ROW_REGULAR,
                    ['no', $this->formSpec["id"], 'native,container', 0]);
406
407
408
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
409
            case FORM_UPDATE:
410
411
                $this->feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR,
                    ['no', $this->formSpec["id"], 'native']);
412
413
                break;

414
415
416
417
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

418
            default:
419
                break;
420
421
        }

422
        // Expand F_FE_PARAMETER ('parameter')
423
        HelperFormElement::explodeParameterInArrayElements($this->feSpecNative);
424
425
        $this->feSpecNative = $this->copyAttributesToFormElements($this->formSpec, $this->feSpecNative);

426
        $this->feSpecNative = HelperFormElement::duplicateRetypeElements($this->feSpecNative);
427
428

        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
429
430
    }

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

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

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

471
472
473
474
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

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

484
        return $formName;
485
    }
Carsten  Rose's avatar
Carsten Rose committed
486

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

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

        return $form;
    }

508
    /**
509
510
     * If not already defined, set various defaults on the form.
     *
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
     * @param array $formSpec
     * @return array
     */
    private function setFormDefault(array $formSpec) {
        # Set defaults:
        Support::setIfNotSet($formSpec, 'class', '');
        Support::setIfNotSet($formSpec, F_BS_LABEL_COLUMNS, 3, '');
        Support::setIfNotSet($formSpec, F_BS_INPUT_COLUMNS, 6, '');
        Support::setIfNotSet($formSpec, F_BS_NOTE_COLUMNS, 3, '');

        Support::setIfNotSet($formSpec, F_SUBMIT_BUTTON_TEXT, '');
        Support::setIfNotSet($formSpec, F_EXTRA_DELETE_FORM, '');

        // Take default from config.ini
        $value = $this->store->getVar(SYSTEM_FORM_DATA_PATTERN_ERROR, STORE_SYSTEM);
        Support::setIfNotSet($formSpec, F_FE_DATA_PATTERN_ERROR, ($value !== false) ? $value : '');

        // Take default from config.ini
        $value = $this->store->getVar(SYSTEM_FORM_DATA_REQUIRED_ERROR, STORE_SYSTEM);
        Support::setIfNotSet($formSpec, F_FE_DATA_REQUIRED_ERROR, ($value !== false) ? $value : '');

        // Take default from config.ini
        $value = $this->store->getVar(SYSTEM_FORM_DATA_MATCH_ERROR, STORE_SYSTEM);
        Support::setIfNotSet($formSpec, F_FE_DATA_MATCH_ERROR, ($value !== false) ? $value : '');

        // Take default from config.ini
        $value = $this->store->getVar(SYSTEM_FORM_DATA_ERROR, STORE_SYSTEM);
        Support::setIfNotSet($formSpec, F_FE_DATA_ERROR, ($value !== false) ? $value : '');

        // Take default from config.ini
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_FORM_PILL, STORE_SYSTEM);
        $class = $class ? $class : 'qfq-color-grey-1';
        Support::setIfNotSet($formSpec, F_CLASS_PILL, $class);

        // Take default from config.ini
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_FORM_BODY, STORE_SYSTEM);
        $class = $class ? $class : 'qfq-color-grey-2';
        Support::setIfNotSet($formSpec, F_CLASS_BODY, $class);

        return $formSpec;
    }

    /**
554
555
556
557
     * Copy specific attributes defined on the form to all FormElements.
     *
     * @param array $formSpec
     * @param array $feSpecNative
558
559
560
561
562
563
564
565
566
567
568
569
570
     * @return mixed
     */
    private function copyAttributesToFormElements(array $formSpec, array $feSpecNative) {
        foreach ($feSpecNative as $key => $element) {
            Support::setIfNotSet($feSpecNative[$key], F_FE_DATA_PATTERN_ERROR, $formSpec[F_FE_DATA_PATTERN_ERROR]);
            Support::setIfNotSet($feSpecNative[$key], F_FE_DATA_REQUIRED_ERROR, $formSpec[F_FE_DATA_REQUIRED_ERROR]);
            Support::setIfNotSet($feSpecNative[$key], F_FE_DATA_MATCH_ERROR, $formSpec[F_FE_DATA_MATCH_ERROR]);
            Support::setIfNotSet($feSpecNative[$key], F_FE_DATA_ERROR, $formSpec[F_FE_DATA_ERROR]);
        }

        return $feSpecNative;
    }

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

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

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

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

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

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

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

634
635
636
637
638
        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) {
639

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

643
644
645
                if ($name === '') {
                    continue;
                }
646

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

653
        return $sipFound;
654
    }
Carsten  Rose's avatar
Carsten Rose committed
655

656
    /**
Carsten  Rose's avatar
Carsten Rose committed
657
658
     * Load record $id from $table.
     *
659
660
661
662
663
664
665
666
667
668
669
670
671
     * @param string $table
     * @param string $recordId
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    private function fillStoreRecord($table, $recordId) {
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
            $this->store->setVarArray($record, STORE_RECORD, true);
        }
    }

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

        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
687
688
        $sipArray[SIP_RECORD_ID] = $recordId;
        $this->store->setVarArray($sipArray, STORE_SIP, true);
689

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

    }

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

703
        $html = $report->process($this->t3data['bodytext']);
704
705
706
707
708

        return $html;

    }

709
    /**
710
711
     * Save the current form.
     *
712
713
714
715
     * @return string
     */
    public function saveForm() {

716
        $json = $this->doForm(FORM_SAVE);
717

718
        return $json;
719
720
    }

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

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

742
        $this->doForm(FORM_DELETE);
743
744

        return true;
745
746
    }

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

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

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

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

        // Overwrite SIP Store
        $tmpParam[SIP_SIP] = $sip;
        $this->store->setVarArray($tmpParam, STORE_SIP, true);
    }

787
}