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

namespace qfq;

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

//use qfq\Report;

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

Carsten  Rose's avatar
Carsten Rose committed
24

25
26
27
28
29
30
31
32
33
34
35
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');
36
37
require_once(__DIR__ . '/database/Database.php');
require_once(__DIR__ . '/database/DatabaseUpdate.php');
38
39
40
41
42
43
44
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');
Carsten  Rose's avatar
Carsten Rose committed
46
require_once(__DIR__ . '/form/Dirty.php');
47

48
49
50
51
52
53
54
55
56
57
58
59
/*
 * 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
60
/**
61
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
62
63
 * @package qfq
 */
64
class QuickFormQuery {
65

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

71
    /**
72
     * @var \qfq\Database[] - Array of Database instantiated class
73
     */
74
    protected $dbArray = array();
75

76
77
78
79
    /**
     * @var Evaluate instantiated class
     */
    protected $eval = null;
80
81
82
    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
83
    protected $feSpecNativeRaw = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
84

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

90
91
92
    /**
     * @var bool
     */
93
94
    private $phpUnit = false;

95
96
97
98
99
    /**
     * @var Session
     */
    private $session = null;

100
101
102
    private $dbIndexData = false;
    private $dbIndexQfq = false;

103
104
105
106
107
108
109
110
111
112
113
    /*
     * 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'
     */
114

115
116
117
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
118
119
     * 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.
120
     *
121
     * @param array $t3data
Carsten  Rose's avatar
Carsten Rose committed
122
     * @param bool $phpUnit
123
     *
124
125
     * @throws CodeException
     * @throws UserFormException
126
     */
127
128
    public function __construct(array $t3data = array(), $phpUnit = false) {

129
130
        $this->phpUnit = $phpUnit;

131
        mb_internal_encoding("UTF-8");
132

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

135
        // Refresh the session even if no new data saved.
136
        Session::set('LAST_ACTIVITY', time());
137

138
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
139

140
141
142
143
144
145
146
        if (!isset($t3data[T3DATA_BODYTEXT])) {
            $t3data[T3DATA_BODYTEXT] = '';
        }

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

148
        $btp = new BodytextParser();
149
        $t3data[T3DATA_BODYTEXT] = $btp->process($t3data[T3DATA_BODYTEXT]);
150

151
152
        $this->t3data = $t3data;

153
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
154
155

        $this->store = Store::getInstance($bodytext, $phpUnit);
156
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
157

158
159
        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);
160

161
        $this->dbArray[$this->dbIndexData] = new Database($this->dbIndexData);
162
163
164
165

        $dbName = $this->dbArray[$this->dbIndexData]->getDbName();
        $this->store->setVar(SYSTEM_DB_NAME_DATA, $dbName, STORE_SYSTEM);

166
167
        if ($this->dbIndexData != $this->dbIndexQfq) {
            $this->dbArray[$this->dbIndexQfq] = new Database($this->dbIndexQfq);
168
169

            $dbName = $this->dbArray[$this->dbIndexQfq]->getDbName();
170
        }
171
172
        $this->store->setVar(SYSTEM_DB_NAME_QFQ, $dbName, STORE_SYSTEM);

173

174
        $this->eval = new Evaluate($this->store, $this->dbArray[$this->dbIndexData]);
175

176
        $dbUpdate = $this->store->getVar(SYSTEM_DB_UPDATE, STORE_SYSTEM);
177
        $updateDb = new DatabaseUpdate($this->dbArray[$this->dbIndexQfq]);
178
        $updateDb->checkNupdate($dbUpdate);
179

180
        $this->store->StoreSystemUpdate(); // Do this after the DB-update
181
182
183
184
185
186

        // Set dbIndex, evaluate any
        $dbIndex = $this->store->getVar(TOKEN_DB_INDEX, STORE_TYPO3 . STORE_EMPTY);
        $dbIndex = $this->eval->parse($dbIndex);
        $dbIndex = ($dbIndex == '') ? DB_INDEX_DEFAULT : $dbIndex;
        $this->store->setVar(TOKEN_DB_INDEX, $dbIndex, STORE_TYPO3);
Carsten  Rose's avatar
Carsten Rose committed
187
188
    }

