QuickFormQuery.php 38.2 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');
Carsten  Rose's avatar
Carsten Rose committed
47
require_once(__DIR__ . '/form/Dirty.php');
48

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

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

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

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

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

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

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

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

112
113
114
115
116
    /**
     * 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.
117
     *
118
119
120
121
     * @param array $t3data
     * @param bool $phpUnit
     * @throws CodeException
     * @throws UserFormException
122
     */
123
124
    public function __construct(array $t3data = array(), $phpUnit = false) {

125
126
        $this->phpUnit = $phpUnit;

127
        mb_internal_encoding("UTF-8");
128

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

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

134
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
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] = $btp->process($t3data[T3DATA_BODYTEXT]);
146

147
148
        $this->t3data = $t3data;

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

        $this->store = Store::getInstance($bodytext, $phpUnit);
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);
        }

Carsten  Rose's avatar
Carsten Rose committed
270
271
272
273
274
275
276
        // Check and release dirtyRecord.
        if ($formMode === FORM_DELETE || $formMode === FORM_SAVE) {
            $dirty = new Dirty();
            $timeOutDurationSeconds = $this->store->getVar(STORE_SYSTEM, SYSTEM_DIRTY_RECORD_TIMEOUT_SECONDS);
            $dirty->releaseDirty($this->formSpec[F_DIRTY_MODE], $this->formSpec[F_TABLE_NAME], $recordId, $timeOutDurationSeconds);
        }

277
        if ($formMode === FORM_DELETE) {
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296

            $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);
            }
297
298
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
299
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
300
        switch ($formMode) {
301
            case FORM_LOAD:
302
303
304
305
306
307
308
309
                $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
310
            case FORM_UPDATE:
311
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
312
313
                // data['form-update']=....
                $data = $build->process($formMode);
314
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
315
                break;
Carsten  Rose's avatar
Carsten Rose committed
316

317
318
319
320
321
322
323
324
            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;

325
            case FORM_SAVE:
326
327
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

328
                // Action: Before
329
330
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

334
                // SAVE
335
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
336
337
                $rc = $save->process();

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

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

343
                // Action: After
344
345
                $status = $formAction->elements($rc, $this->feSpecAction, FE_TYPE_AFTER_INSERT . ',' . FE_TYPE_AFTER_UPDATE . ',' . FE_TYPE_AFTER_SAVE);
                if ($status != ACTION_ELEMENT_NO_CHANGE) {
346
                    // Reload fresh saved record and fill STORE_RECORD with it.
347
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
348
                }
349

Carsten  Rose's avatar
Carsten Rose committed
350
351
352
353
354
355
356
                // Action: Paste
                $this->pasteClipboard($this->formSpec[F_ID], $formAction);

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

                //                $htmlElementNameIdZero = false;
357
                $getJson = true;
358
359
360
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
361

Carsten  Rose's avatar
Carsten Rose committed
362
363
364
365
                    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
                    ) {
366
                        $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
367
368
                    }
                    $getJson = false;
369
                }
370

371
372
373
374
375
376
                if ($getJson) {
                    // Retrieve FE Values as JSON
                    // $data['form-update']=...
//                    $data = $build->process($formMode, $htmlElementNameIdZero);
                    $data = $build->process($formMode);
                }
377
                break;
Carsten  Rose's avatar
Carsten Rose committed
378

379
380
381
382
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

383
        if (is_array($data)) {
384
            // $data['element-update']=...
385
386
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
387

Carsten  Rose's avatar
Carsten Rose committed
388
        return $data;
389
390
    }

Carsten  Rose's avatar
Carsten Rose committed
391
392
393
394
395
396
397
398
399
400
401
    /**
     * 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) {

402
403
404
405
        if (!$this->isPasteRecord()) {
            return;
        }

Carsten  Rose's avatar
Carsten Rose committed
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
        $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()

422
423
424
425
426
427
428
429
430
431
432
433
434
435
    /**
     * @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;

    }

436
437
438
439
440
441
442
443
444
445
446
447
    /**
     * 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) {

448
        $formSpec[F_FORWARD_MODE] = API_ANSWER_REDIRECT_URL_SKIP_HISTORY;
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465

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

    }

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

484
        // formName
Carsten  Rose's avatar
Carsten Rose committed
485
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
486
487
            return false;
        }
488

489
490
491
492
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

496
497
498
499
500
501
502
        // 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);
        }

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

507
        $form = $this->modeCleanFormConfig($mode, $form);
508

Carsten  Rose's avatar
Carsten Rose committed
509
510
511
512
        // Save specific elements to be expanded later.
        $parseLater = OnArray::getArrayItems($form, [F_FORWARD_PAGE]);
        $form[F_FORWARD_PAGE] = '';

513
        $formSpec = $this->eval->parseArray($form);
514
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
515

516
517
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
518

Carsten  Rose's avatar
Carsten Rose committed
519
520
        $formSpec = array_merge($formSpec, $parseLater);

521
        // Set F_FINAL_DELETE_FORM
522
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
523

524
        $this->formSpec = $formSpec;
525

526
527
528
        // 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
529
        // Clear
530
531
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

532
        // FE: Action
533
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
534
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
535
536

        // FE: Native & Container
537
538
539
        // "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:
540
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
541
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
542
543
544
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
545
            case FORM_UPDATE:
Carsten  Rose's avatar
Carsten Rose committed
546
//              $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
547
            $this->feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
548
549
                break;

550
551
552
553
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

554
            default:
555
                break;
556
557
        }

558
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
559
560
    }

561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
    /**
     * 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);

576
577
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);

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
628
629
630
631
632
633
634
635
        // 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
636
    /**
637
638
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
639
640
641
642
643
644
645
646
647
648
649
650
     * 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
651
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
652
     * @param string $foundInStore
653
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
654
     * @throws CodeException
655
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
656
     */
