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

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;
27
use IMATHUZH\Qfq\Core\Report\ReportAsFile;
Marc Egger's avatar
Marc Egger committed
28
29
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
use IMATHUZH\Qfq\Core\Store\Session;
30
31
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
Marc Egger's avatar
Marc Egger committed
32

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

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

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

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

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

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

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

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

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

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

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

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

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

127
        mb_internal_encoding("UTF-8");
128

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

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

134
135
        Support::setQfqErrorHandler();

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

139
        if (!isset($t3data[T3DATA_BODYTEXT])) {
140
            // TODO: ?CR: when does this happen? why no exception thrown?
141
142
143
144
            $t3data[T3DATA_BODYTEXT] = '';
        }

        if (!isset($t3data[T3DATA_UID])) {
145
            // TODO: ?CR: when does this happen? why no exception thrown?
146
147
            $t3data[T3DATA_UID] = 0;
        }
148

149
        // Read report file, if file keyword exists in bodytext
150
151
        $reportPathFileNameFull = ReportAsFile::parseFileKeyword($t3data[T3DATA_BODYTEXT]);
        if ($reportPathFileNameFull !== null) {
152
            $t3data[T3DATA_BODYTEXT] = ReportAsFile::read_report_file($reportPathFileNameFull);
153
        }
154

155
156
157
158
159
160
161
        // SUPER HACK: to render inline editor when an exception is thrown
        // Can't use store, since store needs bodytext to be parsed, which might throw exceptions if there is a syntax error.
        \UserReportException::$report_uid = $t3data[T3DATA_UID];
        \UserReportException::$report_bodytext = $t3data[T3DATA_BODYTEXT];
        \UserReportException::$report_header = t3data[T3DATA_HEADER];
        \UserReportException::$report_pathFileName = $reportPathFileNameFull;

162
        $btp = new BodytextParser();
163
        $t3data[T3DATA_BODYTEXT_RAW] = $t3data[T3DATA_BODYTEXT];
164
        $t3data[T3DATA_BODYTEXT] = $btp->process($t3data[T3DATA_BODYTEXT]);
165

166
167
        $this->t3data = $t3data;

168
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
169
170

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

172
173
174
        $timeout = $this->store::getVar(SYSTEM_SESSION_TIMEOUT_SECONDS, STORE_SYSTEM);
        Session::checkSessionExpired($timeout);

175
        // If an FE user logs out and a different user logs in (same browser session) - the old values has to be destroyed!
176
        if (Session::getAndDestroyFlagFeUserHasChanged()) {
177
178
179
            $this->store->unsetStore(STORE_USER);
        }

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

182
183
        $this->dbIndexData = $this->store->getVar(SYSTEM_DB_INDEX_DATA, STORE_SYSTEM);
        $this->dbIndexQfq = $this->store->getVar(SYSTEM_DB_INDEX_QFQ, STORE_SYSTEM);
184

185
        $this->dbArray[$this->dbIndexData] = new Database($this->dbIndexData);
186

187
188
189
        if ($this->dbIndexData != $this->dbIndexQfq) {
            $this->dbArray[$this->dbIndexQfq] = new Database($this->dbIndexQfq);
        }
190

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

193
        $dbUpdate = $this->store->getVar(SYSTEM_DB_UPDATE, STORE_SYSTEM);
194
        $updateDb = new DatabaseUpdate($this->dbArray[$this->dbIndexQfq], $this->store);
195
        $updateDb->checkNupdate($dbUpdate);
196

197
        $this->store->FillStoreSystemBySql(); // Do this after the DB-update
198
199
200

        // Set dbIndex, evaluate any
        $dbIndex = $this->store->getVar(TOKEN_DB_INDEX, STORE_TYPO3 . STORE_EMPTY);
201
        $dbIndex = $this->evaluate->parse($dbIndex);
