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

namespace qfq;

Carsten  Rose's avatar
Carsten Rose committed
11
use qfq;
12
13
14
15
16
17
18
19
20

//use qfq\Report;

//use qfq\BuildFormPlain;
//use qfq\BuildFormTable;
//use qfq\BuildFormBootstrap;
//use qfq\UserException;
//use qfq\CodeException;
//use qfq\DbException;
21
//use qfq\helper;
22
//use qfq\Store;
Carsten  Rose's avatar
Carsten Rose committed
23

Carsten  Rose's avatar
Carsten Rose committed
24

25
26
27
28
29
30
31
32
33
34
35
require_once(__DIR__ . '/store/Store.php');
require_once(__DIR__ . '/store/FillStoreForm.php');
require_once(__DIR__ . '/store/Session.php');
require_once(__DIR__ . '/Constants.php');
require_once(__DIR__ . '/Save.php');
require_once(__DIR__ . '/helper/KeyValueStringParser.php');
require_once(__DIR__ . '/helper/HelperFormElement.php');
require_once(__DIR__ . '/exceptions/UserFormException.php');
require_once(__DIR__ . '/exceptions/CodeException.php');
require_once(__DIR__ . '/exceptions/DbException.php');
require_once(__DIR__ . '/exceptions/ErrorHandler.php');
36
37
require_once(__DIR__ . '/database/Database.php');
require_once(__DIR__ . '/database/DatabaseUpdate.php');
38
39
40
41
42
43
44
require_once(__DIR__ . '/Evaluate.php');
require_once(__DIR__ . '/BuildFormPlain.php');
require_once(__DIR__ . '/BuildFormTable.php');
require_once(__DIR__ . '/BuildFormBootstrap.php');
require_once(__DIR__ . '/report/Report.php');
require_once(__DIR__ . '/BodytextParser.php');
require_once(__DIR__ . '/Delete.php');
45
require_once(__DIR__ . '/form/FormAction.php');
Carsten  Rose's avatar
Carsten Rose committed
46
require_once(__DIR__ . '/form/Dirty.php');
47

48
49
50
51
52
53
54
55
56
57
58
59
/*
 * 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
60
/**
61
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
62
63
 * @package qfq
 */
64
class QuickFormQuery {
65

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

71
72
73
    /**
     * @var Database instantiated class
     */
74
    protected $db = null;
75

76
77
78
79
    /**
     * @var Evaluate instantiated class
     */
    protected $eval = null;
80
81
82
    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
83

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

89
90
91
    /**
     * @var bool
     */
92
93
    private $phpUnit = false;

94
95
96
97
98
    /**
     * @var Session
     */
    private $session = null;

99
100
101
102
103
104
105
106
107
108
109
    /*
     * 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'
     */
110

111
112
113
114
115
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
     * 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.
116
     *
117
118
119
120
     * @param array $t3data
     * @param bool $phpUnit
     * @throws CodeException
     * @throws UserFormException
121
     */
122
123
    public function __construct(array $t3data = array(), $phpUnit = false) {

124
125
        $this->phpUnit = $phpUnit;

126
        mb_internal_encoding("UTF-8");
127

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

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

133
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
134

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

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

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

146
147
        $this->t3data = $t3data;

148
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
149
150

        $this->store = Store::getInstance($bodytext, $phpUnit);
151
        $this->store->systemStoreUpdate();
152
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
153
        $this->db = new Database();
154

155
        $this->eval = new Evaluate($this->store, $this->db);
156

157
        $dbUpdate = $this->store->getVar(SYSTEM_DB_UPDATE, STORE_SYSTEM);
158
        $updateDb = new DatabaseUpdate($this->db);
159
        $updateDb->checkNupdate($dbUpdate);
160

Carsten  Rose's avatar
Carsten Rose committed
161
162
    }

163
    /**
164
     * Returns the defined forwardMode and set forwardPage
165
     *
166
     * @return array
167
     */
168
169
    public function getForwardMode() {

Carsten  Rose's avatar
Carsten Rose committed
170
171
172
173
174
175
176
177
178
        $forwardPage = $this->eval->parse($this->formSpec[F_FORWARD_PAGE]);
        if ($this->formSpec[F_FORWARD_MODE] == F_FORWARD_MODE_URL_SIP) {
            $forwardPage = store::getSipInstance()->queryStringToSip($forwardPage, RETURN_URL);
            // F_FORWARD_MODE_URL_SIP is not defined in API PROTOCOL. At the moment it's only used for 'copyForm'.
            // 'copyForm' behaves better if the page is not in history.
            // An option for better implenting would be to separate SKIP History from ForwardMode. For API, it can be combined again.
            $this->formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_URL_SKIP_HISTORY;
        }

179
180
        return ([
            API_REDIRECT => $this->formSpec[F_FORWARD_MODE],
Carsten  Rose's avatar
Carsten Rose committed
181
            API_REDIRECT_URL => $forwardPage,
182
        ]);
183
184
    }

185
    /**
Carsten  Rose's avatar
Carsten Rose committed
186
     * Main entrypoint for display content: a) form and/or b) report
187
     *
188
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
189
     */
190
    public function process() {
191
        $html = '';
192

193
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
194
195
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
196
197
198
        }

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

201
        // 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
202
203
204
205
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

206
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
207
        if ($class) {
208
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
209
210
        }

211
        return $html;
212
213
    }

