QuickFormQuery.php 24.6 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 $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
211
     * @return array|string
212
     * @throws CodeException
213
     * @throws UserFormException
214
     */
Carsten  Rose's avatar
Carsten Rose committed
215
216
    private function doForm($mode) {
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
217
        $foundInStore = '';
218

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

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

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

        } else {
            // FORM_DELETE without a form definition: Fake the form wiht only a tableName.
            $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
249
        $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.
        if (!$sipFound || ($mode == FORM_LOAD && $recordId == 0)) {
250
251
            $this->store->createSipAfterFormLoad($formName);
        }
252

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

            $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
277
        switch ($mode) {
            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($mode);
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($mode, $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

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

Carsten  Rose's avatar
Carsten Rose committed
384
        # Set defaults:
385
        Support::setIfNotSet($this->formSpec, 'class', '');
386
        Support::setIfNotSet($this->formSpec, F_BS_LABEL_COLUMNS, 3, '');
387
388
        Support::setIfNotSet($this->formSpec, F_BS_INPUT_COLUMNS, 6, '');
        Support::setIfNotSet($this->formSpec, F_BS_NOTE_COLUMNS, 3, '');
Carsten  Rose's avatar
Carsten Rose committed
389

390
391
        Support::setIfNotSet($this->formSpec, F_SUBMIT_BUTTON_TEXT, '');

392
393
394
395
396
397
398
399
400
        // 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($this->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($this->formSpec, F_CLASS_BODY, $class);
401

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

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

        // FE: Native & Container
412
413
414
        // "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:
415
416
                $this->feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ROW_REGULAR,
                    ['no', $this->formSpec["id"], 'native,container', 0]);
417
418
419
                break;

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

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

429
            default:
430
                break;
431
432
        }

433
        HelperFormElement::explodeParameterInArrayElements($this->feSpecNative);
434
435

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

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

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

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

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

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

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

494
    /**
Carsten  Rose's avatar
Carsten Rose committed
495
     * Check if loading of the given form is permitted. If not, throw an exception.
496
     *
Carsten  Rose's avatar
Carsten Rose committed
497
498
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
499
     * @throws CodeException
500
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
501
     * @internal param $foundInStore
502
     */
Carsten  Rose's avatar
Carsten Rose committed
503
    private function validateForm($formNameFoundInStore) {
504
505

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

Carsten  Rose's avatar
Carsten Rose committed
508
        // Set missing 'r'.
509
        if ($r === false) {
510
511
512
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
513
514
        }

Carsten  Rose's avatar
Carsten Rose committed
515
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
516
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
517
518
519
520
521

        $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
522
523
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
524
                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
525
526
527
            }
        }

528
        switch ($permitMode) {
529
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
530
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
531
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
532
533
534
535
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
536
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
537
538
539
540
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
541
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
542
543
544
545
546
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
547
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
548
            default:
549
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
550
        }
Carsten  Rose's avatar
Carsten Rose committed
551

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

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
        $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) {

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

            if ($name === '') {
                continue;
            }

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

574
        return $sipFound;
575
    }
Carsten  Rose's avatar
Carsten Rose committed
576

577
    /**
Carsten  Rose's avatar
Carsten Rose committed
578
579
     * Load record $id from $table.
     *
580
581
582
583
584
585
586
587
588
589
590
591
592
     * @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);
        }
    }

593
    /**
Carsten  Rose's avatar
Carsten Rose committed
594
595
     * Update current SIP Store with new $recordId and update SESSION store.
     *
596
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
597
598
     * @throws CodeException
     * @throws UserFormException
599
     */
Carsten  Rose's avatar
#2067    
Carsten Rose committed
600
601
602
    private function newRecordUpdateSip($recordId) {
        // Update current SIP store with new RecordID
        $sipArray = $this->store->getStore(STORE_SIP);
Carsten  Rose's avatar
Carsten Rose committed
603
604
605
606
607

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

Carsten  Rose's avatar
#2067    
Carsten Rose committed
611
612
        // Update SIP urlparam
        store::getSipInstance()->updateSipToSession($sipArray);
613
614
615

    }

616
    /**
617
618
     * Process the SQL Queries from bodytext. Return the output.
     *
619
620
     * @return string
     */
621
    private function doReport() {
622
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
623

624
        $html = $report->process($this->t3data['bodytext']);
625
626
627
628
629

        return $html;

    }

630
    /**
631
632
     * Save the current form.
     *
633
634
635
636
     * @return string
     */
    public function saveForm() {

637
        $json = $this->doForm(FORM_SAVE);
638

639
        return $json;
640
641
    }

Carsten  Rose's avatar
Carsten Rose committed
642
643
644
645
646
647
648
649
650
651
652
653
654
    /**
     * 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;
    }

655
656
657
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
658
     * @return bool
659
660
661
662
     * @throws CodeException
     */
    public function delete() {

663
        $this->doForm(FORM_DELETE);
664
665

        return true;
666
667
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
668
    /**
Carsten  Rose's avatar
Carsten Rose committed
669
670
     * 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
671
672
673
674
675
676
677
678
679
680
681
682
     * @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
683
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
684
685

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
686
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
687
688
689
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
690
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
                    $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);
    }

708
}