Store.php 31.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;
12

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

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

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

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
52
53
54
55
56
57
58
59
60
61
    /**
     * @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
     */
62
    private static $raw = array();
Carsten  Rose's avatar
Carsten Rose committed
63
64

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

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

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

80

81
    /**
82
     * @param string $bodytext
83
     * @param string $fileConfigIni
Carsten  Rose's avatar
Carsten Rose committed
84
     *
85
     * @throws CodeException
86
     * @throws UserFormException
87
     * @throws UserReportException
88
     */
89
    private function __construct($bodytext = '', $fileConfigIni = '') {
90

91
//        self::$session = Session::getInstance(self::$phpUnit);
92

93
        // This check is critical for some unwanted exception recursion during startup.
Carsten  Rose's avatar
Carsten Rose committed
94
95
        if (!function_exists('normalizer_normalize')) {
            throw new CodeException("Function normalizer_normalize() not found - Please install 'php5-intl' / 'php7.0-intl'", ERROR_MISSING_INTL);
96
97
        }

Carsten  Rose's avatar
Carsten Rose committed
98
99
100
101
102
103
104
105
        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,

Carsten  Rose's avatar
Carsten Rose committed
106
107
108
109
            CLIENT_SIP => SANITIZE_ALLOW_ALNUMX,
            CLIENT_TYPO3VARS => SANITIZE_ALLOW_ALNUMX,
            CLIENT_RECORD_ID => SANITIZE_ALLOW_DIGIT,
            CLIENT_KEY_SEM_ID => SANITIZE_ALLOW_DIGIT,
Carsten  Rose's avatar
Carsten Rose committed
110
            CLIENT_KEY_SEM_ID_USER => SANITIZE_ALLOW_DIGIT,
Carsten  Rose's avatar
Carsten Rose committed
111
112
113
114
            CLIENT_PAGE_ID => SANITIZE_ALLOW_DIGIT,
            CLIENT_PAGE_TYPE => SANITIZE_ALLOW_DIGIT,
            CLIENT_PAGE_LANGUAGE => SANITIZE_ALLOW_DIGIT,
            CLIENT_FORM => SANITIZE_ALLOW_ALNUMX,
Carsten  Rose's avatar
Carsten Rose committed
115
116

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

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

151
152
        ];

Carsten  Rose's avatar
Carsten Rose committed
153
        self::$sanitizeStore = [
Carsten  Rose's avatar
Carsten Rose committed
154
155
156
157
158
159
160
161
162
163
164
165
166
167
            STORE_FORM => true,
            STORE_SIP => false,
            STORE_RECORD => false,
            STORE_BEFORE => false,
            STORE_PARENT_RECORD => false,
            STORE_TABLE_DEFAULT => false,
            STORE_TABLE_COLUMN_TYPES => false,
            STORE_CLIENT => true,
            STORE_TYPO3 => false,
            STORE_VAR => false,
            STORE_ZERO => false,
            STORE_EMPTY => false,
            STORE_SYSTEM => false,
            STORE_EXTRA => false,
168
            STORE_USER => false,
Carsten  Rose's avatar
Carsten Rose committed
169
            STORE_LDAP => false,
Carsten  Rose's avatar
Carsten Rose committed
170
            STORE_ADDITIONAL_FORM_ELEMENTS => false,
171
172
        ];

173
174
        self::fillStoreTypo3($bodytext);  // should be filled before fillStoreSystem() to offer T3 variables
        self::fillStoreClient();  // should be filled before fillStoreSystem() to offer Client variables
175
176
        self::fillStorePhpSession(STORE_EXTRA); // should be filled before fillStoreSystem() to restore variables like SYSTEM_SHOW_DEBUG_INFO
        self::fillStorePhpSession(STORE_USER); // should be filled before fillStoreSystem() to restore variables like SYSTEM_SHOW_DEBUG_INFO
177
        self::fillStoreSystem($fileConfigIni);
178
        self::fillStoreSip();
179
    }
180

181
    /**
182
     * Fill the system store by reading config.qfq.ini. Also setup config defaults.
Carsten  Rose's avatar
Carsten Rose committed
183
     *
184
     * @param string $fileConfigIni
185
     * @throws CodeException
186
     * @throws UserFormException
187
     * @throws UserReportException
188
     */
