Store.php 10.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\store;
10
11

use qfq\exceptions\CodeException;
12
use qfq;
13
use \qfq\helper\keyValueStringParser;
14

15
16
require_once(__DIR__ . '/../../qfq/helper/KeyValueStringParser.php');
require_once(__DIR__ . '/../../qfq/helper/Sanatize.php');
17
require_once(__DIR__ . '/../../qfq/Constants.php');
18
require_once(__DIR__ . '/../../qfq/store/Sip.php');
19
require_once(__DIR__ . '/../../qfq/Database.php');
20
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
33
34
/**
 * Class Store
 * @package qfq\store
 */
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;

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

    /**
     * @var array Default sanatize classes.
     */
62
    private static $sanatizeClass = array();
Carsten  Rose's avatar
Carsten Rose committed
63
64
65
66
67
68
69
70

    /**
     * $sanatizeClass['S'] = false
     * $sanatizeClass['C'] = true
     * ...
     *
     * @var array each entry with true/false - depending if store needs to be sanatized.
     */
71
    private static $sanatizeStore = array();
72
73

    /**
74
     * @param string $bodytext
75
     */
76
77
    private function __construct($bodytext = '') {

78
79
80
81
82
83
84
        self::$sanatizeClass = [
//            TYPO3_DEBUG_LOAD => SANATIZE_ALLOW_DIGIT,
//            TYPO3_DEBUG_SAVE => SANATIZE_ALLOW_DIGIT,
//            TYPO3_FORM => SANATIZE_ALLOW_ALNUMX,
//            TYPO3_FE_USER => SANATIZE_ALLOW_ALNUMX,
//            TYPO3_FE_USER_UID => SANATIZE_ALLOW_DIGIT,
//            TYPO3_FE_USER_GROUP => SANATIZE_ALLOW_ALNUMX,
85
86
87
88
89
90
91
92
93
94
95
96

            CLIENT_SIP => SANATIZE_ALLOW_ALNUMX,
            CLIENT_GET_SIP => SANATIZE_ALLOW_DIGIT,
            CLIENT_POST_SIP => SANATIZE_ALLOW_DIGIT,
            CLIENT_RECORD_ID => SANATIZE_ALLOW_DIGIT,
            CLIENT_KEY_SEM_ID => SANATIZE_ALLOW_DIGIT,
            CLIENT_KEY_SEM_ID_USER => SANATIZE_ALLOW_DIGIT,
            CLIENT_PAGE_ID => SANATIZE_ALLOW_DIGIT,
            CLIENT_PAGE_TYPE => SANATIZE_ALLOW_DIGIT,
            CLIENT_PAGE_LANGUAGE => SANATIZE_ALLOW_DIGIT,
            CLIENT_FORM => SANATIZE_ALLOW_ALNUMX,

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
            // Part of $_SERVER. Missing vars must be requested individual with the needed sanatize class.
            CLIENT_SCRIPT_URL => SANATIZE_ALLOW_ALNUMX,
            CLIENT_SCRIPT_URI => SANATIZE_ALLOW_ALNUMX,
            CLIENT_HTTP_HOST => SANATIZE_ALLOW_ALNUMX,
            CLIENT_HTTP_USER_AGENT => SANATIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_NAME => SANATIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_ADDRESS => SANATIZE_ALLOW_ALNUMX,
            CLIENT_SERVER_PORT => SANATIZE_ALLOW_DIGIT,
            CLIENT_REMOTE_ADDRESS => SANATIZE_ALLOW_ALNUMX,
            CLIENT_REQUEST_SCHEME => SANATIZE_ALLOW_ALNUMX,
            CLIENT_SCRIPT_FILENAME => SANATIZE_ALLOW_ALNUMX,
            CLIENT_QUERY_STRING => SANATIZE_ALLOW_ALL,
            CLIENT_REQUEST_URI => SANATIZE_ALLOW_ALL,
            CLIENT_SCRIPT_NAME => SANATIZE_ALLOW_ALNUMX,
            CLIENT_PHP_SELF => SANATIZE_ALLOW_ALNUMX,

113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
//            SYSTEM_DBUSER => SANATIZE_ALLOW_ALNUMX,
//            SYSTEM_DBSERVER => SANATIZE_ALLOW_ALNUMX,
//            SYSTEM_DBPW => SANATIZE_ALLOW_ALL,
//            SYSTEM_DB => SANATIZE_ALLOW_ALNUMX,
//            SYSTEM_TESTDB => SANATIZE_ALLOW_ALNUMX,
//            SYSTEM_SESSIONNAME => SANATIZE_ALLOW_ALNUMX,
//            SYSTEM_DBH => SANATIZE_ALLOW_ALL,

//            SYSTEM_SQL_RAW => SANATIZE_ALLOW_ALL,
//            SYSTEM_SQL_FINAL => SANATIZE_ALLOW_ALL,
//            SYSTEM_SQL_COUNT => SANATIZE_ALLOW_DIGIT,
//            SYSTEM_SQL_PARAM_ARRAY => SANATIZE_ALLOW_ALL,

//            SIP_SIP => SANATIZE_ALLOW_ALNUMX,
//            SIP_RECORD_ID => SANATIZE_ALLOW_DIGIT,
//            SIP_FORM => SANATIZE_ALLOW_ALNUMX,
//            SIP_URLPARAM => SANATIZE_ALLOW_ALL
130

131
132
        ];

133
134
135
136
137
        self::$sanatizeStore = [
            STORE_FORM => true,
            STORE_SIP => false,
            STORE_RECORD => false,
            STORE_PARENT_RECORD => false,
138
139
            STORE_TABLE_DEFAULT => false,
            STORE_TABLE_COLUMN_TYPES => false,
140
141
142
143
144
145
            STORE_CLIENT => true,
            STORE_TYPO3 => false,
            STORE_ZERO => false,
            STORE_SYSTEM => false
        ];

146
        self::fillSystemStore();
147
        self::fillStoreTypo3($bodytext);
148
        self::fillStoreClient();
149
        self::fillStoreSip();
150
    }