189
    /**
190
     * Returns the defined forwardMode and set forwardPage
191
     *
192
     * @return array
193
     */
194
195
    public function getForwardMode() {

196
        $forwardPage = $this->formSpec[F_FORWARD_PAGE];
197

Carsten  Rose's avatar
Carsten Rose committed
198
199
200
201
        if ($this->formSpec[F_FORWARD_MODE] == F_FORWARD_MODE_URL_SIP) {
            $forwardPage = store::getSipInstance()->queryStringToSip($forwardPage, RETURN_URL);
            // F_FORWARD_MODE_URL_SIP is not defined in API PROTOCOL. At the moment it's only used for 'copyForm'.
            // 'copyForm' behaves better if the page is not in history.
202
            // An option for better implementing would be to separate SKIP History from ForwardMode. For API, it can be combined again.
Carsten  Rose's avatar
Carsten Rose committed
203
204
205
            $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_URL_SKIP_HISTORY;
        }

206
207
        return ([
            API_REDIRECT => $this->formSpec[F_FORWARD_MODE],
Carsten  Rose's avatar
Carsten Rose committed
208
            API_REDIRECT_URL => $forwardPage,
209
        ]);
210
211
    }

212
    /**
Carsten  Rose's avatar
Carsten Rose committed
213
     * Main entrypoint for display content: a) form and/or b) report
214
     *
215
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
216
     */
217
    public function process() {
218
        $html = '';
219

220
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
221
222
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
223
224
225
        }

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

228
        // Only needed if there are potential 'download'-links, which shall show a popup during processing of the download.
Carsten  Rose's avatar
Carsten Rose committed
229
230
231
232
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

233
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
234
        if ($class) {
235
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
236
237
        }

238
        return $html;
239
240
    }

241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
    /**
     * Determine the name of the language parameter field, which has to be taken to fill language specific defintions.
     */
    private function setParameterLanguageFieldName() {

        $typo3PageLanguage = $this->store->getVar(TYPO3_PAGE_LANGUAGE, STORE_TYPO3);
        if (empty($typo3PageLanguage)) {
            return;
        }

        foreach (['A', 'B', 'C', 'D'] as $key) {
            $languageIdx = SYSTEM_FORM_LANGUAGE . "_$key" . "_ID";
            if ($this->store->getVar($languageIdx, STORE_SYSTEM) == $typo3PageLanguage) {
                $this->store->setVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, 'parameterLanguage' . $key, STORE_SYSTEM);
                break;
            }
        }
    }

260
    /**
261
     * Process form.
262
263
264
265
266
     * $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:
267
     *
268
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
269
     *
270
     * @return array|string
271
     * @throws CodeException
272
     * @throws UserFormException
273
     */
274
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
275
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
276
        $foundInStore = '';
277

Carsten  Rose's avatar
Carsten Rose committed
278
        // Fill STORE_FORM
279
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
280
            $fillStoreForm = new FillStoreForm();
281
            $fillStoreForm->process($formMode);
Carsten  Rose's avatar
Carsten Rose committed
282
        }
283

284
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO);
285
        $this->setParameterLanguageFieldName();
286
287

        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore);
288
        if ($formName === false && $formMode !== FORM_DELETE) {
289
            // No form found: do nothing
290
            return '';
291
        }
292

293
294
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
295
            $sipFound = $this->validateForm($foundInStore, $formMode);
296
297

        } else {
298
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
299
300
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
301
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
302
303
304
305
            }
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
306
307
            $this->formSpec[F_RECORD_LOCK_TIMEOUT_SECONDS] = 1; // just indicate a timeout, the exact timeout is stored in the dirty record.
            $this->formSpec[F_DIRTY_MODE] = DIRTY_MODE_EXCLUSIVE; // just set a mode,, the exact mode is stored in the dirty record.
