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

Carsten  Rose's avatar
Carsten Rose committed
9

10
11
namespace qfq;

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

//use qfq\Report;

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

Carsten  Rose's avatar
Carsten Rose committed
25

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

48
49
50
51
52
53
54
55
56
57
58
59
/*
 * Form will be called
 * a) with a SIP identifier, or
 * b) without a SIP identifier (form setting has to allow this) and will create on the fly a new SIP.
 *
 * The SIP-Store stores:
 *  form=<formname>
 *  r=<record id>  (table.id for a single record form)
 *  keySemId,keySemIduser
 *  <further individual variables>
 */

Carsten  Rose's avatar
Carsten Rose committed
60
/**
61
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
62
63
 * @package qfq
 */
64
class QuickFormQuery {
65

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

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

76
77
78
79
    /**
     * @var Evaluate instantiated class
     */
    protected $eval = null;
80
81
82
    protected $formSpec = array();
    protected $feSpecAction = array();  // Form Definition: copy of the loaded form
    protected $feSpecNative = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
83

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

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

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

99
100
101
102
103
104
105
106
107
108
109
    /*
     * TODO:
     *  Preparation: setup logging, database access, record locking
     *  fill stores
     *  Check permission_create / permission_update
     *  Multi: iterate over all records, Single: activate record
     *      Check mode: Load | Save
     *      doActions 'Before'
     *      Do all FormElements
     *      doActions 'After'
     */
110

111
112
113
114
115
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
     * As a result of instantiating of Form, the class Store will initially called the first time and therefore instantiated automatically.
     * Store might throw an exception, in case the URL-passed SIP is invalid.
116
     *
117
118
119
120
     * @param array $t3data
     * @param bool $phpUnit
     * @throws CodeException
     * @throws UserFormException
121
     */
122
123
    public function __construct(array $t3data = array(), $phpUnit = false) {

124
125
        $this->phpUnit = $phpUnit;

126
        mb_internal_encoding("UTF-8");
127

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

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

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

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

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

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

146
147
        $this->t3data = $t3data;

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

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

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

        $updateDb = new DatabaseUpdate($this->db);
157
        $updateDb->checkNupdate();
158

Carsten  Rose's avatar
Carsten Rose committed
159
160
    }

161
    /**
162
     * Returns the defined forwardMode and set $forwardPage (call by reference)
163
     *
164
165
166
167
     * @param $forwardPage
     * @return mixed
     */
    public function getForwardMode(&$forwardPage) {
168
169
        $forwardPage = $this->formSpec[F_FORWARD_PAGE];
        return $this->formSpec[F_FORWARD_MODE];
170
171
    }

172
    /**
Carsten  Rose's avatar
Carsten Rose committed
173
     * Main entrypoint for display content: a) form and/or b) report
174
     *
175
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
176
     */
177
    public function process() {
178
        $html = '';
179

180
        if ($this->store->getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === 'yes') {
181
182
            $htmlId = HelperFormElement::buildFormElementId($this->formSpec[F_ID], 0, 0, 0);
            $html .= Support::doTooltip($htmlId . HTML_ID_EXTENSION_TOOLTIP, $this->t3data['bodytext']);
183
184
185
        }

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

188
        // 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
189
190
191
192
        if ($this->store->getVar(SYSTEM_DOWNLOAD_POPUP, STORE_SYSTEM) == DOWNLOAD_POPUP_REQUEST) {
            $html .= $this->getModalCode();
        }

193
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
194
        if ($class) {
195
            $html = Support::wrapTag("<div class='$class'>", $html);
Carsten  Rose's avatar
Carsten Rose committed
196
197
        }

198
        return $html;
199
200
    }

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

Carsten  Rose's avatar
Carsten Rose committed
218
        // Fill STORE_FORM
219
        if ($formMode === FORM_UPDATE || $formMode === FORM_SAVE) {
Carsten  Rose's avatar
Carsten Rose committed
220
221
222
            $fillStoreForm = new FillStoreForm();
            $fillStoreForm->process();
        }
223

224
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_TYPO3 . STORE_CLIENT . STORE_ZERO);
225
226

        $formName = $this->loadFormSpecification($formMode, $recordId, $foundInStore);
227
        if ($formName === false && $formMode !== FORM_DELETE) {
228
            // No form found: do nothing
229
            return '';
230
        }
231