189
    private static function fillStoreSystem($fileConfigIni = '') {
190

191
        $config = Config::readConfig($fileConfigIni);
192
193

        $config = self::doSystemPath($config);
194
        $config = self::adjustConfig($config);
195

196
        self::checkMandatoryParameter($config);
197

198
        self::setStore($config, STORE_SYSTEM, true);
199
200
201
    }

    /**
202
     * QFQ might be called via Typo3 (index.php) or directly via AJAX (directory: api). The
Carsten  Rose's avatar
Carsten Rose committed
203
     *
204
     * @param array $config
Carsten  Rose's avatar
Carsten Rose committed
205
     *
206
207
     * @return array
     */
Carsten  Rose's avatar
Carsten Rose committed
208
    private static function doSystemPath(array $config) {
209

210
211
212
213
214
215
216
        // 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);
217
218
                if ($pos === false && isset($GLOBALS['TYPO3_LOADED_EXT'][EXT_KEY]['ext_localconf.php'])) {

219
                    // Typo3 extension: probably index.php
220
                    $config[SYSTEM_PATH_EXT] = dirname($GLOBALS['TYPO3_LOADED_EXT'][EXT_KEY]['ext_localconf.php']);
221
                    $config[SYSTEM_SITE_PATH] = dirname($_SERVER['SCRIPT_FILENAME']);
222
                } else {
223
                    // API
224
                    $config[SYSTEM_PATH_EXT] = substr($_SERVER['SCRIPT_FILENAME'], 0, $pos + strlen($relExtDir));
225
                    $config[SYSTEM_SITE_PATH] = substr($_SERVER['SCRIPT_FILENAME'], 0, $pos);
226
                }
227
228
229
230
            } else {
                // No $_SERVER >>this means phpUnit.
                $config[SYSTEM_SITE_PATH] = getcwd();
                $config[SYSTEM_PATH_EXT] = getcwd();
231
232
            }
        }
233
234
235
236
237
238
239
240

        return $config;
    }

    /**
     * Depending on some configuration value, update corresponding values.
     *
     * @param array $config
Carsten  Rose's avatar
Carsten Rose committed
241
     *
242
243
244
     * @return array
     */
    private static function adjustConfig(array $config) {
245
246

        $config[SYSTEM_SHOW_DEBUG_INFO] = self::adjustConfigShowDebugInfo($config[SYSTEM_SHOW_DEBUG_INFO], self::beUserLoggdIn());
247
248

        // make SQL PATH absolute. This is necessary to work in different directories correctly.
249
        if (!empty($config[SYSTEM_SQL_LOG]) && $config[SYSTEM_SQL_LOG][0] !== '/') {
250
            $config[SYSTEM_SQL_LOG] = $config[SYSTEM_SITE_PATH] . '/' . $config[SYSTEM_SQL_LOG];
251
252
        }

253
254
        // make SQL PATH absolute. This is necessary to work in different directories correctly.
        if (!empty($config[SYSTEM_MAIL_LOG]) && $config[SYSTEM_MAIL_LOG][0] !== '/') {
255
            $config[SYSTEM_MAIL_LOG] = $config[SYSTEM_SITE_PATH] . '/' . $config[SYSTEM_MAIL_LOG];
256
257
258
259
        }

        $config[SYSTEM_SEND_E_MAIL] = $config[SYSTEM_PATH_EXT] . '/qfq/external/sendEmail';

260
261
262
263
264
265
266
267
        // In case the database credentials are given in the old style: copy them to the new style
        if (!isset($config[SYSTEM_DB_1_USER]) && isset($config[SYSTEM_DB_USER])) {
            $config[SYSTEM_DB_1_USER] = $config[SYSTEM_DB_USER];
            $config[SYSTEM_DB_1_SERVER] = $config[SYSTEM_DB_SERVER];
            $config[SYSTEM_DB_1_PASSWORD] = $config[SYSTEM_DB_PASSWORD];
            $config[SYSTEM_DB_1_NAME] = $config[SYSTEM_DB_NAME];
        }

268
        return $config;
269
270
    }

