QuickFormQuery.php 32.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
37
38
39
40
41
42
43
44
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');
require_once(__DIR__ . '/Database.php');
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');
46

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

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

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

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

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

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

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

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

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

123
124
        $this->phpUnit = $phpUnit;

125
        mb_internal_encoding("UTF-8");
126

127
128
129
130
131
//        session_name(SESSION_NAME);
//        session_start();

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

Carsten  Rose's avatar
Carsten Rose committed
132
133
134
135
136
137
138
139
140
141
        // session.cache_expire
        // session.cookie_lifetime
        // session.gc_maxlifetime

//        $arr1['sessionname'] =   session_name();
//        $arr1['session.auto_start']  = ini_get('session.auto_start');
//        $arr1['session.gc_maxlifetime']  = ini_get('session.gc_maxlifetime');
//        $arr1['session.cookie_lifetime']  = ini_get('session.cookie_lifetime');
//        $arr1['session.name']  = ini_get('session.name');

142
        // Refresh the session even if no new data saved.
143
        Session::set('LAST_ACTIVITY', time());
144

145
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
146

147
148
149
150
151
152
153
        if (!isset($t3data[T3DATA_BODYTEXT])) {
            $t3data[T3DATA_BODYTEXT] = '';
        }

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

155
        $btp = new BodytextParser();
156
        $t3data[T3DATA_BODYTEXT] = $btp->process($t3data[T3DATA_BODYTEXT]);
157

158
159
        $this->t3data = $t3data;

160
        $bodytext = $this->t3data[T3DATA_BODYTEXT];
161
162

        $this->store = Store::getInstance($bodytext, $phpUnit);
163
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
164
165
        $this->db = new Database();
        $this->eval = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
166
167
    }

168
    /**
Carsten  Rose's avatar
Carsten Rose committed
169
     * Returns the defined forwardMode and set $forwardPage (call be reference)
170
     *
171
172
173
174
175
176
177
178
     * @param $forwardPage
     * @return mixed
     */
    public function getForwardMode(&$forwardPage) {
        $forwardPage = $this->formSpec['forwardPage'];
        return $this->formSpec['forwardMode'];
    }

179
    /**
Carsten  Rose's avatar
Carsten Rose committed
180
     * Main entrypoint for display content: a) form and/or b) report
181
     *
182
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
183
     */
184
    public function process() {
185
        $html = '';
186

187
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
188
189
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
190
191
192
        }

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

195
196
197
198
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
        if ($class)
            $html = Support::wrapTag("<div class='$class'>", $html);

199
200
201
202
//        $feUidLoggedIn = isset($GLOBALS["TSFE"]->fe_user->user["uid"]) ? $GLOBALS["TSFE"]->fe_user->user["uid"] : false;
//        $feUidSession = $_SESSION[SESSION_NAME][SESSION_FE_USER_UID];
//        $html .= "<p>feUidLoggedIn: $feUidLoggedIn / feUidSession: $feUidSession</p>";

203
        return $html;
204
205
    }

206
    /**
207
     * Process form.
208
209
210
211
212
     * $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:
213
     *
214
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
215
     * @return array|string
216
     * @throws CodeException
217
     * @throws UserFormException
218
     */
219
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
220
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
221
        $foundInStore = '';
222

Carsten  Rose's avatar
Carsten Rose committed
223
        // Fill STORE_FORM
224
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
225
226
227
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
228

229
230
231
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT);

        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore);
232
        if ($formName === false && $formMode !== FORM_DELETE) {
233
            // No form found: do nothing
234
            return '';
235
        }
236

237
238
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
239
            $sipFound = $this->validateForm($foundInStore, $formMode);
240
241

        } else {
242
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
243
244
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
245
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
246
247
248
249
250
251
            }
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
        }

252
253
        // 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.
254
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId == 0)) {
255
256
            $this->store->createSipAfterFormLoad($formName);
        }
257

258
259
260
261
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

262
        if ($formMode === FORM_DELETE) {
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

            $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);
            }
282
283
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
284
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
285
        switch ($formMode) {
286
            case FORM_LOAD:
287
288
289
290
291
292
293
294
                $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
295
            case FORM_UPDATE:
296

297
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
298
299
                // data['form-update']=....
                $data = $build->process($formMode);
300
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
301
                break;
Carsten  Rose's avatar
Carsten Rose committed
302

303
304
305
306
307
308
309
310
            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;

311
            case FORM_SAVE:
312
313
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

314
                // Action: Before
315
316
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

320
                // SAVE
321
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
322
323
                $rc = $save->process();

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

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

329
                // Action: After
330
331
332
                $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.
333
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
334
                }
