QuickFormQuery.php 83.4 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
 */

Marc Egger's avatar
Marc Egger committed
9
10
11
12
namespace IMATHUZH\Qfq\Core;

require __DIR__ . '/../../vendor/autoload.php';

13
14
15
16
17
use IMATHUZH\Qfq\Core\Database\Database;
use IMATHUZH\Qfq\Core\Database\DatabaseUpdate;
use IMATHUZH\Qfq\Core\Form\Dirty;
use IMATHUZH\Qfq\Core\Form\DragAndDrop;
use IMATHUZH\Qfq\Core\Form\FormAction;
Marc Egger's avatar
Marc Egger committed
18
use IMATHUZH\Qfq\Core\Form\FormAsFile;
Marc Egger's avatar
Marc Egger committed
19
use IMATHUZH\Qfq\Core\Helper\HelperFile;
20
21
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
Marc Egger's avatar
Marc Egger committed
22
23
24
use IMATHUZH\Qfq\Core\Helper\Logger;
use IMATHUZH\Qfq\Core\Helper\OnArray;
use IMATHUZH\Qfq\Core\Helper\Support;
25
26
use IMATHUZH\Qfq\Core\Report\Monitor;
use IMATHUZH\Qfq\Core\Report\Report;
Marc Egger's avatar
Marc Egger committed
27
28
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
use IMATHUZH\Qfq\Core\Store\Session;
29
30
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
Marc Egger's avatar
Marc Egger committed
31

32
33
34
35
36
37
38
39
40
41
42
43
/*
 * 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
44
/**
45
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
46
47
 * @package qfq
 */