308
309
        }

310
311
        // 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.
312
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
313
314
            $this->store->createSipAfterFormLoad($formName);
        }
315

316
317
318
319
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

320
        // Check (and release) dirtyRecord.
Carsten  Rose's avatar
Carsten Rose committed
321
        if ($formMode === FORM_DELETE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
322
            $dirty = new Dirty();
Carsten  Rose's avatar
Carsten Rose committed
323

324
            $answer = $dirty->checkDirtyAndRelease($formMode, $this->formSpec[F_RECORD_LOCK_TIMEOUT_SECONDS],
Carsten  Rose's avatar
Carsten Rose committed
325
                $this->formSpec[F_DIRTY_MODE], $this->formSpec[F_TABLE_NAME], $recordId, true);
326

327
            // In case of a conflict, return immediately
Carsten  Rose's avatar
Carsten Rose committed
328
329
            if ($answer[API_STATUS] != API_ANSWER_STATUS_SUCCESS) {
                $answer[API_STATUS] = API_ANSWER_STATUS_ERROR;
330

331
332
                return $answer;
            }
Carsten  Rose's avatar
Carsten Rose committed
333
334
        }

335
336
337
338
339
340
341
342
343
344
        // FORM_LOAD: if there is an foreign exclusive record lock - show form in F_MODE_READONLY mode.
        if ($formMode === FORM_LOAD) {
            $dirty = new Dirty();
            $recordDirty = array();
            $rcLockFound = $dirty->getCheckDirty($this->formSpec[F_TABLE_NAME], $recordId, $recordDirty, $msg);
            if (($rcLockFound == LOCK_FOUND_CONFLICT || $rcLockFound == LOCK_FOUND_OWNER) && $recordDirty[F_DIRTY_MODE] == DIRTY_MODE_EXCLUSIVE) {
                $this->formSpec[F_MODE] = F_MODE_READONLY;
            }
        }

345
        if ($formMode === FORM_DELETE) {
346
347
348
349
350
351
352
353

            $build = new Delete();

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

            switch ($this->formSpec['render']) {
                case 'plain':
354
                    $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
355
356
                    break;
                case 'table':
357
                    $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
358
359
                    break;
                case 'bootstrap':
360
                    $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
361
362
363
364
                    break;
                default:
                    throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
            }
365
366
        }

367
        $formAction = new FormAction($this->formSpec, $this->dbArray[$this->dbIndexQfq], $this->phpUnit);
368
        switch ($formMode) {
369
            case FORM_LOAD:
370
371
372
373
374
375
376
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
                $data = $build->process($formMode);
                $data = Support::wrapTag("<div class='" . 'col-md-' . $this->formSpec[F_BS_COLUMNS] . "'>", $data);
                $data = Support::wrapTag("<div class='row'>", $data);
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
                break;

Carsten  Rose's avatar
Carsten Rose committed
377
            case FORM_UPDATE:
378
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
379
380
                // data['form-update']=....
                $data = $build->process($formMode);
381
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
382
                break;
Carsten  Rose's avatar
Carsten Rose committed
383

384
385
386
387
388
389
390
391
            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;

392
            case FORM_SAVE:
393
394
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

395
                // Action: Before
396
397
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

401
                // SAVE
402
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->feSpecNativeRaw);
403
404
405

                $save->processAllImageCutFE();

406
407
                $rc = $save->process();

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

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

413
                // Action: After
414
415
                $status = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
416
                    // Reload fresh saved record and fill STORE_RECORD with it.
417
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
418
                }
419

Carsten  Rose's avatar
Carsten Rose committed
420
421
422
423
424
425
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

426
427
428
429
430
431
432

                $customForward = $this->setForwardModePage();

                // Logic: If a) r=0 and
                //           b) User presses only 'save' (not save & close) and
                //           c) there is no forwardMode=='url...'
                // then the client should reload the current page with the newly created record. A new SIP is necessary!