232
233
        if ($formName !== false) {
            // Validate only if there is a 'real' form (not a FORM_DELETE with only a tablename).
234
            $sipFound = $this->validateForm($foundInStore, $formMode);
235
236

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

247
248
        // 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.
249
        if (!$sipFound || ($formMode == FORM_LOAD && $recordId === 0)) {
250
251
            $this->store->createSipAfterFormLoad($formName);
        }
252

253
254
255
256
        if ($this->store->getVar('id', STORE_BEFORE) === false) {
            $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $recordId, STORE_BEFORE);
        }

257
        if ($formMode === FORM_DELETE) {
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

            $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);
            }
277
278
        }

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

292
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_LOAD);
293
294
                // data['form-update']=....
                $data = $build->process($formMode);
295
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_AFTER_LOAD);
296
                break;
Carsten  Rose's avatar
Carsten Rose committed
297

298
299
300
301
302
303
304
305
            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;

306
            case FORM_SAVE:
307
308
                $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);

309
                // Action: Before
310
311
                $formAction->elements($recordId, $this->feSpecAction, FE_TYPE_BEFORE_INSERT . ',' . FE_TYPE_BEFORE_UPDATE . ',' . FE_TYPE_BEFORE_SAVE);

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

315
                // SAVE
316
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
317
318
                $rc = $save->process();

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

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

324
                // Action: After
325
326
327
                $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.
328
                    $this->fillStoreWithRecord($this->formSpec[F_TABLE_NAME], $rc, STORE_RECORD);
329
                }
330

331
332
//                $htmlElementNameIdZero = false;
                $getJson = true;
333
334
335
                // Retrieve current STORE_SIP.
                $sipArray = $this->store->getStore(STORE_SIP);
                if ($sipArray[SIP_RECORD_ID] == 0) {
336
337

                    if ($this->formSpec[F_FORWARD_MODE] !== F_FORWARD_MODE_PAGE) {
338
                        $this->formSpec = $this->buildNSetReloadUrl($this->formSpec, $rc);
339
340
                    }
                    $getJson = false;
341
                }
342

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

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

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

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

365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
    /**
     * 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) {

        $formSpec[F_FORWARD_MODE] = F_FORWARD_MODE_PAGE;

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

    }

395
    /**
396
     * Load form. Evaluates form. Load FormElements.
397
     *
Carsten  Rose's avatar
Carsten Rose committed
398
     * After processing:
399
400
401
402
     * 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
403
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
404
     * @param int $recordId
Carsten  Rose's avatar
Carsten Rose committed
405
406
407
     * @param string $foundInStore
     * @return bool|string if found the formName, else 'false'.
     * @throws CodeException
408
     * @throws DbException
409
     * @throws UserFormException
410
     */
411
    private function loadFormSpecification($mode, $recordId, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
412

413
        // formName
Carsten  Rose's avatar
Carsten Rose committed
414
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
415
416
            return false;
        }
417

418
419
420
421
        if (!$this->db->existTable('Form')) {
            throw new UserFormException("Table 'Form' not found", ERROR_MISSING_TABLE);
        }

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

425
426
427
428
429
430
431
        // 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);
        }

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

436
        $form = $this->modeCleanFormConfig($mode, $form);
437

438
        $formSpec = $this->eval->parseArray($form);
439
        HelperFormElement::explodeParameter($formSpec, F_PARAMETER);
440

441
442
        $formSpec = $this->syncSystemFormConfig($formSpec);
        $formSpec = $this->initForm($formSpec);
443
444

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

447
        $this->formSpec = $formSpec;
448

449
450
451
        // 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
452
        // Clear
453
454
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

455
        // FE: Action
456
        $this->feSpecAction = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR, ['no', $this->formSpec["id"], 'action']);
457
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction, FE_PARAMETER);
458
459

        // FE: Native & Container
460
461
462
        // "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:
463
                // Select all Native elements (native, pill, fieldset, templateGroup) which are NOT nested = Root level.
464
                $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['no', $this->formSpec["id"], 'native,container', 0], $this->formSpec);
465
466
467
                break;

            case FORM_SAVE:
Carsten  Rose's avatar
Carsten Rose committed
468
            case FORM_UPDATE:
Carsten  Rose's avatar
Carsten Rose committed
469
//              $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_ALL_CONTAINER, ['no', $this->formSpec["id"], 'native'], $this->formSpec);
470
            $this->feSpecNative = $this->getNativeFormElements(SQL_FORM_ELEMENT_NATIVE_TG_COUNT, [$this->formSpec["id"]], $this->formSpec);
