Store.php: Added SIP Store. Rearranged code.

qfq/store/Store.php

@@ -11,10 +11,10 @@ namespace qfq\store;
 use qfq\exceptions\CodeException;
 use qfq;
 
-
 require_once(__DIR__ . '/../../qfq/helper/KeyValueStringParser.php');
 require_once(__DIR__ . '/../../qfq/helper/Sanatize.php');
 require_once(__DIR__ . '/../../qfq/Constants.php');
+require_once(__DIR__ . '/../../qfq/store/Sip.php');
 
 
 /*
@@ -30,51 +30,61 @@ class Store {
 
     private static $instance = null;
 
+    private static $sip = null;
+
     private static $raw = array();
     private static $cache = array();
     private static $defaultSanatizeClass = array();
 
     /**
-     * Design Pattern: Singleton - class 'store' should only be instanced once.
+     * @param string $bodytext
      */
     private function __construct($bodytext = '') {
 
         self::$defaultSanatizeClass = [
-            T3_BODYTEXT_DEBUG_LOAD => SANATIZE_DIGIT,
-            T3_BODYTEXT_DEBUG_SAVE => SANATIZE_DIGIT,
-
-            CLIENT_SIP => SANATIZE_DIGIT,
-            CLIENT_GET_SIP => SANATIZE_DIGIT,
-            CLIENT_POST_SIP => SANATIZE_DIGIT,
-            CLIENT_RECORD_ID => SANATIZE_DIGIT,
-            CLIENT_KEY_SEM_ID => SANATIZE_DIGIT,
-            CLIENT_KEY_SEM_ID_USER => SANATIZE_DIGIT,
-            CLIENT_PAGE_ID => SANATIZE_DIGIT,
-            CLIENT_PAGE_TYPE => SANATIZE_DIGIT,
-            CLIENT_PAGE_LANGUAGE => SANATIZE_DIGIT,
-            CLIENT_FORM => SANATIZE_ALNUMX,
-
-            SYSTEM_DBUSER => SANATIZE_ALNUMX,
-            SYSTEM_DBSERVER => SANATIZE_ALNUMX,
-            SYSTEM_DBPW => SANATIZE_ALL,
-            SYSTEM_DB => SANATIZE_ALNUMX,
-            SYSTEM_TESTDB => SANATIZE_ALNUMX,
-            SYSTEM_SESSIONNAME => SANATIZE_ALNUMX,
-            SYSTEM_DBH => SANATIZE_ALL,
+            T3_BODYTEXT_DEBUG_LOAD => SANATIZE_ALLOW_DIGIT,
+            T3_BODYTEXT_DEBUG_SAVE => SANATIZE_ALLOW_DIGIT,
+            T3_BODYTEXT_FORM => SANATIZE_ALLOW_ALNUMX,
+
+            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,
+
+            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_FORM_DEF => SANATIZE_ALL,
 //            SYSTEM_FORM_ELEMENT_DEF => SANATIZE_ALL,
 //            SYSTEM_FORM_ELEMENT_FIELD => SANATIZE_ALL,
-            SYSTEM_SQL_RAW => SANATIZE_ALL,
-            SYSTEM_SQL_FINAL => SANATIZE_ALL,
-            SYSTEM_SQL_COUNT => SANATIZE_DIGIT,
-            SYSTEM_SQL_PARAM_ARRAY => SANATIZE_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
 
         ];
 
         self::fillSystemStore();
         self::fillStoreT3Bodytext($bodytext);
         self::fillStoreClient();
+        self::fillStoreSip();
+
     }
 
     /**
@@ -109,9 +119,9 @@ class Store {
      * @throws CodeException
      */
     private function fillStoreT3Bodytext($bodytext) {
-        $keyValue = new \qfq\helper\KeyValueStringParser("=", "\n");
+        $parser = new \qfq\helper\KeyValueStringParser("=", "\n");
 
-        self::setVarArray($keyValue->parse($bodytext), STORE_T3_BODYTEXT);
+        self::setVarArray($parser->parse($bodytext), STORE_T3_BODYTEXT);
     }
 
     /**
@@ -128,10 +138,16 @@ class Store {
         # SIP: if POST exist, this means 'form save'. To distinguish load and save, store both.
         if (isset($_GET[CLIENT_SIP]))
             self::setVar(CLIENT_GET_SIP, $_GET[CLIENT_SIP], STORE_CLIENT);
+
         if (isset($_POST[CLIENT_SIP]))
             self::setVar(CLIENT_POST_SIP, $_GET[CLIENT_SIP], STORE_CLIENT);
     }
 
+
+    /*
+     *
+     */
+
     /**
      * @param $key
      * @param $value
@@ -146,24 +162,19 @@ class Store {
 
     }
 
-    /**
-     *
-     * @return Store
-     */
-    public static function getInstance($bodytext = '', $phpunit = false) {
+    private function fillStoreSip() {
 
-        if ($phpunit) {
-            if (self::$instance === null) {
-                unset(self::$instance);
-                self::$instance = null;
-            }
-        }
+        $sessionName = self::getVar(SYSTEM_SESSIONNAME, STORE_SYSTEM);
+        self::$sip = new \qfq\store\Sip($sessionName);
 
-        // Design Pattern: Singleton
-        if (self::$instance === null) {
-            self::$instance = new Store($bodytext);
+        $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);
         }
-        return self::$instance;
     }
 
     /**
@@ -176,7 +187,7 @@ class Store {
      * @param string $sanatizeClass
      * @return string a) if found: value, b) false
      */