214
    /**
215
     * Process form.
216
217
218
219
220
     * $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:
221
     *
222
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
223
     * @return array|string
224
     * @throws CodeException
225
     * @throws UserFormException
226
     */
227
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
228
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
229
        $foundInStore = '';
230

Carsten  Rose's avatar
Carsten Rose committed
231
        // Fill STORE_FORM
232
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
233
234
235
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
236

237
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO);
238
239

        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore);
240
        if ($formName === false && $formMode !== FORM_DELETE) {
241
            // No form found: do nothing
242
            return '';
243
        }
244

245
246
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
247
            $sipFound = $this->validateForm($foundInStore, $formMode);
248
249

        } else {
250
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
251
252
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
253
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
254
255
256
257
258
259
            }
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
        }

260
261
        // 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.
262
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
263
264
            $this->store->createSipAfterFormLoad($formName);
        }
265

266
267
268
269
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

270
        // Check (and release) dirtyRecord.
Carsten  Rose's avatar
Carsten Rose committed
271
        if ($formMode === FORM_DELETE || $formMode === FORM_SAVE) {
272
            $recordDirty = array();
Carsten  Rose's avatar
Carsten Rose committed
273
            $dirty = new Dirty();
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
            // Comment as long as long as 4127 is open
            $dirty->checkDirtyAndRelease($formMode, $this->formSpec[F_RECORD_LOCK_TIMEOUT_SECONDS],
                $this->formSpec[F_DIRTY_MODE], $this->formSpec[F_TABLE_NAME], $recordId);
//
//            $lockStatus = $dirty->getCheckDirty($this->formSpec[F_TABLE_NAME], $recordId, $recordDirty, $msg);
//            switch ($lockStatus) {
//                case LOCK_NOT_FOUND:
//                    if ($this->formSpec[F_DIRTY_MODE] != DIRTY_MODE_NONE) {
//                        throw new UserFormException("Missing record lock: please reload the form, edit and save again.", ERROR_DIRTY_MISSING_LOCK);
//                    }
//                    break;
//                case LOCK_FOUND_CONFLICT:
//                    throw new UserFormException($msg, ERROR_DIRTY_ALREADY_LOCKED);
//                case LOCK_FOUND_OWNER:
//                    break;
//                default:
//            }
Carsten  Rose's avatar
Carsten Rose committed
291
292
        }