48
class QuickFormQuery {
49

50
    /**
51
     * @var Store instantiated class
52
     */
Carsten  Rose's avatar
Carsten Rose committed
53
    protected $store = null;
54

55
    /**
Marc Egger's avatar
Marc Egger committed
56
     * @var Database[] - Array of Database instantiated class
57
     */
58
    protected $dbArray = array();
59

60
61
62
    /**
     * @var Evaluate instantiated class
     */
63
64
    protected $evaluate = null;

65
    protected $formSpec = array(); // Stores the form content after parsing SQL queries and QFQ syntax stored in form attributes
66
67
    protected $feSpecAction = array();  // Form Definition: copy of the loaded form
    protected $feSpecNative = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
68
    protected $feSpecNativeRaw = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
69

70
71
72
    /**
     * @var array
     */
73
    private $t3data = array(); // FormElement Definition: all formElement.class='native' of the loaded form
74

75
76
77
    /**
     * @var bool
     */
78
79
    private $phpUnit = false;

80
81
82
83
84
    /**
     * @var bool
     */
    private $inlineReport = false;

85
86
87
88
89
    /**
     * @var Session
     */
    private $session = null;

90
91
92
    private $dbIndexData = false;
    private $dbIndexQfq = false;

93
94
95
96
97
98
99
100
101
102
103
    /*
     * 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'
     */
104

105
106
107
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
108
109
     * 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.
110
     *
111
     * @param array $t3data
Carsten  Rose's avatar
Carsten Rose committed
112
     * @param bool $phpUnit
113
     * @param bool $inlineReport
114
     *
Marc Egger's avatar
Marc Egger committed
115
116
117
118
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
119
     */
120
    public function __construct(array $t3data = array(), $phpUnit = false, $inlineReport = true) {
121
122

        #TODO: rewrite $phpUnit to: "if (!defined('PHPUNIT_QFQ')) {...}"
123
        $this->phpUnit = $phpUnit;
124
        $this->inlineReport = $inlineReport;
125

126
        mb_internal_encoding("UTF-8");
127

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

130
        // Refresh the session even if no new data saved.
131
        Session::set(SESSION_LAST_ACTIVITY, time());
132

133
134
        Support::setQfqErrorHandler();

Carsten  Rose's avatar
Carsten Rose committed
135
136
        // PHPExcel
        set_include_path(get_include_path() . PATH_SEPARATOR . '../../Resources/Private/Classes/');
137

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

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

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

150
151
        $this->t3data = $t3data;

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

        $this->store = Store::getInstance($bodytext, $phpUnit);
155

156
157
158
        $timeout = $this->store::getVar(SYSTEM_SESSION_TIMEOUT_SECONDS, STORE_SYSTEM);
        Session::checkSessionExpired($timeout);

159
        // If an FE user logs out and a different user logs in (same browser session) - the old values has to be destroyed!
160
        if (Session::getAndDestroyFlagFeUserHasChanged()) {
161
162
163
            $this->store->unsetStore(STORE_USER);
        }

164
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
165

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

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

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

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

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

181
        $this->store->FillStoreSystemBySql(); // Do this after the DB-update
182
183
184

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

190
    /**
191
     * Returns the defined forwardMode and set forwardPage
192
     *
193
     * @return array
Marc Egger's avatar
Marc Egger committed
194
195
     * @throws \CodeException
     * @throws \UserFormException
196
     */
197
198
    public function getForwardMode() {

199
        if (!isset($this->formSpec[F_FORWARD_PAGE])) {
Carsten  Rose's avatar
Carsten Rose committed
200
            // For QFQ inline editing: no redirect and no further processing.
201
202
203
            return [API_REDIRECT => API_ANSWER_REDIRECT_NO, API_REDIRECT_URL => ''];
        }

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

206
207
208
209
210
211
212
213
214
215
216
217
218
219
        switch ($this->formSpec[F_FORWARD_MODE]) {
            case F_FORWARD_MODE_URL_SIP:
                $forwardPage = store::getSipInstance()->queryStringToSip($forwardPage, RETURN_URL);
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_URL;
                break;
            case F_FORWARD_MODE_URL_SIP_SKIP_HISTORY:
                // 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.
                // An option for better implementing would be to separate SKIP History from ForwardMode. For API, it can be combined again.
                $forwardPage = store::getSipInstance()->queryStringToSip($forwardPage, RETURN_URL);
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_URL_SKIP_HISTORY;
                break;
            default:
                break;
Carsten  Rose's avatar
Carsten Rose committed
220
221
        }

222
223
        return ([
            API_REDIRECT => $this->formSpec[F_FORWARD_MODE],
Carsten  Rose's avatar
Carsten Rose committed
224
            API_REDIRECT_URL => $forwardPage,
225
        ]);
226
227
    }

228
    /**
229
     * Main entry point to display content: a) form and/or b) report
230
     *
231
     * @return string
Marc Egger's avatar
Marc Egger committed
232
233
234
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
235
236
237
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
238
239
240
241
242
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Carsten Rose committed
243
     */
244
    public function process() {
245
        $html = '';
246

247
248
249
250
251
        $render = $this->store->getVar(SYSTEM_RENDER, STORE_TYPO3 . STORE_SYSTEM);
        if ($render == SYSTEM_RENDER_API && isset($GLOBALS['TYPO3_CONF_VARS'])) {
            return '';
        }

252
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
253
254
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
255
256
257
        }

        $html .= $this->doForm(FORM_LOAD);
258
259
260
        if ($render == SYSTEM_RENDER_BOTH || $render == SYSTEM_RENDER_API || ($render == SYSTEM_RENDER_SINGLE && $html == '')) {
            $html .= $this->doReport();
        }
Carsten  Rose's avatar
Carsten Rose committed
261

262
        // 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
263
264
265
266
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

267
268
269
270
271
        // Only needed if there are 'drag and drop' elements.
        if ($this->store->getVar(SYSTEM_DRAG_AND_DROP_JS, STORE_SYSTEM) == 'true') {
            $html .= $this->getDragAndDropCode();
        }

272
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
273
        if ($class) {
274
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
275
276
        }

277
        return $html;
278
279
    }

280
    /**
281
     * Determine the name of the language parameter field, which has to be taken to fill language specific definitions.
282
     *
Marc Egger's avatar
Marc Egger committed
283
284
     * @throws \CodeException
     * @throws \UserFormException
285
286
287
288
289
290
291
292
293
     */
    private function setParameterLanguageFieldName() {

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

        foreach (['A', 'B', 'C', 'D'] as $key) {
294
            $languageIdx = SYSTEM_FORM_LANGUAGE . "$key" . "Id";
295
296
297
298
299
300
301
            if ($this->store->getVar($languageIdx, STORE_SYSTEM) == $typo3PageLanguage) {
                $this->store->setVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, 'parameterLanguage' . $key, STORE_SYSTEM);
                break;
            }
        }
    }