271
    /**
272
     * @param string $value
Carsten  Rose's avatar
Carsten Rose committed
273
     *
274
     * @param $flag
275
     * @return string
276
     */
277
    private static function adjustConfigShowDebugInfo($value, $flag) {
278

279
        // Check if SHOW_DEBUG_INFO contains 'auto'. Replace with appropriate.
280
281
        if (Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_AUTO, $value) && $flag) {
            $value = str_replace(SYSTEM_SHOW_DEBUG_INFO_AUTO, SYSTEM_SHOW_DEBUG_INFO_YES, $value);
282
283
        }

284
285
286
287
288
289
290
291
292
293
294
        return $value;
    }

    /**
     * Check if there is a Typo3 beUser is logged in. This is only possible if QFQ is called via T3, not via API
     *
     * @return bool  true: current Browser session is a logged in BE User.
     */
    private static function beUserLoggdIn() {

        return (!empty($GLOBALS["TSFE"]->beUserLogin) && $GLOBALS["TSFE"]->beUserLogin === true);
295
296
    }

297
298
299
300
    /**
     * Iterate over all Parameter which have to exist in the config. Throw an array if any is missing.
     *
     * @param array $config
Carsten  Rose's avatar
Carsten Rose committed
301
     *
302
303
304
     * @throws UserFormException
     */
    private static function checkMandatoryParameter(array $config) {
305

306
        // Check mandatory config vars.
307
        $names = array_merge([SYSTEM_SQL_LOG, SYSTEM_SQL_LOG_MODE],
308
309
310
            self::dbCredentialName($config[SYSTEM_DB_INDEX_DATA]),
            self::dbCredentialName($config[SYSTEM_DB_INDEX_QFQ]));

311
312
        foreach ($names as $name) {
            if (!isset($config[$name])) {
313
                throw new qfq\UserFormException ("Missing configuration in `" . CONFIG_QFQ_PHP . "`: $name", ERROR_MISSING_CONFIG_INI_VALUE);
314
315
316
317
            }
        }
    }

318
    /**
319
320
     * @param $index
     * @return array
321
322
323
324
325
326
327
328
329
330
331
     */
    private static function dbCredentialName($index) {
        $names = array();
        $names[] = 'DB_' . $index . '_USER';
        $names[] = 'DB_' . $index . '_SERVER';
        $names[] = 'DB_' . $index . '_PASSWORD';
        $names[] = 'DB_' . $index . '_NAME';

        return $names;
    }

332
    /**
Carsten  Rose's avatar
Carsten Rose committed
333
334
     * Set or overwrite a complete store.
     *
Carsten  Rose's avatar
Carsten Rose committed
335
     * @param array $dataArray
Carsten  Rose's avatar
Carsten Rose committed
336
     * @param            $store
337
     * @param bool|false $flagOverwrite
Carsten  Rose's avatar
Carsten Rose committed
338
     *
339
     * @throws UserFormException
340
     * @throws \qfq\CodeException
341
     */
342
    public static function setStore(array $dataArray, $store, $flagOverwrite = false) {
343

Carsten  Rose's avatar
Carsten Rose committed
344
        // Check valid Storename
Carsten  Rose's avatar
Carsten Rose committed
345
        if (!isset(self::$sanitizeStore))
346
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
Carsten  Rose's avatar
Carsten Rose committed
347

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

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

355
356
        self::$raw[$store] = $dataArray;
    }
357

358
    /**
359
     * Copy the BodyText as well as some T3 specific vars to STORE_TYPO3.
Carsten  Rose's avatar
Carsten Rose committed
360
361
     * Attention: if called through API, there is no T3 environment. The only values which are available are fe_user
     * and fe_user_uid.
362
     *
363
     * @param $bodytext
Carsten  Rose's avatar
Carsten Rose committed
364
     *
365
     * @throws CodeException
366
     * @throws UserFormException
367
     */
