]> git.mxchange.org Git - core.git/blobdiff - inc/classes/main/class_BaseFrameworkSystem.php
Fixed criteria handling
[core.git] / inc / classes / main / class_BaseFrameworkSystem.php
index 4b2812dc41adfc530e6fbbb9fe106b0d69f71dc4..679e5e4af81ee8c9586a6afcdb22c62702362ebc 100644 (file)
@@ -163,6 +163,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $visitorInstance = NULL;
 
+       /**
+        * DHT instance
+        */
+       private $dhtInstance = NULL;
+
        /**
         * An instance of a database wrapper class
         */
@@ -328,7 +333,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,7 +343,7 @@ 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 <span class=\"object_name\">%s</span> is already destroyed.",
+                       self::createDebugInstance(__CLASS__)->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
                                __CLASS__,
                                $this->__toString()
                        ));
@@ -353,8 +358,21 @@ 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 = '';
+
+               // Is it empty or an array?
                if (empty($args)) {
                        // No arguments
                        $argsString = 'NULL';
@@ -373,10 +391,10 @@ 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);
+                                       $argsString .= ', ' . count($arg);
                                } elseif ($arg === true) {
                                        // ... is boolean 'true'
                                        $argsString .= ', true';
@@ -399,8 +417,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                }
 
                // Output stub message
-               $this->debugOutput(sprintf("[%s-&gt;%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
                ));
@@ -979,19 +997,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * 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,7 +1022,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function setSocketResource ($socketResource) {
-               //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
                $this->socketResource = $socketResource;
        }
 
@@ -1014,7 +1032,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $socketResource         A valid socket resource
         */
        public final function getSocketResource () {
-               //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
                return $this->socketResource;
        }
 
@@ -1132,6 +1150,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
         *
@@ -1305,7 +1342,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                );
 
                // Output it
-               ApplicationEntryPoint::app_die(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
+               ApplicationEntryPoint::app_exit(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
                        $this->__toString(),
                        $content,
                        ClassLoader::getSelfInstance()->getPrintableIncludeList()
@@ -1355,16 +1392,16 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Is the extra message given?
                if (!empty($message)) {
                        // Then add it as well
-                       $stubMessage .= sprintf(' Message: <span id="stub_message">%s</span>', $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 . '<br />' . chr(10));
+                       trigger_error($stubMessage);
                }
        }
 
@@ -1375,7 +1412,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @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
@@ -1393,13 +1430,42 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * 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       $className              Name of the class (currently unsupported)
+        * @return      $debugInstance  An instance of a debugger class
+        */
+       public final static function createDebugInstance ($className) {
+               // Init debug instance
+               $debugInstance = NULL;
+
+               // Try it
+               try {
+                       // Get a debugger instance
+                       $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
+               } catch (NullPointerException $e) {
+                       // Didn't work, no instance there
+                       exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
+               }
+
+               // Empty string should be ignored and used for testing the middleware
+               DebugMiddleware::getSelfInstance()->output('');
+
+               // Return it
+               return $debugInstance;
+       }
+
+       /**
+        * 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 we shall print or die here which first is the default
+        * @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) {
+       public function debugOutput ($message, $doPrint = true, $stripTags = false) {
                // Set debug instance to NULL
                $debugInstance = NULL;
 
@@ -1414,29 +1480,26 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Is the debug instance there?
                if (is_object($debugInstance)) {
                        // Use debug output handler
-                       $debugInstance->output($message);
+                       $debugInstance->output($message, $stripTags);
 
                        if ($doPrint === false) {
                                // Die here if not printed
-                               die();
+                               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) {
-                               // Are debug times enabled?
-                               if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
-                                       // Output it first
-                                       print($this->getPrintableExecutionTime());
-                               } // END - if
-
                                // Print message
                                print($message . chr(10));
                        } else {
-                               /*
-                                * BIG FAT NOTE: Do NEVER rewrite this to app_die(), this will
-                                * cause an endless loop.
-                                */
-                               die($message);
+                               // Die here
+                               exit($message);
                        }
                }
        }
@@ -1636,7 +1699,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 
                // Get current array
                $fieldArray = $resultInstance->current();
-               //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
 
                // Convert dashes to underscore
                $fieldName = $this->convertDashesToUnderscores($fieldName);
@@ -1647,7 +1710,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $fieldValue = $fieldArray[$fieldName];
                } else {
                        // Missing field entry, may require debugging
-                       $this->debugOutput($this->__toString() . ':fieldname=' . $fieldName . ' not found!');
+                       self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ':fieldname=' . $fieldName . ' not found!');
                }
 
                // Return it
@@ -1689,7 +1752,7 @@ 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 . "<br />\n");
@@ -1788,8 +1851,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:
         * <http://de.php.net/manual/en/function.hexdec.php#97756>
@@ -1812,18 +1875,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;
                }
 
@@ -1874,7 +1939,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
@@ -1891,41 +1956,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
         *
@@ -1974,7 +2004,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                );
 
                // And return it
-               //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
                return $cacheKey;
        }
 
@@ -2065,6 +2095,20 @@ 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;
+       }
 }
 
 // [EOF]