302
    /**
303
304
     * Creates an empty file. This indicates that the current form is in debug mode. Returns HTML element which will be
     * replaced by the logfile.
305
306
307
     *
     * @param $formName
     * @param $formLogMode
308
     * @return string
Marc Egger's avatar
Marc Egger committed
309
310
311
     * @throws \CodeException
     * @throws \UserFormException
     * @throws \UserReportException
312
313
314
315
     */
    private function getFormLog($formName, $formLogMode) {

        $formLogFileName = Support::getFormLogFileName($formName, $formLogMode);
316
        file_put_contents($formLogFileName, '');
317

318
319
        $monitor = new Monitor();

320
321
        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]);
322
    }
323

324
    /**
325
     * Process form.
326
327
328
329
330
     * $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:
331
     *
332
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
333
     *
334
     * @return array|string
Marc Egger's avatar
Marc Egger committed
335
336
337
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
Carsten  Rose's avatar
Carsten Rose committed
338
339
340
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
341
342
343
344
345
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
346
     */
347
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
348
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
349
        $foundInStore = '';
350
        $flagApiStructureReGroup = true;
351
        $formModeNew = '';
352
        $build = null;
353

354
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO, SANITIZE_ALLOW_DIGIT, $foundInStore);
355
        $this->setParameterLanguageFieldName();
356

357
358
359
        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore, $formLogMode);
        if ($formName !== false && $formLogMode !== false) {
            return $this->getFormLog($formName, $formLogMode);
360
361
        }

362
        if ($formName === false) {
363
            switch ($formMode) {
364
                case FORM_DELETE:
365
                    $formModeNew = FORM_DELETE;
366
367
                    break;
                case FORM_DRAG_AND_DROP:
Marc Egger's avatar
Marc Egger committed
368
                    throw new \CodeException('Missing form in SIP', ERROR_MISSING_FORM);
369
370
371
                default:
                    return '';// No form found: do nothing
            }
372
        }
373

Carsten  Rose's avatar
Carsten Rose committed
374
        // Check 'session expire' happens quite late, cause it can be configured per form.
375
376
377
        if ($formName !== false) {
            Session::checkSessionExpired($this->formSpec[F_SESSION_TIMEOUT_SECONDS]);
        }
378

379
380
381
382
383
384
385
        // Fill STORE_FORM: might need Form.fillStoreVar={{!SELECT ...}}) to provide STORE_VAR - therefore the FORM-definition should already been processed. #8058
        switch ($formMode) {
            case FORM_UPDATE:
            case FORM_SAVE:
            case FORM_REST:
                $fillStoreForm = new FillStoreForm();
                $fillStoreForm->process($formMode);
386
387
388
389
390
391

                // STORE_TYPO3 has been filled: fire fillStoreVar again.
                if (!empty($this->formSpec[FE_FILL_STORE_VAR])) {
                    $this->fillStoreVar($this->formSpec[FE_FILL_STORE_VAR]);
                }

392
393
394
                break;
        }

395
        if ($formName !== false) {
Carsten  Rose's avatar
Carsten Rose committed
396
            // Validate (only if there is a 'real' form, not a FORM_DELETE with only a table name).
Carsten  Rose's avatar
Carsten Rose committed
397
398
            // Attention: $formModeNew will be set
            $sipFound = $this->validateForm($foundInStore, $formMode, $formModeNew);
399
400

        } else {
401
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
402
403
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
Marc Egger's avatar
Marc Egger committed
404
                throw new \UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
405
            }
