QuickFormQuery.php 62.2 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
require_once(__DIR__ . '/store/Store.php');
26
require_once(__DIR__ . '/store/Sip.php');
27
28
29
30
31
32
33
34
35
36
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');
37
38
require_once(__DIR__ . '/database/Database.php');
require_once(__DIR__ . '/database/DatabaseUpdate.php');
39
40
41
42
43
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');
44
require_once(__DIR__ . '/report/Monitor.php');
45
46
require_once(__DIR__ . '/BodytextParser.php');
require_once(__DIR__ . '/Delete.php');
47
require_once(__DIR__ . '/form/FormAction.php');
Carsten  Rose's avatar
Carsten Rose committed
48
require_once(__DIR__ . '/form/Dirty.php');
49
require_once(__DIR__ . '/form/DragAndDrop.php');
50
51
52
53
54
55
56
57
58
59
60
61
/*
 * 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
62
/**
63
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
64
65
 * @package qfq
 */
66
class QuickFormQuery {
67

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

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

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

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

92
93
94
    /**
     * @var bool
     */
95
96
    private $phpUnit = false;

97
98
99
100
101
    /**
     * @var Session
     */
    private $session = null;

102
103
104
    private $dbIndexData = false;
    private $dbIndexQfq = false;

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

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

133
134
        $this->phpUnit = $phpUnit;

135
        mb_internal_encoding("UTF-8");
136

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

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");
Carsten  Rose's avatar
Carsten Rose committed
143
144
        // PHPExcel
        set_include_path(get_include_path() . PATH_SEPARATOR . '../../Resources/Private/Classes/');
145

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

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

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

158
159
        $this->t3data = $t3data;

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

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

165
166
        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);
167

168
        $this->dbArray[$this->dbIndexData] = new Database($this->dbIndexData);
169
170
171
172

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

173
174
        if ($this->dbIndexData != $this->dbIndexQfq) {
            $this->dbArray[$this->dbIndexQfq] = new Database($this->dbIndexQfq);
175
176

            $dbName = $this->dbArray[$this->dbIndexQfq]->getDbName();
177
        }
178
179
        $this->store->setVar(SYSTEM_DB_NAME_QFQ, $dbName, STORE_SYSTEM);

180

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

183
        $dbUpdate = $this->store->getVar(SYSTEM_DB_UPDATE, STORE_SYSTEM);
184
        $updateDb = new DatabaseUpdate($this->dbArray[$this->dbIndexQfq]);
185
        $updateDb->checkNupdate($dbUpdate);
186

187
        $this->store->StoreSystemUpdate(); // Do this after the DB-update
188
189
190
191
192
193

        // 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
194
195
    }

196
    /**
197
     * Returns the defined forwardMode and set forwardPage
198
     *
199
     * @return array
200
201
     * @throws CodeException
     * @throws UserFormException
202
     */
203
204
    public function getForwardMode() {

205
        $forwardPage = $this->formSpec[F_FORWARD_PAGE];
206

Carsten  Rose's avatar
Carsten Rose committed
207
208
209
210
        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.
211
            // 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
212
213
214
            $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_URL_SKIP_HISTORY;
        }

215
216
        return ([
            API_REDIRECT => $this->formSpec[F_FORWARD_MODE],
Carsten  Rose's avatar
Carsten Rose committed
217
            API_REDIRECT_URL => $forwardPage,
218
        ]);
219
220
    }

221
    /**
Carsten  Rose's avatar
Carsten Rose committed
222
     * Main entrypoint for display content: a) form and/or b) report
223
     *
224
     * @return string
225
226
     * @throws CodeException
     * @throws DbException
227
     * @throws DownloadException
228
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
229
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
230
     */
231
    public function process() {
232
        $html = '';
233

234
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
235
236
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
237
238
239
        }

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

242
        // 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
243
244
245
246
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

247
248
249
250
251
        // Only needed if there are 'drag and drop' elements.
        if ($this->store->getVar(SYSTEM_DRAG_AND_DROP_JS, STORE_SYSTEM) == 'true') {
            $html .= $this->getDragAndDropCode();
        }

252
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
253
        if ($class) {
254
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
255
256
        }

257
        return $html;
258
259
    }