293
        if ($formMode === FORM_DELETE) {
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312

            $build = new Delete();

        } else {
            $this->store->fillStoreTableDefaultColumnType($this->formSpec[F_TABLE_NAME]);

            switch ($this->formSpec['render']) {
                case 'plain':
                    $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                case 'table':
                    $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                case 'bootstrap':
                    $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                    break;
                default:
                    throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
            }
313
314
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
315
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
316
        switch ($formMode) {
317
            case FORM_LOAD:
318
319
320
321
322
323
324
325
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
                $data = $build->process($formMode);
                $data = Support::wrapTag("<div class='" . 'col-md-' . $this->formSpec[F_BS_COLUMNS] . "'>", $data);
                $data = Support::wrapTag("<div class='row'>", $data);

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

Carsten  Rose's avatar
Carsten Rose committed
326
            case FORM_UPDATE:
327
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
328
329
                // data['form-update']=....
                $data = $build->process($formMode);
330
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
331
                break;
Carsten  Rose's avatar
Carsten Rose committed
332

333
334
335
336
337
338
339
340
            case FORM_DELETE:
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_DELETE);

                $build->process($this->formSpec[F_TABLE_NAME], $recordId);

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

341
            case FORM_SAVE:
342
343
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

344
                // Action: Before
345
346
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

350
                // SAVE
351
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
352
353
                $rc = $save->process();

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

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

359
                // Action: After
360
361
                $status = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
362
                    // Reload fresh saved record and fill STORE_RECORD with it.
363
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
364
                }
365

Carsten  Rose's avatar
Carsten Rose committed
366
367
368
369
370
371
372
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

                //                $htmlElementNameIdZero = false;
373
                $getJson = true;
374
375
376
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
377

Carsten  Rose's avatar
Carsten Rose committed
378
379
380
381
                    if ($this->formSpec[F_FORWARD_MODE] !== F_FORWARD_MODE_URL &&
                        $this->formSpec[F_FORWARD_MODE] !== F_FORWARD_MODE_URL_SKIP_HISTORY &&
                        $this->formSpec[F_FORWARD_MODE] !== F_FORWARD_MODE_URL_SIP
                    ) {
382
                        $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
383
384
                    }
                    $getJson = false;
385
                }
386

387
388
389
390
391
392
                if ($getJson) {
                    // Retrieve FE Values as JSON
                    // $data['form-update']=...
//                    $data = $build->process($formMode, $htmlElementNameIdZero);
                    $data = $build->process($formMode);
                }
393
                break;
Carsten  Rose's avatar
Carsten Rose committed
394

395
396
397
398
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

399
        if (is_array($data)) {
400
            // $data['element-update']=...
401
402
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
403

Carsten  Rose's avatar
Carsten Rose committed
404
        return $data;
405
406
    }

Carsten  Rose's avatar
Carsten Rose committed
407
408
409
410
411
412
413
414
415
416
417
    /**
     * Iterate over all Clipboard source records and fire for each all FE.type=paste records.
     *
     * @param int $formId
     * @param FormAction $formAction
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    private function pasteClipboard($formId, FormAction $formAction) {

418
419
420
421
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
        $cookieQfq = $this->store->getVar(CLIENT_COOKIE_QFQ, STORE_CLIENT, SANITIZE_ALLOW_ALNUMX);
        if ($cookieQfq === false || $cookieQfq == '') {
            throw new UserFormException('Qfq Session missing', ERROR_QFQ_SESSION_MISSING);
        }

        # select clipboard records
        $sql = "SELECT c.idSrc as id, c.xId FROM Clipboard AS c WHERE c.cookie='$cookieQfq' AND c.formIdPaste=$formId ORDER BY c.id";
        $arrClipboard = $this->db->sql($sql);

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

    } # doClipboard()

438
439
440
441
442
443
444
445
446
447
448
449
450
451
    /**
     * @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;
            }
        }
        return false;

    }

452
453
454
455
456
457
458
459
460
461
462
463
    /**
     * 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
     * @param $recordId
     * @return array
     * @throws CodeException
     * @throws UserFormException
     */
    private function buildNSetReloadUrl(array $formSpec, $recordId) {

464
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481

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

    }

482
    /**
483
     * Load form. Evaluates form. Load FormElements.
484
     *
Carsten  Rose's avatar
Carsten Rose committed
485
     * After processing:
486
487
488
489
     * Loaded Form is in  $this->formSpec
     * Loaded 'action' FormElements are in $this->feSpecAction
     * Loaded 'native' FormElements are in $this->feSpecNative
     *
Carsten  Rose's avatar
Carsten Rose committed
490
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
491
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
492
493
494
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
495
     * @throws DbException
496
     * @throws UserFormException
497
     */
498
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
499

500
        // formName
Carsten  Rose's avatar
Carsten Rose committed
501
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
502
503
            return false;
        }
504

505
506
507
508
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