433
                $getJson = true;
434
435
436
437
438
                if (0 == $this->store->getVar(SIP_RECORD_ID, STORE_SIP) &&
                    API_SUBMIT_REASON_SAVE == $this->store->getVar(API_SUBMIT_REASON, STORE_CLIENT . STORE_EMPTY, SANITIZE_ALLOW_ALNUMX) &&
                    $customForward == false
                ) {
                    $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
439
                    $getJson = false;
440
                }
441

442
                if ($getJson) {
443

444
445
                    // Values of FormElements might be changed during 'afterSave': rebuild the form to load the new values. Especially for non primary template groups.
//                    $this->loadFormSpecification($formMode, $recordId, $foundInStore);
446
447
448
449
                    $feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec[F_ID]], $this->formSpec);
                    $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);
                    $feSpecNative = HelperFormElement::setLanguage($feSpecNative, $parameterLanguageFieldName);
                    $this->feSpecNative = HelperFormElement::setFeContainerFormElementId($feSpecNative, $this->formSpec[F_ID], $recordId);
450

451
452
                    // Retrieve FE Values as JSON
                    // $data['form-update']=...
453
                    // $data = $build->process($formMode, $htmlElementNameIdZero);
454
                    $data = $build->process($formMode, false, $this->feSpecNative);
455
                }
456

457
                break;
Carsten  Rose's avatar
Carsten Rose committed
458

459
460
461
462
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

463
        if (is_array($data)) {
464
            // $data['element-update']=...
465
466
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
467

Carsten  Rose's avatar
Carsten Rose committed
468
        return $data;
469
470
    }

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
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

    /**
     * Check if forwardMode='url...'.
     * yes: process 'forwardPage' and fill $this->formSpec[F_FORWARD_MODE] and $this->formSpec[F_FORWARD_PAGE]
     * no: do nothing
     *
     * '$this->formSpec[F_FORWARD_PAGE]' might give a new forwardMode. If so, set $this->formSpec[F_FORWARD_MODE] to
     * it.
     *
     * '$this->formSpec[F_FORWARD_PAGE]':
     * a) url     http://www.nzz.ch/index.html?a=123#bottom, website.html?a=123#bottom,
     *            ?<T3 Alias pageid>&a=123#bottom, ?id=<T3 page id>&a=123#bottom
     * b) mode      no|client|url|...
     * c) mode|url  combination of above
     *
     * @return bool  TRUE if F_FORWARD_MODE = 'url..', else FALSE
     *
     * @throws UserFormException
     */
    private function setForwardModePage() {

        if ('url' != substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
            return false;
        }

        $forwardPageTmp = $this->eval->parse($this->formSpec[F_FORWARD_PAGE]);

        // Format: [mode/url][|url]
        $forwardArray = explode('|', $forwardPageTmp, 2);
        $forward = trim($forwardArray[0]);
        switch ($forward) {

            case F_FORWARD_MODE_CLIENT:
            case F_FORWARD_MODE_NO:
            case F_FORWARD_MODE_URL:
            case F_FORWARD_MODE_URL_SKIP_HISTORY:
            case F_FORWARD_MODE_URL_SIP:
                $this->formSpec[F_FORWARD_MODE] = $forward;
                if (isset($forwardArray[1])) {
                    $this->formSpec[F_FORWARD_PAGE] = trim($forwardArray[1]);
                } else {
                    $this->formSpec[F_FORWARD_PAGE] = '';
                }
                break;

            default:
                $this->formSpec[F_FORWARD_PAGE] = $forward;
                break;
        }

        if ('url' == substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
            if ($this->formSpec[F_FORWARD_PAGE] == '') {
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_CLIENT;
                $customForward = false;
            } else {
                $customForward = true;
            }

        } else {
            $customForward = false;
        }

        return $customForward;

    }

