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

Carsten  Rose's avatar
Carsten Rose committed
9

10
11
namespace qfq;

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

//use qfq\Report;

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

Carsten  Rose's avatar
Carsten Rose committed
25

26
27
28
29
30
31
32
33
34
35
36
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');
37
38
require_once(__DIR__ . '/database/Database.php');
require_once(__DIR__ . '/database/DatabaseUpdate.php');
39
40
41
42
43
44
45
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');
46
require_once(__DIR__ . '/form/FormAction.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->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
152
        $this->db = new Database();
153

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

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

Carsten  Rose's avatar
Carsten Rose committed
160
161
    }

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

Carsten  Rose's avatar
Carsten Rose committed
169
170
171
172
173
174
175
176
177
        $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;
        }

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

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

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

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

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

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

210
        return $html;
211
212
    }

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

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

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

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

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

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

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

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

269
        if ($formMode === FORM_DELETE) {
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

            $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);
            }
289
290
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
291
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
292
        switch ($formMode) {
293
            case FORM_LOAD:
294
295
296
297
298
299
300
301
                $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
302
            case FORM_UPDATE:
303
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
304
305
                // data['form-update']=....
                $data = $build->process($formMode);
306
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
307
                break;
Carsten  Rose's avatar
Carsten Rose committed
308

309
310
311
312
313
314
315
316
            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;

317
            case FORM_SAVE:
318
319
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

320
                // Action: Before
321
322
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

326
                // SAVE
327
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
328
329
                $rc = $save->process();

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

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

335
                // Action: After
336
337
338
                $modified = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($modified) {
                    // Reload fresh saved record and fill STORE_RECORD with it.
339
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
340
                }
341

Carsten  Rose's avatar
Carsten Rose committed
342
343
344
345
346
347
348
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

                //                $htmlElementNameIdZero = false;
349
                $getJson = true;
350
351
352
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
353

Carsten  Rose's avatar
Carsten Rose committed
354
355
356
357
                    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
                    ) {
358
                        $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
359
360
                    }
                    $getJson = false;
361
                }
362

363
364
365
366
367
368
                if ($getJson) {
                    // Retrieve FE Values as JSON
                    // $data['form-update']=...
//                    $data = $build->process($formMode, $htmlElementNameIdZero);
                    $data = $build->process($formMode);
                }
369
                break;
Carsten  Rose's avatar
Carsten Rose committed
370

371
372
373
374
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

375
        if (is_array($data)) {
376
            // $data['element-update']=...
377
378
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
379

Carsten  Rose's avatar
Carsten Rose committed
380
        return $data;
381
382
    }

Carsten  Rose's avatar
Carsten Rose committed
383
384
385
386
387
388
389
390
391
392
393
    /**
     * 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) {

394
395
396
397
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
        $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()

414
415
416
417
418
419
420
421
422
423
424
425
426
427
    /**
     * @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;

    }

428
429
430
431
432
433
434
435
436
437
438
439
    /**
     * 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) {

440
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457

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

    }

458
    /**
459
     * Load form. Evaluates form. Load FormElements.
460
     *
Carsten  Rose's avatar
Carsten Rose committed
461
     * After processing:
462
463
464
465
     * 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
466
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
467
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
468
469
470
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
471
     * @throws DbException
472
     * @throws UserFormException
473
     */
474
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
475

476
        // formName
Carsten  Rose's avatar
Carsten Rose committed
477
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
478
479
            return false;
        }
480

481
482
483
484
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

488
489
490
491
492
493
494
        // 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);
        }

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

499
        $form = $this->modeCleanFormConfig($mode, $form);
500

Carsten  Rose's avatar
Carsten Rose committed
501
502
503
504
        // Save specific elements to be expanded later.
        $parseLater = OnArray::getArrayItems($form, [F_FORWARD_PAGE]);
        $form[F_FORWARD_PAGE] = '';

505
        $formSpec = $this->eval->parseArray($form);
506
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
507

508
509
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
510

Carsten  Rose's avatar
Carsten Rose committed
511
512
        $formSpec = array_merge($formSpec, $parseLater);

513
        // Set F_FINAL_DELETE_FORM
514
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
515

516
        $this->formSpec = $formSpec;
517

518
519
520
        // 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
521
        // Clear
522
523
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

524
        // FE: Action
525
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
526
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
527
528

        // FE: Native & Container
529
530
531
        // "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:
532
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
533
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
534
535
536
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
537
            case FORM_UPDATE:
Carsten  Rose's avatar
Carsten Rose committed
538
//              $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
539
            $this->feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
540
541
                break;

542
543
544
545
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

546
            default:
547
                break;
548
549
        }

550
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
551
552
    }

553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
    /**
     * 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);

568
569
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);

570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
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
        // 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
628
    /**
629
630
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
631
632
633
634
635
636
637
638
639
640
641
642
     * 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
643
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
644
     * @param string $foundInStore
645
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
646
     * @throws CodeException
647
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
648
     */
