Store.php 23.9 KB
Newer Older
1
2
3
4
5
6
7
8
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/1/16
 * Time: 6:51 PM
 */

9
namespace qfq;
10

11
use qfq\CodeException;
12
13
use qfq\keyValueStringParser;
use qfq\OnArray;
14
use qfq;
15

16
require_once(__DIR__ . '/../../qfq/helper/KeyValueStringParser.php');
Carsten  Rose's avatar
Carsten Rose committed
17
require_once(__DIR__ . '/../../qfq/helper/Sanitize.php');
18
require_once(__DIR__ . '/../../qfq/Constants.php');
19
require_once(__DIR__ . '/../../qfq/store/Sip.php');
20
//require_once(__DIR__ . '/../../qfq/store/Session.php');
21
require_once(__DIR__ . '/../../qfq/Database.php');
22
23
24
25
26
27
28
29
30
31

/*
 * Stores:
 * - SIP
 * - webVar
 * - record
 * - form
 * - formElement
 */

Carsten  Rose's avatar
Carsten Rose committed
32
33
/**
 * Class Store
34
 * @package qfq
Carsten  Rose's avatar
Carsten Rose committed
35
 */
36
37
class Store {

Carsten  Rose's avatar
Carsten Rose committed
38
39
40
    /**
     * @var Store Instance of class Store. There should only be one class 'Store' at a time.
     */
41
42
    private static $instance = null;

Carsten  Rose's avatar
Carsten Rose committed
43
44
45
    /**
     * @var Sip Instance of class SIP
     */
46
47
    private static $sip = null;

48
49
50
    /**
     * @var Session Instance of class Session
     */
51
//    private static $session = null;
52

Carsten  Rose's avatar
Carsten Rose committed
53
54
55
56
57
58
59
60
61
62
    /**
     * @var array Stores all indiviudal stores with the variable raw values
     *
     * $raw['D']['id'] = 0  - Defaultvalues from Tabledefinition
     * ...
     * $raw['S']['r'] = 1234 - record ID from current SIP identifier
     * ...
     * $raw['C']['HTTP_SERVER'] = 'qfq' - Servername
     * $raw['C']['s'] = 'badcaffee1234' - recent SIP
     */
63
    private static $raw = array();
Carsten  Rose's avatar
Carsten Rose committed
64
65

    /**
Carsten  Rose's avatar
Carsten Rose committed
66
     * @var array Default sanitize classes.
Carsten  Rose's avatar
Carsten Rose committed
67
     */
Carsten  Rose's avatar
Carsten Rose committed
68
    private static $sanitizeClass = array();
Carsten  Rose's avatar
Carsten Rose committed
69
70