406

407
408
409
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
410
411
            $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.
412
            $this->formSpec[F_PRIMARY_KEY] = F_PRIMARY_KEY_DEFAULT;
413
414
415
416
417
418
419
420
421
422

            $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);
                    }
                }
            }
423
424
        }

425
426
427
428
429
430
        // Make sure form file is writable (before DB changes are made)
        if (in_array($this->formSpec[F_TABLE_NAME], [TABLE_NAME_FORM, TABLE_NAME_FORM_ELEMENT])
            && in_array($formModeNew, [FORM_SAVE, FORM_DRAG_AND_DROP, FORM_DELETE])) {
            FormAsFile::enforceFormFileWritable($recordId, $this->dbArray[$this->dbIndexQfq]);
        }

431
432
        // 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.
433
434
435
436
        if ($formMode != FORM_REST) {
            if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
                $this->store->createSipAfterFormLoad($formName);
            }
437
        }
438

439
        // Fill STORE_BEFORE
440
        if ($formName !== false && $this->store->getVar($this->formSpec[F_PRIMARY_KEY], STORE_BEFORE) === false) {
441
            $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId,
442
                $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY], STORE_BEFORE);
443
444
        }

445
        // Check (and release) dirtyRecord.
Carsten  Rose's avatar
Carsten Rose committed
446
        if ($formModeNew === FORM_DELETE || $formModeNew === FORM_SAVE) {
447
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
Carsten  Rose's avatar
Carsten Rose committed
448

Carsten  Rose's avatar
Carsten Rose committed
449
            $answer = $dirty->checkDirtyAndRelease($formModeNew, $this->formSpec[F_RECORD_LOCK_TIMEOUT_SECONDS],
450
                $this->formSpec[F_DIRTY_MODE], $this->formSpec[F_TABLE_NAME], $this->formSpec[F_PRIMARY_KEY], $recordId, true);
451

452
            // In case of a conflict, return immediately
Carsten  Rose's avatar
Carsten Rose committed
453
454
            if ($answer[API_STATUS] != API_ANSWER_STATUS_SUCCESS) {
                $answer[API_STATUS] = API_ANSWER_STATUS_ERROR;
455

456
457
                return $answer;
            }
Carsten  Rose's avatar
Carsten Rose committed
458
459
        }

460
        // FORM_LOAD: if there is a foreign exclusive record lock - show form in F_MODE_READONLY mode.
Carsten  Rose's avatar
Carsten Rose committed
461
        if ($formModeNew === FORM_LOAD) {
462
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
463
464
465
            $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) {
466
                $this->formSpec[F_MODE_GLOBAL] = F_MODE_READONLY;
467
468
469
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
470
        switch ($formModeNew) {
471
472
473
474
475
476
477
478
479
            case FORM_DELETE:
                $build = new Delete($this->dbIndexData);
                break;
            case FORM_REST:
                break;
            case FORM_LOAD:
            case FORM_SAVE:
            case FORM_UPDATE:
            case FORM_DRAG_AND_DROP:
480

481
482
483
                $tableDefinition = $this->dbArray[$this->dbIndexData]->getTableDefinition($this->formSpec[F_TABLE_NAME]);
                $this->store->fillStoreTableDefaultColumnType($tableDefinition);

484
485
                // Check if the defined column primary key exist.
                if ($this->store::getVar($this->formSpec[F_PRIMARY_KEY], STORE_TABLE_COLUMN_TYPES) === false) {
486
                    throw new \UserFormException("Primary Key '" . $this->formSpec[F_PRIMARY_KEY] . "' not found in table " . $this->formSpec[F_TABLE_NAME], ERROR_INVALID_OR_MISSING_PARAMETER);
487
488
                }

489
490
491
492
493
494
495
496
497
498
499
                switch ($this->formSpec['render']) {
                    case 'plain':
                        $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
                        break;
                    case 'table':
                        $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
                        break;
                    case 'bootstrap':
                        $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->dbArray);
                        break;
                    default:
Marc Egger's avatar
Marc Egger committed
500
                        throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
501
502
503
                }
                break;
            default:
Marc Egger's avatar
Marc Egger committed
504
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
505
506
        }

