QuickFormQuery.php 80.3 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\Helper\HelperFile;
19
20
use IMATHUZH\Qfq\Core\Helper\HelperFormElement;
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
Marc Egger's avatar
Marc Egger committed
21
22
23
use IMATHUZH\Qfq\Core\Helper\Logger;
use IMATHUZH\Qfq\Core\Helper\OnArray;
use IMATHUZH\Qfq\Core\Helper\Support;
24
25
use IMATHUZH\Qfq\Core\Report\Monitor;
use IMATHUZH\Qfq\Core\Report\Report;
Marc Egger's avatar
Marc Egger committed
26
27
use IMATHUZH\Qfq\Core\Store\FillStoreForm;
use IMATHUZH\Qfq\Core\Store\Session;
28
29
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
Marc Egger's avatar
Marc Egger committed
30

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

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

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

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

64
65
66
    protected $formSpec = array();
    protected $feSpecAction = array();  // Form Definition: copy of the loaded form
    protected $feSpecNative = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
67
    protected $feSpecNativeRaw = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
68

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

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

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

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

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

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

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

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

125
        mb_internal_encoding("UTF-8");
126

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

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

Marc Egger's avatar
Marc Egger committed
132
        set_error_handler("\\IMATHUZH\\Qfq\\Core\\Exception\\ErrorHandler::exception_error_handler");
Carsten  Rose's avatar
Carsten Rose committed
133
134
        // PHPExcel
        set_include_path(get_include_path() . PATH_SEPARATOR . '../../Resources/Private/Classes/');
135

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

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

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

148
149
        $this->t3data = $t3data;

150
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
151
152

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

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

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

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

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

167
        $this->dbArray[$this->dbIndexData] = new Database($this->dbIndexData);
168

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

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

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

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

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

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

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

202
        $forwardPage = $this->formSpec[F_FORWARD_PAGE];
203

204
205
206
207
208
209
210
211
212
213
214
215
216
217
        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
218
219
        }

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

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

245
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
246
247
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
248
249
250
        }

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

253
        // 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
254
255
256
257
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

258
259
260
261
262
        // Only needed if there are 'drag and drop' elements.
        if ($this->store->getVar(SYSTEM_DRAG_AND_DROP_JS, STORE_SYSTEM) == 'true') {
            $html .= $this->getDragAndDropCode();
        }

263
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
264
        if ($class) {
265
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
266
267
        }

268
        return $html;
269
270
    }

271
    /**
272
     * Determine the name of the language parameter field, which has to be taken to fill language specific definitions.
273
     *
Marc Egger's avatar
Marc Egger committed
274
275
     * @throws \CodeException
     * @throws \UserFormException
276
277
278
279
280
281
282
283
284
     */
    private function setParameterLanguageFieldName() {

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

        foreach (['A', 'B', 'C', 'D'] as $key) {
285
            $languageIdx = SYSTEM_FORM_LANGUAGE . "$key" . "Id";
286
287
288
289
290
291
292
            if ($this->store->getVar($languageIdx, STORE_SYSTEM) == $typo3PageLanguage) {
                $this->store->setVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, 'parameterLanguage' . $key, STORE_SYSTEM);
                break;
            }
        }
    }

293
    /**
294
295
     * Creates an empty file. This indicates that the current form is in debug mode. Returns HTML element which will be
     * replaced by the logfile.
296
297
298
     *
     * @param $formName
     * @param $formLogMode
299
     * @return string
Marc Egger's avatar
Marc Egger committed
300
301
302
     * @throws \CodeException
     * @throws \UserFormException
     * @throws \UserReportException
303
304
305
306
     */
    private function getFormLog($formName, $formLogMode) {

        $formLogFileName = Support::getFormLogFileName($formName, $formLogMode);
307
        file_put_contents($formLogFileName, '');
308

309
310
        $monitor = new Monitor();

311
312
        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]);
313
    }
314

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

345
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO);
346
        $this->setParameterLanguageFieldName();
347

348
349
350
        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore, $formLogMode);
        if ($formName !== false && $formLogMode !== false) {
            return $this->getFormLog($formName, $formLogMode);
351
352
        }

353
        if ($formName === false) {
354
            switch ($formMode) {
355
                case FORM_DELETE:
356
                    $formModeNew = FORM_DELETE;
357
358
                    break;
                case FORM_DRAG_AND_DROP:
Marc Egger's avatar
Marc Egger committed
359
                    throw new \CodeException('Missing form in SIP', ERROR_MISSING_FORM);
360
361
362
                default:
                    return '';// No form found: do nothing
            }
363
        }