    /**
Carsten  Rose's avatar
Carsten Rose committed
71
72
     * $sanitizeClass['S'] = false
     * $sanitizeClass['C'] = true
Carsten  Rose's avatar
Carsten Rose committed
73
74
     * ...
     *
Carsten  Rose's avatar
Carsten Rose committed
75
     * @var array each entry with true/false - depending if store needs to be sanitized.
Carsten  Rose's avatar
Carsten Rose committed
76
     */
Carsten  Rose's avatar
Carsten Rose committed
77
    private static $sanitizeStore = array();
78

Carsten  Rose's avatar
Carsten Rose committed
79
    private static $phpUnit = false;
80

81

82
    /**
83
     * @param string $bodytext
84
     */
85
    private function __construct($bodytext = '') {
86

87
//        self::$session = Session::getInstance(self::$phpUnit);
88

Carsten  Rose's avatar
Carsten Rose committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
        self::$sanitizeClass = [
//            TYPO3_DEBUG_LOAD => SANITIZE_ALLOW_DIGIT,
//            TYPO3_DEBUG_SAVE => SANITIZE_ALLOW_DIGIT,
//            TYPO3_FORM => SANITIZE_ALLOW_ALNUMX,
//            TYPO3_FE_USER => SANITIZE_ALLOW_ALNUMX,
//            TYPO3_FE_USER_UID => SANITIZE_ALLOW_DIGIT,
//            TYPO3_FE_USER_GROUP => SANITIZE_ALLOW_ALNUMX,

            CLIENT_SIP => SANITIZE_ALLOW_ALNUMX,
            CLIENT_RECORD_ID => SANITIZE_ALLOW_DIGIT,
            CLIENT_KEY_SEM_ID => SANITIZE_ALLOW_DIGIT,
            CLIENT_KEY_SEM_ID_USER => SANITIZE_ALLOW_DIGIT,
            CLIENT_PAGE_ID => SANITIZE_ALLOW_DIGIT,
            CLIENT_PAGE_TYPE => SANITIZE_ALLOW_DIGIT,
            CLIENT_PAGE_LANGUAGE => SANITIZE_ALLOW_DIGIT,
            CLIENT_FORM => SANITIZE_ALLOW_ALNUMX,

            // Part of $_SERVER. Missing vars must be requested individual with the needed sanitize class.
            CLIENT_SCRIPT_URL => SANITIZE_ALLOW_ALNUMX,
            CLIENT_SCRIPT_URI => SANITIZE_ALLOW_ALNUMX,
            CLIENT_HTTP_HOST => SANITIZE_ALLOW_ALNUMX,
            CLIENT_HTTP_USER_AGENT => SANITIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_NAME => SANITIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_ADDRESS => SANITIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_PORT => SANITIZE_ALLOW_DIGIT,
            CLIENT_REMOTE_ADDRESS => SANITIZE_ALLOW_ALNUMX,
            CLIENT_REQUEST_SCHEME => SANITIZE_ALLOW_ALNUMX,
            CLIENT_SCRIPT_FILENAME => SANITIZE_ALLOW_ALNUMX,
            CLIENT_QUERY_STRING => SANITIZE_ALLOW_ALL,
            CLIENT_REQUEST_URI => SANITIZE_ALLOW_ALL,
            CLIENT_SCRIPT_NAME => SANITIZE_ALLOW_ALNUMX,
            CLIENT_PHP_SELF => SANITIZE_ALLOW_ALNUMX,
121
            CLIENT_UPLOAD_FILENAME => SANITIZE_ALLOW_ALLBUT,
Carsten  Rose's avatar
Carsten Rose committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//            SYSTEM_DBUSER => SANITIZE_ALLOW_ALNUMX,
//            SYSTEM_DBSERVER => SANITIZE_ALLOW_ALNUMX,
//            SYSTEM_DBPW => SANITIZE_ALLOW_ALL,
//            SYSTEM_DB => SANITIZE_ALLOW_ALNUMX,
//            SYSTEM_TESTDB => SANITIZE_ALLOW_ALNUMX,
//            SYSTEM_SESSIONNAME => SANITIZE_ALLOW_ALNUMX,
//            SYSTEM_DBH => SANITIZE_ALLOW_ALL,

//            SYSTEM_SQL_RAW => SANITIZE_ALLOW_ALL,
//            SYSTEM_SQL_FINAL => SANITIZE_ALLOW_ALL,
//            SYSTEM_SQL_COUNT => SANITIZE_ALLOW_DIGIT,
//            SYSTEM_SQL_PARAM_ARRAY => SANITIZE_ALLOW_ALL,

//            SIP_SIP => SANITIZE_ALLOW_ALNUMX,
//            SIP_RECORD_ID => SANITIZE_ALLOW_DIGIT,
//            SIP_FORM => SANITIZE_ALLOW_ALNUMX,
//            SIP_URLPARAM => SANITIZE_ALLOW_ALL
140

141
142
        ];

Carsten  Rose's avatar
Carsten Rose committed
143
        self::$sanitizeStore = [
144
145
146
            STORE_FORM => true,
            STORE_SIP => false,
            STORE_RECORD => false,
147
            STORE_BEFORE => false,
148
            STORE_PARENT_RECORD => false,
149
150
            STORE_TABLE_DEFAULT => false,
            STORE_TABLE_COLUMN_TYPES => false,
151
152
            STORE_CLIENT => true,
            STORE_TYPO3 => false,
153
            STORE_VAR => false,
154
            STORE_ZERO => false,
155
            STORE_EMPTY => false,
156
            STORE_SYSTEM => false,
157
            STORE_EXTRA => false
158
159
        ];

160
        self::fillSystemStore();
161
        self::fillStoreTypo3($bodytext);
162
        self::fillStoreClient();
163
        self::fillStoreSip();
Carsten  Rose's avatar
Carsten Rose committed
164
        self::fillStoreExtra();
165
166


167
    }
168

169
    /**
Carsten  Rose's avatar
Carsten Rose committed
170
171
     * Fills the system store.
     *
172
     * @throws CodeException
173
     * @throws qfq\UserFormException
174
     */
175
    private static function fillSystemStore() {
176
177
178
179
180
181
182
183
184
185
186
187

        // PHPUnit Path to CONFIG_INI
        $configIni = __DIR__ . '/../../../' . CONFIG_INI;
        if (!file_exists($configIni)) {
            // Production Path to CONFIG_INI
            $configIni = __DIR__ . '/../../../../../' . CONFIG_INI;

            if (!file_exists($configIni)) {
                throw new qfq\UserFormException ("Config not found: " . getcwd() . "/" . $configIni, ERROR_IO_READ_FILE);
            }
        }

188
        try {
189
            $config = parse_ini_file($configIni, false);
190

191
        } catch (\Exception $e) {
192
            throw new qfq\UserFormException ("Error read file " . CONFIG_INI . ": " . $e->getMessage(), ERROR_IO_READ_FILE);
193
        }
194

195
196
197
198
199
200
201
202
203
        $config = self::renameConfigElements($config);

        // Defaults
        Support::setIfNotSet($config, SYSTEM_DATE_FORMAT, 'yyyy-mm-dd');
        Support::setIfNotSet($config, SYSTEM_SHOW_DEBUG_INFO, 'auto');
        Support::setIfNotSet($config, F_BS_LABEL_COLUMNS, '3');
        Support::setIfNotSet($config, F_BS_INPUT_COLUMNS, '6');
        Support::setIfNotSet($config, F_BS_NOTE_COLUMNS, '3');

204
        // Adjust config
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        if ($config[SYSTEM_SHOW_DEBUG_INFO] === 'auto') {
            $config[SYSTEM_SHOW_DEBUG_INFO] = (isset($GLOBALS["TSFE"]->beUserLogin) && $GLOBALS["TSFE"]->beUserLogin === true) ? 'yes' : 'no';
        }

        $config = self::doSystemPath($config);

        // make SQL PATH absolute. This is necessary to work in different directories correctly.
        if (isset($config[SYSTEM_SQL_LOG]) && $config[SYSTEM_SQL_LOG][0] !== '/') {
            $config[SYSTEM_SQL_LOG] = $config[SYSTEM_PATH_EXT] . '/' . $config[SYSTEM_SQL_LOG];
        }

        // Verify existence
        $names = array('DB_USER', 'DB_SERVER', 'DB_PASSWORD', 'DB_NAME', 'SQL_LOG', 'SQL_LOG_MODE');
        foreach ($names as $name) {
            if (!isset($config[$name])) {
                throw new qfq\UserFormException ("Missing configuration in `config.ini`: $name", ERROR_MISSING_CONFIG_INI_VALUE);
            }
        }

        self::setVarArray($config, STORE_SYSTEM, true);
    }