507
        $formAction = new FormAction($this->formSpec, $this->dbArray[$this->dbIndexData], $this->phpUnit);
Carsten  Rose's avatar
Carsten Rose committed
508
        switch ($formModeNew) {
509
            case FORM_LOAD:
510
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
511
512

                // Build FORM
Carsten  Rose's avatar
Carsten Rose committed
513
                $data = $build->process($formModeNew);
514

515
516
517
518
                $tmpClass = is_numeric($this->formSpec[F_BS_COLUMNS]) ? ('col-md-' . $this->formSpec[F_BS_COLUMNS]) : $this->formSpec[F_BS_COLUMNS];
//                $data = Support::wrapTag("<div class='" . 'col-md-' . $this->formSpec[F_BS_COLUMNS] . "'>", $data);
                $data = Support::wrapTag('<div class="' . $tmpClass . '">', $data);
                $data = Support::wrapTag('<div class="row">', $data);
519
520
521
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
                break;

Carsten  Rose's avatar
Carsten Rose committed
522
            case FORM_UPDATE:
523
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
524
                // data['form-update']=....
Carsten  Rose's avatar
Carsten Rose committed
525
                $data = $build->process($formModeNew);
526
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
527
                break;
Carsten  Rose's avatar
Carsten Rose committed
528

529
530
531
            case FORM_DELETE:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_DELETE);

532
                $build->process($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
533
534
535
536

                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_DELETE);
                break;

537
            case FORM_SAVE:
538
539
                $this->logFormSubmitRequest();

Carsten  Rose's avatar
Carsten Rose committed
540
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3);
541

542
                // Action: Before
543
544
                $feTypeList = FE_TYPE_BEFORE_SAVE . ',' . ($recordId == 0 ? FE_TYPE_BEFORE_INSERT : FE_TYPE_BEFORE_UPDATE);
                $formAction->elements($recordId, $this->feSpecAction, $feTypeList);
545

546
                // If an old record exist: load it. Necessary to delete uploaded files which should be overwritten.
547
                $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId,
548
                    $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY]);
549

550
551
                $this->ifPillIsHiddenSetChildFeToHidden();

552
                // SAVE
553
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->feSpecNativeRaw);
554
555

                $save->processAllImageCutFE();
556
                $save->checkRequiredHidden();
557

558
559
                $rc = $save->process();

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

562
563
                // Action: After*, Sendmail
                $feTypeList = FE_TYPE_SENDMAIL . ',' . FE_TYPE_AFTER_SAVE . ',' . ($recordId == 0 ? FE_TYPE_AFTER_INSERT : FE_TYPE_AFTER_UPDATE);
564
                $status = $formAction->elements($rc, $this->feSpecAction, $feTypeList);
565
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
566
                    // Reload fresh saved record and fill STORE_RECORD with it.
567
                    $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY]);
568
                }
569

Carsten  Rose's avatar
Carsten Rose committed
570
571
572
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

Carsten  Rose's avatar
Carsten Rose committed
573
574
                if ($formMode == FORM_REST) {
                    $data = ['id' => $rc];
575
                    $flagApiStructureReGroup = false;
Carsten  Rose's avatar
Carsten Rose committed
576
577
                    break;
                }
578

579
                $this->setForwardModePage();
580
581

                // Logic: If a) r=0 and
582
                //           b) final: (forwardMode=='auto' and User presses only 'save' (not 'save & close')) OR (forwardMode=='no')
583
                // then the client should reload the current page with the newly created record. A new SIP is necessary!