512
513
514
515
516
517
518
        // Check if there is a recordId specified in Bodytext - as variable or query.
        $rTmp = $this->store->getVar(CLIENT_RECORD_ID, STORE_TYPO3, SANITIZE_ALLOW_ALL);
        if (false !== $rTmp && !is_int($rTmp)) {
            $rTmp = $this->eval->parse($rTmp);
            $this->store->setVar(CLIENT_RECORD_ID, $rTmp, STORE_TYPO3);
        }

519
        // Load form
520
        $form = $this->db->sql("SELECT * FROM Form AS f WHERE f." . F_NAME . " LIKE ? AND f.deleted='no'", ROW_EXPECT_1,
521
            [$formName], 'Form not found or multiple forms with the same name.');
522

523
        $form = $this->modeCleanFormConfig($mode, $form);
524

Carsten  Rose's avatar
Carsten Rose committed
525
526
527
528
        // Save specific elements to be expanded later.
        $parseLater = OnArray::getArrayItems($form, [F_FORWARD_PAGE]);
        $form[F_FORWARD_PAGE] = '';

529
        $formSpec = $this->eval->parseArray($form);
530
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
531

532
533
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
534

Carsten  Rose's avatar
Carsten Rose committed
535
536
        $formSpec = array_merge($formSpec, $parseLater);

537
        // Set F_FINAL_DELETE_FORM
538
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
539

540
        $this->formSpec = $formSpec;
541

542
543
544
        // this is needed for filling templateGroup records with their default values
        $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_RECORD);

Carsten  Rose's avatar
Carsten Rose committed
545
        // Clear
546
547
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

548
        // FE: Action
549
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
550
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
551
552

        // FE: Native & Container
553
554
555
        // "SELECT *, ? AS 'nestedInFieldSet' FROM FormElement AS fe WHERE fe.formId = ? AND fe.deleted = 'no' AND FIND_IN_SET(fe.class, ? ) AND fe.feIdContainer = ? AND fe.enabled='yes' ORDER BY fe.ord, fe.id";
        switch ($mode) {
            case FORM_LOAD:
556
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
557
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
558
559
560
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
561
            case FORM_UPDATE:
Carsten  Rose's avatar
Carsten Rose committed
562
//              $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
563
                $this->feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
564
565
                break;

566
567
568
569
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

570
            default:
571
                break;
572
573
        }

574
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
575
576
    }

577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
    /**
     * Depending on $sql reads FormElements to a specific container or all. Preprocess all FormElements.
     * This code is dirty: the nearly same function exists in class 'Database' - the difference is only 'explodeTemplateGroupElements()'.
     *
     * @param string $sql SQL_FORM_ELEMENT_SPECIFIC_CONTAINER | SQL_FORM_ELEMENT_ALL_CONTAINER
     * @param array $param Parameter which matches the prepared statement in $sql
     * @param array $formSpec Main FormSpec to copy generic parameter to FormElements
     * @return array|int
     * @throws \qfq\CodeException
     * @throws \qfq\DbException
     */
    public function getNativeFormElements($sql, array $param, $formSpec) {

        $feSpecNative = $this->db->sql($sql, ROW_REGULAR, $param);

592
593
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);