Carsten  Rose's avatar
Carsten Rose committed
537
538
539
    /**
     * Iterate over all Clipboard source records and fire for each all FE.type=paste records.
     *
Carsten  Rose's avatar
Carsten Rose committed
540
     * @param int $formId
Carsten  Rose's avatar
Carsten Rose committed
541
     * @param FormAction $formAction
542
     *
Carsten  Rose's avatar
Carsten Rose committed
543
544
545
546
547
548
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    private function pasteClipboard($formId, FormAction $formAction) {

549
550
551
552
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
553
554
555
556
557
558
559
        $cookieQfq = $this->store->getVar(CLIENT_COOKIE_QFQ, STORE_CLIENT, SANITIZE_ALLOW_ALNUMX);
        if ($cookieQfq === false || $cookieQfq == '') {
            throw new UserFormException('Qfq Session missing', ERROR_QFQ_SESSION_MISSING);
        }

        # select clipboard records
        $sql = "SELECT c.idSrc as id, c.xId FROM Clipboard AS c WHERE c.cookie='$cookieQfq' AND c.formIdPaste=$formId ORDER BY c.id";
560
        $arrClipboard = $this->dbArray[$this->dbIndexQfq]->sql($sql);
Carsten  Rose's avatar
Carsten Rose committed
561
562
563
564
565
566
567
568

        // Process clipboard records.
        foreach ($arrClipboard AS $srcIdRecord) {
            $formAction->doAllFormElementPaste($this->feSpecAction, $this->formSpec[F_TABLE_NAME], $this->formSpec[F_TABLE_NAME], "", $srcIdRecord);
        }

    } # doClipboard()

569
570
571
572
573
574
575
576
577
578
    /**
     * @return bool  true if there is at least one paste record, else false.
     */
    private function isPasteRecord() {

        foreach ($this->feSpecAction as $formElement) {
            if ($formElement[FE_TYPE] == FE_TYPE_PASTE) {
                return true;
            }
        }
579

580
581
582
583
        return false;

    }

584
585
586
587
588
    /**
     * Set F_FORWARD_MODE to  F_FORWARD_MODE_PAGE and builds a redirection URL to the current page with the already
     * used parameters. Do this by building a new SIP with the new recordId.
     *
     * @param array $formSpec
Carsten  Rose's avatar
Carsten Rose committed
589
     * @param int $recordId
590
     *
591
592
593
594
595
596
     * @return array
     * @throws CodeException
     * @throws UserFormException
     */
    private function buildNSetReloadUrl(array $formSpec, $recordId) {

597
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614

        // Rebuild original URL
        $storeT3 = $this->store->getStore(STORE_TYPO3);
        $storeT3['id'] = $storeT3[TYPO3_PAGE_ID];
        $storeT3 = OnArray::getArrayItems($storeT3, ['id', TYPO3_PAGE_TYPE, TYPO3_PAGE_LANGUAGE], true, true);

        $arr = KeyValueStringParser::parse($this->store->getVar(SIP_URLPARAM, STORE_SIP), '=', '&');
        $arr[SIP_RECORD_ID] = $recordId;
        $arr = array_merge($storeT3, $arr);
        $queryString = KeyValueStringParser::unparse($arr, '=', '&');

        $formSpec[F_FORWARD_PAGE] = store::getSipInstance()->queryStringToSip($queryString, RETURN_URL);

        return $formSpec;

    }

615
    /**
616
     * Load form. Evaluates form. Load FormElements.
617
     *
Carsten  Rose's avatar
Carsten Rose committed
618
     * After processing:
619
620
621
622
     * 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
623
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
624
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
625
     * @param string $foundInStore
626
     *
Carsten  Rose's avatar
Carsten Rose committed
627
628
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
629
     * @throws DbException
630
     * @throws UserFormException
631
     */
632
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
633

634
        // formName
Carsten  Rose's avatar
Carsten Rose committed
635
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
636
637
            return false;
        }
638