584
                $getJson = true;
585
586
587
588
                if (0 == $this->store->getVar(SIP_RECORD_ID, STORE_SIP)
                    && (($this->formSpec[F_FORWARD_MODE] == F_FORWARD_MODE_AUTO
                            && API_SUBMIT_REASON_SAVE == $this->store->getVar(API_SUBMIT_REASON, STORE_CLIENT . STORE_EMPTY, SANITIZE_ALLOW_ALNUMX)
                        ) || $this->formSpec[F_FORWARD_MODE] == F_FORWARD_MODE_NO)) {
589
                    $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
590
                    $getJson = false;
591
                }
592

593
                if ($getJson) {
594

595
                    // Values of FormElements might be changed during 'afterSave': rebuild the form to load the new values. Especially for non primary template groups.
596
597
598
599
                    $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);
600

Carsten  Rose's avatar
Carsten Rose committed
601
                    $data = $build->process($formModeNew, false, $this->feSpecNative);
602
                }
603
                break;
604

605
606
607
            case FORM_DRAG_AND_DROP:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);

608
                $dragAndDrop = new DragAndDrop($this->formSpec);
609
                $data = $dragAndDrop->process();
610
                $flagApiStructureReGroup = false;
611
612

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

615
            case FORM_REST:
616
                $flagApiStructureReGroup = false;
617
                $data = $this->doRestGet();
618
619
                break;

620
            default:
Marc Egger's avatar
Marc Egger committed
621
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
622
623
        }

624
        if ($flagApiStructureReGroup && is_array($data)) {
625
            // $data['element-update']=...
626
627
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
628

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
        // export Form to file, if loaded record is a Form/FormElement
        switch ($formModeNew) {
            case FORM_SAVE:
            case FORM_DRAG_AND_DROP:
                if (TABLE_NAME_FORM === $this->formSpec[F_TABLE_NAME]) {
                    FormAsFile::exportFormWithId($recordId, $this->dbArray[$this->dbIndexQfq]);
                } elseif (TABLE_NAME_FORM_ELEMENT === $this->formSpec[F_TABLE_NAME]) {
                    FormAsFile::exportFormElementWithId($recordId, $this->dbArray[$this->dbIndexQfq]);
                }
                break;
            case FORM_DELETE:
                if (TABLE_NAME_FORM === $this->formSpec[F_TABLE_NAME]) {
                    // TODO: delete form file
                } elseif (TABLE_NAME_FORM_ELEMENT === $this->formSpec[F_TABLE_NAME]) {
                    // TODO: find out the formId of the FormElement. should be in store. Or save it in a variable earlier.
                    // TODO: export Form
                }

        }

Carsten  Rose's avatar
Carsten Rose committed
649
        return $data;
650
651
    }

652
653
    /**
     * @return array
Marc Egger's avatar
Marc Egger committed
654
655
656
657
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
658
     */
659
    private function doRestGet() {
660

Carsten  Rose's avatar
Carsten Rose committed
661
        $this->nameGenericRestParam();
662
663
664
665

        $r = $this->store::getVar(TYPO3_RECORD_ID, STORE_TYPO3);
        $key = empty($r) ? F_REST_SQL_LIST : F_REST_SQL_DATA;

666
        if (!isset($this->formSpec[$key])) {
Marc Egger's avatar
Marc Egger committed
667
            throw new \UserFormException("Missing Parameter '$key'", ERROR_INVALID_VALUE);
668
669
670
671
672
673
        }

        return $this->evaluate->parse($this->formSpec[$key]);

    }