    /**
     * Rename Elements defined in config.qfq.ini to more appropriate in user interaction.
     * E.g.: in config.qfq.ini everything is in upper case and word space is '_'. In Form.parameter it's lowercase and camel hook.
     *
     * @param array $config
     * @return array
     */
    private function renameConfigElements(array $config) {

        // oldname > newname
        $setting = [
            [SYSTEM_FORM_BS_LABEL_COLUMNS, F_BS_LABEL_COLUMNS],
            [SYSTEM_FORM_BS_INPUT_COLUMNS, F_BS_INPUT_COLUMNS],
            [SYSTEM_FORM_BS_NOTE_COLUMNS, F_BS_NOTE_COLUMNS],
        ];

        foreach ($setting as $row) {
            $oldName = $row[0];
            $newName = $row[1];

            if (isset($config[$oldName])) {
                $config[$newName] = $config[$oldName];
                if ($oldName != $newName) {
                    unset($config[$oldName]);
                }
            }
253
254
        }

255
256
257
258
259
260
261
262
263
        return $config;
    }

    /**
     * @param array $config
     * @return array
     */
    private function doSystemPath(array $config) {

264
265
266
267
268
269
270
        // SYSTEM_PATH_EXT: compute only if not already defined.
        if (!isset($config[SYSTEM_PATH_EXT]) || $config[SYSTEM_PATH_EXT] === '' || $config[SYSTEM_PATH_EXT][0] !== '/') {
            $relExtDir = '/typo3conf/ext/' . EXT_KEY;

            // If we are called through AJAX API (e.g. api/save.php), there is no TYPO3 environment.
            if (isset($_SERVER['SCRIPT_FILENAME'])) {
                $pos = strpos($_SERVER['SCRIPT_FILENAME'], $relExtDir);
271
272
                if ($pos === false && isset($GLOBALS['TYPO3_LOADED_EXT'][EXT_KEY]['ext_localconf.php'])) {

273
                    // Typo3 extension: probably index.php
274
                    $config[SYSTEM_PATH_EXT] = dirname($GLOBALS['TYPO3_LOADED_EXT'][EXT_KEY]['ext_localconf.php']);
275
                    $config[SYSTEM_SITE_PATH] = dirname($_SERVER['SCRIPT_FILENAME']);
276
                } else {
277
                    // API
278
                    $config[SYSTEM_PATH_EXT] = substr($_SERVER['SCRIPT_FILENAME'], 0, $pos + strlen($relExtDir));
279
                    $config[SYSTEM_SITE_PATH] = substr($_SERVER['SCRIPT_FILENAME'], 0, $pos);
280
                }
281
282
283
284
            } else {
                // No $_SERVER >>this means phpUnit.
                $config[SYSTEM_SITE_PATH] = getcwd();
                $config[SYSTEM_PATH_EXT] = getcwd();
285
286
            }
        }
287
        return $config;
288
289
    }

290
    /**
Carsten  Rose's avatar
Carsten Rose committed
291
292
     * Set or overwrite a complete store.
     *
293
294
     * @param array $dataArray
     * @param $store
295
     * @param bool|false $flagOverwrite
296
     * @throws UserFormException
297
     * @throws \qfq\CodeException
298
     */
299
    public static function setVarArray(array $dataArray, $store, $flagOverwrite = false) {
300

Carsten  Rose's avatar
Carsten Rose committed
301
        // Check valid Storename
Carsten  Rose's avatar
Carsten Rose committed
302
        if (!isset(self::$sanitizeStore))
303
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
Carsten  Rose's avatar
Carsten Rose committed
304

305
        if ($store === STORE_ZERO)
Carsten  Rose's avatar
Carsten Rose committed
306
            throw new CodeException("setVarArray() for STORE_ZERO is impossible - there are no values.", ERROR_SET_STORE_ZERO);
307

Carsten  Rose's avatar
Carsten Rose committed
308
        if (!$flagOverwrite && isset(self::$raw[$store]) && count(self::$raw[$store]) > 0) {
309
            throw new CodeException("Raw values already been copied to store '$store'. Do this only one time.", ERROR_STORE_VALUE_ALREADY_CODPIED);
310
        }
311

312
313
        self::$raw[$store] = $dataArray;
    }
314

315
    /**
316
317
318
     * Copy the BodyText as well as some T3 specific vars to STORE_TYPO3.
     * Attention: if called through API, there is no T3 environment. The only values which are available are fe_user and fe_user_uid.
     *
319
320
321
     * @param $bodytext
     * @throws CodeException
     */
322
    private static function fillStoreTypo3($bodytext) {
323

324
        // form=, showDebugBodyText=, 10.20..
325
        $arr = KeyValueStringParser::parse($bodytext, "=", "\n");
326

327
        if (isset($GLOBALS["TSFE"])) {
328

329
330
331
            if (isset($GLOBALS["TSFE"]->fe_user->user["username"])) {
                $arr[TYPO3_FE_USER] = $GLOBALS["TSFE"]->fe_user->user["username"];
            }
332

333
334
335
336
            if (isset($GLOBALS["TSFE"]->fe_user->user["uid"])) {
                $feUid = $GLOBALS["TSFE"]->fe_user->user["uid"];
                $arr[TYPO3_FE_USER_UID] = $GLOBALS["TSFE"]->fe_user->user["uid"];
            }
337

338
339
340
            if (isset($GLOBALS["TSFE"]->fe_user->user["usergroup"])) {
                $arr[TYPO3_FE_USER_GROUP] = $GLOBALS["TSFE"]->fe_user->user["usergroup"];
            }
Carsten  Rose's avatar
Carsten Rose committed
341

342
343
344
            if (isset($GLOBALS["TSFE"]->page["uid"])) {
                $arr[TYPO3_TT_CONTENT_UID] = $GLOBALS["TSFE"]->page["uid"];
            }
345

346
347
348
349
350
351
352
            if (isset($GLOBALS["TSFE"]->id)) {
                $arr[TYPO3_PAGE_ID] = $GLOBALS["TSFE"]->id;
            }

            if (isset($GLOBALS["TSFE"]->type)) {
                $arr[TYPO3_PAGE_TYPE] = $GLOBALS["TSFE"]->type;
            }
Carsten  Rose's avatar
Carsten Rose committed
353

354
355
356
            if (isset($GLOBALS["TSFE"]->sys_language_uid)) {
                $arr[TYPO3_PAGE_LANGUAGE] = $GLOBALS["TSFE"]->sys_language_uid;
            }
357

358
        } else {
359

360
            // NO T3 environment (called by API): restore from SESSION
361
362
363
364
            foreach([ SESSION_FE_USER, SESSION_FE_USER_UID, SESSION_FE_USER_GROUP ] as $key) {
                if (isset($_SESSION[SESSION_NAME][$key])) {
                    $arr[$key] = $_SESSION[SESSION_NAME][$key];
                }
365
366
            }
        }
367

368
        self::setVarArray($arr, STORE_TYPO3, true);
369
    }
370

371
    /**
Carsten  Rose's avatar
Carsten Rose committed
372
373
     * Fills the STORE_CLIENT
     *
374
375
     * @throws CodeException
     */
376
    private static function fillStoreClient() {
377
        // copy GET and POST and SERVER Parameter. Priority: SERVER, POST, GET
378
379
380
381
382
383
384
        $arr = array();
        if (isset($_GET))
            $arr = array_merge($arr, $_GET);

        if (isset($_POST))
            $arr = array_merge($arr, $_POST);

385
        // It's important to merge the SERVER array last: those entries shall overwrite client values.
386
387
        if (isset($_SERVER))
            $arr = array_merge($arr, $_SERVER);
388

389
        $arr = \qfq\Sanitize::normalize($arr);
390

391
        self::setVarArray($arr, STORE_CLIENT, true);
392

393
    }
394

Carsten  Rose's avatar
Carsten Rose committed
395
    /**
Carsten  Rose's avatar
Carsten Rose committed
396
397
     * Fills the STORE_SIP. Reads therefore specified SIP, decode the values and stores them in STORE_SIP.
     *
Carsten  Rose's avatar
Carsten Rose committed
398
     * @throws CodeException
399
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
400
     */
401
    private static function fillStoreSip() {
Carsten  Rose's avatar
Carsten Rose committed
402

403
        self::$sip = new Sip(self::$phpUnit);
404

405
406
407
408
        $s = self::getVar(CLIENT_SIP, STORE_CLIENT);
        if ($s !== false) {
            // if session is given, copy values to store
            $param = self::$sip->getVarsFromSip($s);
409
410
            $param[SIP_SIP] = $s;
            $param[SIP_URLPARAM] = self::$sip->getQueryStringFromSip($s);
411

412
//            self::setVarArray(KeyValueStringParser::parse($param, "=", "&"), STORE_SIP);
413
            self::setVarArray($param, STORE_SIP, true);
414
415
416
        }
    }

417
    /**
418
     * Cycles through all stores in $useStore.
419
     * First match will return the found value.
Carsten  Rose's avatar
Carsten Rose committed
420
     * During cycling: fill cache with requestet value and sanitize raw value.
421
     *
422
     * @param string $key
423
     * @param string $useStores f.e.: 'FSRD'
Carsten  Rose's avatar
Carsten Rose committed
424
     * @param string $sanitizeClass
Carsten  Rose's avatar
Carsten Rose committed
425
     * @param string $foundInStore Returns the name of the store where $key has been found. If $key is not found, return ''.
426
     * @return string a) if found: value, b) false
Carsten  Rose's avatar
Carsten Rose committed
427
     * @throws \qfq\CodeException
428
     */
Carsten  Rose's avatar
Carsten Rose committed
429
    public static function getVar($key, $useStores = STORE_USE_DEFAULT, $sanitizeClass = '', &$foundInStore = '') {
430
431

        // no store specifed?
432
        if ($useStores === "" || $useStores === null) {
433
            $useStores = STORE_USE_DEFAULT;
434
435
        }

436
        // no sanitizeClass specified: take predefined (if exist) or default.
437
        if ($sanitizeClass === '' || $sanitizeClass === null) {
Carsten  Rose's avatar
Carsten Rose committed
438
            $sanitizeClass = isset(self::$sanitizeClass[$key]) ? self::$sanitizeClass[$key] : SANITIZE_DEFAULT;
439
440
        }

441
442
443
        while ($useStores !== false) {

            $store = substr($useStores, 0, 1); // next store
Carsten  Rose's avatar
Carsten Rose committed
444
            $foundInStore = $store;
445
446
            $useStores = substr($useStores, 1); // shift left remaining stores

447
            if (!isset(self::$raw[$store][$key])) {
448
449
450
                switch ($store) {
                    case STORE_ZERO:
                        return 0;
451
452
                    case STORE_EMPTY:
                        return '';
453
454
                    case STORE_VAR:
                        if ($key === VAR_RANDOM) {
455
                            return Support::randomAlphaNum(RANDOM_LENGTH);
456
457
458
459
460
461
462
                        } else {
                            continue 2;  // no value provided, continue with while loop
                        }
                        break;
                    default:
                        continue 2; // no value provided, continue with while loop
                        break;
Carsten  Rose's avatar
Carsten Rose committed
463
                }
464
465
            }

466
            $rawVal = isset(self::$raw[$store][$key]) ? self::$raw[$store][$key] : null;
Carsten  Rose's avatar
Carsten Rose committed
467
            if (self::$sanitizeStore[$store] && $sanitizeClass != '') {
468
469
470
471
472
                if ($sanitizeClass == SANITIZE_ALLOW_PATTERN || $sanitizeClass == SANITIZE_ALLOW_MIN_MAX || $sanitizeClass == SANITIZE_ALLOW_MIN_MAX_DATE) {
                    // We do not have any pattern or min|max values at this point. For those who be affected, they already checked earlier. So set 'no check'
                    $sanitizeClass = SANITIZE_ALLOW_ALL;
                }
                return \qfq\Sanitize::sanitize($rawVal, $sanitizeClass, '', SANATIZE_EMPTY_STRING);
473
474
            } else {
                return $rawVal;
475
            }
476
        }
Carsten  Rose's avatar
Carsten Rose committed
477
        $foundInStore = '';
478
        return false;
479
    }
480

Carsten  Rose's avatar
Carsten Rose committed
481
    /**
Carsten  Rose's avatar
Carsten Rose committed
482
483
     * Fills the STORE_EXTRA.
     *
Carsten  Rose's avatar
Carsten Rose committed
484
485
486
487
     * @throws UserFormException
     * @throws \qfq\CodeException
     */
    private static function fillStoreExtra() {
488

489
        $value = Session::get(STORE_EXTRA);
490

491
        if (!isset($_SESSION[SESSION_NAME][STORE_EXTRA]) || $_SESSION[SESSION_NAME][STORE_EXTRA] === null) {
492
493
494
495
            $value = false;
        }

        if ($value === false) {
Carsten  Rose's avatar
Carsten Rose committed
496
            self::setVarArray(array(), STORE_EXTRA, true);
497
        } else {
498
            self::setVarArray($_SESSION[SESSION_NAME][STORE_EXTRA], STORE_EXTRA, true);
499
        }
Carsten  Rose's avatar
Carsten Rose committed
500
501
    }

502
    /**
Carsten  Rose's avatar
Carsten Rose committed
503
504
     * Returns a pointer to this Class.
     *
505
     * @param string $bodytext
506
     * @param bool|false $phpUnit
507
     * @return null|\qfq\Store
508
     */
509
    public static function getInstance($bodytext = '', $phpUnit = false) {
510

511
        if ($phpUnit) {
512
            if (self::$instance !== null) {
513
                // fake to have a clean environment for the next test.
514
515
516
517
518
                self::unsetStore(STORE_TYPO3);
                self::fillStoreTypo3($bodytext);

                self::unsetStore(STORE_CLIENT);
                self::fillStoreClient();
519
520
521
522
523
            }
        }

        // Design Pattern: Singleton
        if (self::$instance === null) {
524
525
526
            self::$phpUnit = $phpUnit;

            self::$instance = new self($bodytext);
Carsten  Rose's avatar
Carsten Rose committed
527
528
529
530
        } else {
            // Class Store seems to be presistent over multiple QFQ instantiation. Set bodytext again, with every new request (if bodytext is given).
            if ($bodytext !== '')
                self::fillStoreTypo3($bodytext);
531
532
        }

533
534
535
536
537
538
539
        // Disable TYPO3_DEBUG_SHOW_BODY_TEXT=1 if SYSTEM_SHOW_DEBUG_INFO!='yes'
        if (self::getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === '1' &&
            self::getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) !== 'yes'
        ) {
            self::setVar(TYPO3_DEBUG_SHOW_BODY_TEXT, '0', STORE_TYPO3);
        }

540
        return self::$instance;
541
    }