151

152
153
154
155
156
    /**
     * @throws CodeException
     * @throws qfq\exceptions\UserException
     */
    private function fillSystemStore() {
157
158
        try {
            $config = parse_ini_file(QFQ_INI, false);
159
        } catch (\Exception $e) {
160
161
            throw new qfq\exceptions\UserException ("Error read file " . QFQ_INI . ": " . $e->getMessage(), ERROR_READ_FILE);
        }
162
        self::setVarArray($config, STORE_SYSTEM);
163
164
    }

165
166
167
168
169
    /**
     * @param array $dataArray
     * @param $store
     * @throws CodeException
     */
170
171
    public function setVarArray(array $dataArray, $store) {

172
173
174
        if (isset(self::$raw[$store]) && count(self::$raw[$store]) > 0) {
            throw new CodeException("Raw values already been copied to store '$store'. Do this only one time.", ERROR_VALUE_ALREADY_CODPIED);
        }
175

176
177
        self::$raw[$store] = $dataArray;
    }
178

179
180
181
182
    /**
     * @param $bodytext
     * @throws CodeException
     */
183
184
    private function fillStoreTypo3($bodytext) {

185
        $arr = KeyValueStringParser::parse($bodytext, "=", "\n");
186
187
188
189
190
191
192
193
194

        if (isset($GLOBALS["TSFE"]->fe_user->user["username"]))
            $arr[TYPO3_FE_USER] = $GLOBALS["TSFE"]->fe_user->user["username"];

        if (isset($GLOBALS["TSFE"]->fe_user->user["uid"]))
            $arr[TYPO3_FE_USER_UID] = $GLOBALS["TSFE"]->fe_user->user["uid"];

        if (isset($GLOBALS["TSFE"]->fe_user->user["usergroup"]))
            $arr[TYPO3_FE_USER_GROUP] = $GLOBALS["TSFE"]->fe_user->user["usergroup"];
195

196
        self::setVarArray($arr, STORE_TYPO3);
197
    }
198

199
200
201
202
    /*
     *
     */

203
204
205
206
    /**
     * @throws CodeException
     */
    private function fillStoreClient() {
207
208
        // copy GET and POST and SERVER Parameter. Priority: SERVER, POST, GET
        $arr = array_merge($_GET, $_POST, $_SERVER);
209
210
211

        # SIP: if POST exist, this means 'form save'. To distinguish load and save, store both.
        if (isset($_GET[CLIENT_SIP]))
212
            $arr[CLIENT_GET_SIP] = $_GET[CLIENT_SIP];
213

214
        if (isset($_POST[CLIENT_SIP]))
215
            $arr[CLIENT_POST_SIP] = $_POST[CLIENT_SIP];
216

217
218
        self::setVarArray($arr, STORE_CLIENT);
    }
