X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=a3774fc4be4361bccfe3c709fefb6bde8054d959;hp=34b0a22e6a716924f51b6e622b18345175f1e499;hb=c77663981dbaefb7d8ff039967509aa1204ee556;hpb=95673c6dbd12d46bed603a2724437ed863e3215b diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index 34b0a22e..a3774fc4 100644 --- a/inc/classes/main/class_BaseFrameworkSystem.php +++ b/inc/classes/main/class_BaseFrameworkSystem.php @@ -3,11 +3,11 @@ * The simulator system class is the super class of all other classes. This * class handles saving of games etc. * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -23,6 +23,11 @@ * along with this program. If not, see . */ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { + /** + * Length of output from hash() + */ + private static $hashLength = NULL; + /** * The real class name */ @@ -111,7 +116,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Instance of the stacker */ - private $stackerInstance = NULL; + private $stackInstance = NULL; /** * A Compressor instance @@ -124,7 +129,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $parserInstance = NULL; /** - * A ProtocolHandler instance + * A HandleableProtocol instance */ private $protocolInstance = NULL; @@ -144,12 +149,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $sourceInstance = NULL; /** - * An instance of a InputStreamable class + * An instance of a InputStream class */ private $inputStreamInstance = NULL; /** - * An instance of a OutputStreamable class + * An instance of a OutputStream class */ private $outputStreamInstance = NULL; @@ -173,6 +178,36 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ private $wrapperInstance = NULL; + /** + * An instance of a file I/O pointer class (not handler) + */ + private $pointerInstance = NULL; + + /** + * An instance of an Indexable class + */ + private $indexInstance = NULL; + + /** + * An instance of a Block class + */ + private $blockInstance = NULL; + + /** + * A Minable instance + */ + private $minableInstance = NULL; + + /** + * A FrameworkDirectory instance + */ + private $directoryInstance = NULL; + + /** + * Listener instance + */ + private $listenerInstance = NULL; + /** * Thousands separator */ @@ -249,6 +284,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c; const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d; const EXCEPTION_UNSPPORTED_OPERATION = 0x02e; + const EXCEPTION_FACTORY_REQUIRE_PARAMETER = 0x02f; const EXCEPTION_MISSING_ELEMENT = 0x030; const EXCEPTION_HEADERS_ALREADY_SENT = 0x031; const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032; @@ -259,7 +295,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { const EXCEPTION_ASSERTION_FAILED = 0x037; const EXCEPTION_FILE_CANNOT_BE_READ = 0x038; const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039; - const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040; + const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03a; /** * Hexadecimal->Decimal translation array @@ -326,10 +362,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->setConfigInstance(FrameworkConfiguration::getSelfInstance()); } // END - if - // Is the startup time set? (0 cannot be true anymore) + // Is the startup time set? (0 cannot be TRUE anymore) if (self::$startupTime == 0) { // Then set it - self::$startupTime = microtime(true); + self::$startupTime = microtime(TRUE); } // END - if } @@ -355,6 +391,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } else { // Do not call this twice trigger_error(__METHOD__ . ': Called twice.'); + exit; } } @@ -404,11 +441,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // .. or size if array $argsString .= ', ' . count($arg); } elseif ($arg === TRUE) { - // ... is boolean 'true' - $argsString .= ', true'; + // ... is boolean 'TRUE' + $argsString .= ', TRUE'; } elseif ($arg === FALSE) { - // ... is boolean 'true' - $argsString .= ', false'; + // ... is boolean 'FALSE' + $argsString .= ', FALSE'; } // Closing bracket @@ -455,7 +492,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s', $name, gettype($value), - $value + print_r($value, TRUE) )); } @@ -931,20 +968,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Setter for stacker instance * - * @param $stackerInstance An instance of an stacker + * @param $stackInstance An instance of an stacker * @return void */ - public final function setStackerInstance (Stackable $stackerInstance) { - $this->stackerInstance = $stackerInstance; + public final function setStackInstance (Stackable $stackInstance) { + $this->stackInstance = $stackInstance; } /** * Getter for stacker instance * - * @return $stackerInstance An instance of an stacker + * @return $stackInstance An instance of an stacker */ - public final function getStackerInstance () { - return $this->stackerInstance; + public final function getStackInstance () { + return $this->stackInstance; } /** @@ -986,19 +1023,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Setter for ProtocolHandler instance + * Setter for HandleableProtocol instance * - * @param $protocolInstance An instance of an ProtocolHandler + * @param $protocolInstance An instance of an HandleableProtocol * @return void */ - public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) { + public final function setProtocolInstance (HandleableProtocol $protocolInstance = NULL) { $this->protocolInstance = $protocolInstance; } /** - * Getter for ProtocolHandler instance + * Getter for HandleableProtocol instance * - * @return $protocolInstance An instance of an ProtocolHandler + * @return $protocolInstance An instance of an HandleableProtocol */ public final function getProtocolInstance () { return $this->protocolInstance; @@ -1083,40 +1120,40 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Getter for a InputStreamable instance + * Getter for a InputStream instance * - * @param $inputStreamInstance The InputStreamable instance + * @param $inputStreamInstance The InputStream instance */ protected final function getInputStreamInstance () { return $this->inputStreamInstance; } /** - * Setter for a InputStreamable instance + * Setter for a InputStream instance * - * @param $inputStreamInstance The InputStreamable instance + * @param $inputStreamInstance The InputStream instance * @return void */ - protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) { + protected final function setInputStreamInstance (InputStream $inputStreamInstance) { $this->inputStreamInstance = $inputStreamInstance; } /** - * Getter for a OutputStreamable instance + * Getter for a OutputStream instance * - * @param $outputStreamInstance The OutputStreamable instance + * @param $outputStreamInstance The OutputStream instance */ protected final function getOutputStreamInstance () { return $this->outputStreamInstance; } /** - * Setter for a OutputStreamable instance + * Setter for a OutputStream instance * - * @param $outputStreamInstance The OutputStreamable instance + * @param $outputStreamInstance The OutputStream instance * @return void */ - protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) { + protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) { $this->outputStreamInstance = $outputStreamInstance; } @@ -1216,6 +1253,120 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $this->iteratorInstance; } + /** + * Setter for InputOutputPointer instance + * + * @param $pointerInstance An instance of an InputOutputPointer class + * @return void + */ + protected final function setPointerInstance (InputOutputPointer $pointerInstance) { + $this->pointerInstance = $pointerInstance; + } + + /** + * Getter for InputOutputPointer instance + * + * @return $pointerInstance An instance of an InputOutputPointer class + */ + public final function getPointerInstance () { + return $this->pointerInstance; + } + + /** + * Setter for Indexable instance + * + * @param $indexInstance An instance of an Indexable class + * @return void + */ + protected final function setIndexInstance (Indexable $indexInstance) { + $this->indexInstance = $indexInstance; + } + + /** + * Getter for Indexable instance + * + * @return $indexInstance An instance of an Indexable class + */ + public final function getIndexInstance () { + return $this->indexInstance; + } + + /** + * Setter for Block instance + * + * @param $blockInstance An instance of an Block class + * @return void + */ + protected final function setBlockInstance (Block $blockInstance) { + $this->blockInstance = $blockInstance; + } + + /** + * Getter for Block instance + * + * @return $blockInstance An instance of an Block class + */ + public final function getBlockInstance () { + return $this->blockInstance; + } + + /** + * Setter for Minable instance + * + * @param $minableInstance A Minable instance + * @return void + */ + protected final function setMinableInstance (Minable $minableInstance) { + $this->minableInstance = $minableInstance; + } + + /** + * Getter for minable instance + * + * @return $minableInstance A Minable instance + */ + protected final function getMinableInstance () { + return $this->minableInstance; + } + + /** + * Setter for FrameworkDirectory instance + * + * @param $directoryInstance A FrameworkDirectoryPointer instance + * @return void + */ + protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) { + $this->directoryInstance = $directoryInstance; + } + + /** + * Getter for FrameworkDirectory instance + * + * @return $directoryInstance A FrameworkDirectory instance + */ + protected final function getDirectoryInstance () { + return $this->directoryInstance; + } + + /** + * Setter for listener instance + * + * @param $listenerInstance A Listenable instance + * @return void + */ + protected final function setListenerInstance (Listenable $listenerInstance) { + $this->listenerInstance = $listenerInstance; + } + + /** + * Getter for listener instance + * + * @return $listenerInstance A Listenable instance + */ + protected final function getListenerInstance () { + return $this->listenerInstance; + } + /** * Checks whether an object equals this object. You should overwrite this * method to implement own equality checks @@ -1344,7 +1495,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $content .= sprintf('
%s
', trim( htmlentities( - print_r($this, true) + print_r($this, TRUE) ) ) ); @@ -1410,6 +1561,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } else { // Trigger an error trigger_error($stubMessage); + exit; } } @@ -1417,7 +1569,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * Outputs a debug backtrace and stops further script execution * * @param $message An optional message to output - * @param $doExit Whether exit the program (true is default) + * @param $doExit Whether exit the program (TRUE is default) * @return void */ public function debugBackTrace ($message = '', $doExit = TRUE) { @@ -1444,20 +1596,29 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return $debugInstance An instance of a debugger class */ public final static function createDebugInstance ($className) { - // Init debug instance - $debugInstance = NULL; + // Is the instance set? + if (!Registry::getRegistry()->instanceExists('debug')) { + // Init debug instance + $debugInstance = NULL; + + // Try it + try { + // Get a debugger instance + $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class')); + } catch (NullPointerException $e) { + // Didn't work, no instance there + exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage()); + } - // Try it - try { - // Get a debugger instance - $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class')); - } catch (NullPointerException $e) { - // Didn't work, no instance there - exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage()); - } + // Empty string should be ignored and used for testing the middleware + DebugMiddleware::getSelfInstance()->output(''); - // Empty string should be ignored and used for testing the middleware - DebugMiddleware::getSelfInstance()->output(''); + // Set it in its own class. This will set it in the registry + $debugInstance->setDebugInstance($debugInstance); + } else { + // Get instance from registry + $debugInstance = Registry::getRegistry()->getDebugInstance(); + } // Return it return $debugInstance; @@ -1481,7 +1642,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * * @param $message Message we shall send out... * @param $doPrint Whether print or die here (default: print) - * @paran $stripTags Whether to strip tags (default: false) + * @paran $stripTags Whether to strip tags (default: FALSE) * @return void */ public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) { @@ -1718,7 +1879,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Get current array $fieldArray = $resultInstance->current(); - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, true).'
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, TRUE).'
'); // Convert dashes to underscore $fieldName = $this->convertDashesToUnderscores($fieldName); @@ -1729,7 +1890,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $fieldValue = $fieldArray[$fieldName]; } else { // Missing field entry, may require debugging - self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ':fieldname=' . $fieldName . ' not found!'); + self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!'); } // Return it @@ -1775,6 +1936,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } else { // Trigger an error trigger_error($message . "
\n"); + exit; } } else { // @TODO Finish this part! @@ -1804,7 +1966,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function getMilliTime () { // Get the time of day as float - $milliTime = gettimeofday(true); + $milliTime = gettimeofday(TRUE); // Return it return $milliTime; @@ -1983,7 +2145,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function isBase64Encoded ($encodedData) { // Determine it - $isBase64 = (@base64_decode($encodedData, true) !== FALSE); + $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE); // Return it return $isBase64; @@ -2017,7 +2179,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) { // Generate it - $cacheKey = sprintf("%s@%s", + $cacheKey = sprintf('%s@%s', $this->__toString(), $criteriaInstance->getCacheKey($onlyKeys) ); @@ -2043,7 +2205,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function getPrintableExecutionTime () { // Caculate the execution time - $executionTime = microtime(true) - $this->getStartupTime(); + $executionTime = microtime(TRUE) - $this->getStartupTime(); // Pack it in nice braces $executionTime = sprintf('[ %01.5f ] ', $executionTime); @@ -2053,19 +2215,37 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Hashes a given string with a simple but stronger hash function (no salts) + * Hashes a given string with a simple but stronger hash function (no salt) + * and hex-encode it. * * @param $str The string to be hashed * @return $hash The hash from string $str */ - public function hashString ($str) { + public static final function hash ($str) { // Hash given string with (better secure) hasher - $hash = mhash(MHASH_SHA256, $str); + $hash = bin2hex(mhash(MHASH_SHA256, $str)); // Return it return $hash; } + /** + * "Getter" for length of hash() output. This will be "cached" to speed up + * things. + * + * @return $length Length of hash() output + */ + public static final function getHashLength () { + // Is it cashed? + if (is_null(self::$hashLength)) { + // No, then hash a string and save its length. + self::$hashLength = strlen(self::hash('abc123')); + } // END - if + + // Return it + return self::$hashLength; + } + /** * Checks whether the given number is really a number (only chars 0-9). * @@ -2198,6 +2378,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { // No, then abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + exit; } // END - if // Debug message @@ -2304,6 +2485,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) { // Already initialized trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.'); + exit; } // END - if // Initialize it @@ -2327,6 +2509,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) { // Already initialized trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.'); + exit; } // END - if // Initialize it @@ -2351,6 +2534,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) { // Already initialized trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.'); + exit; } // END - if // Initialize it @@ -2430,6 +2614,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { // Not found trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.'); + exit; } // END - if // Then "pop" it @@ -2457,6 +2642,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { // Not found trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.'); + exit; } // END - if // Then "shift" it @@ -2482,6 +2668,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!isset($this->genericArray[$keyGroup])) { // Abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.'); + exit; } // END - if // Then count it @@ -2509,6 +2696,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { // Abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + exit; } // END - if // Then count it @@ -2537,9 +2725,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { // Abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + exit; } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) { // Not valid trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.'); + exit; } // Then count it @@ -2566,6 +2756,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!isset($this->genericArray[$keyGroup])) { // Then abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.'); + exit; } // END - if // Return it @@ -2605,6 +2796,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { // Then abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.'); + exit; } // END - if // Return it @@ -2646,6 +2838,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { // Then abort here trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.'); + exit; } // END - if // Return it @@ -2688,6 +2881,23 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Return it return $isValid; } + + /** + * Translates boolean TRUE to 'Y' and FALSE to 'N' + * + * @param $boolean Boolean value + * @return $translated Translated boolean value + */ + public static final function translateBooleanToYesNo ($boolean) { + // Make sure it is really boolean + assert(is_bool($boolean)); + + // "Translate" it + $translated = ($boolean === TRUE) ? 'Y' : 'N'; + + // ... and return it + return $translated; + } } // [EOF]