542

543
    /**
Carsten  Rose's avatar
Carsten Rose committed
544
545
     * Deletes a store assigning a new empty array to it.
     *
546
     * @param $store
547
548
     * @throws UserFormException
     * @throws \qfq\CodeException
549
550
     */
    public static function unsetStore($store) {
Carsten  Rose's avatar
Carsten Rose committed
551
        // Check valid Storename
Carsten  Rose's avatar
Carsten Rose committed
552
        if (!isset(self::$sanitizeStore))
553
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
Carsten  Rose's avatar
Carsten Rose committed
554

555
        if ($store === STORE_ZERO)
Carsten  Rose's avatar
Carsten Rose committed
556
557
            throw new CodeException("unsetStore() for STORE_ZERO is impossible - there are no values.", ERROR_SET_STORE_ZERO);

558
559
560
        if (isset(self::$raw[$store])) {
            self::$raw[$store] = array();
        }
Carsten  Rose's avatar
Carsten Rose committed
561

562
563
    }

564
    /**
Carsten  Rose's avatar
Carsten Rose committed
565
566
     * Set's a single $key/$value pair $store.
     *
Carsten  Rose's avatar
Carsten Rose committed
567
568
569
     * @param string $key
     * @param string|array $value
     * @param string $store
570
571
572
573
574
575
576
577
578
579
580
581
582
     * @param bool|true $overWrite
     * @throws UserFormException
     * @throws \qfq\CodeException
     */
    public static function setVar($key, $value, $store, $overWrite = true) {
        // Check valid Storename
        if (!isset(self::$sanitizeStore))
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);

        if ($store === STORE_ZERO)
            throw new CodeException("setVar() for STORE_ZERO is impossible - there are no values.", ERROR_SET_STORE_ZERO);

        if ($overWrite === false && isset(self::$raw[$store][$key])) {
583
            throw new UserFormException("Value of '$key' already set in store '$store'.", ERROR_STORE_KEY_EXIST);
584
585
586
        }

        self::$raw[$store][$key] = $value;