202
203
        $dbIndex = ($dbIndex == '') ? DB_INDEX_DEFAULT : $dbIndex;
        $this->store->setVar(TOKEN_DB_INDEX, $dbIndex, STORE_TYPO3);
204
205

        // Create report file if file keyword not found
206
        // TODO: ?CR: uid could be 0. When does this happen?
207
        if ($reportPathFileNameFull === null && $t3data[T3DATA_UID] !== 0) {
208
            $reportPathFileNameFull = ReportAsFile::create_file_from_ttContent($t3data[T3DATA_UID], $this->dbArray[$this->dbIndexData]);
209
        }
210
211
212

        // Save pathFileName for use in inline editor
        $this->t3data[T3DATA_REPORT_PATH_FILENAME] = $reportPathFileNameFull;
Carsten  Rose's avatar
Carsten Rose committed
213
214
    }

215
    /**
216
     * Returns the defined forwardMode and set forwardPage
217
     *
218
     * @return array
Marc Egger's avatar
Marc Egger committed
219
220
     * @throws \CodeException
     * @throws \UserFormException
221
     */
222
223
    public function getForwardMode() {

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

229
        $forwardPage = $this->formSpec[F_FORWARD_PAGE];
230

231
232
233
234
235
236
237
238
239
240
241
242
243
244
        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
245
246
        }

247
248
        return ([
            API_REDIRECT => $this->formSpec[F_FORWARD_MODE],
Carsten  Rose's avatar
Carsten Rose committed
249
            API_REDIRECT_URL => $forwardPage,
250
        ]);
251
252
    }

253
    /**
254
     * Main entry point to display content: a) form and/or b) report
255
     *
256
     * @return string
Marc Egger's avatar
Marc Egger committed
257
258
259
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
260
261
262
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
263
264
265
266
267
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Carsten Rose committed
268
     */
269
    public function process() {
270
        $html = '';
271

272
273
274
275
276
        $render = $this->store->getVar(SYSTEM_RENDER, STORE_TYPO3 . STORE_SYSTEM);
        if ($render == SYSTEM_RENDER_API && isset($GLOBALS['TYPO3_CONF_VARS'])) {
            return '';
        }

277
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
278
279
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
280
281
282
        }

        $html .= $this->doForm(FORM_LOAD);
283
284
285
        if ($render == SYSTEM_RENDER_BOTH || $render == SYSTEM_RENDER_API || ($render == SYSTEM_RENDER_SINGLE && $html == '')) {
            $html .= $this->doReport();
        }
Carsten  Rose's avatar
Carsten Rose committed
286

287
        // 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
288
289
290
291
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

292
293
294
295
296
        // Only needed if there are 'drag and drop' elements.
        if ($this->store->getVar(SYSTEM_DRAG_AND_DROP_JS, STORE_SYSTEM) == 'true') {
            $html .= $this->getDragAndDropCode();
        }

297
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
298
        if ($class) {
299
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
300
301
        }

302
        return $html;
303
304
    }

305
    /**
306
     * Determine the name of the language parameter field, which has to be taken to fill language specific definitions.
307
     *
Marc Egger's avatar
Marc Egger committed
308
309
     * @throws \CodeException
     * @throws \UserFormException
310
311
312
313
314
315
316
317
318
     */
    private function setParameterLanguageFieldName() {

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

        foreach (['A', 'B', 'C', 'D'] as $key) {
319
            $languageIdx = SYSTEM_FORM_LANGUAGE . "$key" . "Id";
320
321
322
323
324
325
326
            if ($this->store->getVar($languageIdx, STORE_SYSTEM) == $typo3PageLanguage) {
                $this->store->setVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, 'parameterLanguage' . $key, STORE_SYSTEM);
                break;
            }
        }
    }

