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.mxchange.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;
59 private $realClass = "FrameworkSystem";
62 * A human-readable description for this simulator part
64 private $partDescr = "Namenlose Framework-Einheit";
67 * The unique ID string for identifying all type of classes
69 private $uniqueID = "";
74 private $thousands = "."; // German
79 private $decimals = ","; // German
81 /***********************
82 * Exception codes.... *
83 ***********************/
85 const EXCEPTION_IS_NULL_POINTER = 0x001;
86 const EXCEPTION_IS_NO_OBJECT = 0x002;
87 const EXCEPTION_IS_NO_ARRAY = 0x003;
88 const EXCEPTION_MISSING_METHOD = 0x004;
89 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
90 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
91 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
92 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
93 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
94 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
95 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
96 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
97 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
98 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
99 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
100 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
101 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
102 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
103 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
104 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
105 const EXCEPTION_PATH_NOT_FOUND = 0x015;
106 const EXCEPTION_INVALID_PATH_NAME = 0x016;
107 const EXCEPTION_READ_PROTECED_PATH = 0x017;
108 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
109 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
110 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
111 const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
112 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
113 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
114 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
115 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
116 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
117 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
118 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
119 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
120 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
121 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
122 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
123 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
124 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
125 const EXCEPTION_INVALID_STRING = 0x029;
126 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
127 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
128 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
129 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
132 * In the super constructor these system classes shall be ignored or else
133 * we would get an endless calling loop.
135 *--------------------------------------------------------------------*
136 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
137 *--------------------------------------------------------------------*
139 private $systemClasses = array(
140 "DebugMiddleware", // Debug middleware output sub-system
141 "DebugWebOutput", // Debug web output sub-system
142 "DebugConsoleOutput", // Debug console output sub-system
143 "DebugErrorLogOutput", // Debug error_log() output sub-system
144 "CompressorChannel", // Compressor sub-system
145 "FrameworkDirectoryPointer", // Directory handler sub-system
146 "NullCompressor", // Null compressor
147 "Bzip2Compressor", // BZIP2 compressor
148 "GzipCompressor", // GZIP compressor
149 "WebOutput", // Web output sub-system
153 * Private super constructor
157 private function __construct ($class) {
159 $this->setRealClass($class);
163 * Destructor reached...
167 public function __destruct() {
168 // Is this object already destroyed?
169 if ($this->__toString() != "DestructedObject") {
171 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
172 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
173 __CLASS__, $this->__toString()
177 // Destroy all informations about this class but keep some text about it alive
178 $this->setPartDescr(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
179 $this->setRealClass("DestructedObject");
180 $this->resetUniqueID();
181 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
182 // Already destructed object
183 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
184 __CLASS__, $this->__toString()
190 * The call method where all non-implemented methods end up
194 public final function __call ($methodName, $args) {
195 // Implode all given arguments
196 $argsString = implode("|", $args);
197 if (empty($argsString)) $argsString = "NULL";
199 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
210 * Public constructor (for initializing things, etc.)
214 public function constructor ($class) {
216 $this->__construct($class);
218 // Get the current (singleton) configuration instance
219 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
221 // Is the class weather debug nor compressor channel?
222 if (!in_array($class, $this->systemClasses)) {
223 // Initialize debug instance
224 if (is_null($this->getDebugInstance())) {
225 // Set the debug output system if it is not debug class ;)
226 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig("debug_engine")));
229 // Initialize web instance
230 if (is_null($this->getWebOutputInstance())) {
231 // Generate the eval() command
232 $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
233 $this->getConfigInstance()->readConfig("web_engine"),
234 $this->getConfigInstance()->readConfig("web_engine"),
235 $this->getConfigInstance()->readConfig("web_content_type")
239 if ((defined('DEBUG_EVAL')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
248 // Initialize compressor channel
249 if (is_null($this->getCompressorChannel())) {
250 // Set the compressor channel
251 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
253 $this->getConfigInstance()->readConfig("compressor_base_path")
257 // Initialize database middleware
258 if (is_null($this->getDatabaseInstance())) {
259 // Get the middleware instance
260 $db = DatabaseConnection::getInstance();
261 if (is_object($db)) {
262 // Set the database middleware
263 $this->setDatabaseInstance($db);
268 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Alle Sub-Systeme sind initialisiert.<br />\n",
275 * Setter for language instance
277 * @param $configInstance The configuration instance which shall
278 * be FrameworkConfiguration
281 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
282 $this->cfgInstance = $configInstance;
283 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler auf <strong>%s</strong> gesetzt.<br />\n",
285 $configInstance->__toString()
290 * Getter for configuration instance
292 * @return $cfhInstance - Configuration instance
294 public final function getConfigInstance () {
295 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler <strong>%s</strong> angefordert.<br />\n",
297 $this->cfgInstance->__toString()
299 return $this->cfgInstance;
303 * Setter for debug instance
305 * @param $debugInstance The instance for debug output class
308 public final function setDebugInstance (DebugMiddleware $debugInstance) {
309 self::$debug = $debugInstance;
310 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Debug-Handler auf <strong>%s</strong> gesetzt.<br />\n",
312 $this->getDebugInstance()->__toString()
317 * Getter for debug instance
319 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
321 public final function getDebugInstance () {
326 * Setter for web output instance
328 * @param $webInstance The instance for web output class
331 public final function setWebOutputInstance (OutputStreamer $webInstance) {
332 self::$webOutput = $webInstance;
333 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Web-Handler auf <strong>%s</strong> gesetzt.<br />\n",
335 $this->getWebOutputInstance()->__toString()
340 * Getter for web output instance
342 * @return $webOutput - Instance to class WebOutput
344 public final function getWebOutputInstance () {
345 return self::$webOutput;
349 * Static setter for database instance
351 * @param $dbInstance The instance for the database connection
352 * (forced DatabaseConnection)
355 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
356 if ((defined('DEBUG_SYSTEM')) && (is_object($dbInstance->getDebugInstance()))) $dbInstance->getDebugInstance()->output(sprintf("[%s:] Datenbankschicht gesetzt.<br />\n",
357 $dbInstance->__toString()
359 $this->dbInstance = $dbInstance;
363 * Getter for $realClass
365 * @return $realClass The name of the real class (not BaseFrameworkSystem)
367 public final function __toString () {
368 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] __toString() erreicht.<br />\n",
371 return $this->realClass;
375 * Setter for the real class name
377 * @param $realClass Class name (string)
380 public final function setRealClass ($realClass) {
382 $realClass = (string) $realClass;
385 $this->realClass = $realClass;
389 * Generate unique ID from a lot entropy
393 public final function createUniqueID () {
394 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID aufgerufen.<br />\n",
398 // Existiert noch keine?
399 if (empty($this->uniqueID)) {
400 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID erzeugt neue Unique-ID.<br />\n",
404 // Correct missing class name
406 if ($this->__toString() == "") {
407 $this->setRealClass(__CLASS__);
414 // Generate a unique ID number
415 $tempID = $this->generateIdNumber();
418 // Try to figure out if the ID number is not yet used
420 if (is_object($this->getDatabaseInstance())) {
421 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
423 } catch (FrameworkException $e) {
424 // Catches all and ignores all ;-)
432 $this->getDatabaseInstance() === null
435 is_object($this->getDatabaseInstance())
448 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] uniqueID ist auf <strong>%s</strong> gesetzt.<br />\n",
454 $this->setUniqueID($tempID);
456 // Revert maybe corrected class name
458 $this->setRealClass("");
461 // Remove system classes if we are in a system class
462 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
463 // This may save some RAM...
464 $this->removeSystemArray();
470 * Generates a new ID number for classes based from the class' real name,
471 * the description and some random data
473 * @return $tempID The new (temporary) ID number
475 private final function generateIdNumber () {
476 return sprintf("%s@%s",
478 md5(sprintf("%s:%s:%s:%s:%s:%s",
480 $this->getPartDescr(),
482 getenv('REMOTE_ADDR'),
483 getenv('SERVER_ADDR'),
490 * Setter for unique ID
492 * @param $uniqueID The newly generated unique ID number
495 private final function setUniqueID ($uniqueID) {
497 $uniqueID = (string) $uniqueID;
500 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID gesetzt auf <u>%s</u>.<br />\n",
506 $this->uniqueID = $uniqueID;
510 * Getter for unique ID
512 * @return $uniqueID The unique ID of this class
514 public final function getUniqueID () {
515 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID angefordert.<br />\n",
518 return $this->uniqueID;
522 * Resets or recreates the unique ID number
526 public final function resetUniqueID() {
527 // Sweet and simple... ;-)
528 $newUniqueID = $this->generateIdNumber();
529 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID zurückgesetzt auf <u>%s</u>.<br />\n",
533 $this->setUniqueID($newUniqueID);
537 * Getter for simulator description
539 * @return $partDescr The description of this simulation part
541 public final function getPartDescr () {
542 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] getPartDescr erreicht.<br />\n",
545 if (isset($this->partDescr)) {
546 return $this->partDescr;
553 * Setter for simulation part description
555 * @param $partDescr The description as string for this simulation part
558 public final function setPartDescr ($partDescr) {
559 $this->partDescr = (String) $partDescr;
560 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Teilbeschreibung wird auf <strong>%s</strong> gesetzt.<br />\n",
567 * Validate if given object is the same as current
569 * @param $object An object instance for comparison with this class
570 * @return boolean The result of comparing both's unique ID
572 public final function equals ($object) {
573 return ($this->getUniqueID() == $object->getUniqueID());
577 * Compare if both simulation part description and class name matches
580 * @param $itemInstance An object instance to an other class
581 * @return boolean The result of comparing class name simulation part description
583 public function itemMatches ($itemInstance) {
586 $this->__toString() == $itemInstance->__toString()
588 $this->getPartDescr() == $itemInstance->getPartDescr()
594 * Compare class name of this and given class name
596 * @param $class The class name as string from the other class
597 * @return boolean The result of comparing both class names
599 public final function isClass ($class) {
600 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%s</strong>=<strong>%s</strong>?<br />\n",
605 return ($this->__toString() == $class);
609 * Stub method (only real cabins shall override it)
611 * @return boolean false = is no cabin, true = is a cabin
613 public function isCabin () {
618 * Stub method for tradeable objects
620 * @return boolean false = is not tradeable by the Merchant class,
621 * true = is a tradeable object
623 public function isTradeable () {
628 * Formats computer generated price values into human-understandable formats
629 * with thousand and decimal seperators.
631 * @param $value The in computer format value for a price
632 * @param $currency The currency symbol (use HTML-valid characters!)
633 * @param $decNum Number of decimals after commata
634 * @return $price The for the current language formated price string
635 * @throws MissingDecimalsThousandsSeperatorException If decimals or
636 * thousands seperator
639 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
640 // Are all required attriutes set?
641 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
642 // Throw an exception
643 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
647 $value = (float) $value;
648 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%d</strong> wird umformatiert.<br />\n",
653 // Reformat the US number
654 $price = sprintf("%s %s",
655 number_format($value, $decNum, $this->decimals, $this->thousands),
659 // Return as string...
664 * Removes number formating characters
668 public final function removeNumberFormaters () {
669 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Zahlenumformatierungszeichen werden entfernt.<br />\n",
672 unset($this->thousands);
673 unset($this->decimals);
677 * Getter for database layer
679 * @return $dbInstance The database layer instance
681 public final function getDatabaseInstance () {
682 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Datenbank-Instanz <u>%s</u> angefordert.<br />\n",
686 return $this->dbInstance;
690 * Setter for compressor channel
692 * @param $compressorChannel An instance of CompressorChannel
695 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
696 self::$compressor = $compressorChannel;
700 * Getter for compressor channel
702 * @return $compressor The compressor channel
704 public final function getCompressorChannel () {
705 return self::$compressor;
709 * Remove the $systemClasses array from memory
713 public final function removeSystemArray () {
714 unset($this->systemClasses);
718 * Create a file name and path name from the object's unique ID number.
719 * The left part of the ID shall always be a valid class name and the
720 * right part an ID number.
722 * @return $pfn The file name with a prepended path name
723 * @throws NoArrayCreatedException If explode() fails to create an array
724 * @throws InvalidArrayCountException If the array contains less or
725 * more than two elements
727 public final function getPathFileNameFromObject () {
728 // Get the main object's unique ID. We use this as a path/filename combination
729 $pathFile = $this->getUniqueID();
731 // Split it up in path and file name
732 $pathFile = explode("@", $pathFile);
734 // Are there two elements? Index 0 is the path, 1 the file name + global extension
735 if (!is_array($pathFile)) {
737 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
738 } elseif (count($pathFile) != 2) {
739 // Invalid ID returned!
740 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
743 // Auto-append missing trailing slash
744 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
746 // Create the file name and return it
747 $pfn = ($pathFile[0] . $pathFile[1]);
752 * Appends a trailing slash to a string
754 * @param $str A string (maybe) without trailing slash
755 * @return $str A string with an auto-appended trailing slash
757 public final function addMissingTrailingSlash ($str) {
758 // Is there a trailing slash?
759 if (substr($str, -1, 1) != "/") $str .= "/";