inc/classes/main/class_BaseFrameworkSystem.php

   1 <?php
   2 /**
   3  * The simulator system class is the super class of all other classes. This
   4  * class handles saving of games etc.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   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
  11  *
  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.
  16  *
  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.
  21  *
  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/>.
  24  */
  25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
  26         /**
  27          * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
  28          *
  29          * @see         DebugConsoleOutput
  30          * @see         DebugWebOutput
  31          */
  32         private static $debug       = null;
  33
  34         /**
  35          * The instance to the web output handler (should be WebOutput)
  36          *
  37          * @see         WebOutput
  38          */
  39         private static $webOutput   = null;
  40
  41         /**
  42          * The instance to the compression layer which should be CompressorChannel
  43          */
  44         private static $compressor  = null;
  45
  46         /**
  47          * The configuration instance which shall be FrameworkConfiguration
  48          */
  49         private static $cfgInstance = null;
  50
  51         /**
  52          * The instance to the database layer which should be DatabaseConnection
  53          */
  54         private $dbInstance  = null;
  55
  56         /**
  57          * Instance to an application helper class
  58          */
  59         private $applicationInstance = null;
  60
  61         /**
  62          * The real class name
  63          */
  64         private $realClass      = "FrameworkSystem";
  65
  66         /**
  67          * A human-readable description for this simulator part
  68          */
  69         private $objectDescription      = "Namenlose Framework-Einheit";
  70
  71         /**
  72          * The unique ID string for identifying all type of classes
  73          */
  74         private $uniqueID = "";
  75
  76         /**
  77          * Thousands seperator
  78          */
  79         private $thousands = "."; // German
  80
  81         /**
  82          * Decimal seperator
  83          */
  84         private $decimals  = ","; // German
  85
  86         /**
  87          * The language instance for the template loader
  88          */
  89         private $langInstance = null;
  90
  91         /**
  92          * The file I/O instance for the template loader
  93          */
  94         private $fileIOInstance = null;
  95
  96         /***********************
  97          * Exception codes.... *
  98          ***********************/
  99
 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
 154         /**
 155          * In the super constructor these system classes shall be ignored or else
 156          * we would get an endless calling loop.
 157          *
 158          *--------------------------------------------------------------------*
 159          * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
 160          *--------------------------------------------------------------------*
 161          */
 162         private $systemClasses = array(
 163                 "DebugMiddleware",                              // Debug middleware output sub-system
 164                 "DebugWebOutput",                               // Debug web output sub-system
 165                 "DebugConsoleOutput",                   // Debug console output sub-system
 166                 "DebugErrorLogOutput",                  // Debug error_log() output sub-system
 167                 "CompressorChannel",                    // Compressor sub-system
 168                 "FrameworkDirectoryPointer",    // Directory handler sub-system
 169                 "NullCompressor",                               // Null compressor
 170                 "Bzip2Compressor",                              // BZIP2 compressor
 171                 "GzipCompressor",                               // GZIP compressor
 172                 "WebOutput",                                    // Web output sub-system
 173         );
 174
 175         /**
 176          * Private super constructor
 177          *
 178          * @return      void
 179          */
 180         protected function __construct ($class) {
 181                 // Set real class
 182                 $this->setRealClass($class);
 183
 184                 // Init this instance
 185                 $this->initInstance($class);
 186         }
 187
 188         /**
 189          * Destructor reached...
 190          *
 191          * @return      void
 192          */
 193         public function __destruct() {
 194                 // Is this object already destroyed?
 195                 if ($this->__toString() != "DestructedObject") {
 196                         // Debug message
 197                         if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 198                                 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerst&ouml;rt.<br />\n",
 199                                         __CLASS__, $this->__toString()
 200                                 ));
 201                         }
 202
 203                         // Destroy all informations about this class but keep some text about it alive
 204                         $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
 205                         $this->setRealClass("DestructedObject");
 206                         $this->resetUniqueID();
 207                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 208                         // Already destructed object
 209                         $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerst&ouml;rt.<br />\n",
 210                                 __CLASS__, $this->__toString()
 211                         ));
 212                 }
 213         }
 214
 215         /**
 216          * The call method where all non-implemented methods end up
 217          *
 218          * @return      void
 219          */
 220         public final function __call ($methodName, $args) {
 221                 // Implode all given arguments
 222                 $argsString = implode("|", $args);
 223                 if (empty($argsString)) $argsString = "NULL";
 224
 225                 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
 226                         $this->__toString(),
 227                         $methodName,
 228                         $argsString
 229                 ));
 230
 231                 // Return nothing
 232                 return null;
 233         }
 234
 235         /**
 236          * Initializes the instance
 237          *
 238          * @return      void
 239          */
 240         public function initInstance ($class) {
 241                 // Get the current (singleton) configuration instance
 242                 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
 243
 244                 // Is the class weather debug nor compressor channel?
 245                 if (!in_array($class, $this->systemClasses)) {
 246                         // Initialize debug instance
 247                         if (is_null($this->getDebugInstance())) {
 248                                 // Set the debug output system if it is not debug class ;)
 249                                 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig("debug_engine")));
 250                         }
 251
 252                         // Initialize web instance
 253                         if (is_null($this->getWebOutputInstance())) {
 254                                 // Generate the eval() command
 255                                 $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
 256                                         $this->getConfigInstance()->readConfig("web_engine"),
 257                                         $this->getConfigInstance()->readConfig("web_engine"),
 258                                         $this->getConfigInstance()->readConfig("web_content_type")
 259                                 );
 260
 261                                 // Debug message
 262                                 if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
 263                                         $this->__toString(),
 264                                         htmlentities($eval)
 265                                 ));
 266
 267                                 // Run the command
 268                                 eval($eval);
 269                         }
 270
 271                         // Initialize compressor channel
 272                         if (is_null($this->getCompressorChannel())) {
 273                                 // Set the compressor channel
 274                                 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
 275                                         PATH,
 276                                         $this->getConfigInstance()->readConfig("compressor_base_path")
 277                                 )));
 278                         }
 279
 280                         // Initialize database middleware
 281                         if (is_null($this->getDatabaseInstance())) {
 282                                 // Get the middleware instance
 283                                 $db = DatabaseConnection::getInstance();
 284                                 if (is_object($db)) {
 285                                         // Set the database middleware
 286                                         $this->setDatabaseInstance($db);
 287                                 }
 288                         }
 289                 }
 290         }
 291
 292         /**
 293          * Setter for language instance
 294          *
 295          * @param       $configInstance The configuration instance which shall
 296          *                                                      be FrameworkConfiguration
 297          * @return      void
 298          */
 299         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
 300                 self::$cfgInstance = $configInstance;
 301         }
 302
 303         /**
 304          * Getter for configuration instance
 305          *
 306          * @return      $cfhInstance - Configuration instance
 307          */
 308         protected final function getConfigInstance () {
 309                 return self::$cfgInstance;
 310         }
 311
 312         /**
 313          * Setter for debug instance
 314          *
 315          * @param               $debugInstance  The instance for debug output class
 316          * @return      void
 317          */
 318         public final function setDebugInstance (DebugMiddleware $debugInstance) {
 319                 self::$debug = $debugInstance;
 320         }
 321
 322         /**
 323          * Getter for debug instance
 324          *
 325          * @return      $debug - Instance to class DebugConsoleOutput or DebugWebOutput
 326          */
 327         public final function getDebugInstance () {
 328                 return self::$debug;
 329         }
 330
 331         /**
 332          * Setter for web output instance
 333          *
 334          * @param               $webInstance    The instance for web output class
 335          * @return      void
 336          */
 337         public final function setWebOutputInstance (OutputStreamer $webInstance) {
 338                 self::$webOutput = $webInstance;
 339         }
 340
 341         /**
 342          * Getter for web output instance
 343          *
 344          * @return      $webOutput - Instance to class WebOutput
 345          */
 346         public final function getWebOutputInstance () {
 347                 return self::$webOutput;
 348         }
 349
 350         /**
 351          * Static setter for database instance
 352          *
 353          * @param               $dbInstance     The instance for the database connection
 354          *                                      (forced DatabaseConnection)
 355          * @return      void
 356          */
 357         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
 358                 $this->dbInstance = $dbInstance;
 359         }
 360
 361         /**
 362          * Getter for $realClass
 363          *
 364          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
 365          */
 366         public final function __toString () {
 367                 return $this->realClass;
 368         }
 369
 370         /**
 371          * Setter for the real class name
 372          *
 373          * @param               $realClass      Class name (string)
 374          * @return      void
 375          */
 376         public final function setRealClass ($realClass) {
 377                 // Cast to string
 378                 $realClass = (string) $realClass;
 379
 380                 // Set real class
 381                 $this->realClass = $realClass;
 382         }
 383
 384         /**
 385          * Generate unique ID from a lot entropy
 386          *
 387          * @return      void
 388          */
 389         public final function createUniqueID () {
 390                 // Existiert noch keine?
 391                 if (empty($this->uniqueID)) {
 392
 393                         // Correct missing class name
 394                         $corrected = false;
 395                         if ($this->__toString() == "") {
 396                                 $this->setRealClass(__CLASS__);
 397                                 $corrected = true;
 398                         }
 399
 400                         // Neue ID erstellen
 401                         $tempID = false;
 402                         while (true) {
 403                                 // Generate a unique ID number
 404                                 $tempID = $this->generateIdNumber();
 405                                 $isUsed = false;
 406
 407                                 // Try to figure out if the ID number is not yet used
 408                                 try {
 409                                         if (is_object($this->getDatabaseInstance())) {
 410                                                 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
 411                                         }
 412                                 } catch (FrameworkException $e) {
 413                                         // Catches all and ignores all ;-)
 414                                 }
 415
 416                                 if (
 417                                         (
 418                                                 $tempID !== false
 419                                         ) && (
 420                                                 (
 421                                                         $this->getDatabaseInstance() === null
 422                                                 ) || (
 423                                                         (
 424                                                                 is_object($this->getDatabaseInstance())
 425                                                         ) && (
 426                                                                 !$isUsed
 427                                                         )
 428                                                 )
 429                                         )
 430                                 ) {
 431                                         // Abort the loop
 432                                         break;
 433                                 }
 434                         } // END - while
 435
 436                         // Apply the new ID
 437                         $this->setUniqueID($tempID);
 438
 439                         // Revert maybe corrected class name
 440                         if ($corrected) {
 441                                 $this->setRealClass("");
 442                         }
 443
 444                         // Remove system classes if we are in a system class
 445                         if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
 446                                 // This may save some RAM...
 447                                 $this->removeSystemArray();
 448                         }
 449                 }
 450         }
 451
 452         /**
 453          * Generates a new ID number for classes based from the class' real name,
 454          * the description and some random data
 455          *
 456          * @return      $tempID The new (temporary) ID number
 457          */
 458         private final function generateIdNumber () {
 459                 return sprintf("%s@%s",
 460                         $this->__toString(),
 461                         md5(sprintf("%s:%s:%s:%s:%s:%s",
 462                                 $this->__toString(),
 463                                 $this->getObjectDescription(),
 464                                 time(),
 465                                 getenv('REMOTE_ADDR'),
 466                                 getenv('SERVER_ADDR'),
 467                                 mt_rand()
 468                         ))
 469                 );
 470         }
 471
 472         /**
 473          * Setter for unique ID
 474          *
 475          * @param               $uniqueID               The newly generated unique ID number
 476          * @return      void
 477          */
 478         private final function setUniqueID ($uniqueID) {
 479                 // Cast to string
 480                 $uniqueID = (string) $uniqueID;
 481
 482                 // Set the ID number
 483                 $this->uniqueID = $uniqueID;
 484         }
 485
 486         /**
 487          * Getter for unique ID
 488          *
 489          * @return      $uniqueID               The unique ID of this class
 490          */
 491         public final function getUniqueID () {
 492                 return $this->uniqueID;
 493         }
 494
 495         /**
 496          * Resets or recreates the unique ID number
 497          *
 498          * @return      void
 499          */
 500         public final function resetUniqueID() {
 501                 // Sweet and simple... ;-)
 502                 $newUniqueID = $this->generateIdNumber();
 503                 $this->setUniqueID($newUniqueID);
 504         }
 505
 506         /**
 507          * Getter for simulator description
 508          *
 509          * @return      $objectDescription      The description of this simulation part
 510          */
 511         public final function getObjectDescription () {
 512                 if (isset($this->objectDescription)) {
 513                         return $this->objectDescription;
 514                 } else {
 515                         return null;
 516                 }
 517         }
 518
 519         /**
 520          * Setter for simulation part description
 521          *
 522          * @param               $objectDescription      The description as string for this simulation part
 523          * @return      void
 524          */
 525         public final function setObjectDescription ($objectDescription) {
 526                 $this->objectDescription = (String) $objectDescription;
 527         }
 528
 529         /**
 530          * Validate if given object is the same as current
 531          *
 532          * @param               $object An object instance for comparison with this class
 533          * @return      boolean The result of comparing both's unique ID
 534          */
 535         public final function equals ($object) {
 536                 return ($this->getUniqueID() == $object->getUniqueID());
 537         }
 538
 539         /**
 540          * Compare if both simulation part description and class name matches
 541          * (shall be enougth)
 542          *
 543          * @param               $itemInstance   An object instance to an other class
 544          * @return      boolean         The result of comparing class name simulation part description
 545          */
 546         public function itemMatches ($itemInstance) {
 547                 return (
 548                         (
 549                                 $this->__toString()   == $itemInstance->__toString()
 550                         ) && (
 551                                 $this->getObjectDescription() == $itemInstance->getObjectDescription()
 552                         )
 553                 );
 554         }
 555
 556         /**
 557          * Compare class name of this and given class name
 558          *
 559          * @param               $class  The class name as string from the other class
 560          * @return      boolean The result of comparing both class names
 561          */
 562         public final function isClass ($class) {
 563                 return ($this->__toString() == $class);
 564         }
 565
 566         /**
 567          * Stub method (only real cabins shall override it)
 568          *
 569          * @return      boolean false = is no cabin, true = is a cabin
 570          */
 571         public function isCabin () {
 572                 return false;
 573         }
 574
 575         /**
 576          * Stub method for tradeable objects
 577          *
 578          * @return      boolean false = is not tradeable by the Merchant class,
 579          *                                      true  = is a tradeable object
 580          */
 581         public function isTradeable () {
 582                 return false;
 583         }
 584
 585         /**
 586          * Formats computer generated price values into human-understandable formats
 587          * with thousand and decimal seperators.
 588          *
 589          * @param               $value  The in computer format value for a price
 590          * @param               $currency       The currency symbol (use HTML-valid characters!)
 591          * @param               $decNum Number of decimals after commata
 592          * @return      $price  The for the current language formated price string
 593          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
 594          *                                                                                              thousands seperator
 595          *                                                                                              is missing
 596          */
 597         public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
 598                 // Are all required attriutes set?
 599                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
 600                         // Throw an exception
 601                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
 602                 }
 603
 604                 // Cast the number
 605                 $value = (float) $value;
 606
 607                 // Reformat the US number
 608                 $price = sprintf("%s %s",
 609                         number_format($value, $decNum, $this->decimals, $this->thousands),
 610                         $currency
 611                 );
 612
 613                 // Return as string...
 614                 return $price;
 615         }
 616
 617         /**
 618          * Removes number formating characters
 619          *
 620          * @return      void
 621          */
 622         public final function removeNumberFormaters () {
 623                 unset($this->thousands);
 624                 unset($this->decimals);
 625         }
 626
 627         /**
 628          * Getter for database layer
 629          *
 630          * @return      $dbInstance     The database layer instance
 631          */
 632         public final function getDatabaseInstance () {
 633                 return $this->dbInstance;
 634         }
 635
 636         /**
 637          * Setter for compressor channel
 638          *
 639          * @param               $compressorChannel      An instance of CompressorChannel
 640          * @return      void
 641          */
 642         public final function setCompressorChannel (CompressorChannel $compressorChannel) {
 643                 self::$compressor = $compressorChannel;
 644         }
 645
 646         /**
 647          * Getter for compressor channel
 648          *
 649          * @return      $compressor     The compressor channel
 650          */
 651         public final function getCompressorChannel () {
 652                 return self::$compressor;
 653         }
 654
 655         /**
 656          * Remove the $systemClasses array from memory
 657          *
 658          * @return      void
 659          */
 660         public final function removeSystemArray () {
 661                 unset($this->systemClasses);
 662         }
 663
 664         /**
 665          * Create a file name and path name from the object's unique ID number.
 666          * The left part of the ID shall always be a valid class name and the
 667          * right part an ID number.
 668          *
 669          * @return      $pfn            The file name with a prepended path name
 670          * @throws      NoArrayCreatedException If explode() fails to create an array
 671          * @throws      InvalidArrayCountException      If the array contains less or
 672          *                                                                      more than two elements
 673          */
 674         public final function getPathFileNameFromObject () {
 675                 // Get the main object's unique ID. We use this as a path/filename combination
 676                 $pathFile = $this->getUniqueID();
 677
 678                 // Split it up in path and file name
 679                 $pathFile = explode("@", $pathFile);
 680
 681                 // Are there two elements? Index 0 is the path, 1 the file name + global extension
 682                 if (!is_array($pathFile)) {
 683                         // No array found
 684                         throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
 685                 } elseif (count($pathFile) != 2) {
 686                         // Invalid ID returned!
 687                         throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
 688                 }
 689
 690                 // Auto-append missing trailing slash
 691                 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
 692
 693                 // Create the file name and return it
 694                 $pfn = ($pathFile[0] . $pathFile[1]);
 695                 return $pfn;
 696         }
 697
 698         /**
 699          * Appends a trailing slash to a string
 700          *
 701          * @param       $str            A string (maybe) without trailing slash
 702          * @return      $str            A string with an auto-appended trailing slash
 703          */
 704         public final function addMissingTrailingSlash ($str) {
 705                 // Is there a trailing slash?
 706                 if (substr($str, -1, 1) != "/") $str .= "/";
 707                 return $str;
 708         }
 709
 710         /**
 711          * Private getter for language instance
 712          *
 713          * @return      $langInstance   An instance to the language sub-system
 714          */
 715         protected final function getLanguageInstance () {
 716                 return $this->langInstance;
 717         }
 718
 719         /**
 720          * Setter for language instance
 721          *
 722          * @param       $langInstance   An instance to the language sub-system
 723          * @return      void
 724          * @see         LanguageSystem
 725          */
 726         public final function setLanguageInstance (ManageableLanguage $langInstance) {
 727                 $this->langInstance = $langInstance;
 728         }
 729
 730         /**
 731          * Private getter for file IO instance
 732          *
 733          * @return      $fileIOInstance An instance to the file I/O sub-system
 734          */
 735         protected final function getFileIOInstance () {
 736                 return $this->fileIOInstance;
 737         }
 738
 739         /**
 740          * Setter for file I/O instance
 741          *
 742          * @param       $fileIOInstance An instance to the file I/O sub-system
 743          * @return      void
 744          */
 745         public final function setFileIOInstance (FileIOHandler $fileIOInstance) {
 746                 $this->fileIOInstance = $fileIOInstance;
 747         }
 748
 749         /**
 750          * Protected getter for a manageable application helper class
 751          *
 752          * @return      $applicationInstance    An instance of a manageable application helper class
 753          */
 754         protected final function getApplicationInstance () {
 755                 return $this->applicationInstance;
 756         }
 757
 758         /**
 759          * Setter for a manageable application helper class
 760          *
 761          * @param       $applicationInstance    An instance of a manageable application helper class
 762          * @return      void
 763          */
 764         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
 765                 $this->applicationInstance = $applicationInstance;
 766         }
 767
 768         /**
 769          * Prepare the template engine (TemplateEngine by default) for a given
 770          * application helper instance (ApplicationHelper by default).
 771          *
 772          * @param               $appInstance                    An application helper instance or
 773          *                                                                              null if we shall use the default
 774          * @return              $tplEngine                              The template engine instance
 775          * @throws              NullPointerException    If the template engine could not
 776          *                                                                              be initialized
 777          * @throws              UnsupportedTemplateEngineException      If $tplEngine is an
 778          *                                                                              unsupported template engine
 779          * @throws              MissingLanguageHandlerException If the language sub-system
 780          *                                                                              is not yet initialized
 781          * @throws              NullPointerException    If the discovered application
 782          *                                                                              instance is still null
 783          */
 784         protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
 785                 // Is the application instance set?
 786                 if (is_null($appInstance)) {
 787                         // Get the current instance
 788                         $appInstance = $this->getApplicationInstance();
 789
 790                         // Still null?
 791                         if (is_null($appInstance)) {
 792                                 // Thrown an exception
 793                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 794                         }
 795                 }
 796
 797                 // Generate FQFN for all application templates
 798                 $fqfn = sprintf("%s%s/%s/%s",
 799                         PATH,
 800                         $this->getConfigInstance()->readConfig("application_path"),
 801                         strtolower($appInstance->getAppShortName()),
 802                         $this->getConfigInstance()->readConfig("tpl_base_path")
 803                 );
 804
 805                 // Are both instances set?
 806                 if ($appInstance->getLanguageInstance() === null) {
 807                         // Invalid language instance
 808                         throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
 809                 } elseif ($appInstance->getFileIOInstance() === null) {
 810                         // Invalid language instance
 811                         throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
 812                 }
 813
 814                 // Initialize the template engine
 815                 $tplEngine = null;
 816                 $eval = sprintf("\$tplEngine = %s::create%s(
 817         \"%s\",
 818         \$appInstance->getLanguageInstance(),
 819         \$appInstance->getFileIOInstance()
 820 );",
 821                         $this->getConfigInstance()->readConfig("tpl_engine"),
 822                         $this->getConfigInstance()->readConfig("tpl_engine"),
 823                         $fqfn
 824                 );
 825
 826                 // Debug message
 827                 if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
 828                         $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
 829                                 $this->__toString(),
 830                                 htmlentities($eval)
 831                         ));
 832                 }
 833
 834                 // Run the command
 835                 eval($eval);
 836
 837                 // Is it a valid instance?
 838                 if (is_null($tplEngine)) {
 839                         // No class returned
 840                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 841                 } elseif (!$tplEngine instanceof CompileableTemplate) {
 842                         // Not an object! ;-(
 843                         throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
 844                 }
 845
 846                 // Return the prepared instance
 847                 return $tplEngine;
 848         }
 849
 850         /**
 851          * Debugs this instance by putting out it's full content
 852          *
 853          * @return      void
 854          */
 855         public final function debugInstance () {
 856                 // Generate the output
 857                 $content = "<pre>".trim(print_r($this, true))."</pre>";
 858
 859                 // Output it
 860                 ApplicationEntryPoint::app_die("<strong>Debug output:</strong>".$content);
 861         }
 862 }
 863
 864 // [EOF]
 865 ?>