327
    /**
328
329
     * Creates an empty file. This indicates that the current form is in debug mode. Returns HTML element which will be
     * replaced by the logfile.
330
331
332
     *
     * @param $formName
     * @param $formLogMode
333
     * @return string
Marc Egger's avatar
Marc Egger committed
334
335
336
     * @throws \CodeException
     * @throws \UserFormException
     * @throws \UserReportException
337
338
339
340
     */
    private function getFormLog($formName, $formLogMode) {

        $formLogFileName = Support::getFormLogFileName($formName, $formLogMode);
341
        file_put_contents($formLogFileName, '');
342

343
344
        $monitor = new Monitor();

345
346
        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]);
347
    }
348

349
    /**
350
     * Process form.
351
352
353
354
355
     * $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:
356
     *
357
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
358
     *
359
     * @return array|string
Marc Egger's avatar
Marc Egger committed
360
361
362
     * @throws \CodeException
     * @throws \DbException
     * @throws \DownloadException
Carsten  Rose's avatar
Carsten Rose committed
363
364
365
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
366
367
368
369
370
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \UserFormException
     * @throws \UserReportException
371
     */
372
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
373
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
374
        $foundInStore = '';
375
        $flagApiStructureReGroup = true;
376
        $formModeNew = '';
377
        $build = null;
378

379
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO, SANITIZE_ALLOW_DIGIT, $foundInStore);
380
        $this->setParameterLanguageFieldName();
381

382
383
384
        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore, $formLogMode);
        if ($formName !== false && $formLogMode !== false) {
            return $this->getFormLog($formName, $formLogMode);
385
386
        }

387
        if ($formName === false) {
388
            switch ($formMode) {
389
                case FORM_DELETE:
390
                    $formModeNew = FORM_DELETE;
391
392
                    break;
                case FORM_DRAG_AND_DROP:
Marc Egger's avatar
Marc Egger committed
393
                    throw new \CodeException('Missing form in SIP', ERROR_MISSING_FORM);
394
395
396
                default:
                    return '';// No form found: do nothing
            }
397
        }
398

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

404
405
406
407
408
409
410
        // 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);
411
412
413
414
415
416

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

417
418
419
                break;
        }

420
        if ($formName !== false) {
Carsten  Rose's avatar
Carsten Rose committed
421
            // Validate (only if there is a 'real' form, not a FORM_DELETE with only a table name).
Carsten  Rose's avatar
Carsten Rose committed
422
423
            // Attention: $formModeNew will be set
            $sipFound = $this->validateForm($foundInStore, $formMode, $formModeNew);
424
425

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

432
433
434
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
435
436
            $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.
437
            $this->formSpec[F_PRIMARY_KEY] = F_PRIMARY_KEY_DEFAULT;
438
439
440
441
442
443
444
445
446
447

            $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);
                    }
                }
            }
448
449
        }

450
        // FormAsFile: Get the new and the old form file name and make sure both files are writable (before DB changes are made)
451
        // Note: This can't be done earlier because $formModeNew might be changed in the lines above.
452
        $formNameDB = FormAsFile::formNameFromFormRelatedRecord($recordId, $this->formSpec[F_TABLE_NAME], $this->dbArray[$this->dbIndexQfq]);
453
454
455
        switch ($this->formSpec[F_TABLE_NAME]) {
            case TABLE_NAME_FORM: // cases covered: new form, existing form, existing form but form name changed
                $formFileName = $this->store->getVar(F_NAME, STORE_FORM, SANITIZE_ALLOW_ALNUMX);
456
457
458
                $formFileName = $formFileName === false ? $formNameDB : $formFileName;
                if ($formNameDB !== null && $formFileName !== $formNameDB && $formModeNew === FORM_SAVE) {
                    $formFileNameDelete = $formNameDB;
459
                    FormAsFile::enforceFormFileWritable($formFileNameDelete, $this->dbArray[$this->dbIndexQfq]); // file will be deleted after DB changes
460
461
462
463
                }
                break;
            case TABLE_NAME_FORM_ELEMENT: // cases covered: new formElement, existing formElement
                $formId = $this->store->getVar(FE_FORM_ID, STORE_FORM);
464
                $formFileName = $formId !== false ? FormAsFile::formNameFromFormRelatedRecord($formId, TABLE_NAME_FORM, $this->dbArray[$this->dbIndexQfq]) : $formNameDB;
465
466
                break;
            default:
467
                $formFileName = $formNameDB;
468
        }