368
    private static function fillStoreTypo3($bodytext) {
369

370
        // form=, showDebugBodyText=, 10.20..
371
        $arr = KeyValueStringParser::parse($bodytext, "=", "\n");
372

373
        if (isset($GLOBALS["TSFE"])) {
374
            $arr = array_merge($arr, T3Info::getVars());
375
        } else {
376

377
            // No T3 environment (called by API): restore from SESSION
378
            foreach ([SESSION_FE_USER, SESSION_FE_USER_UID, SESSION_FE_USER_GROUP, SESSION_BE_USER] as $key) {
379
380
381
                if (isset($_SESSION[SESSION_NAME][$key])) {
                    $arr[$key] = $_SESSION[SESSION_NAME][$key];
                }
382
383
            }
        }
384

385
        self::setStore($arr, STORE_TYPO3, true);
386
    }
387

388
    /**
Carsten  Rose's avatar
Carsten Rose committed
389
390
     * Fills the STORE_CLIENT
     *
391
     * @throws CodeException
392
     * @throws UserFormException
393
     */
394
    private static function fillStoreClient() {
395

Carsten  Rose's avatar
Carsten Rose committed
396
        $arr = Client::getParam();
397

398
        self::setStore($arr, STORE_CLIENT, true);
399

400
    }
401

Carsten  Rose's avatar
Carsten Rose committed
402
    /**
Carsten  Rose's avatar
Carsten Rose committed
403
404
     * Fills the STORE_SIP. Reads therefore specified SIP, decode the values and stores them in STORE_SIP.
     *
Carsten  Rose's avatar
Carsten Rose committed
405
     * @throws CodeException
406
     * @throws UserFormException
407
     * @throws UserReportException
Carsten  Rose's avatar
Carsten Rose committed
408
     */
409
    private static function fillStoreSip() {
Carsten  Rose's avatar
Carsten Rose committed
410

411
        self::$sip = new Sip(self::$phpUnit);
412

413
414
415
416
        $s = self::getVar(CLIENT_SIP, STORE_CLIENT);
        if ($s !== false) {
            // if session is given, copy values to store
            $param = self::$sip->getVarsFromSip($s);
417
418
            $param[SIP_SIP] = $s;
            $param[SIP_URLPARAM] = self::$sip->getQueryStringFromSip($s);
419

420
//            self::setVarArray(KeyValueStringParser::parse($param, "=", "&"), STORE_SIP);
421
            self::setStore($param, STORE_SIP, true);
422
423
424
        }
    }

425
426
427
428
429
430
431
432
433
434
435
436
437
    /**
     * Unset a variable in store.
     *
     * @param $key
     * @param $store
     */
    public static function unsetVar($key, $store){

        if(isset(self::$raw[$store][$key])) {
            unset(self::$raw[$store][$key]);
        }
    }

438
    /**
439
     * Cycles through all stores in $useStore.
440
     * First match will return the found value.
441
     * During cycling: fill cache with requested value and sanitize raw value.
442
     *
443
     * @param string $key
444
     * @param string $useStores f.e.: 'FSRVD'
Carsten  Rose's avatar
Carsten Rose committed
445
     * @param string $sanitizeClass
Carsten  Rose's avatar
Carsten Rose committed
446
447
448
     * @param string $foundInStore Returns the name of the store where $key has been found. If $key is not found,
     *                             return ''.
     *
449
     * @return string a) if found: value, b) false
450
451
     * @throws CodeException
     * @throws UserFormException
452
     */