Carsten  Rose's avatar
Carsten Rose committed
674
675
676
677
678
    /**
     * Checks if $serverToken matches HTTP_HEADER_AUTHORIZATION,
     * If not: throw an exception.
     *
     * @param string|array $serverToken
Marc Egger's avatar
Marc Egger committed
679
680
     * @throws \CodeException
     * @throws \UserFormException
Carsten  Rose's avatar
Carsten Rose committed
681
682
683
684
685
686
687
688
     */
    private function restCheckAuthToken($serverToken) {

        // No serverToken: no check necessary
        if ($serverToken === '') {
            return;
        }

689
690
        $clientToken = $this->store::getVar(HTTP_HEADER_AUTHORIZATION, STORE_CLIENT, SANITIZE_ALLOW_ALL);
        if ($serverToken === $clientToken) {
Carsten  Rose's avatar
Carsten Rose committed
691
692
693
694
695
696
697
            return;
        }

        // Delay before answering.
        $seconds = $this->store::getVar(SYSTEM_SECURITY_FAILED_AUTH_DELAY, STORE_SYSTEM);
        sleep($seconds);

698
        if ($clientToken == false) {
Marc Egger's avatar
Marc Egger committed
699
            throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Missing authorization token',
Marc Egger's avatar
Marc Egger committed
700
                ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
701
                ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
702
703
704
            ]), ERROR_REST_AUTHORIZATION);
        }

Marc Egger's avatar
Marc Egger committed
705
        throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Authorization token not accepted',
Marc Egger's avatar
Marc Egger committed
706
            ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
707
            ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
708
        ]), ERROR_REST_AUTHORIZATION);
Carsten  Rose's avatar
Carsten Rose committed
709
710
    }

711
712
713
    /**
     * STORE_CLIENT: copy parameter _id1,_id2,...,_idN to named variables, specified via $this->formSpec[F_REST_PARAM] (CSV list)
     *
Marc Egger's avatar
Marc Egger committed
714
715
     * @throws \CodeException
     * @throws \UserFormException
716
     */
Carsten  Rose's avatar
Carsten Rose committed
717
    private function nameGenericRestParam() {
718
719
720
721
722
723
724
725

        $paramNames = explode(',', $this->formSpec[F_REST_PARAM] ?? '');

        $ii = 1;
        foreach ($paramNames as $key) {
            switch ($key) {
                case CLIENT_FORM:
                case CLIENT_RECORD_ID:
Marc Egger's avatar
Marc Egger committed
726
                    throw new \UserFormException("Name '$key' is forbidden in " . F_REST_PARAM, ERROR_INVALID_VALUE);
727
728
729
730
731
732
733
734
735
736
                    break;
                default:
                    break;
            }
            $val = $this->store::getVar(CLIENT_REST_ID . $ii, STORE_CLIENT);
            $this->store::setVar($key, $val, STORE_CLIENT);
            $ii++;
        }
    }

737
738
739
    /**
     * Copies state 'hidden' from a FE pill to all FE child elements of that pill.
     *
Marc Egger's avatar
Marc Egger committed
740
741
742
743
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
744
745
746
747
748
749
750
751
     */
    private function ifPillIsHiddenSetChildFeToHidden() {

        $feFilter = OnArray::filter($this->feSpecNative, FE_TYPE, FE_TYPE_PILL);

        if (!empty($feFilter)) {
            foreach ($feFilter AS $feParent) {

752
                if ($feParent[FE_MODE_SQL]) {
753
                    $mode = $this->evaluate->parse($feParent[FE_MODE_SQL]);
754
755
                    if ($mode != '') {
                        $feParent[FE_MODE] = $mode;
756
757
758
759
760
761
762
763
                    }
                }

                if ($feParent[FE_MODE] == FE_MODE_HIDDEN) {
                    $feChild = OnArray::filter($this->feSpecNative, FE_ID_CONTAINER, $feParent[FE_ID]);
                    foreach ($feChild AS $fe) {

                        # Search for origin
764
765
                        foreach ($this->feSpecNative as $key => $value) {
                            if ($value[FE_ID] == $fe[FE_ID]) {
766
767
768
769
770
771
772
773
774
775
                                $this->feSpecNative[$key][FE_MODE] = FE_MODE_HIDDEN;
                                break;
                            }
                        }
                    }
                }
            }
        }
    }

