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, this is free software
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 * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
29 * @see DebugConsoleOutput
32 private static $debug = null;
35 * The instance to the web output handler (should be WebOutput)
39 private static $webOutput = null;
42 * The instance to the compression layer which should be CompressorChannel
44 private static $compressor = null;
47 * The configuration instance which shall be FrameworkConfiguration
49 private static $cfgInstance = null;
52 * The instance to the database layer which should be DatabaseConnection
54 private $dbInstance = null;
57 * Instance to an application helper class
59 private $applicationInstance = null;
64 private $realClass = "FrameworkSystem";
67 * A human-readable description for this simulator part
69 private $objectDescription = "Namenlose Framework-Einheit";
72 * The unique ID string for identifying all type of classes
74 private $uniqueID = "";
79 private $thousands = "."; // German
84 private $decimals = ","; // German
87 * The language instance for the template loader
89 private $langInstance = null;
92 * The file I/O instance for the template loader
94 private $fileIOInstance = null;
96 /***********************
97 * Exception codes.... *
98 ***********************/
100 const EXCEPTION_IS_NULL_POINTER = 0x001;
101 const EXCEPTION_IS_NO_OBJECT = 0x002;
102 const EXCEPTION_IS_NO_ARRAY = 0x003;
103 const EXCEPTION_MISSING_METHOD = 0x004;
104 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
105 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
106 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
107 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
108 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
109 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
110 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
111 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
112 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
113 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
114 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
115 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
116 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
117 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
118 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
119 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
120 const EXCEPTION_PATH_NOT_FOUND = 0x015;
121 const EXCEPTION_INVALID_PATH_NAME = 0x016;
122 const EXCEPTION_READ_PROTECED_PATH = 0x017;
123 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
124 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
125 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
126 const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
127 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
128 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
129 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
130 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
131 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
132 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
133 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
134 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
135 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
136 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
137 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
138 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
139 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
140 const EXCEPTION_INVALID_STRING = 0x029;
141 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
142 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
143 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
144 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
145 const EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e;
146 const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
147 const EXCEPTION_MISSING_ELEMENT = 0x030;
148 const EXCEPTION_INVALID_COMMAND = 0x031;
149 const EXCEPTION_INVALID_CONTROLLER = 0x032;
150 const EXCEPTION_HEADERS_ALREADY_SENT = 0x033;
151 const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x034;
152 const EXCEPTION_CLASS_NOT_FOUND = 0x035;
153 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x036;
156 * In the super constructor these system classes shall be ignored or else
157 * we would get an endless calling loop.
159 *--------------------------------------------------------------------*
160 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
161 *--------------------------------------------------------------------*
163 private $systemClasses = array(
164 "DebugMiddleware", // Debug middleware output sub-system
165 "DebugWebOutput", // Debug web output sub-system
166 "DebugConsoleOutput", // Debug console output sub-system
167 "DebugErrorLogOutput", // Debug error_log() output sub-system
168 "CompressorChannel", // Compressor sub-system
169 "FrameworkDirectoryPointer", // Directory handler sub-system
170 "NullCompressor", // Null compressor
171 "Bzip2Compressor", // BZIP2 compressor
172 "GzipCompressor", // GZIP compressor
173 "WebOutput", // Web output sub-system
177 * Private super constructor
181 protected function __construct ($class) {
183 $this->setRealClass($class);
185 // Init this instance
186 $this->initInstance($class);
190 * Destructor reached...
194 public function __destruct() {
195 // Is this object already destroyed?
196 if ($this->__toString() != "DestructedObject") {
198 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
199 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
200 __CLASS__, $this->__toString()
204 // Destroy all informations about this class but keep some text about it alive
205 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
206 $this->setRealClass("DestructedObject");
207 $this->resetUniqueID();
208 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
209 // Already destructed object
210 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
211 __CLASS__, $this->__toString()
217 * The call method where all non-implemented methods end up
221 public final function __call ($methodName, $args) {
222 // Implode all given arguments
226 $argsString = "NULL";
227 } elseif (is_array($args)) {
228 // Some arguments are there
229 foreach ($args as $arg) {
233 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
234 } elseif (is_int($arg)) {
236 $argsString .= $arg."(int)";
237 } elseif (is_float($arg)) {
239 $argsString .= $arg."(float)";
240 } elseif ($arg instanceof BaseFrameworkSystem) {
241 // Own object instance
242 $argsString .= $arg->__toString()."(Object)";
243 } elseif (is_object($arg)) {
245 $argsString .= "unknown object(!)";
246 } elseif (is_array($arg)) {
248 $argsString .= "Array(array)";
249 } elseif (is_string($arg)) {
251 $argsString .= "\"".$arg."\"(string)";
252 } elseif (is_null($arg)) {
254 $argsString .= "(null)";
256 // Unknown type (please report!)
257 $argsString .= $arg."(unknown!)";
265 if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
267 // Invalid arguments!
268 $argsString = sprintf("!INVALID:%s!", $args);
271 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
282 * Initializes the instance
286 public function initInstance ($class) {
287 // Get the current (singleton) configuration instance
288 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
290 // Is the class weather debug nor compressor channel?
291 if (!in_array($class, $this->systemClasses)) {
292 // Initialize debug instance
293 if (is_null($this->getDebugInstance())) {
294 // Set the debug output system if it is not debug class ;)
295 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
298 // Initialize web instance
299 if ((is_null($this->getWebOutputInstance())) && ($this->__toString() != "ObjectFactory")) {
300 // Call our object factory
301 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
303 // And set the instance
304 $this->setWebOutputInstance($outputInstance);
307 // Initialize compressor channel
308 if (is_null($this->getCompressorChannel())) {
309 // Set the compressor channel
310 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
312 $this->getConfigInstance()->readConfig('compressor_base_path')
316 // Initialize database middleware
317 if (is_null($this->getDatabaseInstance())) {
318 // Get the middleware instance
319 $db = DatabaseConnection::getInstance();
320 if (is_object($db)) {
321 // Set the database middleware
322 $this->setDatabaseInstance($db);
329 * Setter for language instance
331 * @param $configInstance The configuration instance which shall
332 * be FrameworkConfiguration
335 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
336 self::$cfgInstance = $configInstance;
340 * Getter for configuration instance
342 * @return $cfhInstance - Configuration instance
344 protected final function getConfigInstance () {
345 return self::$cfgInstance;
349 * Setter for debug instance
351 * @param $debugInstance The instance for debug output class
354 public final function setDebugInstance (DebugMiddleware $debugInstance) {
355 self::$debug = $debugInstance;
359 * Getter for debug instance
361 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
363 public final function getDebugInstance () {
368 * Setter for web output instance
370 * @param $webInstance The instance for web output class
373 public final function setWebOutputInstance (OutputStreamer $webInstance) {
374 self::$webOutput = $webInstance;
378 * Getter for web output instance
380 * @return $webOutput - Instance to class WebOutput
382 public final function getWebOutputInstance () {
383 return self::$webOutput;
387 * Static setter for database instance
389 * @param $dbInstance The instance for the database connection
390 * (forced DatabaseConnection)
393 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
394 $this->dbInstance = $dbInstance;
398 * Getter for $realClass
400 * @return $realClass The name of the real class (not BaseFrameworkSystem)
402 public final function __toString () {
403 return $this->realClass;
407 * Setter for the real class name
409 * @param $realClass Class name (string)
412 public final function setRealClass ($realClass) {
414 $realClass = (string) $realClass;
417 $this->realClass = $realClass;
421 * Generate unique ID from a lot entropy
425 public final function generateUniqueId () {
426 // Existiert noch keine?
427 if (empty($this->uniqueID)) {
429 // Correct missing class name
431 if ($this->__toString() == "") {
432 $this->setRealClass(__CLASS__);
439 // Generate a unique ID number
440 $tempID = $this->generateIdNumber();
443 // Try to figure out if the ID number is not yet used
445 if (is_object($this->getDatabaseInstance())) {
446 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
448 } catch (FrameworkException $e) {
449 // Catches all and ignores all ;-)
457 $this->getDatabaseInstance() === null
460 is_object($this->getDatabaseInstance())
473 $this->setUniqueID($tempID);
475 // Revert maybe corrected class name
477 $this->setRealClass("");
480 // Remove system classes if we are in a system class
481 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
482 // This may save some RAM...
483 $this->removeSystemArray();
489 * Generates a new ID number for classes based from the class' real name,
490 * the description and some random data
492 * @return $tempID The new (temporary) ID number
494 private final function generateIdNumber () {
495 return sprintf("%s@%s",
497 md5(sprintf("%s:%s:%s:%s:%s:%s",
499 $this->getObjectDescription(),
501 getenv('REMOTE_ADDR'),
502 getenv('SERVER_ADDR'),
509 * Setter for unique ID
511 * @param $uniqueID The newly generated unique ID number
514 private final function setUniqueID ($uniqueID) {
516 $uniqueID = (string) $uniqueID;
519 $this->uniqueID = $uniqueID;
523 * Getter for unique ID
525 * @return $uniqueID The unique ID of this class
527 public final function getUniqueID () {
528 return $this->uniqueID;
532 * Resets or recreates the unique ID number
536 public final function resetUniqueID() {
537 // Sweet and simple... ;-)
538 $newUniqueID = $this->generateIdNumber();
539 $this->setUniqueID($newUniqueID);
543 * Getter for simulator description
545 * @return $objectDescription The description of this simulation part
547 public final function getObjectDescription () {
548 if (isset($this->objectDescription)) {
549 return $this->objectDescription;
556 * Setter for simulation part description
558 * @param $objectDescription The description as string for this simulation part
561 public final function setObjectDescription ($objectDescription) {
562 $this->objectDescription = (String) $objectDescription;
566 * Validate if given object is the same as current
568 * @param $object An object instance for comparison with this class
569 * @return boolean The result of comparing both's unique ID
571 public final function equals ($object) {
572 return ($this->getUniqueID() == $object->getUniqueID());
576 * Compare if both simulation part description and class name matches
579 * @param $itemInstance An object instance to an other class
580 * @return boolean The result of comparing class name simulation part description
582 public function itemMatches ($itemInstance) {
585 $this->__toString() == $itemInstance->__toString()
587 $this->getObjectDescription() == $itemInstance->getObjectDescription()
593 * Compare class name of this and given class name
595 * @param $class The class name as string from the other class
596 * @return boolean The result of comparing both class names
598 public final function isClass ($class) {
599 return ($this->__toString() == $class);
603 * Stub method (only real cabins shall override it)
605 * @return boolean false = is no cabin, true = is a cabin
607 public function isCabin () {
612 * Stub method for tradeable objects
614 * @return boolean false = is not tradeable by the Merchant class,
615 * true = is a tradeable object
617 public function isTradeable () {
622 * Formats computer generated price values into human-understandable formats
623 * with thousand and decimal seperators.
625 * @param $value The in computer format value for a price
626 * @param $currency The currency symbol (use HTML-valid characters!)
627 * @param $decNum Number of decimals after commata
628 * @return $price The for the current language formated price string
629 * @throws MissingDecimalsThousandsSeperatorException If decimals or
630 * thousands seperator
633 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
634 // Are all required attriutes set?
635 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
636 // Throw an exception
637 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
641 $value = (float) $value;
643 // Reformat the US number
644 $price = sprintf("%s %s",
645 number_format($value, $decNum, $this->decimals, $this->thousands),
649 // Return as string...
654 * Removes number formating characters
658 public final function removeNumberFormaters () {
659 unset($this->thousands);
660 unset($this->decimals);
664 * Getter for database layer
666 * @return $dbInstance The database layer instance
668 public final function getDatabaseInstance () {
669 return $this->dbInstance;
673 * Setter for compressor channel
675 * @param $compressorChannel An instance of CompressorChannel
678 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
679 self::$compressor = $compressorChannel;
683 * Getter for compressor channel
685 * @return $compressor The compressor channel
687 public final function getCompressorChannel () {
688 return self::$compressor;
692 * Remove the $systemClasses array from memory
696 public final function removeSystemArray () {
697 unset($this->systemClasses);
701 * Create a file name and path name from the object's unique ID number.
702 * The left part of the ID shall always be a valid class name and the
703 * right part an ID number.
705 * @return $pfn The file name with a prepended path name
706 * @throws NoArrayCreatedException If explode() fails to create an array
707 * @throws InvalidArrayCountException If the array contains less or
708 * more than two elements
710 public final function getPathFileNameFromObject () {
711 // Get the main object's unique ID. We use this as a path/filename combination
712 $pathFile = $this->getUniqueID();
714 // Split it up in path and file name
715 $pathFile = explode("@", $pathFile);
717 // Are there two elements? Index 0 is the path, 1 the file name + global extension
718 if (!is_array($pathFile)) {
720 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
721 } elseif (count($pathFile) != 2) {
722 // Invalid ID returned!
723 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
726 // Auto-append missing trailing slash
727 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
729 // Create the file name and return it
730 $pfn = ($pathFile[0] . $pathFile[1]);
735 * Appends a trailing slash to a string
737 * @param $str A string (maybe) without trailing slash
738 * @return $str A string with an auto-appended trailing slash
740 public final function addMissingTrailingSlash ($str) {
741 // Is there a trailing slash?
742 if (substr($str, -1, 1) != "/") $str .= "/";
747 * Private getter for language instance
749 * @return $langInstance An instance to the language sub-system
751 protected final function getLanguageInstance () {
752 return $this->langInstance;
756 * Setter for language instance
758 * @param $langInstance An instance to the language sub-system
760 * @see LanguageSystem
762 public final function setLanguageInstance (ManageableLanguage $langInstance) {
763 $this->langInstance = $langInstance;
767 * Private getter for file IO instance
769 * @return $fileIOInstance An instance to the file I/O sub-system
771 protected final function getFileIoInstance () {
772 return $this->fileIOInstance;
776 * Setter for file I/O instance
778 * @param $fileIOInstance An instance to the file I/O sub-system
781 public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
782 $this->fileIOInstance = $fileIOInstance;
786 * Protected getter for a manageable application helper class
788 * @return $applicationInstance An instance of a manageable application helper class
790 protected final function getApplicationInstance () {
791 return $this->applicationInstance;
795 * Setter for a manageable application helper class
797 * @param $applicationInstance An instance of a manageable application helper class
800 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
801 $this->applicationInstance = $applicationInstance;
805 * Prepare the template engine (TemplateEngine by default) for a given
806 * application helper instance (ApplicationHelper by default).
808 * @param $appInstance An application helper instance or
809 * null if we shall use the default
810 * @return $tplEngine The template engine instance
811 * @throws NullPointerException If the template engine could not
813 * @throws UnsupportedTemplateEngineException If $tplEngine is an
814 * unsupported template engine
815 * @throws MissingLanguageHandlerException If the language sub-system
816 * is not yet initialized
817 * @throws NullPointerException If the discovered application
818 * instance is still null
820 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
821 // Is the application instance set?
822 if (is_null($appInstance)) {
823 // Get the current instance
824 $appInstance = $this->getApplicationInstance();
827 if (is_null($appInstance)) {
828 // Thrown an exception
829 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
833 // Generate FQFN for all application templates
834 $fqfn = sprintf("%s%s/%s/%s",
836 $this->getConfigInstance()->readConfig('application_path'),
837 strtolower($appInstance->getAppShortName()),
838 $this->getConfigInstance()->readConfig('tpl_base_path')
841 // Are both instances set?
842 if ($appInstance->getLanguageInstance() === null) {
843 // Invalid language instance
844 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
845 } elseif ($appInstance->getFileIoInstance() === null) {
846 // Invalid language instance
847 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
850 // Initialize the template engine
851 $tplEngine = ObjectFactory::createObjectByConfiguredName('tpl_engine', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
853 // Return the prepared instance
858 * Debugs this instance by putting out it's full content
862 public final function debugInstance () {
863 // Generate the output
864 $content = sprintf("<pre>%s</pre>",
865 trim(print_r($this, true))
869 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
873 * Output a partial stub message for the caller method
875 * @param $message An optional message to display
878 protected function partialStub ($message = "") {
880 $backtrace = debug_backtrace();
882 // Generate the class::method string
883 $methodName = "UnknownClass::unknownMethod";
884 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
885 $methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
888 // Construct the full message
889 $stubMessage = sprintf("[%s:] Partial stub!",
893 // Is the extra message given?
894 if (!empty($message)) {
895 // Then add it as well
896 $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
899 // Debug instance is there?
900 if (!is_null($this->getDebugInstance())) {
901 // Output stub message
902 $this->getDebugInstance()->output($stubMessage);
905 trigger_error($stubMessage."<br />\n");
910 * Converts e.g. a command from URL to a valid class by keeping out bad characters
912 * @param $str The string, what ever it is needs to be converted
913 * @return $className Generated class name
915 public function convertToClassName ($str) {
917 foreach (explode("_", $str) as $strPart) {
918 $className .= ucfirst(strtolower($strPart));
924 * Outputs a debug backtrace and stops further script execution
928 public function debugBacktrace () {
929 // Sorry, there is no other way getting this nice backtrace
931 debug_print_backtrace();