Store.php

<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/1/16
 * Time: 6:51 PM
 */

namespace qfq;

use qfq\CodeException;
use qfq\keyValueStringParser;
use qfq\OnArray;
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');
require_once(__DIR__ . '/../../qfq/Database.php');


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

/**
 * Class Store
 * @package qfq\store
 */
class Store {

    /**
     * @var Store Instance of class Store. There should only be one class 'Store' at a time.
     */
    private static $instance = null;

    /**
     * @var Sip Instance of class SIP
     */
    private static $sip = null;

    /**
     * @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
     */
    private static $raw = array();

    /**
     * @var array Default sanatize classes.
     */
    private static $sanatizeClass = array();

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

    /**
     * @param string $bodytext
     */
    private function __construct($bodytext = '') {

        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,

            CLIENT_SIP => SANATIZE_ALLOW_ALNUMX,
            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,

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

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

        ];

        self::$sanatizeStore = [
            STORE_FORM => true,
            STORE_SIP => false,
            STORE_RECORD => false,
            STORE_PARENT_RECORD => false,
            STORE_TABLE_DEFAULT => false,
            STORE_TABLE_COLUMN_TYPES => false,
            STORE_CLIENT => true,
            STORE_TYPO3 => false,
            STORE_ZERO => false,
            STORE_SYSTEM => false
        ];

        self::fillSystemStore();
        self::fillStoreTypo3($bodytext);
        self::fillStoreClient();
        self::fillStoreSip();
    }

    /**
     * @throws CodeException
     * @throws qfq\UserException
     */
    private function fillSystemStore() {
        try {
            //TODO: Vernuenftige Fehlermeldung falls nicht auf qfq.ini zugegriffen werden kann.
            //TODO: sinnvollen Platz fuer qfq.ini bestimmen. In der Installationsdoku erwaehnen.
            $config = parse_ini_file(__DIR__ . '/../../../' . QFQ_INI, false);
        } catch (\Exception $e) {
            throw new qfq\UserException ("Error read file " . QFQ_INI . ": " . $e->getMessage(), ERROR_READ_FILE);
        }
        self::setVarArray($config, STORE_SYSTEM,true);
    }

    /**
     * @param array $dataArray
     * @param $store
     * @throws CodeException
     */
    public function setVarArray(array $dataArray, $store, $flagOverwrite = false) {
        // Check valid Storename
        if (!isset(self::$sanatizeStore))
            throw new UserException("Unknown Store: $store", ERROR_UNNOWN_STORE);


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

        if ($flagOverwrite && 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);
        }

        self::$raw[$store] = $dataArray;
    }

    /**
     * @param $bodytext
     * @throws CodeException
     */
    private function fillStoreTypo3($bodytext) {

        $arr = KeyValueStringParser::parse($bodytext, "=", "\n");

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

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

    /*
     *
     */

    /**
     * @throws CodeException
     */
    private function fillStoreClient() {
        // copy GET and POST and SERVER Parameter. Priority: SERVER, POST, GET
        $arr = array_merge($_GET, $_POST, $_SERVER);

        self::setVarArray($arr, STORE_CLIENT, true);
    }

    /**
     * @throws CodeException
     * @throws UserException
     */
    private function fillStoreSip() {

        $sessionName = self::getVar(SYSTEM_SESSIONNAME, STORE_SYSTEM);
        self::$sip = new Sip($sessionName);

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

//            self::setVarArray(KeyValueStringParser::parse($param, "=", "&"), STORE_SIP);
            self::setVarArray($param, STORE_SIP, true);
        }
    }

    /**
     * Cycles through all stores in $useStore.
     * First match will return the found value.
     * During cycling: fill cache with requestet value and sanatize raw value.
     *
     * @param string $key
     * @param string $useStores f.e.: 'FSRD'
     * @param string $sanatizeClass
     * @return string a) if found: value, b) false
     */
    public static function getVar($key, $useStores = USE_STORE_DEFAULT, $sanatizeClass = '') {

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

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

        while ($useStores !== false) {

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

            if (!isset(self::$raw[$store][$key])) {
                if ($store === STORE_ZERO) {
                    return 0;
                } else {
                    continue; // no value provided
                }
            }

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

            if (self::$sanatizeStore[$store] && $sanatizeClass != '') {
                return \qfq\Sanatize::sanatize($rawVal, $sanatizeClass);
            } else {
                return $rawVal;
            }
        }

        return false;
    }

    /**
     * @param string $bodytext
     * @param bool|false $phpUnit
     * @return null|\qfq\Store
     */
    public static function getInstance($bodytext = '', $phpUnit = false) {

        if ($phpUnit) {
            if (self::$instance !== null) {

                self::unsetStore(STORE_TYPO3);
                self::fillStoreTypo3($bodytext);

                self::unsetStore(STORE_CLIENT);
                self::fillStoreClient();
            }
        }

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

        return self::$instance;
    }

    /**
     * @param $store
     */
    public static function unsetStore($store) {
        // Check valid Storename
        if (!isset(self::$sanatizeStore))
            throw new UserException("Unknown Store: $store", ERROR_UNNOWN_STORE);

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

        if (isset(self::$raw[$store])) {
            self::$raw[$store] = array();
        }
    }

    /**
     * @param $formName
     * @throws CodeException
     */
    public
    static function createSipAfterFormLoad($formName) {
        $recordId = self::getVar(CLIENT_RECORD_ID, STORE_TYPO3 . STORE_CLIENT);
        if ($recordId === false) {
            $recordId = 0;
        }

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

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

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

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

    }

    /**
     * @return null|Sip
     */
    public static function getSipInstance() {
        return self::$sip;
    }

    /**
     * @param $key
     * @param $value
     * @param $store
     * @param bool|true $overWrite
     * @throws UserException
     */
    public static function setVar($key, $value, $store, $overWrite = true) {
        // Check valid Storename
        if (!isset(self::$sanatizeStore))
            throw new UserException("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])) {
            throw new UserException("Value of '$key' already be set in store '$store'.", ERROR_KEY_EXIST_IN_STORE);
        }

        self::$raw[$store][$key] = $value;
    }

    /**
     * @param $store
     * @return mixed
     */
    public static function getStore($store) {
        // Check valid Storename
        if (!isset(self::$sanatizeStore))
            throw new UserException("Unknown Store: $store", ERROR_UNNOWN_STORE);

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

        if (isset(self::$raw[$store])) {
            return self::$raw[$store];
        }
        return array();
    }


    /**
     * Fills STORE_TABLE_DEFAULT and STORE_TABLE_COLUMN_TYPES
     *
     * @param $tableName
     * @throws CodeException
     */
    public function fillStoreTableDefaultColumnType($tableName) {
        $db = new qfq\Database();

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

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