-    public function getVar($key, $useStores = USE_STORE_DEFAULT, $sanatizeClass = '') {
+    public static function getVar($key, $useStores = USE_STORE_DEFAULT, $sanatizeClass = '') {
 
         // no store specifed?
         if ($useStores === "") {
@@ -217,9 +228,59 @@ class Store {
 
         }
         return false;
+    }
 
+    /**
+     * @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;
     }
 
+    /**
+     * @param $formName
+     * @throws CodeException
+     */
+    public static function createFakeSipAfterFormLoad($formName) {
+        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_T3_BODYTEXT . STORE_CLIENT);
+        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;
+    }
 }
 
 

tests/phpunit/StoreTest.php

@@ -23,11 +23,12 @@ class StoreTest extends \PHPUnit_Framework_TestCase {
      * @var Store
      */
     private $store = null;
+    private $setUpDone = false;
 
     public function setUp() {
         // Client Variables has to setup before the first instantiation of 'Store' 
         $_GET[CLIENT_RECORD_ID] = '1234';
-        $_GET[CLIENT_SIP] = '1234abcd';
+//        $_GET[CLIENT_SIP] = '12badcaffee34';
         $_GET['key01'] = '1234';
         $_POST['key02'] = '2345';
         $_POST['key03'] = '3456';
@@ -35,13 +36,13 @@ class StoreTest extends \PHPUnit_Framework_TestCase {
         $_GET['key04'] = '4567';
         $_POST['key04'] = '5678';
 
-        $this->store = Store::getInstance("\n; some comment\n" . T3_BODYTEXT_FORM . "=testformnameDoNotChange\n" . T3_BODYTEXT_DEBUG_SAVE . "=6\n" . T3_BODYTEXT_DEBUG_LOAD . "=7\n");
+        $this->store = Store::getInstance("\n; some comment\n" . T3_BODYTEXT_FORM . "=testformnameDoNotChange\n" . T3_BODYTEXT_DEBUG_SAVE . "=6\n" . T3_BODYTEXT_DEBUG_LOAD . "=7\n", true);
 
     }
 
     public function testGetInstance() {
-        $a = Store::getInstance();
-        $b = Store::getInstance();
+        $a = Store::getInstance('', true);
+        $b = Store::getInstance('', true);
 
         $this->assertFalse($a === null, "There should be a class");
 
@@ -88,7 +89,7 @@ class StoreTest extends \PHPUnit_Framework_TestCase {
 //TODO: CR: phpunit running _all_ tests, fails with this tests always. Found no way to debug the situation.
 return;
         # Violates SANATIZE class: sanatized string is always an empty string.
-        # Access are cached: 
+        # Access are cached:
 
         # Test: Retrieve a variable, default sanatize class
         $this->assertEquals('1234', $this->store->getVar(CLIENT_RECORD_ID, STORE_CLIENT), "FormName: default sanatize class");
@@ -115,7 +116,7 @@ return;
         $this->assertFalse($this->store->getVar('keyUnknown2', STORE_CLIENT), "Param: unknown from cache");
 
         // Test overwrite default sanatize class
-        $this->assertEquals('', $this->store->getVar(CLIENT_FORM, STORE_CLIENT, SANATIZE_DIGIT), "Param: overwrite default sanatize class");
+        $this->assertEquals('', $this->store->getVar(CLIENT_FORM, STORE_CLIENT, SANATIZE_ALLOW_DIGIT), "Param: overwrite default sanatize class");
 
         // Test: POST higher priority than GET
         $this->assertEquals('5678', $this->store->getVar('key04', STORE_CLIENT), "Param: POST higher priority than GET");