364

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

370
371
372
373
374
375
376
        // 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);
377
378
379
380
381
382

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

383
384
385
                break;
        }

386
        if ($formName !== false) {
Carsten  Rose's avatar
Carsten Rose committed
387
            // Validate (only if there is a 'real' form, not a FORM_DELETE with only a table name).
Carsten  Rose's avatar
Carsten Rose committed
388
389
            // Attention: $formModeNew will be set
            $sipFound = $this->validateForm($foundInStore, $formMode, $formModeNew);
390
391

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

398
399
400
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
401
402
            $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.
403
            $this->formSpec[F_PRIMARY_KEY] = F_PRIMARY_KEY_DEFAULT;
404
405
406
407
408
409
410
411
412
413

            $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);
                    }
                }
            }
414
415
        }

416
417
        // 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.
418
419
420
421
        if ($formMode != FORM_REST) {
            if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
                $this->store->createSipAfterFormLoad($formName);
            }
422
        }
423

424
        // Fill STORE_BEFORE
425
        if ($formName !== false && $this->store->getVar($this->formSpec[F_PRIMARY_KEY], STORE_BEFORE) === false) {
426
            $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId,
427
                $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY], STORE_BEFORE);
428
429
        }

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

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

437
            // In case of a conflict, return immediately
Carsten  Rose's avatar
Carsten Rose committed
438
439
            if ($answer[API_STATUS] != API_ANSWER_STATUS_SUCCESS) {
                $answer[API_STATUS] = API_ANSWER_STATUS_ERROR;
440

441
442
                return $answer;
            }
Carsten  Rose's avatar
Carsten Rose committed
443
444
        }

445
        // FORM_LOAD: if there is a foreign exclusive record lock - show form in F_MODE_READONLY mode.
Carsten  Rose's avatar
Carsten Rose committed
446
        if ($formModeNew === FORM_LOAD) {
447
            $dirty = new Dirty(false, $this->dbIndexData, $this->dbIndexQfq);
448
449
450
451
452
453
454
            $recordDirty = array();
            $rcLockFound = $dirty->getCheckDirty($this->formSpec[F_TABLE_NAME], $recordId, $recordDirty, $msg);
            if (($rcLockFound == LOCK_FOUND_CONFLICT || $rcLockFound == LOCK_FOUND_OWNER) && $recordDirty[F_DIRTY_MODE] == DIRTY_MODE_EXCLUSIVE) {
                $this->formSpec[F_MODE] = F_MODE_READONLY;
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
455
        switch ($formModeNew) {
456
457
458
459
460
461
462
463
464
            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:
465

466
467
468
                $tableDefinition = $this->dbArray[$this->dbIndexData]->getTableDefinition($this->formSpec[F_TABLE_NAME]);
                $this->store->fillStoreTableDefaultColumnType($tableDefinition);

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

474
475
476
477
478
479
480
481
482
483
484
                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
485
                        throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
486
487
488
                }
                break;
            default:
Marc Egger's avatar
Marc Egger committed
489
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
490
491
        }

492
        $formAction = new FormAction($this->formSpec, $this->dbArray[$this->dbIndexData], $this->phpUnit);
Carsten  Rose's avatar
Carsten Rose committed
493
        switch ($formModeNew) {
494
            case FORM_LOAD:
495
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
496
497

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

500
501
502
503
                $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);
504
505
506
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
                break;

Carsten  Rose's avatar
Carsten Rose committed
507
            case FORM_UPDATE:
508
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
509
                // data['form-update']=....
Carsten  Rose's avatar
Carsten Rose committed
510
                $data = $build->process($formModeNew);
511
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
512
                break;
Carsten  Rose's avatar
Carsten Rose committed
513

514
515
516
            case FORM_DELETE:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_DELETE);

517
                $build->process($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]);
518
519
520
521

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

522
            case FORM_SAVE:
523
524
                $this->logFormSubmitRequest();

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

527
                // Action: Before
528
529
                $feTypeList = FE_TYPE_BEFORE_SAVE . ',' . ($recordId == 0 ? FE_TYPE_BEFORE_INSERT : FE_TYPE_BEFORE_UPDATE);
                $formAction->elements($recordId, $this->feSpecAction, $feTypeList);
530

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

535
536
                $this->ifPillIsHiddenSetChildFeToHidden();

537
                // SAVE
538
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative, $this->feSpecNativeRaw);
539
540

                $save->processAllImageCutFE();
541
                $save->checkRequiredHidden();
542

543
544
                $rc = $save->process();