776
    /**
Marc Egger's avatar
Marc Egger committed
777
778
779
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
780
781
782
783
784
785
786
787
788
789
790
     */
    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);
Carsten  Rose's avatar
Carsten Rose committed
791
792
        $clientIp = $_SERVER[CLIENT_REMOTE_ADDRESS] ?? '';
        $userAgent = $_SERVER[CLIENT_HTTP_USER_AGENT] ?? '';
793
794
795
796
797
798
799
        $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();

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

806
807
808
809
810
811
812
813
814
815
816

    /**
     * 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,
817
     *            ?[id=]<T3 Alias pageId>&a=123#bottom, ?id=<T3 pageId>&a=123#bottom
818
819
820
     * b) mode      no|client|url|...
     * c) mode|url  combination of above
     *
Marc Egger's avatar
Marc Egger committed
821
822
823
824
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
825
826
827
     */
    private function setForwardModePage() {

828
        if (F_FORWARD_MODE_URL != substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
829
            return;
830
831
        }

832
        $forwardPageTmp = $this->evaluate->parse($this->formSpec[F_FORWARD_PAGE]);
833
834
835
836
837
838

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

839
            case F_FORWARD_MODE_AUTO:
840
            case F_FORWARD_MODE_CLOSE:
841
842
843
844
            case F_FORWARD_MODE_NO:
            case F_FORWARD_MODE_URL:
            case F_FORWARD_MODE_URL_SKIP_HISTORY:
            case F_FORWARD_MODE_URL_SIP:
845
            case F_FORWARD_MODE_URL_SIP_SKIP_HISTORY:
846
847
848
849
850
851
852
853
854
855
856
857
858
                $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;
        }

859
        if (F_FORWARD_MODE_URL == substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
860
            if ($this->formSpec[F_FORWARD_PAGE] == '') {
861
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_AUTO;
862
863
864
865
            }
        }
    }

Carsten  Rose's avatar
Carsten Rose committed
866
867
868
    /**
     * Iterate over all Clipboard source records and fire for each all FE.type=paste records.
     *
Carsten  Rose's avatar
Carsten Rose committed
869
     * @param int $formId
Carsten  Rose's avatar
Carsten Rose committed
870
     * @param FormAction $formAction
871
     *
Marc Egger's avatar
Marc Egger committed
872
873
874
875
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Carsten Rose committed
876
877
878
     */
    private function pasteClipboard($formId, FormAction $formAction) {

879
880
881
882
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
883
884
        $cookieQfq = $this->store->getVar(CLIENT_COOKIE_QFQ, STORE_CLIENT, SANITIZE_ALLOW_ALNUMX);
        if ($cookieQfq === false || $cookieQfq == '') {
Marc Egger's avatar
Marc Egger committed
885
            throw new \UserFormException('Qfq Session missing', ERROR_QFQ_SESSION_MISSING);
Carsten  Rose's avatar
Carsten Rose committed
886
887
888
        }

        # select clipboard records
889
        $sql = "SELECT c.idSrc as id, c.xId FROM `Clipboard` AS c WHERE `c`.`cookie`='$cookieQfq' AND `c`.`formIdPaste`=$formId ORDER BY `c`.`id`";
890
        $arrClipboard = $this->dbArray[$this->dbIndexQfq]->sql($sql);
Carsten  Rose's avatar
Carsten Rose committed
891
892
893
894
895
896
897
898

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

    } # doClipboard()

899
900
901
902
903
904
905
906
907
908
    /**
     * @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;
            }
        }
909

910
911
912
913
        return false;

    }

914
915
916
917
918
    /**
     * 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
919
     * @param int $recordId
920
     *
921
     * @return array
Marc Egger's avatar
Marc Egger committed
922
923
     * @throws \CodeException
     * @throws \UserFormException
924
925
926
     */
    private function buildNSetReloadUrl(array $formSpec, $recordId) {

927
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944

        // Rebuild original URL