X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=2e42a794b12018efe454f560730ca1a54d9e6d3a;hp=0c08a67a364a0cee1d477d3facee68b7abcbeaa6;hb=9a2de3adcd917b49c9c5fa33095ccbc3a7032e9f;hpb=b79b70f64580d944cbde60cd7a08716ea70b3e11 diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index 0c08a67a..2e42a794 100644 --- a/inc/classes/main/class_BaseFrameworkSystem.php +++ b/inc/classes/main/class_BaseFrameworkSystem.php @@ -5,7 +5,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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.shipsimu.org * @@ -24,39 +24,9 @@ */ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** - * Separator for header data - */ - const SEPARATOR_HEADER_DATA = 0x01; - - /** - * Separator header->entries - */ - const SEPARATOR_HEADER_ENTRIES = 0x02; - - /** - * Separator hash->name - */ - const SEPARATOR_HASH_NAME = 0x03; - - /** - * Separator entry->entry - */ - const SEPARATOR_ENTRIES = 0x04; - - /** - * Length of count - */ - const LENGTH_COUNT = 20; - - /** - * Length of position - */ - const LENGTH_POSITION = 20; - - /** - * Length of name + * Length of output from hash() */ - const LENGTH_NAME = 10; + private static $hashLength = NULL; /** * The real class name @@ -146,7 +116,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Instance of the stacker */ - private $stackerInstance = NULL; + private $stackInstance = NULL; /** * A Compressor instance @@ -159,7 +129,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $parserInstance = NULL; /** - * A ProtocolHandler instance + * A HandleableProtocol instance */ private $protocolInstance = NULL; @@ -178,6 +148,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ private $sourceInstance = NULL; + /** + * An instance of a UrlSource class + */ + private $urlSourceInstance = NULL; + /** * An instance of a InputStream class */ @@ -224,64 +199,59 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $blockInstance = NULL; /** - * Thousands separator + * A Minable instance */ - private $thousands = '.'; // German + private $minableInstance = NULL; /** - * Decimal separator + * A FrameworkDirectory instance */ - private $decimals = ','; // German - - /** - * Socket resource - */ - private $socketResource = FALSE; + private $directoryInstance = NULL; /** - * Package data + * Listener instance */ - private $packageData = array(); + private $listenerInstance = NULL; /** - * Generic array + * Thousands separator */ - private $genericArray = array(); + private $thousands = '.'; // German /** - * Length of output from hash() + * Decimal separator */ - private static $hashLength = NULL; + private $decimals = ','; // German /** - * Counter for total entries + * Socket resource */ - private $totalEntries = 0; + private $socketResource = FALSE; /** - * Current seek position + * Regular expression to use for validation */ - private $seekPosition = 0; + private $regularExpression = ''; /** - * Size of header + * Package data */ - private $headerSize = 0; + private $packageData = array(); /** - * File header + * Generic array */ - private $header = array(); + private $genericArray = array(); /** - * Seek positions for gaps ("fragmentation") + * Command name */ - private $gaps = array(); + private $commandName = ''; /** - * Seek positions for damaged entries (e.g. mismatching hash sum, ...) + * Controller name */ - private $damagedEntries = array(); + private $controllerName = ''; /*********************** * Exception codes.... * @@ -1018,20 +988,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; } /** @@ -1073,19 +1043,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) { $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; @@ -1131,6 +1101,27 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { 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 * @@ -1153,7 +1144,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Setter for a Sourceable instance * - * @param $sourceInstance The Sourceable instance + * @param $sourceInstance An instance of a Sourceable class * @return void */ protected final function setSourceInstance (Sourceable $sourceInstance) { @@ -1163,12 +1154,31 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Getter for a Sourceable instance * - * @return $sourceInstance The Sourceable instance + * @return $sourceInstance An instance of a Sourceable class */ protected final function getSourceInstance () { return $this->sourceInstance; } + /** + * 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 * @@ -1304,24 +1314,40 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Setter for InputOutputPointer instance + * Setter for FilePointer instance * - * @param $pointerInstance An instance of an InputOutputPointer class + * @param $pointerInstance An instance of an FilePointer class * @return void */ - protected final function setPointerInstance (InputOutputPointer $pointerInstance) { + protected final function setPointerInstance (FilePointer $pointerInstance) { $this->pointerInstance = $pointerInstance; } /** - * Getter for InputOutputPointer instance + * Getter for FilePointer instance * - * @return $pointerInstance An instance of an InputOutputPointer class + * @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 * @@ -1360,6 +1386,101 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { 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; + } + + /** + * 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; + } + /** * Checks whether an object equals this object. You should overwrite this * method to implement own equality checks @@ -1436,7 +1557,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 @@ -1459,7 +1580,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; @@ -1597,7 +1718,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Try it try { // Get a debugger instance - $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class')); + $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()); @@ -1837,7 +1958,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Do we have an entry? if ($this->getResultInstance()->valid() === FALSE) { - throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT); + // @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 @@ -1875,21 +1997,55 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, TRUE).'
'); // Convert dashes to underscore - $fieldName = $this->convertDashesToUnderscores($fieldName); + $fieldName2 = $this->convertDashesToUnderscores($fieldName); // Does the field exist? - if (isset($fieldArray[$fieldName])) { + if ($this->isFieldSet($fieldName)) { // Get it - $fieldValue = $fieldArray[$fieldName]; + $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($this->__toString() . ':fieldname=' . $fieldName . ' not found!'); + 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 = $this->convertDashesToUnderscores($fieldName); + + // Determine it + $isSet = isset($fieldArray[$fieldName]); + + // Return result + return $isSet; + } + /** * Flushs all pending updates to the database layer * @@ -2149,14 +2305,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 @@ -2875,6 +3034,28 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { 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' * @@ -2891,197 +3072,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // ... and return it return $translated; } - - /** - * Initializes counter for valid entries, arrays for damaged entries and - * an array for gap seek positions. If you call this method on your own, - * please re-analyze the file structure. So you are better to call - * analyzeFile() instead of this method. - * - * @return void - */ - protected function initCountersGapsArray () { - // Init counter and seek position - $this->setCounter(0); - $this->setSeekPosition(0); - - // Init arrays - $this->gaps = array(); - $this->damagedEntries = array(); - } - - /** - * Getter for total entries - * - * @return $totalEntries Total entries in this file - */ - protected final function getCounter () { - // Get it - return $this->totalEntries; - } - - /** - * Setter for total entries - * - * @param $totalEntries Total entries in this file - * @return void - */ - protected final function setCounter ($counter) { - // Set it - $this->totalEntries = $counter; - } - - /** - * Increment counter - * - * @return void - */ - protected final function incrementCounter () { - // Get it - $this->totalEntries++; - } - - /** - * Getter for header size - * - * @return $totalEntries Size of file header - */ - public final function getHeaderSize () { - // Get it - return $this->headerSize; - } - - /** - * Setter for header size - * - * @param $headerSize Size of file header - * @return void - */ - protected final function setHeaderSize ($headerSize) { - // Set it - $this->headerSize = $headerSize; - } - - /** - * Getter for header array - * - * @return $totalEntries Size of file header - */ - protected final function getHeade () { - // Get it - return $this->header; - } - - /** - * Setter for header - * - * @param $header Array for a file header - * @return void - */ - protected final function setHeader (array $header) { - // Set it - $this->header = $header; - } - - /** - * Getter for seek position - * - * @return $seekPosition Current seek position (stored here in object) - */ - protected final function getSeekPosition () { - // Get it - return $this->seekPosition; - } - - /** - * Setter for seek position - * - * @param $seekPosition Current seek position (stored here in object) - * @return void - */ - protected final function setSeekPosition ($seekPosition) { - // And set it - $this->seekPosition = $seekPosition; - } - - /** - * Updates seekPosition attribute from file to avoid to much access on file. - * - * @return void - */ - protected function updateSeekPosition () { - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__)); - - // Get key (= seek position) - $seekPosition = $this->getIteratorInstance()->key(); - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Setting seekPosition=%s', __METHOD__, __LINE__, $seekPosition)); - - // And set it here - $this->setSeekPosition($seekPosition); - - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__)); - } - - /** - * Seeks to beginning of file, updates seek position in this object and - * flushes the header. - * - * @return void - */ - protected function rewineUpdateSeekPosition () { - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__)); - - // flushFileHeader must be callable - assert(is_callable(array($this, 'flushFileHeader'))); - - // Seek to beginning of file - $this->getIteratorInstance()->rewind(); - - // And update seek position ... - $this->updateSeekPosition(); - - // ... to write it back into the file - $this->flushFileHeader(); - - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__)); - } - - /** - * Seeks to old position - * - * @return void - */ - protected function seekToOldPosition () { - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__)); - - // Seek to currently ("old") saved position - $this->getIteratorInstance()->seek($this->getSeekPosition()); - - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!!', __METHOD__, __LINE__)); - } - - /** - * Checks whether the block separator has been found - * - * @param $str String to look in - * @return $isFound Whether the block separator has been found - */ - public static function isBlockSeparatorFound ($str) { - // Determine it - $isFound = (strpos($str, self::getBlockSeparator()) !== FALSE); - - // Return result - return $isFound; - } - - /** - * Getter for block separator character(s) - * - * @return $blockSeparator A separator for blocks - */ - protected static final function getBlockSeparator () { - return chr(self::SEPARATOR_ENTRIES); - } } // [EOF]