3 * The simulator system class is the super class of all other classes. This
4 * class handles saving of games etc.
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
27 * Instance of a request class
29 private $requestInstance = NULL;
32 * Instance of a response class
34 private $responseInstance = NULL;
37 * Search criteria instance
39 private $searchInstance = NULL;
42 * Update criteria instance
44 private $updateInstance = NULL;
47 * The file I/O instance for the template loader
49 private $fileIoInstance = NULL;
54 private $resolverInstance = NULL;
57 * Template engine instance
59 private $templateInstance = NULL;
62 * Database result instance
64 private $resultInstance = NULL;
67 * Instance for user class
69 private $userInstance = NULL;
72 * A controller instance
74 private $controllerInstance = NULL;
79 private $rngInstance = NULL;
82 * Instance of a crypto helper
84 private $cryptoInstance = NULL;
87 * Instance of an Iterator class
89 private $iteratorInstance = NULL;
92 * Instance of the list
94 private $listInstance = NULL;
99 private $menuInstance = NULL;
102 * Instance of the image
104 private $imageInstance = NULL;
107 * Instance of the stacker
109 private $stackerInstance = NULL;
112 * A Compressor instance
114 private $compressorInstance = NULL;
117 * A Parseable instance
119 private $parserInstance = NULL;
122 * A ProtocolHandler instance
124 private $protocolInstance = NULL;
127 * A database wrapper instance
129 private $databaseInstance = NULL;
132 * A helper instance for the form
134 private $helperInstance = NULL;
137 * An instance of a Sourceable class
139 private $sourceInstance = NULL;
142 * An instance of a InputStreamable class
144 private $inputStreamInstance = NULL;
147 * An instance of a OutputStreamable class
149 private $outputStreamInstance = NULL;
152 * Networkable handler instance
154 private $handlerInstance = NULL;
157 * Visitor handler instance
159 private $visitorInstance = NULL;
162 * The real class name
164 private $realClass = 'BaseFrameworkSystem';
167 * An instance of a database wrapper class
169 private $wrapperInstance = NULL;
172 * Thousands separator
174 private $thousands = '.'; // German
179 private $decimals = ','; // German
184 private $socketResource = false;
189 private $packageData = array();
191 /***********************
192 * Exception codes.... *
193 ***********************/
195 // @todo Try to clean these constants up
196 const EXCEPTION_IS_NULL_POINTER = 0x001;
197 const EXCEPTION_IS_NO_OBJECT = 0x002;
198 const EXCEPTION_IS_NO_ARRAY = 0x003;
199 const EXCEPTION_MISSING_METHOD = 0x004;
200 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
201 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
202 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
203 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
204 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
205 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
206 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
207 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
208 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
209 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
210 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
211 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
212 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
213 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
214 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
215 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
216 const EXCEPTION_PATH_NOT_FOUND = 0x015;
217 const EXCEPTION_INVALID_PATH_NAME = 0x016;
218 const EXCEPTION_READ_PROTECED_PATH = 0x017;
219 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
220 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
221 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
222 const EXCEPTION_INVALID_RESOURCE = 0x01b;
223 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
224 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
225 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
226 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
227 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
228 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
229 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
230 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
231 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
232 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
233 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
234 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
235 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
236 const EXCEPTION_INVALID_STRING = 0x029;
237 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
238 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
239 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
240 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
241 const EXCEPTION_UNSPPORTED_OPERATION = 0x02e;
242 const EXCEPTION_MISSING_ELEMENT = 0x030;
243 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
244 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
245 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
246 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
247 const EXCEPTION_FATAL_ERROR = 0x035;
248 const EXCEPTION_FILE_NOT_FOUND = 0x036;
249 const EXCEPTION_ASSERTION_FAILED = 0x037;
250 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
251 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
252 const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040;
255 * Hexadecimal->Decimal translation array
257 private static $hexdec = array(
277 * Decimal->hexadecimal translation array
279 private static $dechex = array(
299 * Startup time in miliseconds
301 private static $startupTime = 0;
304 * Protected super constructor
306 * @param $className Name of the class
309 protected function __construct ($className) {
311 $this->setRealClass($className);
313 // Set configuration instance if no registry ...
314 if (!$this instanceof Register) {
315 // ... because registries doesn't need to be configured
316 $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
319 // Is the startup time set? (0 cannot be true anymore)
320 if (self::$startupTime == 0) {
322 self::$startupTime = microtime(true);
327 * Destructor for all classes
331 public function __destruct() {
332 // Flush any updated entries to the database
333 $this->flushPendingUpdates();
335 // Is this object already destroyed?
336 if ($this->__toString() != 'DestructedObject') {
337 // Destroy all informations about this class but keep some text about it alive
338 $this->setRealClass('DestructedObject');
339 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
340 // Already destructed object
341 $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
349 * The __call() method where all non-implemented methods end up
351 * @param $methodName Name of the missing method
352 * @args $args Arguments passed to the method
355 public final function __call ($methodName, $args) {
356 // Implode all given arguments
360 $argsString = 'NULL';
361 } elseif (is_array($args)) {
362 // Some arguments are there
363 foreach ($args as $arg) {
365 $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
367 if (is_string($arg)) {
368 // Add length for strings
369 $argsString .= ', '.strlen($arg);
370 } elseif (is_array($arg)) {
371 // .. or size if array
372 $argsString .= ', '.count($arg);
373 } elseif ($arg === true) {
374 // ... is boolean 'true'
375 $argsString .= ', true';
376 } elseif ($arg === false) {
377 // ... is boolean 'true'
378 $argsString .= ', false';
382 $argsString .= '), ';
386 if (substr($argsString, -2, 1) == ',') {
387 $argsString = substr($argsString, 0, -2);
390 // Invalid arguments!
391 $argsString = '!INVALID:' . gettype($args) . '!';
394 // Output stub message
395 $this->debugOutput(sprintf("[%s->%s] Stub! Args: %s",
406 * Getter for $realClass
408 * @return $realClass The name of the real class (not BaseFrameworkSystem)
410 public function __toString () {
411 return $this->realClass;
415 * Magic function to catch setting of missing but set class fields/attributes
417 * @param $name Name of the field/attribute
418 * @param $value Value to store
421 public final function __set ($name, $value) {
422 $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s",
430 * Magic function to catch getting of missing fields/attributes
432 * @param $name Name of the field/attribute
435 public final function __get ($name) {
436 $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s",
442 * Magic function to catch unsetting of missing fields/attributes
444 * @param $name Name of the field/attribute
447 public final function __unset ($name) {
448 $this->debugBackTrace(sprintf("Tried to unset a missing field. name=%s",
454 * Setter for database result instance
456 * @param $resultInstance An instance of a database result class
458 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
460 protected final function setResultInstance (SearchableResult $resultInstance) {
461 $this->resultInstance = $resultInstance;
465 * Getter for database result instance
467 * @return $resultInstance An instance of a database result class
469 public final function getResultInstance () {
470 return $this->resultInstance;
474 * Setter for template engine instances
476 * @param $templateInstance An instance of a template engine class
479 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
480 $this->templateInstance = $templateInstance;
484 * Getter for template engine instances
486 * @return $templateInstance An instance of a template engine class
488 protected final function getTemplateInstance () {
489 return $this->templateInstance;
493 * Setter for search instance
495 * @param $searchInstance Searchable criteria instance
498 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
499 $this->searchInstance = $searchInstance;
503 * Getter for search instance
505 * @return $searchInstance Searchable criteria instance
507 public final function getSearchInstance () {
508 return $this->searchInstance;
512 * Setter for update instance
514 * @param $updateInstance Searchable criteria instance
517 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
518 $this->updateInstance = $updateInstance;
522 * Getter for update instance
524 * @return $updateInstance Updateable criteria instance
526 public final function getUpdateInstance () {
527 return $this->updateInstance;
531 * Setter for resolver instance
533 * @param $resolverInstance Instance of a command resolver class
536 public final function setResolverInstance (Resolver $resolverInstance) {
537 $this->resolverInstance = $resolverInstance;
541 * Getter for resolver instance
543 * @return $resolverInstance Instance of a command resolver class
545 public final function getResolverInstance () {
546 return $this->resolverInstance;
550 * Setter for language instance
552 * @param $configInstance The configuration instance which shall
553 * be FrameworkConfiguration
556 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
557 Registry::getRegistry()->addInstance('config', $configInstance);
561 * Getter for configuration instance
563 * @return $configInstance Configuration instance
565 public final function getConfigInstance () {
566 $configInstance = Registry::getRegistry()->getInstance('config');
567 return $configInstance;
571 * Setter for debug instance
573 * @param $debugInstance The instance for debug output class
576 public final function setDebugInstance (DebugMiddleware $debugInstance) {
577 Registry::getRegistry()->addInstance('debug', $debugInstance);
581 * Getter for debug instance
583 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
585 public final function getDebugInstance () {
586 // Get debug instance
587 $debugInstance = Registry::getRegistry()->getInstance('debug');
590 return $debugInstance;
594 * Setter for web output instance
596 * @param $webInstance The instance for web output class
599 public final function setWebOutputInstance (OutputStreamer $webInstance) {
600 Registry::getRegistry()->addInstance('web_output', $webInstance);
604 * Getter for web output instance
606 * @return $webOutputInstance - Instance to class WebOutput
608 public final function getWebOutputInstance () {
609 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
610 return $webOutputInstance;
614 * Setter for database instance
616 * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
619 public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
620 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
624 * Getter for database layer
626 * @return $databaseInstance The database layer instance
628 public final function getDatabaseInstance () {
630 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
633 return $databaseInstance;
637 * Setter for compressor channel
639 * @param $compressorInstance An instance of CompressorChannel
642 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
643 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
647 * Getter for compressor channel
649 * @return $compressorInstance The compressor channel
651 public final function getCompressorChannel () {
652 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
653 return $compressorInstance;
657 * Protected getter for a manageable application helper class
659 * @return $applicationInstance An instance of a manageable application helper class
661 protected final function getApplicationInstance () {
662 $applicationInstance = Registry::getRegistry()->getInstance('application');
663 return $applicationInstance;
667 * Setter for a manageable application helper class
669 * @param $applicationInstance An instance of a manageable application helper class
672 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
673 Registry::getRegistry()->addInstance('application', $applicationInstance);
677 * Setter for request instance
679 * @param $requestInstance An instance of a Requestable class
682 public final function setRequestInstance (Requestable $requestInstance) {
683 $this->requestInstance = $requestInstance;
687 * Getter for request instance
689 * @return $requestInstance An instance of a Requestable class
691 public final function getRequestInstance () {
692 return $this->requestInstance;
696 * Setter for response instance
698 * @param $responseInstance An instance of a Responseable class
701 public final function setResponseInstance (Responseable $responseInstance) {
702 $this->responseInstance = $responseInstance;
706 * Getter for response instance
708 * @return $responseInstance An instance of a Responseable class
710 public final function getResponseInstance () {
711 return $this->responseInstance;
715 * Setter for the real class name
717 * @param $realClass Class name (string)
720 public final function setRealClass ($realClass) {
722 $realClass = (string) $realClass;
725 $this->realClass = $realClass;
729 * Checks wether an object equals this object. You should overwrite this
730 * method to implement own equality checks
732 * @param $objectInstance An instance of a FrameworkInterface object
733 * @return $equals Wether both objects equals
735 public function equals (FrameworkInterface $objectInstance) {
738 $this->__toString() == $objectInstance->__toString()
740 $this->hashCode() == $objectInstance->hashCode()
748 * Generates a generic hash code of this class. You should really overwrite
749 * this method with your own hash code generator code. But keep KISS in mind.
751 * @return $hashCode A generic hash code respresenting this whole class
753 public function hashCode () {
755 return crc32($this->__toString());
759 * Formats computer generated price values into human-understandable formats
760 * with thousand and decimal separators.
762 * @param $value The in computer format value for a price
763 * @param $currency The currency symbol (use HTML-valid characters!)
764 * @param $decNum Number of decimals after commata
765 * @return $price The for the current language formated price string
766 * @throws MissingDecimalsThousandsSeparatorException If decimals or
767 * thousands separator
770 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
771 // Are all required attriutes set?
772 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
773 // Throw an exception
774 throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
778 $value = (float) $value;
780 // Reformat the US number
781 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
783 // Return as string...
788 * Private getter for language instance
790 * @return $langInstance An instance to the language sub-system
792 protected final function getLanguageInstance () {
793 $langInstance = Registry::getRegistry()->getInstance('language');
794 return $langInstance;
798 * Setter for language instance
800 * @param $langInstance An instance to the language sub-system
802 * @see LanguageSystem
804 public final function setLanguageInstance (ManageableLanguage $langInstance) {
805 Registry::getRegistry()->addInstance('language', $langInstance);
809 * Appends a trailing slash to a string
811 * @param $str A string (maybe) without trailing slash
812 * @return $str A string with an auto-appended trailing slash
814 public final function addMissingTrailingSlash ($str) {
815 // Is there a trailing slash?
816 if (substr($str, -1, 1) != '/') {
820 // Return string with trailing slash
825 * Private getter for file IO instance
827 * @return $fileIoInstance An instance to the file I/O sub-system
829 protected final function getFileIoInstance () {
830 return $this->fileIoInstance;
834 * Setter for file I/O instance
836 * @param $fileIoInstance An instance to the file I/O sub-system
839 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
840 $this->fileIoInstance = $fileIoInstance;
844 * Prepare the template engine (WebTemplateEngine by default) for a given
845 * application helper instance (ApplicationHelper by default).
847 * @param $applicationInstance An application helper instance or
848 * null if we shall use the default
849 * @return $templateInstance The template engine instance
850 * @throws NullPointerException If the discovered application
851 * instance is still null
853 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
854 // Is the application instance set?
855 if (is_null($applicationInstance)) {
856 // Get the current instance
857 $applicationInstance = $this->getApplicationInstance();
860 if (is_null($applicationInstance)) {
861 // Thrown an exception
862 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
866 // Initialize the template engine
867 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
869 // Return the prepared instance
870 return $templateInstance;
874 * Debugs this instance by putting out it's full content
876 * @param $message Optional message to show in debug output
879 public final function debugInstance ($message = '') {
880 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
881 restore_error_handler();
887 if (!empty($message)) {
889 $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
892 // Generate the output
893 $content .= sprintf("<pre>%s</pre>",
902 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>",
905 ClassLoader::getSelfInstance()->getPrintableIncludeList()
910 * Replaces control characters with printable output
912 * @param $str String with control characters
913 * @return $str Replaced string
915 protected function replaceControlCharacters ($str) {
918 chr(13), '[r]', str_replace(
919 chr(10), '[n]', str_replace(
929 * Output a partial stub message for the caller method
931 * @param $message An optional message to display
934 protected function partialStub ($message = '') {
936 $backtrace = debug_backtrace();
938 // Generate the class::method string
939 $methodName = 'UnknownClass->unknownMethod';
940 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
941 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
944 // Construct the full message
945 $stubMessage = sprintf("[%s:] Partial stub!",
949 // Is the extra message given?
950 if (!empty($message)) {
951 // Then add it as well
952 $stubMessage .= sprintf(' Message: <span id="stub_message">%s</span>', $message);
955 // Debug instance is there?
956 if (!is_null($this->getDebugInstance())) {
957 // Output stub message
958 $this->debugOutput($stubMessage);
961 trigger_error($stubMessage . '<br />' + chr(10));
966 * Outputs a debug backtrace and stops further script execution
968 * @param $message An optional message to output
971 public function debugBackTrace ($message = '') {
972 // Sorry, there is no other way getting this nice backtrace
973 if (!empty($message)) {
975 printf("Message: %s<br />\n", $message);
979 debug_print_backtrace();
985 * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
987 * @param $message Message we shall send out...
988 * @param $doPrint Wether we shall print or die here which first is the default
991 public function debugOutput ($message, $doPrint = true) {
992 // Get debug instance
993 $debugInstance = $this->getDebugInstance();
995 // Is the debug instance there?
996 if (is_object($debugInstance)) {
997 // Use debug output handler
998 $debugInstance->output($message);
1000 if ($doPrint === false) {
1001 // Die here if not printed
1006 if ($doPrint === true) {
1007 // Are debug times enabled?
1008 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1010 print($this->getPrintableExecutionTime());
1014 print($message . chr(10));
1016 // DO NOT REWRITE THIS TO app_die() !!!
1023 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1025 * @param $str The string, what ever it is needs to be converted
1026 * @return $className Generated class name
1028 public function convertToClassName ($str) {
1032 // Convert all dashes in underscores
1033 $str = $this->convertDashesToUnderscores($str);
1035 // Now use that underscores to get classname parts for hungarian style
1036 foreach (explode('_', $str) as $strPart) {
1037 // Make the class name part lower case and first upper case
1038 $className .= ucfirst(strtolower($strPart));
1041 // Return class name
1046 * Converts dashes to underscores, e.g. useable for configuration entries
1048 * @param $str The string with maybe dashes inside
1049 * @return $str The converted string with no dashed, but underscores
1051 public final function convertDashesToUnderscores ($str) {
1053 $str = str_replace('-', '_', $str);
1055 // Return converted string
1060 * Marks up the code by adding e.g. line numbers
1062 * @param $phpCode Unmarked PHP code
1063 * @return $markedCode Marked PHP code
1065 public function markupCode ($phpCode) {
1070 $errorArray = error_get_last();
1072 // Init the code with error message
1073 if (is_array($errorArray)) {
1075 $markedCode = sprintf('<div id="error_header">File: <span id="error_data">%s</span>, Line: <span id="error_data">%s</span>, Message: <span id="error_data">%s</span>, Type: <span id="error_data">%s</span></div>',
1076 basename($errorArray['file']),
1077 $errorArray['line'],
1078 $errorArray['message'],
1083 // Add line number to the code
1084 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1086 $markedCode .= sprintf('<span id="code_line">%s</span>: %s' + chr(10),
1088 htmlentities($code, ENT_QUOTES)
1097 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1098 * beatiful for web-based front-ends. If null is given a message id
1099 * null_timestamp will be resolved and returned.
1101 * @param $timestamp Timestamp to prepare (filter) for display
1102 * @return $readable A readable timestamp
1104 public function doFilterFormatTimestamp ($timestamp) {
1105 // Default value to return
1108 // Is the timestamp null?
1109 if (is_null($timestamp)) {
1110 // Get a message string
1111 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1113 switch ($this->getLanguageInstance()->getLanguageCode()) {
1114 case 'de': // German format is a bit different to default
1115 // Split the GMT stamp up
1116 $dateTime = explode(' ', $timestamp );
1117 $dateArray = explode('-', $dateTime[0]);
1118 $timeArray = explode(':', $dateTime[1]);
1120 // Construct the timestamp
1121 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1131 default: // Default is pass-through
1132 $readable = $timestamp;
1142 * Filter a given number into a localized number
1144 * @param $value The raw value from e.g. database
1145 * @return $localized Localized value
1147 public function doFilterFormatNumber ($value) {
1148 // Generate it from config and localize dependencies
1149 switch ($this->getLanguageInstance()->getLanguageCode()) {
1150 case 'de': // German format is a bit different to default
1151 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1154 default: // US, etc.
1155 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1164 * "Getter" for databse entry
1166 * @return $entry An array with database entries
1167 * @throws NullPointerException If the database result is not found
1168 * @throws InvalidDatabaseResultException If the database result is invalid
1170 protected final function getDatabaseEntry () {
1171 // Is there an instance?
1172 if (is_null($this->getResultInstance())) {
1173 // Throw an exception here
1174 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1178 $this->getResultInstance()->rewind();
1180 // Do we have an entry?
1181 if ($this->getResultInstance()->valid() === false) {
1182 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1186 $this->getResultInstance()->next();
1189 $entry = $this->getResultInstance()->current();
1196 * Getter for field name
1198 * @param $fieldName Field name which we shall get
1199 * @return $fieldValue Field value from the user
1200 * @throws NullPointerException If the result instance is null
1202 public final function getField ($fieldName) {
1203 // Default field value
1206 // Get result instance
1207 $resultInstance = $this->getResultInstance();
1209 // Is this instance null?
1210 if (is_null($resultInstance)) {
1211 // Then the user instance is no longer valid (expired cookies?)
1212 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1215 // Get current array
1216 $fieldArray = $resultInstance->current();
1217 //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
1219 // Does the field exist?
1220 if (isset($fieldArray[$fieldName])) {
1222 $fieldValue = $fieldArray[$fieldName];
1230 * Protected setter for user instance
1232 * @param $userInstance An instance of a user class
1235 protected final function setUserInstance (ManageableAccount $userInstance) {
1236 $this->userInstance = $userInstance;
1240 * Getter for user instance
1242 * @return $userInstance An instance of a user class
1244 public final function getUserInstance () {
1245 return $this->userInstance;
1249 * Setter for controller instance (this surely breaks a bit the MVC patterm)
1251 * @param $controllerInstance An instance of the controller
1254 public final function setControllerInstance (Controller $controllerInstance) {
1255 $this->controllerInstance = $controllerInstance;
1259 * Getter for controller instance (this surely breaks a bit the MVC patterm)
1261 * @return $controllerInstance An instance of the controller
1263 public final function getControllerInstance () {
1264 return $this->controllerInstance;
1268 * Flushs all pending updates to the database layer
1272 public function flushPendingUpdates () {
1273 // Get result instance
1274 $resultInstance = $this->getResultInstance();
1276 // Do we have data to update?
1277 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1278 // Get wrapper class name config entry
1279 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1281 // Create object instance
1282 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1284 // Yes, then send the whole result to the database layer
1285 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1290 * Outputs a deprecation warning to the developer.
1292 * @param $message The message we shall output to the developer
1294 * @todo Write a logging mechanism for productive mode
1296 public function deprecationWarning ($message) {
1297 // Is developer mode active?
1298 if (defined('DEVELOPER')) {
1299 // Debug instance is there?
1300 if (!is_null($this->getDebugInstance())) {
1301 // Output stub message
1302 $this->debugOutput($message);
1305 trigger_error($message . "<br />\n");
1308 // @TODO Finish this part!
1309 $this->partialStub('Developer mode inactive. Message:' . $message);
1314 * Checks wether the given PHP extension is loaded
1316 * @param $phpExtension The PHP extension we shall check
1317 * @return $isLoaded Wether the PHP extension is loaded
1319 public final function isPhpExtensionLoaded ($phpExtension) {
1321 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1328 * Setter for RNG instance
1330 * @param $rngInstance An instance of a random number generator (RNG)
1333 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
1334 $this->rngInstance = $rngInstance;
1338 * Getter for RNG instance
1340 * @return $rngInstance An instance of a random number generator (RNG)
1342 public final function getRngInstance () {
1343 return $this->rngInstance;
1347 * Setter for Cryptable instance
1349 * @param $cryptoInstance An instance of a Cryptable class
1352 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
1353 $this->cryptoInstance = $cryptoInstance;
1357 * Getter for Cryptable instance
1359 * @return $cryptoInstance An instance of a Cryptable class
1361 public final function getCryptoInstance () {
1362 return $this->cryptoInstance;
1366 * Setter for Iterator instance
1368 * @param $iteratorInstance An instance of an Iterator
1371 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1372 $this->iteratorInstance = $iteratorInstance;
1376 * Getter for Iterator instance
1378 * @return $iteratorInstance An instance of an Iterator
1380 public final function getIteratorInstance () {
1381 return $this->iteratorInstance;
1385 * "Getter" as a time() replacement but with milliseconds. You should use this
1386 * method instead of the encapsulated getimeofday() function.
1388 * @return $milliTime Timestamp with milliseconds
1390 public function getMilliTime () {
1391 // Get the time of day as float
1392 $milliTime = gettimeofday(true);
1399 * Idles (sleeps) for given milliseconds
1401 * @return $hasSlept Wether it goes fine
1403 public function idle ($milliSeconds) {
1404 // Sleep is fine by default
1407 // Idle so long with found function
1408 if (function_exists('time_sleep_until')) {
1409 // Get current time and add idle time
1410 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1412 // New PHP 5.1.0 function found, ignore errors
1413 $hasSlept = @time_sleep_until($sleepUntil);
1416 * My Sun station doesn't have that function even with latest PHP
1419 usleep($milliSeconds * 1000);
1427 * Setter for the list instance
1429 * @param $listInstance A list of Listable
1432 protected final function setListInstance (Listable $listInstance) {
1433 $this->listInstance = $listInstance;
1437 * Getter for the list instance
1439 * @return $listInstance A list of Listable
1441 protected final function getListInstance () {
1442 return $this->listInstance;
1446 * Setter for the menu instance
1448 * @param $menuInstance A RenderableMenu instance
1451 protected final function setMenuInstance (RenderableMenu $menuInstance) {
1452 $this->menuInstance = $menuInstance;
1456 * Getter for the menu instance
1458 * @return $menuInstance A RenderableMenu instance
1460 protected final function getMenuInstance () {
1461 return $this->menuInstance;
1465 * Setter for image instance
1467 * @param $imageInstance An instance of an image
1470 public final function setImageInstance (BaseImage $imageInstance) {
1471 $this->imageInstance = $imageInstance;
1475 * Getter for image instance
1477 * @return $imageInstance An instance of an image
1479 public final function getImageInstance () {
1480 return $this->imageInstance;
1484 * Setter for stacker instance
1486 * @param $stackerInstance An instance of an stacker
1489 public final function setStackerInstance (Stackable $stackerInstance) {
1490 $this->stackerInstance = $stackerInstance;
1494 * Getter for stacker instance
1496 * @return $stackerInstance An instance of an stacker
1498 public final function getStackerInstance () {
1499 return $this->stackerInstance;
1503 * Setter for compressor instance
1505 * @param $compressorInstance An instance of an compressor
1508 public final function setCompressorInstance (Compressor $compressorInstance) {
1509 $this->compressorInstance = $compressorInstance;
1513 * Getter for compressor instance
1515 * @return $compressorInstance An instance of an compressor
1517 public final function getCompressorInstance () {
1518 return $this->compressorInstance;
1522 * Setter for Parseable instance
1524 * @param $parserInstance An instance of an Parseable
1527 public final function setParserInstance (Parseable $parserInstance) {
1528 $this->parserInstance = $parserInstance;
1532 * Getter for Parseable instance
1534 * @return $parserInstance An instance of an Parseable
1536 public final function getParserInstance () {
1537 return $this->parserInstance;
1541 * Setter for ProtocolHandler instance
1543 * @param $protocolInstance An instance of an ProtocolHandler
1546 public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
1547 $this->protocolInstance = $protocolInstance;
1551 * Getter for ProtocolHandler instance
1553 * @return $protocolInstance An instance of an ProtocolHandler
1555 public final function getProtocolInstance () {
1556 return $this->protocolInstance;
1560 * Setter for BaseDatabaseWrapper instance
1562 * @param $wrapperInstance An instance of an BaseDatabaseWrapper
1565 public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) {
1566 $this->wrapperInstance = $wrapperInstance;
1570 * Getter for BaseDatabaseWrapper instance
1572 * @return $wrapperInstance An instance of an BaseDatabaseWrapper
1574 public final function getWrapperInstance () {
1575 return $this->wrapperInstance;
1579 * Setter for socket resource
1581 * @param $socketResource A valid socket resource
1584 public final function setSocketResource ($socketResource) {
1585 $this->socketResource = $socketResource;
1589 * Getter for socket resource
1591 * @return $socketResource A valid socket resource
1593 public function getSocketResource () {
1594 return $this->socketResource;
1598 * Setter for helper instance
1600 * @param $helperInstance An instance of a helper class
1603 protected final function setHelperInstance (Helper $helperInstance) {
1604 $this->helperInstance = $helperInstance;
1608 * Getter for helper instance
1610 * @return $helperInstance An instance of a helper class
1612 public final function getHelperInstance () {
1613 return $this->helperInstance;
1617 * Setter for a Sourceable instance
1619 * @param $sourceInstance The Sourceable instance
1622 protected final function setSourceInstance (Sourceable $sourceInstance) {
1623 $this->sourceInstance = $sourceInstance;
1627 * Getter for a Sourceable instance
1629 * @return $sourceInstance The Sourceable instance
1631 protected final function getSourceInstance () {
1632 return $this->sourceInstance;
1636 * Getter for a InputStreamable instance
1638 * @param $inputStreamInstance The InputStreamable instance
1640 protected final function getInputStreamInstance () {
1641 return $this->inputStreamInstance;
1645 * Setter for a InputStreamable instance
1647 * @param $inputStreamInstance The InputStreamable instance
1650 protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
1651 $this->inputStreamInstance = $inputStreamInstance;
1655 * Getter for a OutputStreamable instance
1657 * @param $outputStreamInstance The OutputStreamable instance
1659 protected final function getOutputStreamInstance () {
1660 return $this->outputStreamInstance;
1664 * Setter for a OutputStreamable instance
1666 * @param $outputStreamInstance The OutputStreamable instance
1669 protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
1670 $this->outputStreamInstance = $outputStreamInstance;
1674 * Setter for handler instance
1676 * @param $handlerInstance An instance of a Handleable class
1679 protected final function setHandlerInstance (Handleable $handlerInstance) {
1680 $this->handlerInstance = $handlerInstance;
1684 * Getter for handler instance
1686 * @return $handlerInstance A Networkable instance
1688 protected final function getHandlerInstance () {
1689 return $this->handlerInstance;
1693 * Setter for visitor instance
1695 * @param $visitorInstance A Visitor instance
1698 protected final function setVisitorInstance (Visitor $visitorInstance) {
1699 $this->visitorInstance = $visitorInstance;
1703 * Getter for visitor instance
1705 * @return $visitorInstance A Visitor instance
1707 protected final function getVisitorInstance () {
1708 return $this->visitorInstance;
1712 * Setter for raw package Data
1714 * @param $packageData Raw package Data
1717 public final function setPackageData (array $packageData) {
1718 $this->packageData = $packageData;
1722 * Getter for raw package Data
1724 * @return $packageData Raw package Data
1726 public function getPackageData () {
1727 return $this->packageData;
1731 * Converts a hexadecimal string, even with negative sign as first string to
1732 * a decimal number using BC functions.
1734 * This work is based on comment #86673 on php.net documentation page at:
1735 * <http://de.php.net/manual/en/function.dechex.php#86673>
1737 * @param $hex Hexadecimal string
1738 * @return $dec Decimal number
1740 protected function hex2dec ($hex) {
1741 // Convert to all lower-case
1742 $hex = strtolower($hex);
1744 // Detect sign (negative/positive numbers)
1746 if (substr($hex, 0, 1) == '-') {
1748 $hex = substr($hex, 1);
1751 // Decode the hexadecimal string into a decimal number
1753 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
1754 $factor = self::$hexdec[substr($hex, $i, 1)];
1755 $dec = bcadd($dec, bcmul($factor, $e));
1758 // Return the decimal number
1759 return $sign . $dec;
1763 * Converts even very large decimal numbers, also with negative sign, to a
1764 * hexadecimal string.
1766 * This work is based on comment #97756 on php.net documentation page at:
1767 * <http://de.php.net/manual/en/function.hexdec.php#97756>
1769 * @param $dec Decimal number, even with negative sign
1770 * @param $maxLength Optional maximum length of the string
1771 * @return $hex Hexadecimal string
1773 protected function dec2hex ($dec, $maxLength = 0) {
1774 // maxLength can be zero or devideable by 2
1775 assert(($maxLength == 0) || (($maxLength % 2) == 0));
1777 // Detect sign (negative/positive numbers)
1784 // Encode the decimal number into a hexadecimal string
1787 $hex = self::$dechex[($dec % 16)] . $hex;
1789 } while ($dec >= 1);
1792 * We need hexadecimal strings with leading zeros if the length cannot
1795 if ($maxLength > 0) {
1796 // Prepend more zeros
1797 $hex = $this->prependStringToString($hex, '0', $maxLength);
1798 } elseif ((strlen($hex) % 2) != 0) {
1802 // Return the hexadecimal string
1803 return $sign . $hex;
1807 * Converts a ASCII string (0 to 255) into a decimal number.
1809 * @param $asc The ASCII string to be converted
1810 * @return $dec Decimal number
1812 protected function asc2dec ($asc) {
1813 // Convert it into a hexadecimal number
1814 $hex = bin2hex($asc);
1816 // And back into a decimal number
1817 $dec = $this->hex2dec($hex);
1824 * Converts a decimal number into an ASCII string.
1826 * @param $dec Decimal number
1827 * @return $asc An ASCII string
1829 protected function dec2asc ($dec) {
1830 // First convert the number into a hexadecimal string
1831 $hex = $this->dec2hex($dec);
1833 // Then convert it into the ASCII string
1834 $asc = $this->hex2asc($hex);
1841 * Converts a hexadecimal number into an ASCII string. Negative numbers
1844 * @param $hex Hexadecimal string
1845 * @return $asc An ASCII string
1847 protected function hex2asc ($hex) {
1848 // Check for length, it must be devideable by 2
1849 //* DEBUG: */ $this->debugOutput('hex='.$hex);
1850 assert((strlen($hex) % 2) == 0);
1854 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
1855 // Get the decimal number of the chunk
1856 $part = hexdec(substr($hex, $idx, 2));
1858 // Add it to the final string
1862 // Return the final string
1867 * Prepends a given string $prepend to $str with a given total length
1869 * @param $str Given original string which should be prepended
1870 * @param $prepend The string to prepend
1871 * @param $length Total length of the final string
1872 * @return $strFinal Final prepended string
1874 protected function prependStringToString ($str, $prepend, $length) {
1875 // Set final string to original string by default
1879 if (strlen($str) < $length) {
1880 // Difference between total length and length of original string
1881 $diff = $length - strlen($str);
1883 // Prepend the string
1884 $prepend = str_repeat($prepend, ($diff / strlen($prepend) + 1));
1886 // Make sure it will definedly fit
1887 assert(strlen($prepend) >= $diff);
1889 // Cut it a little down
1890 $prepend = substr($prepend, 0, $diff);
1891 //* DEBUG: */ $this->debugOutput('prepend('.strlen($prepend).')='.$prepend.',diff='.$diff.',length='.$length);
1893 // Construct the final prepended string
1894 $strFinal = $prepend . $str;
1902 * Checks wether the given encoded data was encoded with Base64
1904 * @param $encodedData Encoded data we shall check
1905 * @return $isBase64 Wether the encoded data is Base64
1907 protected function isBase64Encoded ($encodedData) {
1909 $isBase64 = (@base64_decode($encodedData, true) !== false);
1916 * "Getter" to get response/request type from analysis of the system.
1918 * @return $responseType Analyzed response type
1920 protected function getResponseTypeFromSystem () {
1921 // Default is console
1922 $responseType = 'console';
1924 // Is 'HTTP_HOST' set?
1925 if (isset($_SERVER['HTTP_HOST'])) {
1926 // Then it is a HTTP response/request
1927 $responseType = 'http';
1931 return $responseType;
1935 * Gets a cache key from Criteria instance
1937 * @param $criteriaInstance An instance of a Criteria class
1938 * @param $onlyKeys Only use these keys for a cache key
1939 * @return $cacheKey A cache key suitable for lookup/storage purposes
1941 protected function getCacheKeyByCriteria (Criteria $criteriaInstance, $onlyKeys = array()) {
1943 $cacheKey = sprintf("%s@%s",
1944 $this->__toString(),
1945 $criteriaInstance->getCacheKey($onlyKeys)
1949 //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
1954 * Getter for startup time in miliseconds
1956 * @return $startupTime Startup time in miliseconds
1958 protected function getStartupTime () {
1959 return self::$startupTime;
1963 * "Getter" for a printable currently execution time in nice braces
1965 * @return $executionTime Current execution time in nice braces
1967 protected function getPrintableExecutionTime () {
1968 // Caculate the execution time
1969 $executionTime = microtime(true) - $this->getStartupTime();
1971 // Pack it in nice braces
1972 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
1975 return $executionTime;
1979 * Hashes a given string with a simple but stronger hash function (no salts)
1981 * @param $str The string to be hashed
1982 * @return $hash The hash from string $str
1984 public function hashString ($str) {
1985 // Hash given string with (better secure) hasher
1986 $hash = mhash(MHASH_SHA256, $str);
1993 * Checks whether the given number is really a number (only chars 0-9).
1995 * @param $num A string consisting only chars between 0 and 9
1996 * @param $castValue Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
1997 * @param $assertMismatch Whether to assert mismatches
1998 * @return $ret The (hopefully) secured numbered value
2000 public function bigintval ($num, $castValue = true, $assertMismatch = false) {
2001 // Filter all numbers out
2002 $ret = preg_replace('/[^0123456789]/', '', $num);
2005 if ($castValue === true) {
2006 // Cast to biggest numeric type
2007 $ret = (double) $ret;
2010 // Assert only if requested
2011 if ($assertMismatch === true) {
2012 // Has the whole value changed?
2013 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));