649
    public function getFormName($mode, &$foundInStore = '') {
650
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
651

Carsten  Rose's avatar
Carsten Rose committed
652
653
654
655
656
657
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
658
659
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
660
661
662
663
664
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

668
669
670
671
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

672
        // If the formname is '': no formname name.
673
        if ($formName === '' || $foundInStore === '')
674
675
676
677
678
679
            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;
        }
680

681
        return $formName;
682
    }
Carsten  Rose's avatar
Carsten Rose committed
683

684
685
686
687
688
689
690
691
    /**
     * 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
     */
692
    private function modeCleanFormConfig($mode, array $form) {
693
694
695
696
697
698
699
700
701
702
703
704

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

        return $form;
    }

705
    /**
706
707
708
709
710
711
     * 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.
712
     *
713
714
715
     * @param array $formSpec
     * @return array
     */
716
717
    private function syncSystemFormConfig(array $formSpec) {

718
719
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
720
721
722
723
724
725
726
727
728
            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,
729
            F_BUTTON_ON_CHANGE_CLASS,
730
            F_ESCAPE_TYPE_DEFAULT,
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
            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,

751
752
753
754
        ];

        // 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.
755
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
756
757
758
759
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
760

761
        foreach ($keys as $key) {
762

763
764
765
766
767
768
769
            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);
            }
        }
770

771
772
        return $formSpec;
    }
773

774
775
776
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
777
     * @param array $formSpec
778
779
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
780
781
782
783
784
785
786
787
788
789
790
    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] = '';
        }
791

792
        if ($formSpec[F_ESCAPE_TYPE_DEFAULT] == TOKEN_ESCAPE_CONFIG) {
793
794
795
            $formSpec[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(F_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

Carsten  Rose's avatar
Carsten Rose committed
796
        return $formSpec;
797
798
    }

799
    /**
Carsten  Rose's avatar
Carsten Rose committed
800
     * Check if loading of the given form is permitted. If not, throw an exception.
801
     *
Carsten  Rose's avatar
Carsten Rose committed
802
803
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
804
     * @throws CodeException
805
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
806
     * @internal param $foundInStore
807
     */
808
    private function validateForm($formNameFoundInStore, $formMode) {
809
810

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

Carsten  Rose's avatar
Carsten Rose committed
813
        // Set missing 'r'.
814
        if ($r === false) {
815
816
817
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
818
819
        }

Carsten  Rose's avatar
Carsten Rose committed
820
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
821
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
822
823
824
825
826

        $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
827
828
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
829
                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
830
831
832
            }
        }

833
        switch ($permitMode) {
834
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
835
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
836
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
837
838
839
840
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
841
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
842
843
844
845
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
846
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
847
848
849
850
851
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
852
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
853
            default:
854
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
855
        }
Carsten  Rose's avatar
Carsten Rose committed
856

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

862
863
864
865
866
        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) {
867

868
869
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
870

871
872
873
                if ($name === '') {
                    continue;
                }
874

875
876
877
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
878
879
880
            }
        }

881
        return $sipFound;
882
    }
Carsten  Rose's avatar
Carsten Rose committed
883

884
    /**
885
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
886
     *
887
888
889
     * @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
890
891
892
893
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
894
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
895
896
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
897
            $this->store->setStore($record, $store, true);
898
899
900
        }
    }

901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
    /**
     * 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;
    }

925
    /**
926
927
     * Process the SQL Queries from bodytext. Return the output.
     *
928
929
     * @return string
     */
930
    private function doReport() {
931

932
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
933

934
        $html = $report->process($this->t3data['bodytext']);
935
936
937
938
939

        return $html;

    }

940
    /**
941
942
     * Save the current form.
     *
943
     * @return string
944
945
     * @throws CodeException
     * @throws UserFormException
946
947
948
     */
    public function saveForm() {

949
        $json = $this->doForm(FORM_SAVE);
950

951
        return $json;
952
953
    }

Carsten  Rose's avatar
Carsten Rose committed
954
955
956
957
958
959
960
961
962
963
964
965
966
    /**
     * 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;
    }

967
968
969
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
970
     * @return bool
971
972
973
974
     * @throws CodeException
     */
    public function delete() {

975
        $this->doForm(FORM_DELETE);
976
977

        return true;
978
979
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
980
    /**
Carsten  Rose's avatar
Carsten Rose committed
981
982
     * Based on the given SIP, create a new uniqe SIP by copying the relevant old params and taking the new recordId..
     *
Carsten  Rose's avatar
#2067    
Carsten Rose committed
983
984
985
986
987
988
989
990
991
992
993
994
     * @param $sipArray
     * @param $recordId
     */
    private function newRecordCreateSip($sipArray, $recordId) {

        $tmpParam = array();

        foreach ($sipArray as $key => $value) {
            switch ($key) {
                case SIP_SIP:
                case SIP_URLPARAM:
                case SIP_TABLE:
Carsten  Rose's avatar
Carsten Rose committed
995
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
996
997

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
998
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
999
1000
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;