469
        if ($formFileName !== null && in_array($formModeNew, [FORM_SAVE, FORM_DRAG_AND_DROP, FORM_DELETE])) {
470
            FormAsFile::enforceFormFileWritable($formFileName, $this->dbArray[$this->dbIndexQfq]);
471
472
        }

473
474
        // 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.
475
476
477
478
        if ($formMode != FORM_REST) {
            if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
                $this->store->createSipAfterFormLoad($formName);
            }
479
        }
480

481
        // Fill STORE_BEFORE
482
        if ($formName !== false && $this->store->getVar($this->formSpec[F_PRIMARY_KEY], STORE_BEFORE) === false) {
483
            $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId,
484
                $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY], STORE_BEFORE);
485
486
        }

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

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

494
            // In case of a conflict, return immediately
Carsten  Rose's avatar
Carsten Rose committed
495
496
            if ($answer[API_STATUS] != API_ANSWER_STATUS_SUCCESS) {
                $answer[API_STATUS] = API_ANSWER_STATUS_ERROR;
497

498
499
                return $answer;
            }
Carsten  Rose's avatar
Carsten Rose committed
500
501
        }

502
        // FORM_LOAD: if there is a foreign exclusive record lock - show form in F_MODE_READONLY mode.
Carsten  Rose's avatar
Carsten Rose committed
503
        if ($formModeNew === FORM_LOAD) {
504
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
505
506
507
            $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) {
508
                $this->formSpec[F_MODE_GLOBAL] = F_MODE_READONLY;
509
510
511
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
512
        switch ($formModeNew) {
513
514
515
516
517
518
519
520
521
            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:
522

523
524
525
                $tableDefinition = $this->dbArray[$this->dbIndexData]->getTableDefinition($this->formSpec[F_TABLE_NAME]);
                $this->store->fillStoreTableDefaultColumnType($tableDefinition);

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

531
532
533
534
535
536
537
538
539
540
541
                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
542
                        throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
543
544
545
                }
                break;
            default:
Marc Egger's avatar
Marc Egger committed
546
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
547
548
        }

549
        $formAction = new FormAction($this->formSpec, $this->dbArray[$this->dbIndexData], $this->phpUnit);
Carsten  Rose's avatar
Carsten Rose committed
550
        switch ($formModeNew) {
551
            case FORM_LOAD:
552
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
553
554

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

557
558
559
560
                $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);
561
562
563
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
                break;

Carsten  Rose's avatar
Carsten Rose committed
564
            case FORM_UPDATE:
565
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
566
                // data['form-update']=....
Carsten  Rose's avatar
Carsten Rose committed
567
                $data = $build->process($formModeNew);
568
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
569
                break;
Carsten  Rose's avatar
Carsten Rose committed
570

571
572
573
            case FORM_DELETE:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_DELETE);

574
                $build->process($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
575
576
577
578

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

579
            case FORM_SAVE:
580
581
                $this->logFormSubmitRequest();

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

584
                // Action: Before
585
586
                $feTypeList = FE_TYPE_BEFORE_SAVE . ',' . ($recordId == 0 ? FE_TYPE_BEFORE_INSERT : FE_TYPE_BEFORE_UPDATE);
                $formAction->elements($recordId, $this->feSpecAction, $feTypeList);
587

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

592
593
                $this->ifPillIsHiddenSetChildFeToHidden();

594
                // SAVE
595
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->feSpecNativeRaw);
596
597

                $save->processAllImageCutFE();
598
                $save->checkRequiredHidden();
599

600
601
                $rc = $save->process();

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

604
605
                // Action: After*, Sendmail
                $feTypeList = FE_TYPE_SENDMAIL . ',' . FE_TYPE_AFTER_SAVE . ',' . ($recordId == 0 ? FE_TYPE_AFTER_INSERT : FE_TYPE_AFTER_UPDATE);
606
                $status = $formAction->elements($rc, $this->feSpecAction, $feTypeList);
607
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
608
                    // Reload fresh saved record and fill STORE_RECORD with it.
609
                    $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY]);
610
                }
611

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

Carsten  Rose's avatar
Carsten Rose committed
615
616
                if ($formMode == FORM_REST) {
                    $data = ['id' => $rc];
617
                    $flagApiStructureReGroup = false;
Carsten  Rose's avatar
Carsten Rose committed
618
619
                    break;
                }
620

621
                $this->setForwardModePage();
622
623

                // Logic: If a) r=0 and
624
                //           b) final: (forwardMode=='auto' and User presses only 'save' (not 'save & close')) OR (forwardMode=='no')
625
                // then the client should reload the current page with the newly created record. A new SIP is necessary!
626
                $getJson = true;
627
628
629
630
                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)) {
631
                    $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
632
                    $getJson = false;
633
                }
634

635
                if ($getJson) {
636

637
                    // Values of FormElements might be changed during 'afterSave': rebuild the form to load the new values. Especially for non primary template groups.
638
639
640
641
                    $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);
642

Carsten  Rose's avatar
Carsten Rose committed
643
                    $data = $build->process($formModeNew, false, $this->feSpecNative);
644
                }
645
                break;
646

647
648
649
            case FORM_DRAG_AND_DROP:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);

650
                $dragAndDrop = new DragAndDrop($this->formSpec);
651
                $data = $dragAndDrop->process();
652
                $flagApiStructureReGroup = false;
653
654

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

657
            case FORM_REST:
658
                $flagApiStructureReGroup = false;
659
                $data = $this->doRestGet();
660
661
                break;

662
            default:
Marc Egger's avatar
Marc Egger committed
663
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
664
665
        }

666
        if ($flagApiStructureReGroup && is_array($data)) {
667
            // $data['element-update']=...
668
669
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
670

671
        // export Form to file, if loaded record is a Form/FormElement
672
        if ($formFileName !== null) {
673
674
675
            switch ($formModeNew) {
                case FORM_SAVE:
                case FORM_DRAG_AND_DROP:
676
                    FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
677
678
679
                    break;
                case FORM_DELETE:
                    if (TABLE_NAME_FORM_ELEMENT === $this->formSpec[F_TABLE_NAME]) {
680
                        FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
681
                    } else {
682
                        FormAsFile::deleteFormFile($formFileName, $this->dbArray[$this->dbIndexQfq]);
683
                    }
684
                    break;
685
            }
686
687
        }

688
689
        // delete old form file if form name was changed
        if (isset($formFileNameDelete)) {
690
            FormAsFile::deleteFormFile($formFileNameDelete, $this->dbArray[$this->dbIndexQfq]);
691
692
        }

Carsten  Rose's avatar
Carsten Rose committed
693
        return $data;
694
695
    }

696
697
    /**
     * @return array
Marc Egger's avatar
Marc Egger committed
698
699
700
701
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
702
     */
703
    private function doRestGet() {
704

Carsten  Rose's avatar
Carsten Rose committed
705
        $this->nameGenericRestParam();
706
707
708
709

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

710
        if (!isset($this->formSpec[$key])) {
Marc Egger's avatar
Marc Egger committed
711
            throw new \UserFormException("Missing Parameter '$key'", ERROR_INVALID_VALUE);
712
713
714
715
716
717
        }

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

    }