Carsten  Rose's avatar
Carsten Rose committed
453
    public static function getVar($key, $useStores = STORE_USE_DEFAULT, $sanitizeClass = '', &$foundInStore = '') {
454

455
        // no store specified?
456
        if ($useStores === "" || $useStores === null) {
457
            $useStores = STORE_USE_DEFAULT;
458
459
        }

460
        // no sanitizeClass specified: take predefined (if exist) or default.
461
        if ($sanitizeClass === '' || $sanitizeClass === null) {
Carsten  Rose's avatar
Carsten Rose committed
462
            $sanitizeClass = isset(self::$sanitizeClass[$key]) ? self::$sanitizeClass[$key] : SANITIZE_DEFAULT;
463
464
        }

Carsten  Rose's avatar
Carsten Rose committed
465
466
        $len = strlen(SIP_PREFIX_BASE64);

467
468
        while ($useStores !== false) {
            $store = substr($useStores, 0, 1); // next store
469
470
471
472
473
474

            $finalKey = $key;
            if ($store == STORE_LDAP) {
                $finalKey = strtolower($key); // in STORE_LDAP all keys are lowercase
            }

Carsten  Rose's avatar
Carsten Rose committed
475
            $foundInStore = $store;
476
477
            $useStores = substr($useStores, 1); // shift left remaining stores

478
            if (!isset(self::$raw[$store][$finalKey])) {
479
480
481
                switch ($store) {
                    case STORE_ZERO:
                        return 0;
482
483
                    case STORE_EMPTY:
                        return '';
484
                    case STORE_VAR:
485
                        if ($finalKey === VAR_RANDOM) {
486
                            return Support::randomAlphaNum(RANDOM_LENGTH);
487
488
489
490
491
492
493
                        } 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
494
                }
495
496
            }

497
            $rawVal = isset(self::$raw[$store][$finalKey]) ? self::$raw[$store][$finalKey] : null;
Carsten  Rose's avatar
Carsten Rose committed
498
            if (self::$sanitizeStore[$store] && $sanitizeClass != '') {
499
                if ($sanitizeClass == SANITIZE_ALLOW_PATTERN) {
500
                    // We do not have any pattern at this point. For those who be affected, they already checked earlier. So set 'no check'
501
502
                    $sanitizeClass = SANITIZE_ALLOW_ALL;
                }
Carsten  Rose's avatar
Carsten Rose committed
503

504
                return Sanitize::sanitize($rawVal, $sanitizeClass, '', '', SANITIZE_EMPTY_STRING);
505
            } else {
Carsten  Rose's avatar
Carsten Rose committed
506
507
508
                if ($store == STORE_SIP && (substr($key, 0, $len) == SIP_PREFIX_BASE64)) {
                    $rawVal = base64_decode($rawVal);
                }
Carsten  Rose's avatar
Carsten Rose committed
509

510
                return $rawVal;
511
            }
512
        }
Carsten  Rose's avatar
Carsten Rose committed
513
        $foundInStore = '';
Carsten  Rose's avatar
Carsten Rose committed
514

515
        return false;
516
    }
517

Carsten  Rose's avatar
Carsten Rose committed
518
    /**
Carsten  Rose's avatar
Carsten Rose committed
519
520
     * Fills the STORE_EXTRA.
     *
521
522
     * @param string $storeName   STORE_EXTRA, STORE_USER
     * @throws CodeException
Carsten  Rose's avatar
Carsten Rose committed
523
524
     * @throws UserFormException
     */
525
    private static function fillStorePhpSession($storeName) {
526

527
        $value = Session::get($storeName);
528

529
        if (!isset($_SESSION[SESSION_NAME][$storeName]) || $_SESSION[SESSION_NAME][$storeName] === null) {
530
531
532
533
            $value = false;
        }

        if ($value === false) {
534
            self::setStore(array(), $storeName, true);
535
        } else {
536
            self::setStore($_SESSION[SESSION_NAME][$storeName], $storeName, true);
537
        }
Carsten  Rose's avatar
Carsten Rose committed
538
539
    }

540
    /**
Carsten  Rose's avatar
Carsten Rose committed
541
542
     * Returns a pointer to this Class.
     *
Carsten  Rose's avatar
Carsten Rose committed
543
     * @param string $bodytext
544
     * @param bool|false $phpUnit
Carsten  Rose's avatar
Carsten Rose committed
545
     * @param string $fileConfigIni
Carsten  Rose's avatar
Carsten Rose committed
546
     *
547
     * @return null|Store
548
     * @throws CodeException
549
     * @throws UserFormException
550
     * @throws UserReportException
551
     */