545
                // Reload fresh saved record and fill STORE_RECORD with it.
546
                $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY]);
547

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

550
                // Action: After
551
552
                $feTypeList = FE_TYPE_AFTER_SAVE . ',' . ($recordId == 0 ? FE_TYPE_AFTER_INSERT : FE_TYPE_AFTER_UPDATE);
                $status = $formAction->elements($rc, $this->feSpecAction, $feTypeList);
553
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
554
                    // Reload fresh saved record and fill STORE_RECORD with it.
555
                    $this->store->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, $this->dbArray[$this->dbIndexData], $this->formSpec[F_PRIMARY_KEY]);
556
                }
557

Carsten  Rose's avatar
Carsten Rose committed
558
559
560
561
562
563
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

Carsten  Rose's avatar
Carsten Rose committed
564
565
                if ($formMode == FORM_REST) {
                    $data = ['id' => $rc];
566
                    $flagApiStructureReGroup = false;
Carsten  Rose's avatar
Carsten Rose committed
567
568
                    break;
                }
569
570
571
572
573
574
575

                $customForward = $this->setForwardModePage();

                // Logic: If a) r=0 and
                //           b) User presses only 'save' (not save & close) and
                //           c) there is no forwardMode=='url...'
                // then the client should reload the current page with the newly created record. A new SIP is necessary!
576
                $getJson = true;
577
578
579
580
581
                if (0 == $this->store->getVar(SIP_RECORD_ID, STORE_SIP) &&
                    API_SUBMIT_REASON_SAVE == $this->store->getVar(API_SUBMIT_REASON, STORE_CLIENT . STORE_EMPTY, SANITIZE_ALLOW_ALNUMX) &&
                    $customForward == false
                ) {
                    $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
582
                    $getJson = false;
583
                }
584

585
                if ($getJson) {
586

587
                    // Values of FormElements might be changed during 'afterSave': rebuild the form to load the new values. Especially for non primary template groups.
588
589
590
591
                    $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);
592

Carsten  Rose's avatar
Carsten Rose committed
593
                    $data = $build->process($formModeNew, false, $this->feSpecNative);
594
                }
595
                break;
596

597
598
599
            case FORM_DRAG_AND_DROP:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);

600
                $dragAndDrop = new DragAndDrop($this->formSpec);
601
                $data = $dragAndDrop->process();
602
                $flagApiStructureReGroup = false;
603
604

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

607
            case FORM_REST:
608
                $flagApiStructureReGroup = false;
609
                $data = $this->doRestGet();
610
611
                break;

612
            default:
Marc Egger's avatar
Marc Egger committed
613
                throw new \CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
614
615
        }

616
        if ($flagApiStructureReGroup && is_array($data)) {
617
            // $data['element-update']=...
618
619
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
620

Carsten  Rose's avatar
Carsten Rose committed
621
        return $data;
622
623
    }

624
625
    /**
     * @return array
Marc Egger's avatar
Marc Egger committed
626
627
628
629
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
630
     */
631
    private function doRestGet() {
632

Carsten  Rose's avatar
Carsten Rose committed
633
        $this->nameGenericRestParam();
634
635
636
637

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

638
        if (!isset($this->formSpec[$key])) {
Marc Egger's avatar
Marc Egger committed
639
            throw new \UserFormException("Missing Parameter '$key'", ERROR_INVALID_VALUE);
640
641
642
643
644
645
        }

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

    }

Carsten  Rose's avatar
Carsten Rose committed
646
647
648
649
650
    /**
     * Checks if $serverToken matches HTTP_HEADER_AUTHORIZATION,
     * If not: throw an exception.
     *
     * @param string|array $serverToken
Marc Egger's avatar
Marc Egger committed
651
652
     * @throws \CodeException
     * @throws \UserFormException
Carsten  Rose's avatar
Carsten Rose committed
653
654
655
656
657
658
659
660
     */
    private function restCheckAuthToken($serverToken) {

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

661
662
        $clientToken = $this->store::getVar(HTTP_HEADER_AUTHORIZATION, STORE_CLIENT, SANITIZE_ALLOW_ALL);
        if ($serverToken === $clientToken) {
Carsten  Rose's avatar
Carsten Rose committed
663
664
665
666
667
668
669
            return;
        }

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

670
        if ($clientToken == false) {
Marc Egger's avatar
Marc Egger committed
671
            throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Missing authorization token',
Marc Egger's avatar
Marc Egger committed
672
                ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
673
                ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
674
675
676
            ]), ERROR_REST_AUTHORIZATION);
        }

Marc Egger's avatar
Marc Egger committed
677
        throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Authorization token not accepted',