639
640
        if (!$this->dbArray[$this->dbIndexQfq]->existTable(TABLE_NAME_FORM)) {
            throw new UserFormException("Table '" . TABLE_NAME_FORM . "' not found", ERROR_MISSING_TABLE);
641
642
        }

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

646
647
648
649
650
651
652
        // 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);
        }

653
        // Load form
654
        $constant = F_NAME; // PhpStorm complains if the constant is directly defined in the string below
655
        $form = $this->dbArray[$this->dbIndexQfq]->sql("SELECT * FROM Form AS f WHERE f.$constant LIKE ? AND f.deleted='no'", ROW_EXPECT_1,
656
            [$formName], 'Form "' . $formName . '" not found or multiple forms with the same name.');
657

658
        $form = $this->modeCleanFormConfig($mode, $form);
659

Carsten  Rose's avatar
Carsten Rose committed
660
661
662
663
        // Save specific elements to be expanded later.
        $parseLater = OnArray::getArrayItems($form, [F_FORWARD_PAGE]);
        $form[F_FORWARD_PAGE] = '';

664
665
666
667
668
669
670
        HelperFormElement::explodeParameter($form, F_PARAMETER);
        unset($form[F_PARAMETER]);
        if (isset($form[FE_FILL_STORE_VAR])) {
            $fillStoreVar = $form[FE_FILL_STORE_VAR];
            unset($form[FE_FILL_STORE_VAR]);
        }

671
672
673
674
        // this is needed for filling templateGroup records with their default values
        // and for evaluating variables in the Form title
        $this->fillStoreWithRecord($form[F_TABLE_NAME], $recordId, STORE_RECORD);

675
        $formSpec = $this->eval->parseArray($form);
676

677
        // Setting defaults later is too late.
678
679
        if (!isset($formSpec[F_DB_INDEX])) {
            $formSpec[F_DB_INDEX] = $this->dbIndexData;
680
681
682
        }

        // Some forms load/save the form data on extra defined databases.
683
684
685
        if ($this->dbIndexData != $formSpec[F_DB_INDEX]) {
            if (!isset($this->dbArray[$formSpec[F_DB_INDEX]])) {
                $this->dbArray[$formSpec[F_DB_INDEX]] = new Database($formSpec[F_DB_INDEX]);
686
            }
687
            $this->dbIndexData = $formSpec[F_DB_INDEX];
688
689
        }

690
691
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);
        $formSpec = HelperFormElement::setLanguage($formSpec, $parameterLanguageFieldName);
692

693
694
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
695

Carsten  Rose's avatar
Carsten Rose committed
696
697
        $formSpec = array_merge($formSpec, $parseLater);

698
        // Set F_FINAL_DELETE_FORM
699
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
700

701
702
703
704
        // Fire FE_FILL_STORE_VAR after the primary form record has been loaded
        if (!empty($fillStoreVar)) {
            $rows = $this->eval->parse($fillStoreVar);
            if (is_array($rows)) {
705
                $this->store->appendToStore($rows[0], STORE_VAR);
706
707
708
709
710
711
712
713
            } else {
                if (!empty($rows)) {
                    throw new UserFormException("Invalid statement for '" . FE_FILL_STORE_VAR . "': " . $formSpec[FE_FILL_STORE_VAR], ERROR_INVALID_OR_MISSING_PARAMETER);
                }
            }
        }

        $this->formSpec = $formSpec;
714

Carsten  Rose's avatar
Carsten Rose committed
715
        // Clear
716
717
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

718
719
720
        // Read all 'active' FE
        $this->feSpecNativeRaw = $this->dbArray[$this->dbIndexQfq]->sql(SQL_FORM_ELEMENT_RAW, ROW_REGULAR, [$this->formSpec["id"]]);

721
        // FE: Action
722
        $this->feSpecAction = $this->dbArray[$this->dbIndexQfq]->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
723
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
724
725

        // FE: Native & Container
726
        // "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";
727
        $feSpecNative = array();
728
729
        switch ($mode) {
            case FORM_LOAD:
730
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
731
                $feSpecNative = $this->dbArray[$this->dbIndexQfq]->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
732
733
734
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
735
            case FORM_UPDATE:
736
            $feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec[F_ID]], $this->formSpec);
737
738
                break;

739
740
741
742
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

743
            default:
744
                break;
745
746
        }

747
        $this->feSpecNative = HelperFormElement::setLanguage($feSpecNative, $parameterLanguageFieldName);
748
        $this->feSpecNative = HelperFormElement::setFeContainerFormElementId($this->feSpecNative, $this->formSpec[F_ID], $recordId);
749

750
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
751
752
    }

753
754
    /**
     * Depending on $sql reads FormElements to a specific container or all. Preprocess all FormElements.
755
756
757
     * This code is dirty: the nearly same function exists in class 'Database' - the difference is only
     * 'explodeTemplateGroupElements()'.
     *
Carsten  Rose's avatar
Carsten Rose committed
758
759
760
     * @param string $sql SQL_FORM_ELEMENT_SPECIFIC_CONTAINER | SQL_FORM_ELEMENT_ALL_CONTAINER
     * @param array $param Parameter which matches the prepared statement in $sql
     * @param array $formSpec Main FormSpec to copy generic parameter to FormElements
761
762
763
764
765
766
767
     *
     * @return array|int
     * @throws \qfq\CodeException
     * @throws \qfq\DbException
     */
    public function getNativeFormElements($sql, array $param, $formSpec) {

768
        $feSpecNative = $this->dbArray[$this->dbIndexQfq]->sql($sql, ROW_REGULAR, $param);
769

770
771
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);

772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
        // Explode and Do $FormElement.parameter
        HelperFormElement::explodeParameterInArrayElements($feSpecNative, FE_PARAMETER);

        // Check for retype FormElements which have to duplicated.
        $feSpecNative = HelperFormElement::duplicateRetypeElements($feSpecNative);

        // Check for templateGroup Elements to explode them
        $feSpecNative = $this->explodeTemplateGroupElements($feSpecNative);

        // Copy Attributes to FormElements
        $feSpecNative = HelperFormElement::copyAttributesToFormElements($formSpec, $feSpecNative);

        return $feSpecNative;
    }

    /**
788
789
790
     * Iterate over all FormElements in $elements. If a row has a column NAME_TG_COPIES, copy those elements
     * NAME_TG_COPIES-times. Adjust FE_TEMPLATE_GROUP_NAME_PATTERN (='%d') with current count on column FE_NAME and
     * FE_LABEL.
791
     *
792
793
794
     * This code is dirty: only to get JSON value, we have to initialize the STORE_RECORD (done earlier) to be capable
     * to parse fe[FE_VALUE], which probably contains as string like '{{!SELECT value FROM table WHERE xId={{id}} ORDER
     * BY id}}' - the {{id}} needs to be replaced by the current recordId (primary record).
795
796
797
798
     *
     * Attention: The resulting order of the FormElements, is not the same as on the Form during FormLoad!
     *
     * @param array $elements
799
     *
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
     * @return array
     */
    private function explodeTemplateGroupElements(array $elements) {
        $new = array();

        // No FormElements or no NAME_TG_COPIES column: nothing to do, return.
        if ($elements == array() || count($elements) == 0 || !isset($elements[0][NAME_TG_COPIES])) {
            return $elements;
        }

        // Iterate over all
        foreach ($elements as $row) {
            if (isset($row[NAME_TG_COPIES]) && $row[NAME_TG_COPIES] > 0) {
                $row[FE_VALUE] = $this->eval->parse($row[FE_VALUE]);
                for ($ii = 1; $ii <= $row[NAME_TG_COPIES]; $ii++) {
                    $tmpRow = $row;
                    if (is_array($row[FE_VALUE])) {
                        $tmpRow[FE_VALUE] = ($ii <= count($row[FE_VALUE])) ? current($row[FE_VALUE][$ii - 1]) : '';
                    }
                    unset($tmpRow[NAME_TG_COPIES]);
                    $tmpRow[FE_NAME] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $tmpRow[FE_NAME]);
                    $tmpRow[FE_LABEL] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $tmpRow[FE_LABEL]);
822
                    $tmpRow[FE_TG_INDEX] = $ii;
823
824
825
826
827
828
                    $new[] = $tmpRow;
                }
            } else {
                $new[] = $row;
            }
        }