552
    public static function getInstance($bodytext = '', $phpUnit = false, $fileConfigIni = '') {
553

554
        if ($phpUnit) {
555

556
            if (self::$instance !== null) {
557
                // fake to have a clean environment for the next test.
558
559
560
561
562
                self::unsetStore(STORE_TYPO3);
                self::fillStoreTypo3($bodytext);

                self::unsetStore(STORE_CLIENT);
                self::fillStoreClient();
563
            }
564
565
566
567
568

            // Testing different config files means initialize completely
            if ($fileConfigIni != '') {
                self::$instance = null;
            }
569
570
571
572
        }

        // Design Pattern: Singleton
        if (self::$instance === null) {
573
574
            self::$phpUnit = $phpUnit;

575
            self::$instance = new self($bodytext, $fileConfigIni);
Carsten  Rose's avatar
Carsten Rose committed
576
        } else {
577
578
            // Class Store seems to be persistent over multiple QFQ instantiation. Set bodytext again, with every new request (if bodytext is given).
            if ($bodytext !== '') {
Carsten  Rose's avatar
Carsten Rose committed
579
                self::fillStoreTypo3($bodytext);
580
581
                self::unsetStore(STORE_RECORD); // At least in Multi DB Setup: STORE_RECORD of former  tt-content QFQ Records interfere with loading a form.
            }
582
583
        }

584
585
        // Disable TYPO3_DEBUG_SHOW_BODY_TEXT=1 if SYSTEM_SHOW_DEBUG_INFO!='yes'
        if (self::getVar(TYPO3_DEBUG_SHOW_BODY_TEXT, STORE_TYPO3) === '1' &&
586
            !Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_YES, self::getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM))
587
588
589
590
        ) {
            self::setVar(TYPO3_DEBUG_SHOW_BODY_TEXT, '0', STORE_TYPO3);
        }

591
        return self::$instance;
592
    }
593

594
    /**
Carsten  Rose's avatar
Carsten Rose committed
595
596
     * Deletes a store assigning a new empty array to it.
     *
597
     * @param $store
Carsten  Rose's avatar
Carsten Rose committed
598
     *
599
600
     * @throws UserFormException
     * @throws \qfq\CodeException
601
602
     */
    public static function unsetStore($store) {
603
604
        // Check valid store name
        if (!isset(self::$sanitizeStore)) {
605
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
606
        }
Carsten  Rose's avatar
Carsten Rose committed
607

608
        if ($store === STORE_ZERO) {
Carsten  Rose's avatar
Carsten Rose committed
609
            throw new CodeException("unsetStore() for STORE_ZERO is impossible - there are no values.", ERROR_SET_STORE_ZERO);
610
        }
Carsten  Rose's avatar
Carsten Rose committed
611

612
613
614
        if (isset(self::$raw[$store])) {
            self::$raw[$store] = array();
        }
Carsten  Rose's avatar
Carsten Rose committed
615

616
617
    }

618
    /**
Carsten  Rose's avatar
Carsten Rose committed
619
620
     * Set's a single $key/$value pair $store.
     *
Carsten  Rose's avatar
Carsten Rose committed
621
     * @param string $key
Carsten  Rose's avatar
Carsten Rose committed
622
     * @param string|array $value
623
     * @param string $storeName
Carsten  Rose's avatar
Carsten Rose committed
624
     * @param bool|true $overWrite
Carsten  Rose's avatar
Carsten Rose committed
625
     *
626
627
628
     * @throws UserFormException
     * @throws \qfq\CodeException
     */
629
    public static function setVar($key, $value, $storeName, $overWrite = true) {
630
        // Check valid Storename
631
632
633
        if (!isset(self::$sanitizeStore)) {
            throw new UserFormException("Unknown Store: $storeName", ERROR_UNNOWN_STORE);
        }
634

635
        if ($storeName === STORE_ZERO) {
636
            throw new CodeException("setVar() for STORE_ZERO is impossible - there are no values.", ERROR_SET_STORE_ZERO);
637
        }
638

639
        // Complain if already set and different.
640
641
        if ($overWrite === false && isset(self::$raw[$storeName][$key]) && self::$raw[$storeName][$key] != $value) {
            throw new UserFormException("Value of '$key' already set in store '$storeName'.", ERROR_STORE_KEY_EXIST);
642
643
        }

644
        self::$raw[$storeName][$key] = $value;
Carsten  Rose's avatar
Carsten Rose committed
645

646
647
        // The STORE_EXTRA / STORE_USER saves arrays and is persistent
        if ($storeName === STORE_EXTRA || $storeName === STORE_USER) {
648

649
            $data = Session::get($storeName);
650

651
652
            if ($data === false) {
                $data = array();
653
654
            }

655
656
            $data[$key] = $value;
            Session::set($storeName, $data);
Carsten  Rose's avatar
Carsten Rose committed
657
        }
658
659
    }

