X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=4205170200d1e544d6e3dfe34aa55a21350f6222;hp=585e93771f29ec9d3c4ae7ce2054cd180f0a42eb;hb=3cbaa685d35683473f2a13107999108344df2aa7;hpb=607a11e2c22949ea0647568c17d62a605595e83b diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index 585e9377..42051702 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 - 2015 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; @@ -139,17 +144,22 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $helperInstance = NULL; /** - * An instance of a Sourceable class + * An instance of a Source class */ private $sourceInstance = NULL; /** - * An instance of a InputStreamable class + * An instance of a UrlSource class + */ + private $urlSourceInstance = NULL; + + /** + * An instance of a InputStream class */ private $inputStreamInstance = NULL; /** - * An instance of a OutputStreamable class + * An instance of a OutputStream class */ private $outputStreamInstance = NULL; @@ -163,11 +173,56 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ private $visitorInstance = NULL; + /** + * DHT instance + */ + private $dhtInstance = NULL; + /** * An instance of a database wrapper class */ 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; + + /** + * An instance of a communicator + */ + private $communicatorInstance = NULL; + + /** + * State instance + */ + private $stateInstance = NULL; + /** * Thousands separator */ @@ -181,13 +236,66 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Socket resource */ - private $socketResource = false; + private $socketResource = FALSE; + + /** + * Regular expression to use for validation + */ + private $regularExpression = ''; /** * Package data */ private $packageData = array(); + /** + * Generic array + */ + private $genericArray = array(); + + /** + * Command name + */ + private $commandName = ''; + + /** + * Controller name + */ + private $controllerName = ''; + + /** + * Name of used protocol + */ + private $protocolName = 'invalid'; + + /** + * Array with bitmasks and such for pack/unpack methods to support both + * 32-bit and 64-bit systems + */ + private $packingData = array( + 32 => array( + 'step' => 3, + 'left' => 0xffff0000, + 'right' => 0x0000ffff, + 'factor' => 16, + 'format' => 'II', + ), + 64 => array( + 'step' => 7, + 'left' => 0xffffffff00000000, + 'right' => 0x00000000ffffffff, + 'factor' => 32, + 'format' => 'NN' + ) + ); + + /** + * Simple 64-bit check, thanks to "Salman A" from stackoverflow.com: + * + * The integer size is 4 bytes on 32-bit and 8 bytes on a 64-bit system. + */ + private $archArrayElement = FALSE; + /*********************** * Exception codes.... * ***********************/ @@ -239,6 +347,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; @@ -247,9 +356,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { const EXCEPTION_FATAL_ERROR = 0x035; const EXCEPTION_FILE_NOT_FOUND = 0x036; 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_FILE_NOT_REACHABLE = 0x038; + const EXCEPTION_FILE_CANNOT_BE_READ = 0x039; + const EXCEPTION_FILE_CANNOT_BE_WRITTEN = 0x03a; + const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x03b; + const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03c; /** * Hexadecimal->Decimal translation array @@ -316,11 +427,14 @@ 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 + + // Set array element + $this->archArrayElement = (PHP_INT_SIZE === 8 ? 64 : 32); } /** @@ -328,7 +442,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * * @return void */ - public function __destruct() { + public function __destruct () { // Flush any updated entries to the database $this->flushPendingUpdates(); @@ -338,10 +452,14 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->setRealClass('DestructedObject'); } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) { // Already destructed object - $this->debugOutput(sprintf("[%s:] The object %s is already destroyed.", + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object %s is already destroyed.', __CLASS__, $this->__toString() )); + } else { + // Do not call this twice + trigger_error(__METHOD__ . ': Called twice.'); + exit; } } @@ -353,11 +471,27 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function __call ($methodName, $args) { - // Implode all given arguments + return self::__callStatic($methodName, $args); + } + + /** + * The __callStatic() method where all non-implemented static methods end up + * + * @param $methodName Name of the missing method + * @args $args Arguments passed to the method + * @return void + */ + public static final function __callStatic ($methodName, $args) { + // Init argument string $argsString = ''; - if (empty($args)) { + + // Is it NULL, empty or an array? + if (is_null($args)) { // No arguments $argsString = 'NULL'; + } elseif (empty($args)) { + // Empty arguments + $argsString = '(empty)'; } elseif (is_array($args)) { // Some arguments are there foreach ($args as $arg) { @@ -373,16 +507,16 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { if (is_string($arg)) { // Add length for strings - $argsString .= ', '.strlen($arg); + $argsString .= ', ' . strlen($arg); } elseif (is_array($arg)) { // .. or size if array - $argsString .= ', '.count($arg); - } elseif ($arg === true) { - // ... is boolean 'true' - $argsString .= ', true'; - } elseif ($arg === false) { - // ... is boolean 'true' - $argsString .= ', false'; + $argsString .= ', ' . count($arg); + } elseif ($arg === TRUE) { + // ... is boolean 'TRUE' + $argsString .= ', TRUE'; + } elseif ($arg === FALSE) { + // ... is boolean 'FALSE' + $argsString .= ', FALSE'; } // Closing bracket @@ -399,8 +533,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } // Output stub message - $this->debugOutput(sprintf("[%s->%s] Stub! Args: %s", - $this->__toString(), + // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s', $methodName, $argsString )); @@ -419,44 +553,74 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Magic function to catch setting of missing but set class fields/attributes + * Magic method to catch setting of missing but set class fields/attributes * * @param $name Name of the field/attribute * @param $value Value to store * @return void */ public final function __set ($name, $value) { - $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s", + $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s', $name, gettype($value), - $value + print_r($value, TRUE) )); } /** - * Magic function to catch getting of missing fields/attributes + * Magic method to catch getting of missing fields/attributes * * @param $name Name of the field/attribute * @return void */ public final function __get ($name) { - $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s", + $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s', $name )); } /** - * Magic function to catch unsetting of missing fields/attributes + * Magic method to catch unsetting of missing fields/attributes * * @param $name Name of the field/attribute * @return void */ public final function __unset ($name) { - $this->debugBackTrace(sprintf("Tried to unset a missing field. name=%s", + $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s', $name )); } + /** + * Magic method to catch object serialization + * + * @return $unsupported Unsupported method + * @throws UnsupportedOperationException Objects of this framework cannot be serialized + */ + public final function __sleep () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } + + /** + * Magic method to catch object deserialization + * + * @return $unsupported Unsupported method + * @throws UnsupportedOperationException Objects of this framework cannot be serialized + */ + public final function __wakeup () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } + + /** + * Magic method to catch calls when an object instance is called + * + * @return $unsupported Unsupported method + * @throws UnsupportedOperationException Objects of this framework cannot be serialized + */ + public final function __invoke () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } + /** * Setter for the real class name * @@ -765,7 +929,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $fileIoInstance An instance to the file I/O sub-system * @return void */ - public final function setFileIoInstance (FileIoHandler $fileIoInstance) { + public final function setFileIoInstance (IoHandler $fileIoInstance) { $this->fileIoInstance = $fileIoInstance; } @@ -905,20 +1069,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; } /** @@ -960,38 +1124,38 @@ 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) { $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; } /** - * Setter for BaseDatabaseWrapper instance + * Setter for DatabaseWrapper instance * - * @param $wrapperInstance An instance of an BaseDatabaseWrapper + * @param $wrapperInstance An instance of an DatabaseWrapper * @return void */ - public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) { + public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) { $this->wrapperInstance = $wrapperInstance; } /** - * Getter for BaseDatabaseWrapper instance + * Getter for DatabaseWrapper instance * - * @return $wrapperInstance An instance of an BaseDatabaseWrapper + * @return $wrapperInstance An instance of an DatabaseWrapper */ public final function getWrapperInstance () { return $this->wrapperInstance; @@ -1004,6 +1168,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function setSocketResource ($socketResource) { + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource); $this->socketResource = $socketResource; } @@ -1012,10 +1177,32 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * * @return $socketResource A valid socket resource */ - public function getSocketResource () { + public final function getSocketResource () { + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource); return $this->socketResource; } + /** + * Setter for regular expression + * + * @param $regularExpression A valid regular expression + * @return void + */ + public final function setRegularExpression ($regularExpression) { + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression=' . $regularExpression . ',previous[' . gettype($this->regularExpression) . ']=' . $this->regularExpression); + $this->regularExpression = $regularExpression; + } + + /** + * Getter for regular expression + * + * @return $regularExpression A valid regular expression + */ + public final function getRegularExpression () { + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression[' . gettype($this->regularExpression) . ']=' . $this->regularExpression); + return $this->regularExpression; + } + /** * Setter for helper instance * @@ -1036,59 +1223,78 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Setter for a Sourceable instance + * Setter for a Source instance * - * @param $sourceInstance The Sourceable instance + * @param $sourceInstance An instance of a Source class * @return void */ - protected final function setSourceInstance (Sourceable $sourceInstance) { + protected final function setSourceInstance (Source $sourceInstance) { $this->sourceInstance = $sourceInstance; } /** - * Getter for a Sourceable instance + * Getter for a Source instance * - * @return $sourceInstance The Sourceable instance + * @return $sourceInstance An instance of a Source class */ protected final function getSourceInstance () { return $this->sourceInstance; } /** - * Getter for a InputStreamable instance + * Setter for a UrlSource instance + * + * @param $sourceInstance An instance of a UrlSource class + * @return void + */ + protected final function setUrlSourceInstance (UrlSource $urlSourceInstance) { + $this->urlSourceInstance = $urlSourceInstance; + } + + /** + * Getter for a UrlSource instance + * + * @return $urlSourceInstance An instance of a UrlSource class + */ + protected final function getUrlSourceInstance () { + return $this->urlSourceInstance; + } + + /** + * 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; } @@ -1130,6 +1336,25 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $this->visitorInstance; } + /** + * Setter for DHT instance + * + * @param $dhtInstance A Distributable instance + * @return void + */ + protected final function setDhtInstance (Distributable $dhtInstance) { + $this->dhtInstance = $dhtInstance; + } + + /** + * Getter for DHT instance + * + * @return $dhtInstance A Distributable instance + */ + protected final function getDhtInstance () { + return $this->dhtInstance; + } + /** * Setter for raw package Data * @@ -1169,6 +1394,231 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $this->iteratorInstance; } + /** + * Setter for FilePointer instance + * + * @param $pointerInstance An instance of an FilePointer class + * @return void + */ + protected final function setPointerInstance (FilePointer $pointerInstance) { + $this->pointerInstance = $pointerInstance; + } + + /** + * Getter for FilePointer instance + * + * @return $pointerInstance An instance of an FilePointer class + */ + public final function getPointerInstance () { + return $this->pointerInstance; + } + + /** + * Unsets pointer instance which triggers a call of __destruct() if the + * instance is still there. This is surely not fatal on already "closed" + * file pointer instances. + * + * I don't want to mess around with above setter by giving it a default + * value NULL as setter should always explicitly only set (existing) object + * instances and NULL is NULL. + * + * @return void + */ + protected final function unsetPointerInstance () { + // Simply it to NULL + $this->pointerInstance = NULL; + } + + /** + * 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; + } + + /** + * Getter for communicator instance + * + * @return $communicatorInstance An instance of a Communicator class + */ + public final function getCommunicatorInstance () { + return $this->communicatorInstance; + } + + /** + * Setter for communicator instance + * + * @param $communicatorInstance An instance of a Communicator class + * @return void + */ + protected final function setCommunicatorInstance (Communicator $communicatorInstance) { + $this->communicatorInstance = $communicatorInstance; + } + + /** + * Setter for state instance + * + * @param $stateInstance A Stateable instance + * @return void + */ + public final function setStateInstance (Stateable $stateInstance) { + $this->stateInstance = $stateInstance; + } + + /** + * Getter for state instance + * + * @return $stateInstance A Stateable instance + */ + public final function getStateInstance () { + return $this->stateInstance; + } + + /** + * Setter for command name + * + * @param $commandName Last validated command name + * @return void + */ + protected final function setCommandName ($commandName) { + $this->commandName = $commandName; + } + + /** + * Getter for command name + * + * @return $commandName Last validated command name + */ + protected final function getCommandName () { + return $this->commandName; + } + + /** + * Setter for controller name + * + * @param $controllerName Last validated controller name + * @return void + */ + protected final function setControllerName ($controllerName) { + $this->controllerName = $controllerName; + } + + /** + * Getter for controller name + * + * @return $controllerName Last validated controller name + */ + protected final function getControllerName () { + return $this->controllerName; + } + + /** + * Getter for protocol name + * + * @return $protocolName Name of used protocol + */ + public final function getProtocolName () { + return $this->protocolName; + } + + /** + * Setter for protocol name + * + * @param $protocolName Name of used protocol + * @return void + */ + protected final function setProtocolName ($protocolName) { + $this->protocolName = $protocolName; + } + /** * Checks whether an object equals this object. You should overwrite this * method to implement own equality checks @@ -1245,7 +1695,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Prepare the template engine (WebTemplateEngine by default) for a given + * Prepare the template engine (HtmlTemplateEngine by default) for a given * application helper instance (ApplicationHelper by default). * * @param $applicationInstance An application helper instance or @@ -1268,7 +1718,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } // END - if // Initialize the template engine - $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class'); + $templateInstance = ObjectFactory::createObjectByConfiguredName('html_template_class'); // Return the prepared instance return $templateInstance; @@ -1290,20 +1740,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Is a message set? if (!empty($message)) { // Construct message - $content = sprintf("
Message: %s
\n", $message); + $content = sprintf('
Message: %s
' . PHP_EOL, $message); } // END - if // Generate the output - $content .= sprintf("
%s
", + $content .= sprintf('
%s
', trim( htmlentities( - print_r($this, true) + print_r($this, TRUE) ) ) ); // Output it - ApplicationEntryPoint::app_die(sprintf("
%s debug output:
%s
\nLoaded includes:
%s
", + ApplicationEntryPoint::app_exit(sprintf('
%s debug output:
%s
Loaded includes:
%s
', $this->__toString(), $content, ClassLoader::getSelfInstance()->getPrintableIncludeList() @@ -1353,16 +1803,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Is the extra message given? if (!empty($message)) { // Then add it as well - $stubMessage .= sprintf(' Message: %s', $message); + $stubMessage .= ' Message: ' . $message; } // END - if // Debug instance is there? if (!is_null($this->getDebugInstance())) { // Output stub message - $this->debugOutput($stubMessage); + self::createDebugInstance(__CLASS__)->debugOutput($stubMessage); } else { // Trigger an error - trigger_error($stubMessage . '
' . chr(10)); + trigger_error($stubMessage); + exit; } } @@ -1370,10 +1821,10 @@ 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) { + public function debugBackTrace ($message = '', $doExit = TRUE) { // Sorry, there is no other way getting this nice backtrace if (!empty($message)) { // Output message @@ -1385,48 +1836,102 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { print(''); // Exit program? - if ($doExit === true) { + if ($doExit === TRUE) { exit(); } // END - if } /** - * Outputs a debug message whether to debug instance (should be set!) or dies with or pints the message + * Creates an instance of a debugger instance * - * @param $message Message we shall send out... - * @param $doPrint Whether we shall print or die here which first is the default - * @return void + * @param $className Name of the class (currently unsupported) + * @return $debugInstance An instance of a debugger class */ - public function debugOutput ($message, $doPrint = true) { - // Get debug instance - $debugInstance = $this->getDebugInstance(); + public final static function createDebugInstance ($className) { + // Is the instance set? + if (!Registry::getRegistry()->instanceExists('debug')) { + // Init debug instance + $debugInstance = NULL; - // Is the debug instance there? - if (is_object($debugInstance)) { - // Use debug output handler - $debugInstance->output($message); + // Try it + try { + // Get a debugger instance + $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_' . self::getResponseTypeFromSystem() . '_class')); + } catch (NullPointerException $e) { + // Didn't work, no instance there + exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage()); + } - if ($doPrint === false) { - // Die here if not printed - die(); - } // END - if - } else { - // Put directly out - if ($doPrint === true) { - // Are debug times enabled? - if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') { - // Output it first - print($this->getPrintableExecutionTime()); - } // END - if + // 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; + } + + /** + * Simple output of a message with line-break + * + * @param $message Message to output + * @return void + */ + public function outputLine ($message) { + // Simply output it + print($message . PHP_EOL); + } + + /** + * Outputs a debug message whether to debug instance (should be set!) or + * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to + * ApplicationEntryPoint::app_exit(), this would cause an endless loop. + * + * @param $message Message we shall send out... + * @param $doPrint Whether print or die here (default: print) + * @paran $stripTags Whether to strip tags (default: FALSE) + * @return void + */ + public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) { + // Set debug instance to NULL + $debugInstance = NULL; + + // Try it: + try { + // Get debug instance + $debugInstance = $this->getDebugInstance(); + } catch (NullPointerException $e) { + // The debug instance is not set (yet) + } + + // Is the debug instance there? + if (is_object($debugInstance)) { + // Use debug output handler + $debugInstance->output($message, $stripTags); + + if ($doPrint === FALSE) { + // Die here if not printed + exit(); + } // END - if + } else { + // Are debug times enabled? + if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') { + // Prepent it + $message = $this->getPrintableExecutionTime() . $message; + } // END - if + + // Put directly out + if ($doPrint === TRUE) { // Print message - print($message . chr(10)); + $this->outputLine($message); } else { - /* - * BIG FAT NOTE: Do NEVER rewrite this to app_die(), this will - * cause an endless loop. - */ - die($message); + // Die here + exit($message); } } } @@ -1437,12 +1942,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $str The string, what ever it is needs to be converted * @return $className Generated class name */ - public function convertToClassName ($str) { + public static final function convertToClassName ($str) { // Init class name $className = ''; // Convert all dashes in underscores - $str = $this->convertDashesToUnderscores($str); + $str = self::convertDashesToUnderscores($str); // Now use that underscores to get classname parts for hungarian style foreach (explode('_', $str) as $strPart) { @@ -1460,7 +1965,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $str The string with maybe dashes inside * @return $str The converted string with no dashed, but underscores */ - public final function convertDashesToUnderscores ($str) { + public static final function convertDashesToUnderscores ($str) { // Convert them all $str = str_replace('-', '_', $str); @@ -1581,7 +2086,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected final function getDatabaseEntry () { // Is there an instance? - if (is_null($this->getResultInstance())) { + if (!$this->getResultInstance() instanceof SearchableResult) { // Throw an exception here throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); } // END - if @@ -1590,8 +2095,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->getResultInstance()->rewind(); // Do we have an entry? - if ($this->getResultInstance()->valid() === false) { - throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT); + if ($this->getResultInstance()->valid() === FALSE) { + // @TODO Move the constant to e.g. BaseDatabaseResult when there is a non-cached database result available + throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), CachedDatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT); } // END - if // Get next entry @@ -1626,18 +2132,58 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Get current array $fieldArray = $resultInstance->current(); - //* DEBUG: */ $this->debugOutput($fieldName.':
'.print_r($fieldArray, true).'
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, TRUE).'
'); + + // Convert dashes to underscore + $fieldName2 = self::convertDashesToUnderscores($fieldName); // Does the field exist? - if (isset($fieldArray[$fieldName])) { + if ($this->isFieldSet($fieldName)) { // Get it - $fieldValue = $fieldArray[$fieldName]; - } // END - if + $fieldValue = $fieldArray[$fieldName2]; + } elseif (defined('DEVELOPER')) { + // Missing field entry, may require debugging + self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldArray
=' . print_r($fieldArray, TRUE) . '
,fieldName=' . $fieldName . ' not found!'); + } else { + // Missing field entry, may require debugging + self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!'); + } // Return it return $fieldValue; } + /** + * Checks if given field is set + * + * @param $fieldName Field name to check + * @return $isSet Whether the given field name is set + * @throws NullPointerException If the result instance is null + */ + public function isFieldSet ($fieldName) { + // Get result instance + $resultInstance = $this->getResultInstance(); + + // Is this instance null? + if (is_null($resultInstance)) { + // Then the user instance is no longer valid (expired cookies?) + throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); + } // END - if + + // Get current array + $fieldArray = $resultInstance->current(); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . $this->__toString() . ':' . __LINE__ . '] fieldName=' . $fieldName . ',fieldArray=
'.print_r($fieldArray, TRUE).'
'); + + // Convert dashes to underscore + $fieldName = self::convertDashesToUnderscores($fieldName); + + // Determine it + $isSet = isset($fieldArray[$fieldName]); + + // Return result + return $isSet; + } + /** * Flushs all pending updates to the database layer * @@ -1653,7 +2199,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry(); // Create object instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry); + $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName($configEntry); // Yes, then send the whole result to the database layer $wrapperInstance->doUpdateByResult($this->getResultInstance()); @@ -1673,10 +2219,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Debug instance is there? if (!is_null($this->getDebugInstance())) { // Output stub message - $this->debugOutput($message); + self::createDebugInstance(__CLASS__)->debugOutput($message); } else { // Trigger an error trigger_error($message . "
\n"); + exit; } } else { // @TODO Finish this part! @@ -1706,7 +2253,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; @@ -1719,7 +2266,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function idle ($milliSeconds) { // Sleep is fine by default - $hasSlept = true; + $hasSlept = TRUE; // Idle so long with found function if (function_exists('time_sleep_until')) { @@ -1772,8 +2319,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Converts even very large decimal numbers, also with negative sign, to a - * hexadecimal string. + * Converts even very large decimal numbers, also signed, to a hexadecimal + * string. * * This work is based on comment #97756 on php.net documentation page at: * @@ -1796,18 +2343,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Encode the decimal number into a hexadecimal string $hex = ''; do { - $hex = self::$dechex[($dec % 16)] . $hex; - $dec /= 16; + $hex = self::$dechex[($dec % (2 ^ 4))] . $hex; + $dec /= (2 ^ 4); } while ($dec >= 1); /* - * We need hexadecimal strings with leading zeros if the length cannot - * be divided by 2 + * Leading zeros are required for hex-decimal "numbers". In some + * situations more leading zeros are wanted, so check for both + * conditions. */ if ($maxLength > 0) { // Prepend more zeros - $hex = $this->prependStringToString($hex, '0', $maxLength); + $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT); } elseif ((strlen($hex) % 2) != 0) { + // Only make string's length dividable by 2 $hex = '0' . $hex; } @@ -1858,7 +2407,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function hex2asc ($hex) { // Check for length, it must be devideable by 2 - //* DEBUG: */ $this->debugOutput('hex='.$hex); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex); assert((strlen($hex) % 2) == 0); // Walk the string @@ -1875,41 +2424,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $asc; } - /** - * Prepends a given string $prepend to $str with a given total length - * - * @param $str Given original string which should be prepended - * @param $prepend The string to prepend - * @param $length Total length of the final string - * @return $strFinal Final prepended string - */ - protected function prependStringToString ($str, $prepend, $length) { - // Set final string to original string by default - $strFinal = $str; - - // Can it devided - if (strlen($str) < $length) { - // Difference between total length and length of original string - $diff = $length - strlen($str); - - // Prepend the string - $prepend = str_repeat($prepend, ($diff / strlen($prepend) + 1)); - - // Make sure it will definedly fit - assert(strlen($prepend) >= $diff); - - // Cut it a little down - $prepend = substr($prepend, 0, $diff); - //* DEBUG: */ $this->debugOutput('prepend('.strlen($prepend).')='.$prepend.',diff='.$diff.',length='.$length); - - // Construct the final prepended string - $strFinal = $prepend . $str; - } // END - if - - // Return it - return $strFinal; - } - /** * Checks whether the given encoded data was encoded with Base64 * @@ -1918,7 +2432,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; @@ -1929,14 +2443,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * * @return $responseType Analyzed response type */ - protected function getResponseTypeFromSystem () { + protected static function getResponseTypeFromSystem () { // Default is console $responseType = 'console'; // Is 'HTTP_HOST' set? if (isset($_SERVER['HTTP_HOST'])) { - // Then it is a HTTP response/request - $responseType = 'http'; + /* + * Then it is a HTML response/request as RSS and so on may be + * transfered over HTTP as well. + */ + $responseType = 'html'; } // END - if // Return it @@ -1952,13 +2469,13 @@ 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) ); // And return it - //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey); return $cacheKey; } @@ -1978,7 +2495,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); @@ -1988,19 +2505,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). * @@ -2009,18 +2544,39 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $assertMismatch Whether to assert mismatches * @return $ret The (hopefully) secured numbered value */ - public function bigintval ($num, $castValue = true, $assertMismatch = false) { + public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) { // Filter all numbers out $ret = preg_replace('/[^0123456789]/', '', $num); // Shall we cast? - if ($castValue === true) { + if ($castValue === TRUE) { // Cast to biggest numeric type $ret = (double) $ret; } // END - if // Assert only if requested - if ($assertMismatch === true) { + if ($assertMismatch === TRUE) { + // Has the whole value changed? + assert(('' . $ret . '' != '' . $num . '') && (!is_null($num))); + } // END - if + + // Return result + return $ret; + } + + /** + * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f). + * + * @param $num A string consisting only chars between 0 and 9 + * @param $assertMismatch Whether to assert mismatches + * @return $ret The (hopefully) secured hext-numbered value + */ + public function hexval ($num, $assertMismatch = FALSE) { + // Filter all numbers out + $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num); + + // Assert only if requested + if ($assertMismatch === TRUE) { // Has the whole value changed? assert(('' . $ret . '' != '' . $num . '') && (!is_null($num))); } // END - if @@ -2028,6 +2584,752 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Return result return $ret; } + + /** + * Checks whether start/end marker are set + * + * @param $data Data to be checked + * @return $isset Whether start/end marker are set + */ + public final function ifStartEndMarkersSet ($data) { + // Determine it + $isset = ((substr($data, 0, strlen(BaseRawDataHandler::STREAM_START_MARKER)) == BaseRawDataHandler::STREAM_START_MARKER) && (substr($data, -1 * strlen(BaseRawDataHandler::STREAM_END_MARKER), strlen(BaseRawDataHandler::STREAM_END_MARKER)) == BaseRawDataHandler::STREAM_END_MARKER)); + + // ... and return it + return $isset; + } + + /** + * Determines if an element is set in the generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to check + * @param $element Element to check + * @return $isset Whether the given key is set + */ + protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]); + + // Return it + return $isset; + } + /** + * Determines if a key is set in the generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to check + * @return $isset Whether the given key is set + */ + protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return it + return $isset; + } + + + /** + * Determines if a group is set in the generic array + * + * @param $keyGroup Main group + * @param $subGroup Sub group + * @return $isset Whether the given group is set + */ + protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup]); + + // Return it + return $isset; + } + + /** + * Getter for sub key group + * + * @param $keyGroup Main key group + * @param $subGroup Sub key group + * @return $array An array with all array elements + */ + protected final function getGenericSubArray ($keyGroup, $subGroup) { + // Is it there? + if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { + // No, then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + exit; + } // END - if + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE)); + + // Return it + return $this->genericArray[$keyGroup][$subGroup]; + } + + /** + * Unsets a given key in generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return void + */ + protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Remove it + unset($this->genericArray[$keyGroup][$subGroup][$key]); + } + + /** + * Unsets a given element in generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $element Element to unset + * @return void + */ + protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Remove it + unset($this->genericArray[$keyGroup][$subGroup][$key][$element]); + } + + /** + * Append a string to a given generic array key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $value Value to add/append + * @return void + */ + protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue); + + // Is it already there? + if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Append it + $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value; + } else { + // Add it + $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value; + } + } + + /** + * Append a string to a given generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $element Element to check + * @param $value Value to add/append + * @return void + */ + protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue); + + // Is it already there? + if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { + // Append it + $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value; + } else { + // Add it + $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value; + } + } + + /** + * Initializes given generic array group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit)); + + // Is it already set? + if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) { + // Already initialized + trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.'); + exit; + } // END - if + + // Initialize it + $this->genericArray[$keyGroup][$subGroup] = array(); + } + + /** + * Initializes given generic array key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit)); + + // Is it already set? + 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 + $this->genericArray[$keyGroup][$subGroup][$key] = array(); + } + + /** + * Initializes given generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $element Element to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit)); + + // Is it already set? + 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 + $this->genericArray[$keyGroup][$subGroup][$key][$element] = array(); + } + + /** + * Pushes an element to a generic key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $value Value to add/append + * @return $count Number of array elements + */ + protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Is it set? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Initialize array + $this->initGenericArrayKey($keyGroup, $subGroup, $key); + } // END - if + + // Then push it + $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value); + + // Return count + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL); + return $count; + } + + /** + * Pushes an element to a generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $element Element to check + * @param $value Value to add/append + * @return $count Number of array elements + */ + protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Is it set? + if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { + // Initialize array + $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element); + } // END - if + + // Then push it + $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value); + + // Return count + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL); + return $count; + } + + /** + * Pops an element from a generic group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Last "popped" value + */ + protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it set? + 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 + $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return value + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL); + return $value; + } + + /** + * Shifts an element from a generic group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Last "popped" value + */ + protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it set? + 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 + $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return value + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL); + return $value; + } + + /** + * Count generic array group + * + * @param $keyGroup Main group for the key + * @return $count Count of given group + */ + protected final function countGenericArray ($keyGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup); + + // Is it there? + if (!isset($this->genericArray[$keyGroup])) { + // Abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.'); + exit; + } // END - if + + // Then count it + $count = count($this->genericArray[$keyGroup]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Count generic array sub group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @return $count Count of given group + */ + protected final function countGenericArrayGroup ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Is it there? + if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { + // Abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + exit; + } // END - if + + // Then count it + $count = count($this->genericArray[$keyGroup][$subGroup]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Count generic array elements + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @para $key Key to count + * @return $count Count of given key + */ + protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + 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 + $count = count($this->genericArray[$keyGroup][$subGroup][$key]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Getter for whole generic group array + * + * @param $keyGroup Key group to get + * @return $array Whole generic array group + */ + protected final function getGenericArray ($keyGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup); + + // Is it there? + if (!isset($this->genericArray[$keyGroup])) { + // Then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.'); + exit; + } // END - if + + // Return it + return $this->genericArray[$keyGroup]; + } + + /** + * Setter for generic array key + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $value Mixed value from generic array element + * @return void + */ + protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Set value here + $this->genericArray[$keyGroup][$subGroup][$key] = $value; + } + + /** + * Getter for generic array key + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Mixed value from generic array element + */ + protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + 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 + return $this->genericArray[$keyGroup][$subGroup][$key]; + } + + /** + * Sets a value in given generic array key/element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to set + * @param $element Element to set + * @param $value Value to set + * @return void + */ + protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Then set it + $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value; + } + + /** + * Getter for generic array element + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to look for + * @param $element Element to look for + * @return $value Mixed value from generic array element + */ + protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Is it there? + 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 + return $this->genericArray[$keyGroup][$subGroup][$key][$element]; + } + + /** + * Checks if a given sub group is valid (array) + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @return $isValid Whether given sub group is valid + */ + protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Determine it + $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup)))); + + // Return it + return $isValid; + } + + /** + * Checks if a given key is valid (array) + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to check + * @return $isValid Whether given sub group is valid + */ + protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Determine it + $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key)))); + + // Return it + return $isValid; + } + + /** + * Initializes the web output instance + * + * @return void + */ + protected function initWebOutputInstance () { + // Get application instance + $applicationInstance = Registry::getRegistry()->getInstance('app'); + + // Is this a response instance? + if ($this instanceof Responseable) { + // Then set it in application instance + $applicationInstance->setResponseInstance($this); + } // END - if + + // Init web output instance + $outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($applicationInstance)); + + // Set it locally + $this->setWebOutputInstance($outputInstance); + } + + /** + * 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; + } + + /** + * Encodes raw data (almost any type) by "serializing" it and then pack it + * into a "binary format". + * + * @param $rawData Raw data (almost any type) + * @return $encoded Encoded data + */ + protected function encodeData ($rawData) { + // Make sure no objects or resources pass through + assert(!is_object($rawData)); + assert(!is_resource($rawData)); + + // First "serialize" it (json_encode() is faster than serialize()) + $encoded = $this->packString(json_encode($rawData)); + + // And return it + return $encoded; + } + + /** + * Pack a string into a "binary format". Please execuse me that this is + * widely undocumented. :-( + * + * @param $str Unpacked string + * @return $packed Packed string + * @todo Improve documentation + */ + protected function packString ($str) { + // Debug message + //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('str=' . $str . ' - CALLED!'); + + // First compress the string (gzcompress is okay) + $str = gzcompress($str); + + // Init variable + $packed = ''; + + // And start the "encoding" loop + for ($idx = 0; $idx < strlen($str); $idx += $this->packingData[$this->archArrayElement]['step']) { + $big = 0; + for ($i = 0; $i < $this->packingData[$this->archArrayElement]['step']; $i++) { + $factor = ($this->packingData[$this->archArrayElement]['step'] - 1 - $i); + + if (($idx + $i) <= strlen($str)) { + $ord = ord(substr($str, ($idx + $i), 1)); + + $add = $ord * pow(256, $factor); + + $big += $add; + + //print 'idx=' . $idx . ',i=' . $i . ',ord=' . $ord . ',factor=' . $factor . ',add=' . $add . ',big=' . $big . PHP_EOL; + } // END - if + } // END - for + + $l = ($big & $this->packingData[$this->archArrayElement]['left']) >>$this->packingData[$this->archArrayElement]['factor']; + $r = $big & $this->packingData[$this->archArrayElement]['right']; + + $chunk = str_pad(pack($this->packingData[$this->archArrayElement]['format'], $l, $r), 8, '0', STR_PAD_LEFT); + //* NOISY-DEBUG */ print 'big=' . $big . ',chunk('.strlen($chunk) . ')='.md5($chunk).PHP_EOL; + + $packed .= $chunk; + } // END - for + + // Return it + //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('packed=' . $packed . ' - EXIT!'); + return $packed; + } + + /** + * Checks whether the given file/path is in open_basedir(). This does not + * gurantee that the file is actually readable and/or writeable. If you need + * such gurantee then please use isReadableFile() instead. + * + * @param $filePathName Name of the file/path to be checked + * @return $isReachable Whether it is within open_basedir() + */ + public static function isReachableFilePath ($filePathName) { + // Is not reachable by default + $isReachable = FALSE; + + // Get open_basedir parameter + $openBaseDir = ini_get('open_basedir'); + + // Is it set? + if (!empty($openBaseDir)) { + // Check all entries + foreach (explode(PATH_SEPARATOR, $openBaseDir) as $dir) { + // Check on existence + if (substr($filePathName, 0, strlen($dir)) == $dir) { + // Is reachable + $isReachable = TRUE; + } // END - if + } // END - foreach + } else { + // If open_basedir is not set, all is allowed + $isReachable = TRUE; + } + + // Return status + return $isReachable; + } + + /** + * Checks whether the give file is within open_basedir() (done by + * isReachableFilePath()), is actually a file and is readable. + * + * @param $fileName Name of the file to be checked + * @return $isReadable Whether the file is readable (and therefor exists) + */ + public static function isReadableFile ($fileName) { + // Default is not readable + $isReadable = FALSE; + + // Is within parameters, so check if it is a file and readable + $isReadable = ((self::isReachableFilePath($fileName)) && (file_exists($fileName)) && (is_file($fileName)) && (is_readable($fileName))); + + // Return status + return $isReadable; + } } // [EOF]