Store.php 10 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

14
15
require_once(__DIR__ . '/../../qfq/helper/KeyValueStringParser.php');
require_once(__DIR__ . '/../../qfq/helper/Sanatize.php');
16
require_once(__DIR__ . '/../../qfq/Constants.php');
17
require_once(__DIR__ . '/../../qfq/store/Sip.php');
18
require_once(__DIR__ . '/../../qfq/Database.php');
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


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

class Store {

    private static $instance = null;

34
35
    private static $sip = null;

36
    private static $raw = array();
37
38
    private static $sanatizeClass = array();
    private static $sanatizeStore = array();
39
40

    /**
41
     * @param string $bodytext
42
     */
43
44
    private function __construct($bodytext = '') {

45
46
47
48
49
50
51
        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,
52
53
54
55
56
57
58
59
60
61
62
63

            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,

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
            // 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,

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
//            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
97

98
99
        ];

100
101
102
103
104
105
106
107
108
109
110
111
        self::$sanatizeStore = [
            STORE_FORM => true,
            STORE_SIP => false,
            STORE_RECORD => false,
            STORE_PARENT_RECORD => false,
            STORE_TABLE_DEFINITION => false,
            STORE_CLIENT => true,
            STORE_TYPO3 => false,
            STORE_ZERO => false,
            STORE_SYSTEM => false
        ];

112
        self::fillSystemStore();
113
        self::fillStoreTypo3($bodytext);
114
        self::fillStoreClient();
115
        self::fillStoreSip();
116
    }
117

118
119
120
121
122
    /**
     * @throws CodeException
     * @throws qfq\exceptions\UserException
     */
    private function fillSystemStore() {
123
124
        try {
            $config = parse_ini_file(QFQ_INI, false);
125
        } catch (\Exception $e) {
126
127
            throw new qfq\exceptions\UserException ("Error read file " . QFQ_INI . ": " . $e->getMessage(), ERROR_READ_FILE);
        }
128
        self::setVarArray($config, STORE_SYSTEM);
129
130
    }

131
132
133
134
135
    /**
     * @param array $dataArray
     * @param $store
     * @throws CodeException
     */
136
137
    public function setVarArray(array $dataArray, $store) {

138
139
140
        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);
        }
141

142
143
        self::$raw[$store] = $dataArray;
    }
144

145
146
147
148
    /**
     * @param $bodytext
     * @throws CodeException
     */
149
150
    private function fillStoreTypo3($bodytext) {

151
        $parser = new \qfq\helper\KeyValueStringParser("=", "\n");
152
153
154
155
156
157
158
159
160
161
        $arr = $parser->parse($bodytext);

        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"];
162

163
        self::setVarArray($arr, STORE_TYPO3);
164
    }
165

166
167
168
169
    /*
     *
     */

170
171
172
173
    /**
     * @throws CodeException
     */
    private function fillStoreClient() {
174
175
        // copy GET and POST and SERVER Parameter. Priority: SERVER, POST, GET
        $arr = array_merge($_GET, $_POST, $_SERVER);
176
177
178

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

181
        if (isset($_POST[CLIENT_SIP]))
182
            $arr[CLIENT_POST_SIP] = $_POST[CLIENT_SIP];
183

184
185
        self::setVarArray($arr, STORE_CLIENT);
    }
186
187

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

189
190
        $sessionName = self::getVar(SYSTEM_SESSIONNAME, STORE_SYSTEM);
        self::$sip = new \qfq\store\Sip($sessionName);
191

192
193
194
195
196
197
198
        $s = self::getVar(CLIENT_SIP, STORE_CLIENT);
        if ($s !== false) {
            // if session is given, copy values to store
            $param = self::$sip->getVarsFromSip($s);

            $parser = new \qfq\helper\KeyValueStringParser("=", "&");
            self::setVarArray($parser->parse($param), STORE_SIP);
199
200
201
        }
    }

202
    /**
203
     * Cycles through all stores in $useStore.
204
     * First match will return the found value.
205
     * During cycling: fill cache with requestet value and sanatize raw value.
206
     *
207
     * @param string $key
208
     * @param string $useStores f.e.: 'FSRD'
209
210
211
     * @param string $sanatizeClass
     * @return string a) if found: value, b) false
     */
212
    public static function getVar($key, $useStores = USE_STORE_DEFAULT, $sanatizeClass = '') {
213
214

        // no store specifed?
215
216
        if ($useStores === "" || $useStores === null) {
            $useStores = USE_STORE_DEFAULT;
217
218
        }

219
220
221
222
223
        // no sanatizeClass specified: take last/default
        if ($sanatizeClass === '') {
            $sanatizeClass = isset(self::$sanatizeClass[$key]) ? self::$sanatizeClass[$key] : SANATIZE_DEFAULT;
        }

224
225
226
227
228
        while ($useStores !== false) {

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

229
230
            if (!isset(self::$raw[$store][$key])) {
                continue; // no value provided
231
232
            }

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

235
236
237
238
            if (self::$sanatizeStore[$store] && $sanatizeClass != '') {
                return \qfq\Sanatize::sanatize($rawVal, $sanatizeClass);
            } else {
                return $rawVal;
239
            }
240
        }
241

242
        return false;
243
    }
244

245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    /**
     * @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;
265
    }
266

267
268
269
270
    /**
     * @param $formName
     * @throws CodeException
     */
271
272
    public static function createSipAfterFormLoad($formName) {
        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_TYPO3 . STORE_CLIENT);
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
        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;
    }
296
297
298
299
300
301
302
303
304
305

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

        self::$raw[$store][$key] = $value;
306
307
308
309
310
311
312
    }

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

314
        return self::$raw[$store];
315
    }
316
317
318
319
320
321
322
323
324
325
326
327
328

    /**
     * @param $tableName
     * @throws CodeException
     */
    public function fillStoreTableDefinition($tableName) {
        $db = new qfq\Database();

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

        self::setVarArray(array_column($tableDefinition, 'Default', 'Field'), STORE_TABLE_DEFINITION);
    }

329
330
331
332
333
}