594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
        // Explode and Do $FormElement.parameter
        HelperFormElement::explodeParameterInArrayElements($feSpecNative, FE_PARAMETER);

        // Check for retype FormElements which have to duplicated.
        $feSpecNative = HelperFormElement::duplicateRetypeElements($feSpecNative);

        // Check for templateGroup Elements to explode them
        $feSpecNative = $this->explodeTemplateGroupElements($feSpecNative);

        // Copy Attributes to FormElements
        $feSpecNative = HelperFormElement::copyAttributesToFormElements($formSpec, $feSpecNative);

        return $feSpecNative;
    }

    /**
     * Iterate over all FormElements in $elements. If a row has a column NAME_TG_COPIES, copy those elements NAME_TG_COPIES-times.
     * Adjust FE_TEMPLATE_GROUP_NAME_PATTERN (='%d') with current count on column FE_NAME and FE_LABEL.
     *
     * This code is dirty: only to get JSON value, we have to initialize the STORE_RECORD (done earlier) to be capable to
     *  parse fe[FE_VALUE], which probably contains as string like '{{!SELECT value FROM table WHERE xId={{id}} ORDER BY id}}' -
     *  the {{id}} needs to be replaced by the current recordId (primary record).
     *
     * Attention: The resulting order of the FormElements, is not the same as on the Form during FormLoad!
     *
     * @param array $elements
     * @return array
     */
    private function explodeTemplateGroupElements(array $elements) {
        $new = array();

        // No FormElements or no NAME_TG_COPIES column: nothing to do, return.
        if ($elements == array() || count($elements) == 0 || !isset($elements[0][NAME_TG_COPIES])) {
            return $elements;
        }

        // Iterate over all
        foreach ($elements as $row) {
            if (isset($row[NAME_TG_COPIES]) && $row[NAME_TG_COPIES] > 0) {
                $row[FE_VALUE] = $this->eval->parse($row[FE_VALUE]);
                for ($ii = 1; $ii <= $row[NAME_TG_COPIES]; $ii++) {
                    $tmpRow = $row;
                    if (is_array($row[FE_VALUE])) {
                        $tmpRow[FE_VALUE] = ($ii <= count($row[FE_VALUE])) ? current($row[FE_VALUE][$ii - 1]) : '';
                    }
                    unset($tmpRow[NAME_TG_COPIES]);
                    $tmpRow[FE_NAME] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $tmpRow[FE_NAME]);
                    $tmpRow[FE_LABEL] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $tmpRow[FE_LABEL]);
                    $new[] = $tmpRow;
                }
            } else {
                $new[] = $row;
            }
        }
        return $new;
    }


Carsten  Rose's avatar
Carsten Rose committed
652
    /**
653
654
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
655
656
657
658
659
660
661
662
663
664
665
666
     * FORM_LOAD:
     *   Specified in T3 body text with form=<formname>            Returned Store:Typo3
     *   Specified in T3 body text with form={{form}} ':FSRD'      Returned Store:SIP
     *   Specified in T3 body text with form={{form:C:ALNUMX}}     Returned Store:Client
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:S0}} }}
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:C0:DIGIT}} }}
     *   Specified in SIP
     *
     * FORM_SAVE:
     *   Specified in SIP
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
667
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
668
     * @param string $foundInStore
669
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
670
     * @throws CodeException
671
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
672
     */
673
    public function getFormName($mode, &$foundInStore = '') {
674
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
675

Carsten  Rose's avatar
Carsten Rose committed
676
677
678
679
680
681
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
682
683
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
684
685
686
687
688
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

689
690
        $storeFormName = $this->store->getVar(SIP_FORM, $store, '', $foundInStore);
        $formName = $this->eval->parse($storeFormName, 0, $dummy, $foundInStore);
Carsten  Rose's avatar
Carsten Rose committed
691

692
693
694
695
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

696
        // If the formname is '': no formname name.
697
        if ($formName === '' || $foundInStore === '')
698
699
700
701
702
703
            return false;

        // If the formname is surrounded by single ticks: the token (typically 'form') has not been replaced by a value.
        if ($formName[0] === "'" && $formName[strlen($formName) - 1] === "'") {
            return false;
        }
704

705
        return $formName;
706
    }
Carsten  Rose's avatar
Carsten Rose committed
707

708
709
710
711
712
713
714
715
    /**
     * Depending on $mode various formSpec fields might be adjusted.
     * E.g.: the form title is not important during a delete.
     *
     * @param $mode
     * @param array $form
     * @return array
     */
716
    private function modeCleanFormConfig($mode, array $form) {
717
718
719
720
721
722
723
724
725
726
727
728

        switch ($mode) {
            case FORM_DELETE:
                $form[F_TITLE] = '';
                break;
            default:
                break;
        }

        return $form;
    }

729
    /**
730
731
732
733
734
735
     * The named $keys will be synced between STORE_SYSTEM and $formSpec (both directions).
     * The per form definition has precedence over STORE_SYSTEM.
     * STORE_SYSTEM if filled with the default values (config.qfq.ini or if note exist than QFQ hardcoded)
     * Copying the 'Form' definition back to the system store helps to access the values
     * by '{{ ...:Y}}' (system store). E.g. the value of bs-*-columns might be displayed as placeholder in the
     * corresponding inputfield.
736
     *
737
738
739
     * @param array $formSpec
     * @return array
     */