260
261
    /**
     * Determine the name of the language parameter field, which has to be taken to fill language specific defintions.
262
263
264
     *
     * @throws CodeException
     * @throws UserFormException
265
266
267
268
269
270
271
272
273
     */
    private function setParameterLanguageFieldName() {

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

        foreach (['A', 'B', 'C', 'D'] as $key) {
274
            $languageIdx = SYSTEM_FORM_LANGUAGE . "$key" . "Id";
275
276
277
278
279
280
281
            if ($this->store->getVar($languageIdx, STORE_SYSTEM) == $typo3PageLanguage) {
                $this->store->setVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, 'parameterLanguage' . $key, STORE_SYSTEM);
                break;
            }
        }
    }

282
    /**
283
284
     * Creates an empty file. This indicates that the current form is in debug mode. Returns HTML element which will be
     * replaced by the logfile.
285
286
287
288
289
290
291
292
293
294
295
     *
     * @param $formName
     * @param $formLogMode
     * @return
     * @throws CodeException
     * @throws UserFormException
     * @throws UserReportException
     */
    private function getFormLog($formName, $formLogMode) {

        $formLogFileName = Support::getFormLogFileName($formName, $formLogMode);
296
        file_put_contents($formLogFileName, '');
297

298
299
        $monitor = new Monitor();

300
301
        return "<pre id='" . FORM_LOG_HTML_ID . "'>Please wait</pre>" .
            $monitor->process([TOKEN_L_FILE => $formLogFileName, TOKEN_L_APPEND => '1', TOKEN_L_HTML_ID => FORM_LOG_HTML_ID]);
302
    }
303

304
    /**
305
     * Process form.
306
307
308
309
310
     * $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:
311
     *
312
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
313
     *
314
     * @return array|string
315
     * @throws CodeException
316
     * @throws DbException
317
     * @throws DownloadException
318
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
319
     * @throws UserReportException
320
     */
321
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
322
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
323
        $foundInStore = '';
324
        $flagApiStructureReGroup=true;
325

Carsten  Rose's avatar
Carsten Rose committed
326
        // Fill STORE_FORM
327
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
328
            $fillStoreForm = new FillStoreForm();
329
            $fillStoreForm->process($formMode);
Carsten  Rose's avatar
Carsten Rose committed
330
        }
331

332
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO);
333
        $this->setParameterLanguageFieldName();
334

335
336
337
        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore, $formLogMode);
        if ($formName !== false && $formLogMode !== false) {
            return $this->getFormLog($formName, $formLogMode);
338
339
        }

340
        if ($formName === false) {
341
            switch ($formMode) {
342
343
344
345
346
347
348
                case FORM_DELETE:
                    break;
                case FORM_DRAG_AND_DROP:
                    throw new CodeException('Missing form in SIP', ERROR_MISSING_FORM);
                default:
                    return '';// No form found: do nothing
            }
349
        }
350

351
352
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
353
            $sipFound = $this->validateForm($foundInStore, $formMode);
354
355

        } else {
356
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
357
358
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
359
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
360
            }
361

362
363
364
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
365
366
            $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.
367
368
369
370
371
372
373
374
375
376

            $tmpDbIndexData = $this->store->getVar(PARAM_DB_INDEX_DATA, STORE_SIP);
            if (!empty($tmpDbIndexData)) {
                $this->formSpec[F_DB_INDEX] = $tmpDbIndexData;
                if ($tmpDbIndexData != $this->dbIndexData) {
                    if (!isset($this->dbArray[$tmpDbIndexData])) {
                        $this->dbArray[$tmpDbIndexData] = new Database($tmpDbIndexData);
                    }
                }
            }
377
378
        }

379
380
        // 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.
381
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
382
383
            $this->store->createSipAfterFormLoad($formName);
        }
384

385
386
387
388
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

389
        // Check (and release) dirtyRecord.
Carsten  Rose's avatar
Carsten Rose committed
390
        if ($formMode === FORM_DELETE || $formMode === FORM_SAVE) {
391
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
Carsten  Rose's avatar
Carsten Rose committed
392

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

396
            // In case of a conflict, return immediately
Carsten  Rose's avatar
Carsten Rose committed
397
398
            if ($answer[API_STATUS] != API_ANSWER_STATUS_SUCCESS) {
                $answer[API_STATUS] = API_ANSWER_STATUS_ERROR;
399

400
401
                return $answer;
            }
Carsten  Rose's avatar
Carsten Rose committed
402
403
        }

404
405
        // FORM_LOAD: if there is an foreign exclusive record lock - show form in F_MODE_READONLY mode.
        if ($formMode === FORM_LOAD) {
406
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
407
408
409
410
411
412
413
            $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;
            }
        }