Carsten  Rose's avatar
Carsten Rose committed
587
588
589

        // The STORE_EXTRA saves arrays and is persistent
        if ($store === STORE_EXTRA) {
590

591
            $store = Session::get(STORE_EXTRA);
592
593

            if ($store === false) {
594
                $store = array();
595
596
            }

597
598
            $store[$key] = $value;
            Session::set(STORE_EXTRA, $store);
599

Carsten  Rose's avatar
Carsten Rose committed
600
        }
601
602
    }

603
    /**
Carsten  Rose's avatar
Carsten Rose committed
604
605
     * Create a SIP after a form load. This is necessary on forms without a sip and on forms with r=0 (new record).
     *
606
607
608
     * @param $formName
     * @throws CodeException
     */
609
    public static function createSipAfterFormLoad($formName) {
610

611
        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_TYPO3 . STORE_CLIENT);
612
613
614
615
        if ($recordId === false) {
            $recordId = 0;
        }

616
617
618
619
620
621
        // If there are existing SIP param, keep them by copying to the new SIP Param Array
        $tmpParam = self::getNonSystemSipParam();

        $tmpParam[SIP_RECORD_ID] = $recordId;
        $tmpParam[SIP_FORM] = $formName;

Carsten  Rose's avatar
#2067    
Carsten Rose committed
622
623
624
625
        if ($recordId == 0) {
            // SIPs for 'new records' needs to be uniq per TAB! Therefore add a uniq parameter
            $tmpParam[SIP_MAKE_URLPARAM_UNIQ] = uniqid();
        }