740
741
    private function syncSystemFormConfig(array $formSpec) {

742
743
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
744
745
746
747
748
749
750
751
752
            F_BS_INPUT_COLUMNS,
            F_BS_NOTE_COLUMNS,
            F_FE_DATA_PATTERN_ERROR,
            F_FE_DATA_REQUIRED_ERROR,
            F_FE_DATA_MATCH_ERROR,
            F_FE_DATA_ERROR,
            F_CLASS,
            F_CLASS_PILL,
            F_CLASS_BODY,
753
            F_BUTTON_ON_CHANGE_CLASS,
754
            F_ESCAPE_TYPE_DEFAULT,
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
            F_SAVE_BUTTON_TEXT,
            F_SAVE_BUTTON_TOOLTIP,
            F_SAVE_BUTTON_CLASS,
            F_SAVE_BUTTON_GLYPH_ICON,

            F_CLOSE_BUTTON_TEXT,
            F_CLOSE_BUTTON_TOOLTIP,
            F_CLOSE_BUTTON_CLASS,
            F_CLOSE_BUTTON_GLYPH_ICON,

            F_DELETE_BUTTON_TEXT,
            F_DELETE_BUTTON_TOOLTIP,
            F_DELETE_BUTTON_CLASS,
            F_DELETE_BUTTON_GLYPH_ICON,

            F_NEW_BUTTON_TEXT,
            F_NEW_BUTTON_TOOLTIP,
            F_NEW_BUTTON_CLASS,
            F_NEW_BUTTON_GLYPH_ICON,

775
776
            F_RECORD_LOCK_TIMEOUT_SECONDS,

777
778
779
780
        ];

        // By definition: existing vars which are empty, means: EMPTY - do not use any default!
        // But: if these variables are table columns, they always exist. For those: empty value means 'not set' - unset those.
781
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
782
783
784
785
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
786

787
        foreach ($keys as $key) {
788

789
790
791
792
793
794
795
            if (isset($formSpec[$key])) {
                $this->store->setVar($key, $formSpec[$key], STORE_SYSTEM);
            } else {
                // if not found set ''
                $formSpec[$key] = $this->store->getVar($key, STORE_SYSTEM . STORE_EMPTY);
            }
        }
796

797
798
        return $formSpec;
    }
799

800
801
802
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
803
     * @param array $formSpec
