QuickFormQuery.php 33.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
        $this->session = Session::getInstance($phpUnit);

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

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

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

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

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

145
146
        $this->t3data = $t3data;

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

        $this->store = Store::getInstance($bodytext, $phpUnit);
150
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data[T3DATA_UID], STORE_TYPO3);
151
152
        $this->db = new Database();
        $this->eval = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
153
154
    }

155
    /**
Carsten  Rose's avatar
Carsten Rose committed
156
     * Returns the defined forwardMode and set $forwardPage (call be reference)
157
     *
158
159
160
161
162
163
164
165
     * @param $forwardPage
     * @return mixed
     */
    public function getForwardMode(&$forwardPage) {
        $forwardPage = $this->formSpec['forwardPage'];
        return $this->formSpec['forwardMode'];
    }

166
    /**
Carsten  Rose's avatar
Carsten Rose committed
167
     * Main entrypoint for display content: a) form and/or b) report
168
     *
169
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
170
     */
171
    public function process() {
172
        $html = '';
173

174
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
175
176
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
177
178
179
        }

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

182
        // 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
183
184
185
186
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

187
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
188
        if ($class) {
189
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
190
191
        }

192
        return $html;
193
194
    }

195
    /**
196
     * Process form.
197
198
199
200
201
     * $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:
202
     *
203
     * @param string $formMode FORM_LOAD | FORM_UPDATE | FORM_SAVE | FORM_DELETE
204
     * @return array|string
205
     * @throws CodeException
206
     * @throws UserFormException
207
     */
208
    private function doForm($formMode) {
Carsten  Rose's avatar
Carsten Rose committed
209
        $data = '';
Carsten  Rose's avatar
Carsten Rose committed
210
        $foundInStore = '';
211

Carsten  Rose's avatar
Carsten Rose committed
212
        // Fill STORE_FORM
213
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
214
215
216
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
217

218
219
220
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT);

        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore);
221
        if ($formName === false && $formMode !== FORM_DELETE) {
222
            // No form found: do nothing
223
            return '';
224
        }
225

226
227
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
228
            $sipFound = $this->validateForm($foundInStore, $formMode);
229
230

        } else {
231
            // FORM_DELETE without a form definition: Fake the form with only a tableName.
232
233
            $table = $this->store->getVar(SIP_TABLE, STORE_SIP);
            if ($table === false) {
234
                throw new UserFormException("No 'form' and no 'table' definition found.", ERROR_MISSING_VALUE);
235
236
237
238
239
240
            }
            $sipFound = true;
            $this->formSpec[F_NAME] = '';
            $this->formSpec[F_TABLE_NAME] = $table;
        }

241
242
        // 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.
243
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId == 0)) {
244
245
            $this->store->createSipAfterFormLoad($formName);
        }
246

247
248
249
250
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

251
        if ($formMode === FORM_DELETE) {
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

            $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);
            }
271
272
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
273
        $formAction = new FormAction($this->formSpec, $this->db, $this->phpUnit);
274
        switch ($formMode) {
275
            case FORM_LOAD:
276
277
278
279
280
281
282
283
                $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
284
            case FORM_UPDATE:
285

286
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
287
288
                // data['form-update']=....
                $data = $build->process($formMode);
289
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
290
                break;
Carsten  Rose's avatar
Carsten Rose committed
291

292
293
294
295
296
297
298
299
            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;

300
            case FORM_SAVE:
301
302
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

303
                // Action: Before
304
305
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

309
                // SAVE
310
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
311
312
                $rc = $save->process();

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

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

318
                // Action: After
319
320
321
                $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.
322
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
323
                }
324

325
326
327
328
                $htmlElementNameIdZero = false;
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
329
                    // After insert: a new SIP for the new record id is required.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
330
                    $this->newRecordUpdateSip($rc);
331
332
                    $htmlElementNameIdZero = true;
                }
333

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

337
                // Retrieve FE Values as JSON
338
                // $data['form-update']=...
339
                $data = $build->process($formMode, $htmlElementNameIdZero);
340
                break;
Carsten  Rose's avatar
Carsten Rose committed
341

342
343
344
345
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }

346
        if (is_array($data)) {
347
            // $data['element-update']=...
348
349
            $data = $this->groupElementUpdateEntries($data);
        }
Carsten  Rose's avatar
Carsten Rose committed
350
        return $data;
351
352
    }

353
    /**
354
     * Load form. Evaluates form. Load FormElements.
355
     *
Carsten  Rose's avatar
Carsten Rose committed
356
     * After processing:
357
358
359
360
     * 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
361
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
362
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
363
364
365
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
366
     * @throws DbException
367
     * @throws UserFormException
368
     */
369
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
370

371
        // formName
Carsten  Rose's avatar
Carsten Rose committed
372
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
373
374
            return false;
        }
375

376
377
378
379
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

383
384
385
386
387
388
389
        // 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);
        }

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

394
        $form = $this->modeCleanFormConfig($mode, $form);
395

396
        $formSpec = $this->eval->parseArray($form);
397
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
398

399
400
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
401
402

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

405
        $this->formSpec = $formSpec;
406

407
408
409
        // 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
410
        // Clear
411
412
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

413
        // FE: Action
414
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
415
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
416
417

        // FE: Native & Container
418
419
420
        // "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:
421
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
422
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
423
424
425
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
426
            case FORM_UPDATE:
427
//                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
428
429

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

432
433
434
435
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

436
            default:
437
                break;
438
439
        }

440
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
441
442
    }

443
444
445
446
447
448
449
450
451
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
    /**
     * 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
516
    /**
517
518
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
519
520
521
522
523
524
525
526
527
528
529
530
     * 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
531
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
532
     * @param string $foundInStore
533
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
534
     * @throws CodeException
535
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
536
     */
537
    public function getFormName($mode, &$foundInStore = '') {
538
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
539

Carsten  Rose's avatar
Carsten Rose committed
540
541
542
543
544
545
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
546
547
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
548
549
550
551
552
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

556
557
558
559
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

560
        // If the formname is '': no formname name.
561
        if ($formName === '' || $foundInStore === '')
562
563
564
565
566
567
            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;
        }
568

569
        return $formName;
570
    }
Carsten  Rose's avatar
Carsten Rose committed
571

572
573
574
575
576
577
578
579
    /**
     * 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
     */
580
    private function modeCleanFormConfig($mode, array $form) {
581
582
583
584
585
586
587
588
589
590
591
592

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

        return $form;
    }

593
    /**
594
595
596
597
598
599
     * 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.
600
     *
601
602
603
     * @param array $formSpec
     * @return array
     */
604
605
    private function syncSystemFormConfig(array $formSpec) {

606
607
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
608
609
610
611
612
613
614
615
616
            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,
617
            F_BUTTON_ON_CHANGE_CLASS,
618
            F_ESCAPE_TYPE_DEFAULT,
619
620
621
622
        ];

        // 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.
623
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
624
625
626
627
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
628

629
        foreach ($keys as $key) {
630

631
632
633
634
635
636
637
            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);
            }
        }
638

639
640
        return $formSpec;
    }
641

642
643
644
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
645
     * @param array $formSpec
646
647
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
648
649
650
651
652
653
654
655
656
657
658
    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] = '';
        }
659

660
661
662
663
        if ($formSpec[F_ESCAPE_TYPE_DEFAULT] == '') {
            $formSpec[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(F_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

Carsten  Rose's avatar
Carsten Rose committed
664
        return $formSpec;
665
666
    }

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

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

Carsten  Rose's avatar
Carsten Rose committed
681
        // Set missing 'r'.
682
        if ($r === false) {
683
684
685
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
686
687
        }

Carsten  Rose's avatar
Carsten Rose committed
688
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
689
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
690
691
692
693
694

        $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
695
696
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
697
                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
698
699
700
            }
        }

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

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

730
731
732
733
734
        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) {
735

736
737
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
738

739
740
741
                if ($name === '') {
                    continue;
                }
742

743
744
745
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
746
747
748
            }
        }

749
        return $sipFound;
750
    }
Carsten  Rose's avatar
Carsten Rose committed
751

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

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

        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
784
        $sipArray[SIP_RECORD_ID] = $recordId;
785
        $this->store->setStore($sipArray, STORE_SIP, true);
786

Carsten  Rose's avatar
#2067    
Carsten Rose committed
787
788
        // Update SIP urlparam
        store::getSipInstance()->updateSipToSession($sipArray);
789
790
791

    }

792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
    /**
     * 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;
    }

816
    /**
817
818
     * Process the SQL Queries from bodytext. Return the output.
     *
819
820
     * @return string
     */
821
    private function doReport() {
822
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
823

824
        $html = $report->process($this->t3data['bodytext']);
825
826
827
828
829

        return $html;

    }

830
    /**
831
832
     * Save the current form.
     *
833
     * @return string
834
835
     * @throws CodeException
     * @throws UserFormException
836
837
838
     */
    public function saveForm() {

839
        $json = $this->doForm(FORM_SAVE);
840

841
        return $json;
842
843
    }

Carsten  Rose's avatar
Carsten Rose committed
844
845
846
847
848
849
850
851
852
853
854
855
856
    /**
     * 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;
    }

857
858
859
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
860
     * @return bool
861
862
863
864
     * @throws CodeException
     */
    public function delete() {

865
        $this->doForm(FORM_DELETE);
866
867

        return true;
868
869
    }

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

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
888
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
889
890
891
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
892
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
893
894
895
896
897
898
899
900
901
902
903
904
905
906
                    $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;
907
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
908
909
    }

Carsten  Rose's avatar
Carsten Rose committed
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925

    /**
     * @return string
     */
    private function getModalCode() {

        $code = <<<EOF
    <!-- Modal -->
    <div class="modal fade" id="qfqModal101" tabindex="-1" role="dialog" aria-labelledby="myModalLabel">
        <div class="modal-dialog" role="document">
            <div class="modal-content">
                <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
                    <h4 class="modal-title" id="qfqModalTitle101">Loading Document</h4>
                </div>
                <div class="modal-body" style="text-align: center;">
926
                    <img class="qfq-icon-gear glyphicon-spin" src="typo3conf/ext/qfq/Resources/Public/icons/gear.svg">
927
                    <p id="qfqModalText101">Document is being generated. Please wait.</p>
Carsten  Rose's avatar
Carsten Rose committed
928
929
930
931
932
933
934
                </div>
                <div class="modal-footer">
                    <p>In progress..</p>
                </div>
            </div>
        </div>
    </div>
935
936
937
    <script type="application/javascript">
        window.onblur = function () { $("#qfqModal101").modal('hide'); }
    </script>
Carsten  Rose's avatar
Carsten Rose committed
938
939
940
941
942
943
EOF;

        return $code;
    }


944
}