660
    /**
Carsten  Rose's avatar
Carsten Rose committed
661
662
     * Create a SIP after a form load. This is necessary on forms without a sip and on forms with r=0 (new record).
     *
663
     * @param $formName
Carsten  Rose's avatar
Carsten Rose committed
664
     *
665
     * @throws CodeException
666
     * @throws UserFormException
667
     */
668
    public static function createSipAfterFormLoad($formName) {
669

670
        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_TYPO3 . STORE_CLIENT);
671
672
673
674
        if ($recordId === false) {
            $recordId = 0;
        }

675
676
677
678
679
680
        // 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
681
682
683
684
        if ($recordId == 0) {
            // SIPs for 'new records' needs to be uniq per TAB! Therefore add a uniq parameter
            $tmpParam[SIP_MAKE_URLPARAM_UNIQ] = uniqid();
        }
685
686

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

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

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

697
698
699
    }

    /**
700
     * Return an array with non system SIP parameter. Take the whole STORE_SIP and search for non system parameter.
701
     *
702
703
704
     * @return array
     * @throws UserFormException
     * @throws \qfq\CodeException
705
     */
706
    public static function getNonSystemSipParam() {
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
        $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;
727
    }
728

729
730
731
732
    /**
     * Returns a complete $store.
     *
     * @param $store
Carsten  Rose's avatar
Carsten Rose committed
733
     *
734
735
736
737
738
     * @return array
     * @throws UserFormException
     * @throws \qfq\CodeException
     */
    public static function getStore($store) {
Carsten  Rose's avatar
Carsten Rose committed
739
740
        $vars = array();

741
        // Check valid Storename
Carsten  Rose's avatar
Carsten Rose committed
742
        if (!isset(self::$sanitizeStore[$store])) {
743
            throw new UserFormException("Unknown Store: $store", ERROR_UNNOWN_STORE);
Carsten  Rose's avatar
Carsten Rose committed
744
        }
745

Carsten  Rose's avatar
Carsten Rose committed
746
        if ($store === STORE_ZERO) {
747
            throw new CodeException("getStore() for STORE_ZERO is impossible - there are no values saved.", ERROR_GET_STORE_ZERO);
Carsten  Rose's avatar
Carsten Rose committed
748
        }
749
750

        if (isset(self::$raw[$store])) {
Carsten  Rose's avatar
Carsten Rose committed
751
752
753
754
            $vars = self::$raw[$store];
            if ($store == STORE_SIP) {
                $vars = self::checkDecodeBase64Arr($vars);
            }
755
756
        }

Carsten  Rose's avatar
Carsten Rose committed
757
758
759
760
761
762
763
764
        return $vars;
    }

    /**
     * Iterate over an array and look for keynames starting with SIP_PREFIX_BASE64.
     * Found elements will be base64_decode().
     *
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
765
     *
Carsten  Rose's avatar
Carsten Rose committed
766
767
768
769
770
771
772
773
774
775
776
     * @return array - incl. decoded base64 vars.
     */
    private static function checkDecodeBase64Arr(array $vars) {

        $len = strlen(SIP_PREFIX_BASE64);

        foreach ($vars as $key => $value) {
            if (substr($key, 0, $len) == SIP_PREFIX_BASE64) {
                $vars[$key] = base64_decode($value);
            }
        }
Carsten  Rose's avatar
Carsten Rose committed
777

Carsten  Rose's avatar
Carsten Rose committed
778
        return $vars;
779
780
    }