804
805
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
806
807
808
809
810
811
812
813
814
815
816
    private function initForm(array $formSpec) {
        Support::setIfNotSet($formSpec, F_EXTRA_DELETE_FORM, '');
        Support::setIfNotSet($formSpec, F_SUBMIT_BUTTON_TEXT, '');
        Support::setIfNotSet($formSpec, F_BUTTON_ON_CHANGE_CLASS, '');
        Support::setIfNotSet($formSpec, F_LDAP_USE_BIND_CREDENTIALS, '');
        Support::setIfNotSet($formSpec, F_MODE, '');

        if ($formSpec[F_MODE] == F_MODE_READONLY) {
            $formSpec[F_SHOW_BUTTON] = FORM_BUTTON_CLOSE;
            $formSpec[F_SUBMIT_BUTTON_TEXT] = '';
        }
817

818
        if ($formSpec[F_ESCAPE_TYPE_DEFAULT] == TOKEN_ESCAPE_CONFIG) {
819
820
821
            $formSpec[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(F_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

Carsten  Rose's avatar
Carsten Rose committed
822
        return $formSpec;
823
824
    }

825
    /**
Carsten  Rose's avatar
Carsten Rose committed
826
     * Check if loading of the given form is permitted. If not, throw an exception.
827
     *
Carsten  Rose's avatar
Carsten Rose committed
828
829
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
830
     * @throws CodeException
831
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
832
     * @internal param $foundInStore
833
     */
834
    private function validateForm($formNameFoundInStore, $formMode) {
835
836

        // Retrieve record_id either from SIP (prefered) or via URL
837
        $r = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT, '', $recordIdFoundInStore);
838

Carsten  Rose's avatar
Carsten Rose committed
839
        // Set missing 'r'.
840
        if ($r === false) {
841
842
843
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
844
845
        }

Carsten  Rose's avatar
Carsten Rose committed
846
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
847
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
848
849
850
851
852

        $feUserLoggedIn = isset($GLOBALS["TSFE"]->fe_user->user["uid"]) && $GLOBALS["TSFE"]->fe_user->user["uid"] > 0;

        $sipFound = $this->store->getVar(SIP_SIP, STORE_SIP) !== false;

Carsten  Rose's avatar
Carsten Rose committed
853
854
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
855
                throw new UserFormException("SIP exist but FORM or RECORD_ID are given by CLIENT.", ERROR_SIP_EXIST_BUT_OTHER_PARAM_GIVEN_BY_CLIENT);
Carsten  Rose's avatar
Carsten Rose committed
856
857
858
            }
        }

859
        switch ($permitMode) {
860
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
861
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
862
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
863
864
865
866
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
867
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
868
869
870
871
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
872
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
873
874
875
876
877
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
878
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
879
            default:
880
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
881
        }
Carsten  Rose's avatar
Carsten Rose committed
882

Carsten  Rose's avatar
Carsten Rose committed
883
        // Form Definition valid?
884
        if ($this->formSpec['multiMode'] !== 'none' && $this->formSpec['multiSql'] === '') {
885
            throw new UserFormException("MultiMode selected, but MultiSQL missing", ERROR_MULTI_SQL_MISSING);
Carsten  Rose's avatar
Carsten Rose committed
886
887
        }

888
889
890
891
892
        if ($formMode !== FORM_DELETE) {
            $sipArray = $this->store->getStore(STORE_SIP);
            // Check: requiredParameter: '' or 'form' or 'form,grId' or 'form #formname for form,grId'
            $param = explode(',', $this->formSpec[F_REQUIRED_PARAMETER]);
            foreach ($param AS $name) {
893

894
895
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
896

897
898
899
                if ($name === '') {
                    continue;
                }
900

901
902
903
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
904
905
906
            }
        }

907
        return $sipFound;
908
    }
Carsten  Rose's avatar
Carsten Rose committed
909

910
    /**
911
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
912
     *
913
914
915
     * @param string $table tablename from where to load record wiht $recordId
     * @param string $recordId record ID of current record
     * @param string $store name of store where to save the record
916
917
918
919
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
920
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
921
922
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
923
            $this->store->setStore($record, $store, true);
924
925
926
        }
    }

927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
    /**
     * Searches the whole array $dataArray on the second level for API_ELEMENT_UPDATE.
     * All found elements collect under $collect[API_ELEMENT_UPDATE]... . Leave the rest unchanged.
     *
     * @param array $dataArray
     * @return array to build JSON
     */
    private function groupElementUpdateEntries(array $dataArray) {
        $collect = array();

        foreach ($dataArray as $data) {

            if (isset($data[API_ELEMENT_UPDATE])) {
                foreach ($data[API_ELEMENT_UPDATE] as $key => $item) {
                    $collect[API_ELEMENT_UPDATE][$key] = $item;
                }
                unset($data[API_ELEMENT_UPDATE]);
            }
            $collect[] = $data;
        }

        return $collect;
    }

951
    /**
952
953
     * Process the SQL Queries from bodytext. Return the output.
     *
954
955
     * @return string
     */
956
    private function doReport() {
957

958
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
959

960
        $html = $report->process($this->t3data['bodytext']);
961
962
963
964
965

        return $html;

    }

966
    /**
967
968
     * Save the current form.
     *
969
     * @return string
970
971
     * @throws CodeException
     * @throws UserFormException
972
973
974
     */
    public function saveForm() {

975
        $json = $this->doForm(FORM_SAVE);
976

977
        return $json;
978
979
    }

Carsten  Rose's avatar
Carsten Rose committed
980
981
982
983
984
985
986
987
988
989
990
991
992
    /**
     * Update FormElements and form values. Receives the current form values via POST.
     *
     * @return array
     * @throws CodeException
     */
    public function updateForm() {

        $json = $this->doForm(FORM_UPDATE);

        return $json;
    }

993
994
995
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
996
     * @return bool
997
998
999
1000
     * @throws CodeException
     */
    public function delete() {