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;
153 * In the super constructor these system classes shall be ignored or else
154 * we would get an endless calling loop.
156 *--------------------------------------------------------------------*
157 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
158 *--------------------------------------------------------------------*
160 private $systemClasses = array(
161 "DebugMiddleware", // Debug middleware output sub-system
162 "DebugWebOutput", // Debug web output sub-system
163 "DebugConsoleOutput", // Debug console output sub-system
164 "DebugErrorLogOutput", // Debug error_log() output sub-system
165 "CompressorChannel", // Compressor sub-system
166 "FrameworkDirectoryPointer", // Directory handler sub-system
167 "NullCompressor", // Null compressor
168 "Bzip2Compressor", // BZIP2 compressor
169 "GzipCompressor", // GZIP compressor
170 "WebOutput", // Web output sub-system
174 * Private super constructor
178 protected function __construct ($class) {
180 $this->setRealClass($class);
182 // Init this instance
183 $this->initInstance($class);
187 * Destructor reached...
191 public function __destruct() {
192 // Is this object already destroyed?
193 if ($this->__toString() != "DestructedObject") {
195 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
196 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
197 __CLASS__, $this->__toString()
201 // Destroy all informations about this class but keep some text about it alive
202 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
203 $this->setRealClass("DestructedObject");
204 $this->resetUniqueID();
205 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
206 // Already destructed object
207 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
208 __CLASS__, $this->__toString()
214 * The call method where all non-implemented methods end up
218 public final function __call ($methodName, $args) {
219 // Implode all given arguments
220 $argsString = implode("|", $args);
221 if (empty($argsString)) $argsString = "NULL";
223 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
234 * Initializes the instance
238 public function initInstance ($class) {
239 // Get the current (singleton) configuration instance
240 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
242 // Is the class weather debug nor compressor channel?
243 if (!in_array($class, $this->systemClasses)) {
244 // Initialize debug instance
245 if (is_null($this->getDebugInstance())) {
246 // Set the debug output system if it is not debug class ;)
247 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig("debug_engine")));
250 // Initialize web instance
251 if (is_null($this->getWebOutputInstance())) {
252 // Generate the eval() command
253 $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
254 $this->getConfigInstance()->readConfig("web_engine"),
255 $this->getConfigInstance()->readConfig("web_engine"),
256 $this->getConfigInstance()->readConfig("web_content_type")
260 if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
269 // Initialize compressor channel
270 if (is_null($this->getCompressorChannel())) {
271 // Set the compressor channel
272 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
274 $this->getConfigInstance()->readConfig("compressor_base_path")
278 // Initialize database middleware
279 if (is_null($this->getDatabaseInstance())) {
280 // Get the middleware instance
281 $db = DatabaseConnection::getInstance();
282 if (is_object($db)) {
283 // Set the database middleware
284 $this->setDatabaseInstance($db);
291 * Setter for language instance
293 * @param $configInstance The configuration instance which shall
294 * be FrameworkConfiguration
297 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
298 self::$cfgInstance = $configInstance;
302 * Getter for configuration instance
304 * @return $cfhInstance - Configuration instance
306 public final function getConfigInstance () {
307 return self::$cfgInstance;
311 * Setter for debug instance
313 * @param $debugInstance The instance for debug output class
316 public final function setDebugInstance (DebugMiddleware $debugInstance) {
317 self::$debug = $debugInstance;
321 * Getter for debug instance
323 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
325 public final function getDebugInstance () {
330 * Setter for web output instance
332 * @param $webInstance The instance for web output class
335 public final function setWebOutputInstance (OutputStreamer $webInstance) {
336 self::$webOutput = $webInstance;
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 $this->dbInstance = $dbInstance;
360 * Getter for $realClass
362 * @return $realClass The name of the real class (not BaseFrameworkSystem)
364 public final function __toString () {
365 return $this->realClass;
369 * Setter for the real class name
371 * @param $realClass Class name (string)
374 public final function setRealClass ($realClass) {
376 $realClass = (string) $realClass;
379 $this->realClass = $realClass;
383 * Generate unique ID from a lot entropy
387 public final function createUniqueID () {
388 // Existiert noch keine?
389 if (empty($this->uniqueID)) {
391 // Correct missing class name
393 if ($this->__toString() == "") {
394 $this->setRealClass(__CLASS__);
401 // Generate a unique ID number
402 $tempID = $this->generateIdNumber();
405 // Try to figure out if the ID number is not yet used
407 if (is_object($this->getDatabaseInstance())) {
408 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
410 } catch (FrameworkException $e) {
411 // Catches all and ignores all ;-)
419 $this->getDatabaseInstance() === null
422 is_object($this->getDatabaseInstance())
435 $this->setUniqueID($tempID);
437 // Revert maybe corrected class name
439 $this->setRealClass("");
442 // Remove system classes if we are in a system class
443 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
444 // This may save some RAM...
445 $this->removeSystemArray();
451 * Generates a new ID number for classes based from the class' real name,
452 * the description and some random data
454 * @return $tempID The new (temporary) ID number
456 private final function generateIdNumber () {
457 return sprintf("%s@%s",
459 md5(sprintf("%s:%s:%s:%s:%s:%s",
461 $this->getObjectDescription(),
463 getenv('REMOTE_ADDR'),
464 getenv('SERVER_ADDR'),
471 * Setter for unique ID
473 * @param $uniqueID The newly generated unique ID number
476 private final function setUniqueID ($uniqueID) {
478 $uniqueID = (string) $uniqueID;
481 $this->uniqueID = $uniqueID;
485 * Getter for unique ID
487 * @return $uniqueID The unique ID of this class
489 public final function getUniqueID () {
490 return $this->uniqueID;
494 * Resets or recreates the unique ID number
498 public final function resetUniqueID() {
499 // Sweet and simple... ;-)
500 $newUniqueID = $this->generateIdNumber();
501 $this->setUniqueID($newUniqueID);
505 * Getter for simulator description
507 * @return $objectDescription The description of this simulation part
509 public final function getObjectDescription () {
510 if (isset($this->objectDescription)) {
511 return $this->objectDescription;
518 * Setter for simulation part description
520 * @param $objectDescription The description as string for this simulation part
523 public final function setObjectDescription ($objectDescription) {
524 $this->objectDescription = (String) $objectDescription;
528 * Validate if given object is the same as current
530 * @param $object An object instance for comparison with this class
531 * @return boolean The result of comparing both's unique ID
533 public final function equals ($object) {
534 return ($this->getUniqueID() == $object->getUniqueID());
538 * Compare if both simulation part description and class name matches
541 * @param $itemInstance An object instance to an other class
542 * @return boolean The result of comparing class name simulation part description
544 public function itemMatches ($itemInstance) {
547 $this->__toString() == $itemInstance->__toString()
549 $this->getObjectDescription() == $itemInstance->getObjectDescription()
555 * Compare class name of this and given class name
557 * @param $class The class name as string from the other class
558 * @return boolean The result of comparing both class names
560 public final function isClass ($class) {
561 return ($this->__toString() == $class);
565 * Stub method (only real cabins shall override it)
567 * @return boolean false = is no cabin, true = is a cabin
569 public function isCabin () {
574 * Stub method for tradeable objects
576 * @return boolean false = is not tradeable by the Merchant class,
577 * true = is a tradeable object
579 public function isTradeable () {
584 * Formats computer generated price values into human-understandable formats
585 * with thousand and decimal seperators.
587 * @param $value The in computer format value for a price
588 * @param $currency The currency symbol (use HTML-valid characters!)
589 * @param $decNum Number of decimals after commata
590 * @return $price The for the current language formated price string
591 * @throws MissingDecimalsThousandsSeperatorException If decimals or
592 * thousands seperator
595 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
596 // Are all required attriutes set?
597 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
598 // Throw an exception
599 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
603 $value = (float) $value;
605 // Reformat the US number
606 $price = sprintf("%s %s",
607 number_format($value, $decNum, $this->decimals, $this->thousands),
611 // Return as string...
616 * Removes number formating characters
620 public final function removeNumberFormaters () {
621 unset($this->thousands);
622 unset($this->decimals);
626 * Getter for database layer
628 * @return $dbInstance The database layer instance
630 public final function getDatabaseInstance () {
631 return $this->dbInstance;
635 * Setter for compressor channel
637 * @param $compressorChannel An instance of CompressorChannel
640 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
641 self::$compressor = $compressorChannel;
645 * Getter for compressor channel
647 * @return $compressor The compressor channel
649 public final function getCompressorChannel () {
650 return self::$compressor;
654 * Remove the $systemClasses array from memory
658 public final function removeSystemArray () {
659 unset($this->systemClasses);
663 * Create a file name and path name from the object's unique ID number.
664 * The left part of the ID shall always be a valid class name and the
665 * right part an ID number.
667 * @return $pfn The file name with a prepended path name
668 * @throws NoArrayCreatedException If explode() fails to create an array
669 * @throws InvalidArrayCountException If the array contains less or
670 * more than two elements
672 public final function getPathFileNameFromObject () {
673 // Get the main object's unique ID. We use this as a path/filename combination
674 $pathFile = $this->getUniqueID();
676 // Split it up in path and file name
677 $pathFile = explode("@", $pathFile);
679 // Are there two elements? Index 0 is the path, 1 the file name + global extension
680 if (!is_array($pathFile)) {
682 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
683 } elseif (count($pathFile) != 2) {
684 // Invalid ID returned!
685 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
688 // Auto-append missing trailing slash
689 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
691 // Create the file name and return it
692 $pfn = ($pathFile[0] . $pathFile[1]);
697 * Appends a trailing slash to a string
699 * @param $str A string (maybe) without trailing slash
700 * @return $str A string with an auto-appended trailing slash
702 public final function addMissingTrailingSlash ($str) {
703 // Is there a trailing slash?
704 if (substr($str, -1, 1) != "/") $str .= "/";
709 * Private getter for language instance
711 * @return $langInstance An instance to the language sub-system
713 protected final function getLanguageInstance () {
714 return $this->langInstance;
718 * Setter for language instance
720 * @param $langInstance An instance to the language sub-system
722 * @see LanguageSystem
724 public final function setLanguageInstance (ManageableLanguage $langInstance) {
725 $this->langInstance = $langInstance;
729 * Private getter for file IO instance
731 * @return $fileIOInstance An instance to the file I/O sub-system
733 protected final function getFileIOInstance () {
734 return $this->fileIOInstance;
738 * Setter for file I/O instance
740 * @param $fileIOInstance An instance to the file I/O sub-system
743 public final function setFileIOInstance (FileIOHandler $fileIOInstance) {
744 $this->fileIOInstance = $fileIOInstance;
748 * Protected getter for a manageable application helper class
750 * @return $applicationInstance An instance of a manageable application helper class
752 protected final function getApplicationInstance () {
753 return $this->applicationInstance;
757 * Setter for a manageable application helper class
759 * @param $applicationInstance An instance of a manageable application helper class
762 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
763 $this->applicationInstance = $applicationInstance;
767 * Prepare the template engine (TemplateEngine by default) for a given
768 * application helper instance (ApplicationHelper by default).
770 * @param $appInstance An application helper instance or
771 * null if we shall use the default
772 * @return $tplEngine The template engine instance
773 * @throws NullPointerException If the template engine could not
775 * @throws UnsupportedTemplateEngineException If $tplEngine is an
776 * unsupported template engine
777 * @throws MissingLanguageHandlerException If the language sub-system
778 * is not yet initialized
779 * @throws NullPointerException If the discovered application
780 * instance is still null
782 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
783 // Is the application instance set?
784 if (is_null($appInstance)) {
785 // Get the current instance
786 $appInstance = $this->getApplicationInstance();
789 if (is_null($appInstance)) {
790 // Thrown an exception
791 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
795 // Generate FQFN for all application templates
796 $fqfn = sprintf("%s%s/%s/%s",
798 $this->getConfigInstance()->readConfig("application_path"),
799 strtolower($appInstance->getAppShortName()),
800 $this->getConfigInstance()->readConfig("tpl_base_path")
803 // Are both instances set?
804 if ($appInstance->getLanguageInstance() === null) {
805 // Invalid language instance
806 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
807 } elseif ($appInstance->getFileIOInstance() === null) {
808 // Invalid language instance
809 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
812 // Initialize the template engine
814 $eval = sprintf("\$tplEngine = %s::create%s(
816 \$appInstance->getLanguageInstance(),
817 \$appInstance->getFileIOInstance()
819 $this->getConfigInstance()->readConfig("tpl_engine"),
820 $this->getConfigInstance()->readConfig("tpl_engine"),
825 if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
826 $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
835 // Is it a valid instance?
836 if (is_null($tplEngine)) {
838 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
839 } elseif (!$tplEngine instanceof CompileableTemplate) {
840 // Not an object! ;-(
841 throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
844 // Return the prepared instance
849 * Debugs this instance by putting out it's full content
853 public final function debugInstance () {
854 // Generate the output
855 $content = "<pre>".trim(print_r($this, true))."</pre>";
858 ApplicationEntryPoint::app_die("<strong>Debug output:</strong>".$content);