471
472
                break;

473
474
475
476
            case FORM_DELETE:
                $this->feSpecNative = array();
                break;

477
            default:
478
                break;
479
480
        }

481
        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
482
483
    }

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    /**
     * 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);

499
500
        $feSpecNative = HelperFormElement::formElementSetDefault($feSpecNative);

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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
        // 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
559
    /**
560
561
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
562
563
564
565
566
567
568
569
570
571
572
573
     * 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
574
     * @param string $mode FORM_LOAD|FORM_SAVE|FORM_UPDATE
Carsten  Rose's avatar
Carsten Rose committed
575
     * @param string $foundInStore
576
     * @return bool|string  Formname (Form.name) or FALSE (if no formname found)
Carsten  Rose's avatar
Carsten Rose committed
577
     * @throws CodeException
578
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
579
     */
580
    public function getFormName($mode, &$foundInStore = '') {
581
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
582

Carsten  Rose's avatar
Carsten Rose committed
583
584
585
586
587
588
        switch ($mode) {
            case FORM_LOAD:
                $store = STORE_TYPO3;
                break;
            case FORM_SAVE:
            case FORM_UPDATE:
589
590
            case FORM_DELETE:
                $store = STORE_SIP;
Carsten  Rose's avatar
Carsten Rose committed
591
592
593
594
595
                break;
            default:
                throw new CodeException("Unknown mode: $mode.", ERROR_UNKNOWN_MODE);
        }

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

599
600
601
602
//        if($mode===FORM_DELETE && $formName===false) {
//            return "";
//        }

603
        // If the formname is '': no formname name.
604
        if ($formName === '' || $foundInStore === '')
605
606
607
608
609
610
            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;
        }
611

612
        return $formName;
613
    }
Carsten  Rose's avatar
Carsten Rose committed
614

615
616
617
618
619
620
621
622
    /**
     * 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
     */
623
    private function modeCleanFormConfig($mode, array $form) {
624
625
626
627
628
629
630
631
632
633
634
635

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

        return $form;
    }

636
    /**
637
638
639
640
641
642
     * 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.
643
     *
644
645
646
     * @param array $formSpec
     * @return array
     */
647
648
    private function syncSystemFormConfig(array $formSpec) {

649
650
        $keys = [F_BS_COLUMNS,
            F_BS_LABEL_COLUMNS,
651
652
653
654
655
656
657
658
659
            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,
660
            F_BUTTON_ON_CHANGE_CLASS,
661
            F_ESCAPE_TYPE_DEFAULT,
662
663
664
665
        ];

        // 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.
666
        foreach ([F_BS_LABEL_COLUMNS, F_BS_INPUT_COLUMNS, F_BS_NOTE_COLUMNS, F_ESCAPE_TYPE_DEFAULT] as $key) {
667
668
669
670
            if ($formSpec[$key] == '') {
                unset ($formSpec[$key]);
            }
        }
671

672
        foreach ($keys as $key) {
673

674
675
676
677
678
679
680
            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);
            }
        }
681

682
683
        return $formSpec;
    }
684

685
686
687
    /**
     * Set form parameter which are expected to exist.
     *
Carsten  Rose's avatar
Carsten Rose committed
688
     * @param array $formSpec
689
690
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
691
692
693
694
695
696
697
698
699
700
701
    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] = '';
        }
702

703
        if ($formSpec[F_ESCAPE_TYPE_DEFAULT] == TOKEN_ESCAPE_CONFIG) {
704
705
706
            $formSpec[F_ESCAPE_TYPE_DEFAULT] = $this->store->getVar(F_ESCAPE_TYPE_DEFAULT, STORE_SYSTEM);
        }

Carsten  Rose's avatar
Carsten Rose committed
707
        return $formSpec;
708
709
    }

710
    /**
Carsten  Rose's avatar
Carsten Rose committed
711
     * Check if loading of the given form is permitted. If not, throw an exception.
712
     *
Carsten  Rose's avatar
Carsten Rose committed
713
714
     * @param $formNameFoundInStore
     * @return bool 'true' if SIP exists, else 'false'
715
     * @throws CodeException
716
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
717
     * @internal param $foundInStore
718
     */