Marc Egger's avatar
Marc Egger committed
678
            ERROR_MESSAGE_TO_DEVELOPER => "Missing HTTP Header: " . HTTP_HEADER_AUTHORIZATION,
679
            ERROR_MESSAGE_HTTP_STATUS => HTTP_401_UNAUTHORIZED
680
        ]), ERROR_REST_AUTHORIZATION);
Carsten  Rose's avatar
Carsten Rose committed
681
682
    }

683
684
685
    /**
     * 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
686
687
     * @throws \CodeException
     * @throws \UserFormException
688
     */
Carsten  Rose's avatar
Carsten Rose committed
689
    private function nameGenericRestParam() {
690
691
692
693
694
695
696
697

        $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
698
                    throw new \UserFormException("Name '$key' is forbidden in " . F_REST_PARAM, ERROR_INVALID_VALUE);
699
700
701
702
703
704
705
706
707
708
                    break;
                default:
                    break;
            }
            $val = $this->store::getVar(CLIENT_REST_ID . $ii, STORE_CLIENT);
            $this->store::setVar($key, $val, STORE_CLIENT);
            $ii++;
        }
    }

709
710
711
    /**
     * Copies state 'hidden' from a FE pill to all FE child elements of that pill.
     *
Marc Egger's avatar
Marc Egger committed
712
713
714
715
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
716
717
718
719
720
721
722
723
     */
    private function ifPillIsHiddenSetChildFeToHidden() {

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

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

724
                if ($feParent[FE_MODE_SQL]) {
725
                    $mode = $this->evaluate->parse($feParent[FE_MODE_SQL]);
726
727
                    if ($mode != '') {
                        $feParent[FE_MODE] = $mode;
728
729
730
731
732
733
734
735
                    }
                }

                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
736
737
                        foreach ($this->feSpecNative as $key => $value) {
                            if ($value[FE_ID] == $fe[FE_ID]) {
738
739
740
741
742
743
744
745
746
747
                                $this->feSpecNative[$key][FE_MODE] = FE_MODE_HIDDEN;
                                break;
                            }
                        }
                    }
                }
            }
        }
    }

748
    /**
Marc Egger's avatar
Marc Egger committed
749
750
751
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
752
753
754
755
756
757
758
759
760
761
762
     */
    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
763
764
        $clientIp = $_SERVER[CLIENT_REMOTE_ADDRESS] ?? '';
        $userAgent = $_SERVER[CLIENT_HTTP_USER_AGENT] ?? '';
765
766
767
768
769
770
771
772
        $sipData = json_encode($this->store->getStore(STORE_SIP), JSON_UNESCAPED_UNICODE);
        $formId = $this->formSpec[F_ID];
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
        $feUser = $this->store->getVar(TYPO3_FE_USER, STORE_TYPO3, SANITIZE_ALLOW_ALNUMX);
        $pageId = $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3, SANITIZE_ALLOW_ALNUMX);
        $sessionId = session_id();

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

778
779
780
781
782
783
784
785
786
787
788

    /**
     * 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,
789
     *            ?[id=]<T3 Alias pageid>&a=123#bottom, ?id=<T3 page id>&a=123#bottom
790
791
792
793
794
     * b) mode      no|client|url|...
     * c) mode|url  combination of above
     *
     * @return bool  TRUE if F_FORWARD_MODE = 'url..', else FALSE
     *
Marc Egger's avatar
Marc Egger committed
795
796
797
798
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
799
800
801
     */
    private function setForwardModePage() {

802
        if (F_FORWARD_MODE_URL != substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
803
804
805
            return false;
        }

806
        $forwardPageTmp = $this->evaluate->parse($this->formSpec[F_FORWARD_PAGE]);
807
808
809
810
811
812

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

813
            case F_FORWARD_MODE_AUTO:
814
            case F_FORWARD_MODE_CLOSE:
815
816
817
818
            case F_FORWARD_MODE_NO:
            case F_FORWARD_MODE_URL:
            case F_FORWARD_MODE_URL_SKIP_HISTORY:
            case F_FORWARD_MODE_URL_SIP:
819
            case F_FORWARD_MODE_URL_SIP_SKIP_HISTORY:
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
                $this->formSpec[F_FORWARD_MODE] = $forward;
                if (isset($forwardArray[1])) {
                    $this->formSpec[F_FORWARD_PAGE] = trim($forwardArray[1]);
                } else {
                    $this->formSpec[F_FORWARD_PAGE] = '';
                }
                break;

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

        if ('url' == substr($this->formSpec[F_FORWARD_MODE], 0, 3)) {
            if ($this->formSpec[F_FORWARD_PAGE] == '') {
835
                $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_AUTO;
836
837
838
839
840
841
842
843
844
845
846
847
848
                $customForward = false;
            } else {
                $customForward = true;
            }

        } else {
            $customForward = false;
        }

        return $customForward;

    }