626
627

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

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

        // Store in SIP Store (cause it's empty until now).
        $tmpParam[SIP_SIP] = $sip;
636
        self::setVarArray($tmpParam, STORE_SIP, true);
637

638
639
640
    }

    /**
641
642
643
644
     * Return an array with non system SIP parameter. Take the whole STORE_SIP and search for non system parameter.
     * @return array
     * @throws UserFormException
     * @throws \qfq\CodeException
645
     */
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
    private static function getNonSystemSipParam() {
        $tmpParam = array();

        $sipArray = self::getStore(STORE_SIP);

        foreach ($sipArray as $key => $value) {
            if ($key[0] === '_') {
                continue;
            }
            switch ($key) {
                case SIP_SIP:
                case SIP_RECORD_ID:
                case SIP_FORM;
                case SIP_URLPARAM:
                    continue;
                default:
                    $tmpParam[$key] = $value;
            }
        }

        return $tmpParam;
667
    }
668

669
    /**
Carsten  Rose's avatar
Carsten Rose committed
670
671
     * Returns a complete $store.
     *
672
     * @param $store
673
674
675
     * @return array
     * @throws UserFormException
     * @throws \qfq\CodeException
676
677
     */
    public static function getStore($store) {
Carsten  Rose's avatar
Carsten Rose committed
678
        // Check valid Storename
Carsten  Rose's avatar
Carsten Rose committed
679
        if (!isset(self::$sanitizeStore[$store]))
680
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
Carsten  Rose's avatar
Carsten Rose committed
681

682
        if ($store === STORE_ZERO)
Carsten  Rose's avatar
Carsten Rose committed
683
684
            throw new CodeException("getStore() for STORE_ZERO is impossible - there are no values saved.", ERROR_GET_STORE_ZERO);

685
686
687
        if (isset(self::$raw[$store])) {
            return self::$raw[$store];
        }
688

689
690
        return array();
    }
691

692
693
694
695
696
697
698
699
    /**
     * Returns a pointer to this class.
     *
     * @return null|Sip
     */
    public static function getSipInstance() {
        return self::$sip;
    }
Carsten  Rose's avatar
Carsten Rose committed
700

701
    /**
Carsten  Rose's avatar
Carsten Rose committed
702
703
     * Fills STORE_TABLE_DEFAULT and STORE_TABLE_COLUMN_TYPES
     *
704
705
706
     * @param $tableName
     * @throws CodeException
     */
707
    public static function fillStoreTableDefaultColumnType($tableName) {
708
709
710
711
        $db = new qfq\Database();

        $tableDefinition = $db->getTableDefinition($tableName);

Carsten  Rose's avatar
Carsten Rose committed
712
713
        self::setVarArray(array_column($tableDefinition, 'Default', 'Field'), STORE_TABLE_DEFAULT, true);
        self::setVarArray(array_column($tableDefinition, 'Type', 'Field'), STORE_TABLE_COLUMN_TYPES, true);
714
    }
715
716
717
718
719
}