781
782
783
784
785
786
787
788
789
790
791
792
    /**
     * Returns a pointer to this class.
     *
     * @return null|Sip
     */
    public static function getSipInstance() {
        return self::$sip;
    }

    /**
     * Fills STORE_TABLE_DEFAULT and STORE_TABLE_COLUMN_TYPES
     *
793
     * @param array $tableDefinition
Carsten  Rose's avatar
Carsten Rose committed
794
     *
795
     * @throws CodeException
796
     * @throws UserFormException
797
     */
798
    public static function fillStoreTableDefaultColumnType(array $tableDefinition) {
799
800
801
802
803
804

        self::setStore(array_column($tableDefinition, 'Default', 'Field'), STORE_TABLE_DEFAULT, true);
        self::setStore(array_column($tableDefinition, 'Type', 'Field'), STORE_TABLE_COLUMN_TYPES, true);
    }

    /**
805
806
807
808
     * Saves a subset of STORE_TYPO3 vars as a SIP. The SIP will be transmitted as hidden form element.
     *
     * More docs: CODING.md > 'Faking the STORE_TYPO3 for API calls'
     *
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
     * @throws CodeException
     * @throws UserFormException
     */
    public static function copyT3VarsToSip() {

        $tempArray = self::getStore(STORE_TYPO3);

        foreach ([TYPO3_FE_USER, TYPO3_FE_USER_UID, TYPO3_FE_USER_GROUP, TYPO3_TT_CONTENT_UID, TYPO3_PAGE_ID, TYPO3_PAGE_TYPE, TYPO3_PAGE_LANGUAGE, TYPO3_BE_USER_LOGGED_IN] as $key) {
            if (isset($tempArray[$key])) {
                $t3varsArray[$key] = $tempArray[$key];
            }
        }

        $t3varsArray[TYPO3_BE_USER_LOGGED_IN] = (isset($GLOBALS["TSFE"]->beUserLogin) && $GLOBALS["TSFE"]->beUserLogin === true) ? 'yes' : 'no';

        $t3varsString = KeyValueStringParser::unparse($t3varsArray, '=', '&');
        $t3sip = self::$sip->queryStringToSip($t3varsString, RETURN_SIP);

        return $t3sip;
    }

    /**
831
832
833
     * Get stored STORE_TYPO3 vars from SIP and restore the store.
     *
     * More docs: CODING.md > 'Faking the STORE_TYPO3 for API calls'
834
835
     *
     * @param string $sipTypo3Vars
836
837
     * @throws CodeException
     * @throws UserFormException
838
     * @throws UserReportException
839
     */
Carsten  Rose's avatar
Carsten Rose committed
840
    public static function fillTypo3StoreFromSip($sipTypo3Vars) {
841
842
843
844
845
846
847
848
849
850
        $t3vars = self::getStore(STORE_TYPO3);

        // Do nothing if STORE_TYPO3 is already filled
        if (isset($t3vars[TYPO3_TT_CONTENT_UID]) && $t3vars[TYPO3_TT_CONTENT_UID] != '0') {
            return;
        }

        $typo3VarsArray = self::$sip->getVarsFromSip($sipTypo3Vars);

        self::setStore($typo3VarsArray, STORE_TYPO3, true);
Carsten  Rose's avatar
Carsten Rose committed
851

852
        $value = self::getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM);
853
854
        $flag = isset($typo3VarsArray[TYPO3_BE_USER_LOGGED_IN]) && ($typo3VarsArray[TYPO3_BE_USER_LOGGED_IN] == 'yes');
        $value = self::adjustConfigShowDebugInfo($value, $flag);
855
        self::setVar(SYSTEM_SHOW_DEBUG_INFO, $value, STORE_SYSTEM);
856
    }
857

858
859
860
861
862
863
    /**
     * Load $recordId from $tableName using $db and saves it in $store.
     *
     * @param $tableName
     * @param $recordId
     * @param $db
864
     * @param $primaryKey
865
866
867
868
     * @param string $store
     * @throws CodeException
     * @throws UserFormException
     */
869
870
    public static function fillStoreWithRecord($tableName, $recordId, $db,
                                               $primaryKey = F_PRIMARY_KEY_DEFAULT, $store = STORE_RECORD) {
871
872
        if ($recordId !== false && $recordId > 0 &&
            is_string($tableName) && $tableName !== '') {