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

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
use IMATHUZH\Qfq\Core\Helper\Logger;
use IMATHUZH\Qfq\Core\Helper\OnArray;
24
use IMATHUZH\Qfq\Core\Helper\Path;
Marc Egger's avatar
Marc Egger committed
25
use IMATHUZH\Qfq\Core\Helper\Support;
26
27
use IMATHUZH\Qfq\Core\Report\Monitor;
use IMATHUZH\Qfq\Core\Report\Report;
28
use IMATHUZH\Qfq\Core\Report\ReportAsFile;
Marc Egger's avatar
Marc Egger committed
29
30
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
use IMATHUZH\Qfq\Core\Store\Session;
31
32
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
Marc Egger's avatar
Marc Egger committed
33

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

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

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

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

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

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

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

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

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

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

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

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

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

128
        mb_internal_encoding("UTF-8");
129

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

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

135
136
        Support::setQfqErrorHandler();

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

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

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

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

156
157
158
159
160
161
162
        // 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;

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

167
168
        $this->t3data = $t3data;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

303
        return $html;
304
305
    }

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

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

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

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

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

344
345
        $monitor = new Monitor();

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

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

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

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

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

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

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

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

418
419
420
                break;
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

593
594
                $this->ifPillIsHiddenSetChildFeToHidden();

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

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

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

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

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

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

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

622
                $this->setForwardModePage();
623
624

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

636
                if ($getJson) {
637

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

851
852
853
854
855
856
857
858
859
860
861

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

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

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