335

336
337
338
339
                $htmlElementNameIdZero = false;
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
340
                    // After insert: a new SIP for the new record id is required.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
341
                    $this->newRecordUpdateSip($rc);
342
343
                    $htmlElementNameIdZero = true;
                }
344

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

348
                // Retrieve FE Values as JSON
349
                // $data['form-update']=...
350
                $data = $build->process($formMode, $htmlElementNameIdZero);
351
                break;
Carsten  Rose's avatar
Carsten Rose committed
352

353
354
355
356
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

357
        if (is_array($data)) {
358
            // $data['element-update']=...
359
360
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
361
        return $data;
362
363
    }

364
    /**
365
     * Load form. Evaluates form. Load FormElements.
366
     *
Carsten  Rose's avatar
Carsten Rose committed
367
     * After processing:
368
369
370
371
     * 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
372
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
373
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
374
375
376
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
377
     * @throws DbException
378
     * @throws UserFormException
379
     */
380
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
381

382
        // formName
Carsten  Rose's avatar
Carsten Rose committed
383
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
384
385
            return false;
        }
386

387
388
389
390
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

394
395
396
397
398
399
400
        // 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);
        }

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

405
        $form = $this->modeCleanFormConfig($mode, $form);
406

407
        $formSpec = $this->eval->parseArray($form);
408
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
409

410
411
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
412
413

        // Set F_FINAL_DELETE_FORM
414
        $formSpec[F_FINAL_DELETE_FORM] = ($formSpec[F_EXTRA_DELETE_FORM] != '') ? $formSpec[F_EXTRA_DELETE_FORM] : $formSpec[F_NAME];
415

416
        $this->formSpec = $formSpec;
417

418
419
420
        // 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
421
        // Clear
422
423
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

424
        // FE: Action
425
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
426
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
427
428

        // FE: Native & Container
429
430
431
        // "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:
432
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
433
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
434
435
436
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
437
            case FORM_UPDATE:
438
//                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
439
440

            $this->feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
441
442
                break;

443
444
445
446
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

447
            default:
448
                break;
449
450
        }

451
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
452
453
    }

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
    /**
     * 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);

        // 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
527
    /**
528
529
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
530
531
532
533
534
535
536
537
538
539
540
541
     * 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
542
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
543
     * @param string $foundInStore
544
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
545
     * @throws CodeException
546
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
547
     */
548
    public function getFormName($mode, &$foundInStore = '') {
549
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
550

Carsten  Rose's avatar
Carsten Rose committed
551
552
553
554
555
556
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
557
558
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
559
560
561
562
563
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

567
568
569
570
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

571
        // If the formname is '': no formname name.
572
        if ($formName === '' || $foundInStore === '')
573
574
575
576
577
578
            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;
        }
579

580
        return $formName;
581
    }
Carsten  Rose's avatar
Carsten Rose committed
582

583
584
585
586
587
588
589
590
    /**
     * 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
     */
591
    private function modeCleanFormConfig($mode, array $form) {
592
593
594
595
596
597
598
599
600
601
602
603

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

        return $form;
    }

604
    /**
605
606
607
608
609
610
     * 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.
611
     *
612
613
614
     * @param array $formSpec
     * @return array
     */
615
616
    private function syncSystemFormConfig(array $formSpec) {

617
618
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
619
620
621
622
623
624
625
626
627
            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,
628
            F_BUTTON_ON_CHANGE_CLASS,
629
630
631
632
633
634
635
636
637
        ];

        // 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.
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS] as $key) {
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
638

639
        foreach ($keys as $key) {
640

641
642
643
644
645
646
647
            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);
            }
        }
648

649
650
        return $formSpec;
    }
651

652
653
654
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
655
     * @param array $formSpec
656
657
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
658
659
660
661
662
663
664
665
666
667
668
    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] = '';
        }
669

Carsten  Rose's avatar
Carsten Rose committed
670
        return $formSpec;
671
672
    }

673
    /**
Carsten  Rose's avatar
Carsten Rose committed
674
     * Check if loading of the given form is permitted. If not, throw an exception.
675
     *
Carsten  Rose's avatar
Carsten Rose committed
676
677
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
678
     * @throws CodeException
679
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
680
     * @internal param $foundInStore
681
     */