Carsten  Rose's avatar
Carsten Rose committed
718
719
720
721
722
    /**
     * Checks if $serverToken matches HTTP_HEADER_AUTHORIZATION,
     * If not: throw an exception.
     *
     * @param string|array $serverToken
Marc Egger's avatar
Marc Egger committed
723
724
     * @throws \CodeException
     * @throws \UserFormException
Carsten  Rose's avatar
Carsten Rose committed
725
726
727
728
729
730
731
732
     */
    private function restCheckAuthToken($serverToken) {

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

733
734
        $clientToken = $this->store::getVar(HTTP_HEADER_AUTHORIZATION, STORE_CLIENT, SANITIZE_ALLOW_ALL);
        if ($serverToken === $clientToken) {
Carsten  Rose's avatar
Carsten Rose committed
735
736
737
738
739
740
741
            return;
        }

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

742
        if ($clientToken == false) {
Marc Egger's avatar
Marc Egger committed
743
            throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Missing authorization token',
Marc Egger's avatar
Marc Egger committed
744
                ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
745
                ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
746
747
748
            ]), ERROR_REST_AUTHORIZATION);
        }

Marc Egger's avatar
Marc Egger committed
749
        throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Authorization token not accepted',
Marc Egger's avatar
Marc Egger committed
750
            ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
751
            ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
752
        ]), ERROR_REST_AUTHORIZATION);
Carsten  Rose's avatar
Carsten Rose committed
753
754
    }

755
756
757
    /**
     * 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
758
759
     * @throws \CodeException
     * @throws \UserFormException
760
     */
Carsten  Rose's avatar
Carsten Rose committed
761
    private function nameGenericRestParam() {
762
763
764
765
766
767
768
769

        $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
770
                    throw new \UserFormException("Name '$key' is forbidden in " . F_REST_PARAM, ERROR_INVALID_VALUE);
771
772
773
774
775
776
777
778
779
780
                    break;
                default:
                    break;
            }
            $val = $this->store::getVar(CLIENT_REST_ID . $ii, STORE_CLIENT);
            $this->store::setVar($key, $val, STORE_CLIENT);
            $ii++;
        }
    }

781
782
783
    /**
     * Copies state 'hidden' from a FE pill to all FE child elements of that pill.
     *
Marc Egger's avatar
Marc Egger committed
784
785
786
787
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
788
789
790
791
792
793
794
795
     */
    private function ifPillIsHiddenSetChildFeToHidden() {

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

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

796
                if ($feParent[FE_MODE_SQL]) {
797
                    $mode = $this->evaluate->parse($feParent[FE_MODE_SQL]);
798
799
                    if ($mode != '') {
                        $feParent[FE_MODE] = $mode;
800
801
802
803
804
805
806
807
                    }
                }

                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
808
809
                        foreach ($this->feSpecNative as $key => $value) {
                            if ($value[FE_ID] == $fe[FE_ID]) {
810
811
812
813
814
815
816
817
818
819
                                $this->feSpecNative[$key][FE_MODE] = FE_MODE_HIDDEN;
                                break;
                            }
                        }
                    }
                }
            }
        }
    }

820
    /**
Marc Egger's avatar
Marc Egger committed
821
822
823
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
824
825
826
827
828
829
830
831
832
833
834
     */
    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
835
836
        $clientIp = $_SERVER[CLIENT_REMOTE_ADDRESS] ?? '';
        $userAgent = $_SERVER[CLIENT_HTTP_USER_AGENT] ?? '';
837
838
839
840
841
842
843
        $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();

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

850
851
852
853
854
855
856
857
858
859
860

    /**
     * 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,
861
     *            ?[id=]<T3 Alias pageId>&a=123#bottom, ?id=<T3 pageId>&a=123#bottom
862
863
864
     * b) mode      no|client|url|...
     * c) mode|url  combination of above
     *
Marc Egger's avatar
Marc Egger committed
865
866
867
868
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
869
870
871
     */
    private function setForwardModePage() {

872
        if (F_FORWARD_MODE_URL != substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
873
            return;
874
875
        }

876
        $forwardPageTmp = $this->evaluate->parse($this->formSpec[F_FORWARD_PAGE]);
Carsten  Rose's avatar