829

830
831
832
833
        return $new;
    }


Carsten  Rose's avatar
Carsten Rose committed
834
    /**
835
836
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
837
838
839
840
     * 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
841
842
843
     *   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
844
845
846
847
848
     *
     * FORM_SAVE:
     *   Specified in SIP
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
849
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
850
     * @param string $foundInStore
851
     *
852
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
853
     * @throws CodeException
854
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
855
     */
856
    public function getFormName($mode, &$foundInStore = '') {
857
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
858

Carsten  Rose's avatar
Carsten Rose committed
859
860
861
862
863
864
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
865
866
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
867
868
869
870
871
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

875
876
        // If the formname is empty or if 'form' has not been found in any store: no form.
        if ($formName === '' || $foundInStore === '') {
877
878
            return false;
        }
879

880
        return $formName;
881
    }
Carsten  Rose's avatar
Carsten Rose committed
882

883
884
885
886
    /**
     * Depending on $mode various formSpec fields might be adjusted.
     * E.g.: the form title is not important during a delete.
     *
887
     * @param string $mode
Carsten  Rose's avatar
Carsten Rose committed
888
     * @param array $form
889
     *
890
891
     * @return array
     */
892
    private function modeCleanFormConfig($mode, array $form) {
893
894
895
896
897
898
899
900
901

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

902
903
904
905
        if (isset($form[F_ESCAPE_TYPE_DEFAULT]) && $form[F_ESCAPE_TYPE_DEFAULT] == TOKEN_ESCAPE_CONFIG) {
            $form[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(SYSTEM_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

906
907
908
        return $form;
    }

909
    /**
910
911
912
913
914
     * 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
915
     * corresponding input field.
916
     *
917
     * @param array $formSpec
918
     *
919
920
     * @return array
     */
921
922
    private function syncSystemFormConfig(array $formSpec) {

923
924
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
925
926
927
928
929
930
931
932
933
            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,
934
            F_BUTTON_ON_CHANGE_CLASS,
935
            F_ESCAPE_TYPE_DEFAULT,
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
            F_SAVE_BUTTON_TEXT,
            F_SAVE_BUTTON_TOOLTIP,
            F_SAVE_BUTTON_CLASS,
            F_SAVE_BUTTON_GLYPH_ICON,

            F_CLOSE_BUTTON_TEXT,
            F_CLOSE_BUTTON_TOOLTIP,
            F_CLOSE_BUTTON_CLASS,
            F_CLOSE_BUTTON_GLYPH_ICON,

            F_DELETE_BUTTON_TEXT,
            F_DELETE_BUTTON_TOOLTIP,
            F_DELETE_BUTTON_CLASS,
            F_DELETE_BUTTON_GLYPH_ICON,

            F_NEW_BUTTON_TEXT,
            F_NEW_BUTTON_TOOLTIP,
            F_NEW_BUTTON_CLASS,
            F_NEW_BUTTON_GLYPH_ICON,

956
957
            F_RECORD_LOCK_TIMEOUT_SECONDS,

958
            FE_INPUT_EXTRA_BUTTON_INFO_CLASS,
959
960
961
962
        ];

        // 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.
963
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
964
965
966
967
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
968

969
        foreach ($keys as $key) {
970

971
972
973
974
975
976
977
            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);
            }
        }
978

979
980
        return $formSpec;
    }
981

982
983
984
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
985
     * @param array $formSpec
986
     *
987
988
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
989
    private function initForm(array $formSpec) {
Elias Villiger's avatar