219
220

    private function fillStoreSip() {
Carsten  Rose's avatar
Carsten Rose committed
221

222
223
        $sessionName = self::getVar(SYSTEM_SESSIONNAME, STORE_SYSTEM);
        self::$sip = new \qfq\store\Sip($sessionName);
224

225
226
227
228
229
        $s = self::getVar(CLIENT_SIP, STORE_CLIENT);
        if ($s !== false) {
            // if session is given, copy values to store
            $param = self::$sip->getVarsFromSip($s);

230
            self::setVarArray(KeyValueStringParser::parse($param, "=", "&"), STORE_SIP);
231
232
233
        }
    }

234
    /**
235
     * Cycles through all stores in $useStore.
236
     * First match will return the found value.
237
     * During cycling: fill cache with requestet value and sanatize raw value.
238
     *
239
     * @param string $key
240
     * @param string $useStores f.e.: 'FSRD'
241
242
243
     * @param string $sanatizeClass
     * @return string a) if found: value, b) false
     */
244
    public static function getVar($key, $useStores = USE_STORE_DEFAULT, $sanatizeClass = '') {
245
246

        // no store specifed?
247
248
        if ($useStores === "" || $useStores === null) {
            $useStores = USE_STORE_DEFAULT;
249
250
        }

251
252
253
254
255
        // no sanatizeClass specified: take last/default
        if ($sanatizeClass === '') {
            $sanatizeClass = isset(self::$sanatizeClass[$key]) ? self::$sanatizeClass[$key] : SANATIZE_DEFAULT;
        }

256
257
258
259
260
        while ($useStores !== false) {

            $store = substr($useStores, 0, 1); // next store
            $useStores = substr($useStores, 1); // shift left remaining stores

261
262
            if (!isset(self::$raw[$store][$key])) {
                continue; // no value provided
263
264
            }

265
            $rawVal = isset(self::$raw[$store][$key]) ? self::$raw[$store][$key] : null;
266

267
268
269
270
            if (self::$sanatizeStore[$store] && $sanatizeClass != '') {
                return \qfq\Sanatize::sanatize($rawVal, $sanatizeClass);
            } else {
                return $rawVal;
271
            }
272
        }
273

274
        return false;
275
    }
276

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
    /**
     * @param string $bodytext
     * @param bool|false $phpunit
     * @return null|\qfq\store\Store
     */
    public static function getInstance($bodytext = '', $phpunit = false) {

        if ($phpunit) {
            if (self::$instance === null) {
//                unset(self::$instance);
                self::$instance = null;
            }
        }

        // Design Pattern: Singleton
        if (self::$instance === null) {
            self::$instance = new self($bodytext);
        }

        return self::$instance;
297
    }
298

299
300
301
302
    /**
     * @param $formName
     * @throws CodeException
     */
303
304
    public static function createSipAfterFormLoad($formName) {
        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_TYPO3 . STORE_CLIENT);
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
        if ($recordId === false) {
            $recordId = 0;
        }

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

        // Store in SIP Store (cause it's empty until now).
        self::setVarArray($tmpParam, STORE_SIP);

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

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

    /**
     * @return null
     */
    public static function getSip() {
        return self::$sip;
    }
328
329
330
331
332
333
334
335
336
337

    /**
     * @param $key
     * @param $value
     * @param $store
     * @throws CodeException
     */
    public static function setVar($key, $value, $store) {

        self::$raw[$store][$key] = $value;
338
339
340
341
342
343
344
    }

    /**
     * @param $store
     * @return mixed
     */
    public static function getStore($store) {
345

346
        return self::$raw[$store];
347
    }
348
349
350
351
352

    /**
     * @param $tableName
     * @throws CodeException
     */
353
    public function fillStoreTableDefaultColumnType($tableName) {
354
355
356
357
        $db = new qfq\Database();

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

358
359
        self::setVarArray(array_column($tableDefinition, 'Default', 'Field'), STORE_TABLE_DEFAULT);
        self::setVarArray(array_column($tableDefinition, 'Type', 'Field'), STORE_TABLE_COLUMN_TYPES);
360

361
    }
362
363
364
365
366
}