682
    private function validateForm($formNameFoundInStore, $formMode) {
683
684

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

Carsten  Rose's avatar
Carsten Rose committed
687
        // Set missing 'r'.
688
        if ($r === false) {
689
690
691
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
692
693
        }

Carsten  Rose's avatar
Carsten Rose committed
694
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
695
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
696
697
698
699
700

        $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
701
702
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
703
                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
704
705
706
            }
        }

707
        switch ($permitMode) {
708
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
709
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
710
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
711
712
713
714
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
715
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
716
717
718
719
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
720
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
721
722
723
724
725
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
726
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
727
            default:
728
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
729
        }
Carsten  Rose's avatar
Carsten Rose committed
730

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

736
737
738
739
740
        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) {
741

742
743
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
744

745
746
747
                if ($name === '') {
                    continue;
                }
748

749
750
751
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
752
753
754
            }
        }

755
        return $sipFound;
756
    }
Carsten  Rose's avatar
Carsten Rose committed
757

758
    /**
759
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
760
     *
761
762
763
     * @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
764
765
766
767
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
768
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
769
770
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
771
            $this->store->setStore($record, $store, true);
772
773
774
        }
    }

775
    /**
Carsten  Rose's avatar
Carsten Rose committed
776
777
     * Update current SIP Store with new $recordId and update SESSION store.
     *
778
     * @param $recordId
Carsten  Rose's avatar
Carsten Rose committed
779
780
     * @throws CodeException
     * @throws UserFormException
781
     */
Carsten  Rose's avatar
#2067    
Carsten Rose committed
782
783
784
    private function newRecordUpdateSip($recordId) {
        // Update current SIP store with new RecordID
        $sipArray = $this->store->getStore(STORE_SIP);
Carsten  Rose's avatar
Carsten Rose committed
785
786
787
788
789

        if (isset($sipArray[SIP_RECORD_ID]) && $sipArray[SIP_RECORD_ID] > 0) {
            throw new CodeException('Attemp to overwrite existing record id: SIP(otf)=' . $sipArray[SIP_SIP] . " existing_r=" . $sipArray[SIP_RECORD_ID] . " new_r=" . $recordId, ERROR_OVERWRITE_RECORD_ID);
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
790
        $sipArray[SIP_RECORD_ID] = $recordId;
791
        $this->store->setStore($sipArray, STORE_SIP, true);
792

Carsten  Rose's avatar
#2067    
Carsten Rose committed
793
794
        // Update SIP urlparam
        store::getSipInstance()->updateSipToSession($sipArray);
795
796
797

    }

798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
    /**
     * 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;
    }

822
    /**
823
824
     * Process the SQL Queries from bodytext. Return the output.
     *
825
826
     * @return string
     */
827
    private function doReport() {
828
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
829

830
        $html = $report->process($this->t3data['bodytext']);
831
832
833
834
835

        return $html;

    }

836
    /**
837
838
     * Save the current form.
     *
839
840
841
842
     * @return string
     */
    public function saveForm() {

843
        $json = $this->doForm(FORM_SAVE);
844

845
        return $json;
846
847
    }

Carsten  Rose's avatar
Carsten Rose committed
848
849
850
851
852
853
854
855
856
857
858
859
860
    /**
     * 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;
    }

861
862
863
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
864
     * @return bool
865
866
867
868
     * @throws CodeException
     */
    public function delete() {

869
        $this->doForm(FORM_DELETE);
870
871

        return true;
872
873
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
874
    /**
Carsten  Rose's avatar
Carsten Rose committed
875
876
     * 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
877
878
879
880
881
882
883
884
885
886
887
888
     * @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
889
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
890
891

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
892
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
893
894
895
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
896
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
                    $tmpParam[$key] = $value;
                    break;
            }
        }

        // Construct fake urlparam
        $tmpUrlparam = OnArray::toString($tmpParam);

        // Create a SIP which has never been passed by URL - further processing might expect this to exist.
        $sip = store::getSipInstance()->queryStringToSip($tmpUrlparam, RETURN_SIP);
        $this->store->setVar(CLIENT_SIP, $sip, STORE_CLIENT);

        // Overwrite SIP Store
        $tmpParam[SIP_SIP] = $sip;
911
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
912
913
    }

914
}