414
        if ($formMode === FORM_DELETE) {
415

416
            $build = new Delete($this->dbIndexData);
417
418

        } else {
419
            $tableDefinition = $this->dbArray[$this->dbIndexData]->getTableDefinition($this->formSpec[F_TABLE_NAME]);
420
            $this->store->fillStoreTableDefaultColumnType($tableDefinition);
421
422
423

            switch ($this->formSpec['render']) {
                case 'plain':
424
                    $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
425
426
                    break;
                case 'table':
427
                    $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
428
429
                    break;
                case 'bootstrap':
430
                    $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
431
432
433
434
                    break;
                default:
                    throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
            }
435
436
        }

437
        $formAction = new FormAction($this->formSpec, $this->dbArray[$this->dbIndexData], $this->phpUnit);
438
        switch ($formMode) {
439
            case FORM_LOAD:
440
441
442
443
444
445
446
                $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
447
            case FORM_UPDATE:
448
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
449
450
                // data['form-update']=....
                $data = $build->process($formMode);
451
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
452
                break;
Carsten  Rose's avatar
Carsten Rose committed
453

454
455
456
457
458
459
460
461
            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;

462
            case FORM_SAVE:
463
464
                $this->logFormSubmitRequest();

465
466
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

467
                // Action: Before
468
469
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

473
                // SAVE
474
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->feSpecNativeRaw);
475
476

                $save->processAllImageCutFE();
477
                $save->checkRequiredHidden();
478

479
480
                $rc = $save->process();

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

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

486
                // Action: After
487
488
                $status = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
489
                    // Reload fresh saved record and fill STORE_RECORD with it.
490
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
491
                }
492

Carsten  Rose's avatar
Carsten Rose committed
493
494
495
496
497
498
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

499
500
501
502
503
504
505

                $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!
506
                $getJson = true;
507
508
509
510
511
                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);
512
                    $getJson = false;
513
                }
514

515
                if ($getJson) {
516

517
518
                    // 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);
519
520
521
522
                    $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);
523

524
525
                    // Retrieve FE Values as JSON
                    // $data['form-update']=...
526
                    // $data = $build->process($formMode, $htmlElementNameIdZero);
527
                    $data = $build->process($formMode, false, $this->feSpecNative);
528
                }
529
                break;
530

531
532
533
            case FORM_DRAG_AND_DROP:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);

534
                $dragAndDrop = new DragAndDrop($this->formSpec);
535
536
                $data = $dragAndDrop->process();
                $flagApiStructureReGroup=false;
537
538

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

541
542
543
544
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

545
        if ($flagApiStructureReGroup && is_array($data)) {
546
            // $data['element-update']=...
547
548
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
549

Carsten  Rose's avatar
Carsten Rose committed
550
        return $data;
551
552
    }

553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
    /**
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    private function logFormSubmitRequest() {
        $formSubmitLogMode = $this->formSpec[F_FORM_SUBMIT_LOG_MODE] ??
            $this->store->getVar(SYSTEM_FORM_SUBMIT_LOG_MODE, STORE_SYSTEM, SANITIZE_ALLOW_ALNUMX);
        if ($formSubmitLogMode === FORM_SUBMIT_LOG_MODE_NONE) {
            return;
        }

        $formData = $_POST;
        unset($formData[CLIENT_SIP]);
        $formData = json_encode($formData, JSON_UNESCAPED_UNICODE);
        $clientIp = $_SERVER[CLIENT_REMOTE_ADDRESS];
        $userAgent = $_SERVER[CLIENT_HTTP_USER_AGENT];
        $sipData = json_encode($this->store->getStore(STORE_SIP), JSON_UNESCAPED_UNICODE);
        $formId = $this->formSpec[F_ID];
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
        $feUser = $this->store->getVar(TYPO3_FE_USER, STORE_TYPO3, SANITIZE_ALLOW_ALNUMX);
        $pageId = $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3, SANITIZE_ALLOW_ALNUMX);
        $sessionId = session_id();

        $sql = "INSERT INTO FormSubmitLog (formData, sipData, clientIp, feUser, userAgent, formId, recordId, pageId, sessionId, created)" .
        "VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, NOW())";
        $params = [$formData, $sipData, $clientIp, $feUser, $userAgent, $formId, $recordId, $pageId, $sessionId];
        $this->dbArray[$this->dbIndexQfq]->sql($sql, ROW_REGULAR, $params);
    }

583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599

    /**
     * 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
     *
Carsten  Rose's avatar
Carsten Rose committed
600
601
     * @throws CodeException
     * @throws DbException
602
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
603
     * @throws UserReportException
604
605
606
607
608
609
610
611
612
613
614
615
616
617
     */
    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) {

618
            case F_FORWARD_MODE_AUTO:
619
            case F_FORWARD_MODE_CLOSE:
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
            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] == '') {
639
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_AUTO;
640
641
642
643
644
645
646
647
648
649
650
651
652
                $customForward = false;
            } else {
                $customForward = true;
            }

        } else {
            $customForward = false;
        }

        return $customForward;

    }

Carsten  Rose's avatar
Carsten Rose committed
653
654
655
    /**
     * Iterate over all Clipboard source records and fire for each all FE.type=paste records.
     *
Carsten  Rose's avatar
Carsten Rose committed
656
     * @param int $formId
Carsten  Rose's avatar
Carsten Rose committed
657
     * @param FormAction $formAction
658
     *
Carsten  Rose's avatar
Carsten Rose committed
659
660
661
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
662
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
663
664
665
     */
    private function pasteClipboard($formId, FormAction $formAction) {

666
667
668
669
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
670
671
672
673
674
675
676
        $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";
677
        $arrClipboard = $this->dbArray[$this->dbIndexQfq]->sql($sql);
Carsten  Rose's avatar
Carsten Rose committed
678
679
680
681
682
683
684
685

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

    } # doClipboard()

686
687
688
689
690
691
692
693
694
695
    /**
     * @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;
            }
        }
696

697
698
699
700
        return false;

    }

701
702
703
704
705
    /**
     * 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
706
     * @param int $recordId
707
     *
708
709
710
711
712
713
     * @return array
     * @throws CodeException
     * @throws UserFormException
     */
    private function buildNSetReloadUrl(array $formSpec, $recordId) {

714
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731

        // 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;

    }

732
    /**
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
     * Checks if there is formLog mode active for FORM_LOG_SESSION or FORM_LOG_ALL.
     * If yes, set $form[FORM_LOG_FILE_SESSION] resp.  $form[FORM_LOG_FILE_ALL].
     * If the last action is older FORM_LOG_FILE_EXPIRE, the file will be deleted and formLog mode stops (disabled).
     *
     * @param array $form
     * @return array
     * @throws CodeException
     * @throws UserFormException
     * @throws UserReportException
     */
    private function checkFormLogMode(array $form) {

        $form[FORM_LOG_FILE_SESSION] = '';
        $form[FORM_LOG_FILE_ALL] = '';

        foreach ([FORM_LOG_SESSION, FORM_LOG_ALL] as $mode) {
            $file = Support::getFormLogFileName($form[F_NAME], $mode);
            if (false !== ($arr = stat($file))) {

                if (time() - $arr['mtime'] > FORM_LOG_FILE_EXPIRE) {
                    unlink($file);
                } else {
                    $form[FORM_LOG_FILE . '_' . $mode] = $file;
756
                    $form[FORM_LOG_ACTIVE] = 1;
757
758
759
760
761
762
763
                }
            }
        }

        return $form;
    }

764
    /**
765
766
     * Get form name
     * Check if the form is in log mode: set formLog and return
767
     * Load form. Evaluates form. Load FormElements.
768
     *
Carsten  Rose's avatar
Carsten Rose committed
769
     * After processing:
770
771
772
773
     * 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
774
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
775
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
776
     * @param string $foundInStore
777
     * @param string $formLogMode
Carsten  Rose's avatar
Carsten Rose committed
778
     * @return bool|string if found the formName, else 'false'.
779
     *
Carsten  Rose's avatar
Carsten Rose committed
780
     * @throws CodeException
781
     * @throws DbException
782
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
783
     * @throws UserReportException
784
     */
785
786
787
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '', &$formLogMode = '') {

        $formLogMode = false; // Important: if no form is found, formLogMode needs also to be false.
Carsten  Rose's avatar
Carsten Rose committed
788

789
        // formName
Carsten  Rose's avatar
Carsten Rose committed
790
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
791
792
            return false;
        }
793

794
795
796
797
        // Check for '_formLogMode'=logSession|logAll
        $formLogMode = $this->store::getVar(FORM_LOG_MODE, STORE_SIP);
        if ($formLogMode !== false) {
            return $formName; // fomLog: getting the formName is sufficient.
798
799
        }

800
801
        if (!$this->dbArray[$this->dbIndexQfq]->existTable(TABLE_NAME_FORM)) {
            throw new UserFormException("Table '" . TABLE_NAME_FORM . "' not found", ERROR_MISSING_TABLE);
802
803
        }

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

807
808
809
810
811
812
813
        // 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);
        }

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

819
        $form = $this->checkFormLogMode($form);
820
        $form = $this->modeCleanFormConfig($mode, $form);
821

Carsten  Rose's avatar
Carsten Rose committed
822
823
824
825
        // Save specific elements to be expanded later.
        $parseLater = OnArray::getArrayItems($form, [F_FORWARD_PAGE]);
        $form[F_FORWARD_PAGE] = '';

826
827
828
829
830
831
832
        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]);
        }

833
        // Setting defaults later is too late.
834
835
836
837
        if (empty($form[F_DB_INDEX])) {
            $form[F_DB_INDEX] = $this->dbIndexData;
        } else {
            $form[F_DB_INDEX] = $this->eval->parse($form[F_DB_INDEX]);
838
839
840
        }

        // Some forms load/save the form data on extra defined databases.
841
842
843
        if ($this->dbIndexData != $form[F_DB_INDEX]) {
            if (!isset($this->dbArray[$form[F_DB_INDEX]])) {
                $this->dbArray[$form[F_DB_INDEX]] = new Database($form[F_DB_INDEX]);
844
            }
845
846
847
848
            $this->dbIndexData = $form[F_DB_INDEX];

            unset($this->eval);
            $this->eval = new Evaluate($this->store, $this->dbArray[$this->dbIndexData]);
849
850
        }

851
852
853
854
855
856
        // 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);

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

857
858
        $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM);
        $formSpec = HelperFormElement::setLanguage($formSpec, $parameterLanguageFieldName);
859

860
        $formSpec = $this->syncSystemFormConfig($formSpec);
861
        $formSpec = $this->initForm($formSpec, $recordId);
862

Carsten  Rose's avatar
Carsten Rose committed
863
864
        $formSpec = array_merge($formSpec, $parseLater);

865
        // Set F_FINAL_DELETE_FORM
866
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
867

868
869
        // LOG
        !empty($form[FORM_LOG_ACTIVE]) && Logger::logFormLine($form, "F:$mode:evaluated:" . date('Y-m-d H:i:s'), $form, true);
870
871
872
873
874

        // 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)) {
875
                $this->store->appendToStore($rows[0], STORE_VAR);
876
877
                // LOG
                !empty($form[FORM_LOG_ACTIVE]) && Logger::logFormLine($form, "F:add to STORE_VAR", $rows[0]);
878
879
880
881
882
883
884
885
            } 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;
886

Carsten  Rose's avatar
Carsten Rose committed
887
        // Clear
888
889
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

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

893
        // FE: Action
894
        $this->feSpecAction = $this->dbArray[$this->dbIndexQfq]->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
895
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
896
897

        // FE: Native & Container
898
        // "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";
899
        $feSpecNative = array();
900
901
        switch ($mode) {
            case FORM_LOAD:
902
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
903
                $feSpecNative = $this->dbArray[$this->dbIndexQfq]->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
904
905
906
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
907
            case FORM_UPDATE:
908
                $feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec[F_ID]], $this->formSpec);
909
910
                break;

911
912
913
914
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

915
            default:
916
                break;
917
918
        }

919
        $this->feSpecNative = HelperFormElement::setLanguage($feSpecNative, $parameterLanguageFieldName);
920
        $this->feSpecNative = HelperFormElement::setFeContainerFormElementId($this->feSpecNative, $this->formSpec[F_ID], $recordId);
921

922
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
923
924
    }

925
926
    /**
     * Depending on $sql reads FormElements to a specific container or all. Preprocess all FormElements.
927
928
929
     * This code is dirty: the nearly same function exists in class 'Database' - the difference is only
     * 'explodeTemplateGroupElements()'.
     *
Carsten  Rose's avatar
Carsten Rose committed
930
931
932
     * @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
933
934
     *
     * @return array|int
935
936
937
938
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     * @throws UserReportException
939
940
941
     */
    public function getNativeFormElements($sql, array $param, $formSpec) {

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

944
945
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);