Carsten  Rose's avatar
Carsten Rose committed
849
850
851
    /**
     * Iterate over all Clipboard source records and fire for each all FE.type=paste records.
     *
Carsten  Rose's avatar
Carsten Rose committed
852
     * @param int $formId
Carsten  Rose's avatar
Carsten Rose committed
853
     * @param FormAction $formAction
854
     *
Marc Egger's avatar
Marc Egger committed
855
856
857
858
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
Carsten  Rose's avatar
Carsten Rose committed
859
860
861
     */
    private function pasteClipboard($formId, FormAction $formAction) {

862
863
864
865
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
866
867
        $cookieQfq = $this->store->getVar(CLIENT_COOKIE_QFQ, STORE_CLIENT, SANITIZE_ALLOW_ALNUMX);
        if ($cookieQfq === false || $cookieQfq == '') {
Marc Egger's avatar
Marc Egger committed
868
            throw new \UserFormException('Qfq Session missing', ERROR_QFQ_SESSION_MISSING);
Carsten  Rose's avatar
Carsten Rose committed
869
870
871
872
        }

        # select clipboard records
        $sql = "SELECT c.idSrc as id, c.xId FROM Clipboard AS c WHERE c.cookie='$cookieQfq' AND c.formIdPaste=$formId ORDER BY c.id";
873
        $arrClipboard = $this->dbArray[$this->dbIndexQfq]->sql($sql);
Carsten  Rose's avatar
Carsten Rose committed
874
875
876
877
878
879
880
881

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

    } # doClipboard()

882
883
884
885
886
887
888
889
890
891
    /**
     * @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;
            }
        }
892

893
894
895
896
        return false;

    }

897
898
899
900
901
    /**
     * 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
902
     * @param int $recordId
903
     *
904
     * @return array
Marc Egger's avatar
Marc Egger committed
905
906
     * @throws \CodeException
     * @throws \UserFormException
907
908
909
     */
    private function buildNSetReloadUrl(array $formSpec, $recordId) {

910
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927

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

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

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

        return $formSpec;

    }

928
    /**
929
930
931
932
933
934
     * Checks if there is formLog mode active for FORM_LOG_SESSION or FORM_LOG_ALL.
     * If yes, set $form[FORM_LOG_FILE_SESSION] resp.  $form[FORM_LOG_FILE_ALL].
     * If the last action is older FORM_LOG_FILE_EXPIRE, the file will be deleted and formLog mode stops (disabled).
     *
     * @param array $form
     * @return array
Marc Egger's avatar
Marc Egger committed
935
936
937
     * @throws \CodeException
     * @throws \UserFormException
     * @throws \UserReportException
938
939
940
941
942
943
944
945
     */
    private function checkFormLogMode(array $form) {

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

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

                if (time() - $arr['mtime'] > FORM_LOG_FILE_EXPIRE) {
949
                    HelperFile::unlink($file);
950
951
                } else {
                    $form[FORM_LOG_FILE . '_' . $mode] = $file;
952
                    $form[FORM_LOG_ACTIVE] = 1;
953
954
955
956
957
958
959
                }
            }
        }

        return $form;
    }

960
    /**
961
962
     * Get form name
     * Check if the form is in log mode: set formLog and return
963
     * Load form. Evaluates form. Load FormElements.
964
     *
Carsten  Rose's avatar
Carsten Rose committed
965
     * After processing:
966
967
968
969
     * Loaded Form is in  $this->formSpec
     * Loaded 'action' FormElements are in $this->feSpecAction
     * Loaded 'native' FormElements are in $this->feSpecNative
     *
970
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE|FORM_REST
Carsten  Rose's avatar
Carsten Rose committed
971
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
972
     * @param string $foundInStore
973
     * @param string $formLogMode
Carsten  Rose's avatar
Carsten Rose committed
974
     * @return bool|string if found the formName, else 'false'.
975
     *
Marc Egger's avatar
Marc Egger committed
976
977
978
979
     * @throws \CodeException
     * @throws \DbException
     * @throws \UserFormException
     * @throws \UserReportException
980
     */
981
982
983
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '', &$formLogMode = '') {

        $formLogMode = false; // Important: if no form is found, formLogMode needs also to be false.