719
    private function validateForm($formNameFoundInStore, $formMode) {
720
721

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

Carsten  Rose's avatar
Carsten Rose committed
724
        // Set missing 'r'.
725
        if ($r === false) {
726
727
728
            $r = 0;
            $this->store->setVar(TYPO3_RECORD_ID, $r, STORE_TYPO3);
            $recordIdFoundInStore = STORE_TYPO3;
729
730
        }

Carsten  Rose's avatar
Carsten Rose committed
731
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
732
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
733
734
735
736
737

        $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
738
739
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
740
                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
741
742
743
            }
        }

744
        switch ($permitMode) {
745
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
746
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
747
                    throw new UserFormException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
748
749
750
751
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
752
                    throw new UserFormException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
753
754
755
756
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
757
                    throw new UserFormException("User logged in.", ERROR_USER_LOGGED_IN);
758
759
760
761
762
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
763
                throw new UserFormException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
764
            default:
765
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
766
        }
Carsten  Rose's avatar
Carsten Rose committed
767

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

773
774
775
776
777
        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) {
778

779
780
                $name = explode('#', $name, 2);
                $name = trim($name[0]);
781

782
783
784
                if ($name === '') {
                    continue;
                }
785

786
787
788
                if (!isset($sipArray[$name])) {
                    throw new UserFormException("Missing required SIP parameter: $name", ERROR_MISSING_REQUIRED_PARAMETER);
                }
789
790
791
            }
        }

792
        return $sipFound;
793
    }
Carsten  Rose's avatar
Carsten Rose committed
794

795
    /**
796
     * Load record $id from $table and saves them in $store
Carsten  Rose's avatar
Carsten Rose committed
797
     *
798
799
800
     * @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
801
802
803
804
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
805
    private function fillStoreWithRecord($table, $recordId, $store = STORE_RECORD) {
806
807
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
808
            $this->store->setStore($record, $store, true);
809
810
811
        }
    }

812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
    /**
     * 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;
    }

836
    /**
837
838
     * Process the SQL Queries from bodytext. Return the output.
     *
839
840
     * @return string
     */
841
    private function doReport() {
842

843
        $report = new Report($this->t3data, $this->eval, $this->phpUnit);
844

845
        $html = $report->process($this->t3data['bodytext']);
846
847
848
849
850

        return $html;

    }

851
    /**
852
853
     * Save the current form.
     *
854
     * @return string
855
856
     * @throws CodeException
     * @throws UserFormException
857
858
859
     */
    public function saveForm() {

860
        $json = $this->doForm(FORM_SAVE);
861

862
        return $json;
863
864
    }

Carsten  Rose's avatar
Carsten Rose committed
865
866
867
868
869
870
871
872
873
874
875
876
877
    /**
     * 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;
    }

878
879
880
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
881
     * @return bool
882
883
884
885
     * @throws CodeException
     */
    public function delete() {

886
        $this->doForm(FORM_DELETE);
887
888

        return true;
889
890
    }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
891
    /**
Carsten  Rose's avatar
Carsten Rose committed
892
893
     * 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
894
895
896
897
898
899
900
901
902
903
904
905
     * @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
906
                continue; // do not copy these params to the new SIP
Carsten  Rose's avatar
#2067    
Carsten Rose committed
907
908

                case SIP_RECORD_ID:
Carsten  Rose's avatar
Carsten Rose committed
909
                    // set the new recordId
Carsten  Rose's avatar
#2067    
Carsten Rose committed
910
911
912
                    $tmpParam[SIP_RECORD_ID] = $recordId;
                    break;
                default:
Carsten  Rose's avatar
Carsten Rose committed
913
                    // copy further vars stored in old SIP (form, maybe default values)
Carsten  Rose's avatar
#2067    
Carsten Rose committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
                    $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;
928
        $this->store->setStore($tmpParam, STORE_SIP, true);
Carsten  Rose's avatar
#2067    
Carsten Rose committed
929
930
    }

Carsten  Rose's avatar
Carsten Rose committed
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946

    /**
     * @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;">
947
                    <img class="qfq-icon-gear glyphicon-spin" src="typo3conf/ext/qfq/Resources/Public/icons/gear.svg">
948
                    <p id="qfqModalText101">Document is being generated. Please wait.</p>
Carsten  Rose's avatar
Carsten Rose committed
949
950
951
952
953
954
955
                </div>
                <div class="modal-footer">
                    <p>In progress..</p>
                </div>
            </div>
        </div>
    </div>
956
957
958
    <script type="application/javascript">
        window.onblur = function () { $("#qfqModal101").modal('hide'); }
    </script>
Carsten  Rose's avatar
Carsten Rose committed
959
960
961
962
963
964
EOF;

        return $code;
    }


965
}