657
    public function getFormName($mode, &$foundInStore = '') {
658
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
659

Carsten  Rose's avatar
Carsten Rose committed
660
661
662
663
664
665
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
666
667
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
668
669
670
671
672
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

676
677
678
679
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

680
        // If the formname is '': no formname name.
681
        if ($formName === '' || $foundInStore === '')
682
683
684
685
686
687
            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;
        }
688

689
        return $formName;
690
    }
Carsten  Rose's avatar
Carsten Rose committed
691

692
693
694
695
696
697
698
699
    /**
     * 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
     */
700
    private function modeCleanFormConfig($mode, array $form) {
701
702
703
704
705
706
707
708
709
710
711
712

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

        return $form;
    }

713
    /**
714
715
716
717
718
719
     * 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.
720
     *
721
722
723
     * @param array $formSpec
     * @return array
     */
724
725
    private function syncSystemFormConfig(array $formSpec) {

726
727
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
728
729
730
731
732
733
734
735
736
            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,
737
            F_BUTTON_ON_CHANGE_CLASS,
738
            F_ESCAPE_TYPE_DEFAULT,
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
            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,

759
760
761
762
        ];

        // 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.
763
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
764
765
766
767
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
768

769
        foreach ($keys as $key) {
770

771
772
773
774
775
776
777
            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);
            }
        }
778

779
780
        return $formSpec;
    }
781

782
783
784
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
785
     * @param array $formSpec
786
787
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
788
789
790
791
792
793
794
795
796
797
798
    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] = '';
        }
799

800
        if ($formSpec[F_ESCAPE_TYPE_DEFAULT] == TOKEN_ESCAPE_CONFIG) {
801
802
803
            $formSpec[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(F_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

Carsten  Rose's avatar
Carsten Rose committed
804
        return $formSpec;
805
806
    }

807
    /**
Carsten  Rose's avatar
Carsten Rose committed
808
     * Check if loading of the given form is permitted. If not, throw an exception.
809
     *
Carsten  Rose's avatar
Carsten Rose committed
810
811
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
812
     * @throws CodeException
813
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
814
     * @internal param $foundInStore
815
     */
816
    private function validateForm($formNameFoundInStore, $formMode) {
817
818

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

Carsten  Rose's avatar
Carsten Rose committed
821
        // Set missing 'r'.
822
        if ($r === false) {
823
824
825
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
826
827
        }

Carsten  Rose's avatar
Carsten Rose committed
828
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
829
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
830
831
832
833
834

        $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
835
836
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
837
                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
838
839
840
            }
        }

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

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

870
871
872
873
874
        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) {
875

876
877
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
878

879
880
881
                if ($name === '') {
                    continue;
                }
882

883
884
885
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
886
887
888
            }
        }

889
        return $sipFound;
890
    }
Carsten  Rose's avatar
Carsten Rose committed
891

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

909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
    /**
     * 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;
    }

933
    /**
934
935
     * Process the SQL Queries from bodytext. Return the output.
     *
936
937
     * @return string
     */
938
    private function doReport() {
939

940
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
941

942
        $html = $report->process($this->t3data['bodytext']);
943
944
945
946
947

        return $html;

    }

948
    /**
949
950
     * Save the current form.
     *
951
     * @return string
952
953
     * @throws CodeException
     * @throws UserFormException
954
955
956
     */
    public function saveForm() {

957
        $json = $this->doForm(FORM_SAVE);
958

959
        return $json;
960
961
    }

Carsten  Rose's avatar
Carsten Rose committed
962
963
964
965
966
967
968
969
970
971
972
973
974
    /**
     * 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;
    }

975
976
977
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
978
     * @return bool
979
980
981
982
     * @throws CodeException
     */
    public function delete() {

983
        $this->doForm(FORM_DELETE);
984
985

        return true;
986
987
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
988
    /**
Carsten  Rose's avatar
Carsten Rose committed
989
990
     * 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
991
992
993
994
995
996
997
998
999
1000
     * @param $sipArray
     * @param $recordId
     */
    private function newRecordCreateSip($sipArray, $recordId) {

        $tmpParam = array();

        foreach ($sipArray as $key => $value) {
            switch ($key) {
                case SIP_SIP: