inc/classes/main/template/class_TemplateEngine.php

   1 <?php
   2 /**
   3  * The own template engine for loading caching and sending out the web pages
   4  * and emails.
   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 TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate {
  26         /**
  27          * The local path name where all templates and sub folders for special
  28          * templates are stored. We will internally determine the language plus
  29          * "html" for web templates or "emails" for email templates
  30          */
  31         private $basePath = "";
  32
  33         /**
  34          * The extension for web and email templates (not compiled templates)
  35          */
  36         private $templateExtension = ".tpl";
  37
  38         /**
  39          * The extension for code templates (not compiled templates)
  40          */
  41         private $codeExtension = ".ctp";
  42
  43         /**
  44          * Path relative to $basePath and language code for compiled code-templates
  45          */
  46         private $compileOutputPath = "templates/_compiled";
  47
  48         /**
  49          * The raw (maybe uncompiled) template
  50          */
  51         private $rawTemplateData = "";
  52
  53         /**
  54          * Template data with compiled-in variables
  55          */
  56         private $compiledData = "";
  57
  58         /**
  59          * The last loaded template's FQFN for debugging the engine
  60          */
  61         private $lastTemplate = "";
  62
  63         /**
  64          * The variable stack for the templates. This must be initialized and
  65          * shall become an instance of FrameworkArrayObject.
  66          */
  67         private $varStack = null;
  68
  69         /**
  70          * Configuration variables in a simple array
  71          */
  72         private $configVariables = array();
  73
  74         /**
  75          * Loaded templates for recursive protection and detection
  76          */
  77         private $loadedTemplates = array();
  78
  79         /**
  80          * Compiled templates for recursive protection and detection
  81          */
  82         private $compiledTemplates = array();
  83
  84         /**
  85          * Loaded raw template data
  86          */
  87         private $loadedRawData = null;
  88
  89         /**
  90          * Raw templates which are linked in code templates
  91          */
  92         private $rawTemplates = null;
  93
  94         /**
  95          * A regular expression for variable=value pairs
  96          */
  97         private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
  98
  99         /**
 100          * A regular expression for filtering out code tags
 101          *
 102          * E.g.: {?template:variable=value;var2=value2;[...]?}
 103          */
 104         private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
 105
 106         /**
 107          * Loaded helpers
 108          */
 109         private $helpers = array();
 110
 111         // Exception codes for the template engine
 112         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0xa00;
 113         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0xa01;
 114         const EXCEPTION_INVALID_VIEW_HELPER           = 0xa02;
 115
 116         /**
 117          * Protected constructor
 118          *
 119          * @return      void
 120          */
 121         protected function __construct () {
 122                 // Call parent constructor
 123                 parent::__construct(__CLASS__);
 124
 125                 // Set part description
 126                 $this->setObjectDescription("Web template engine");
 127
 128                 // Create unique ID number
 129                 $this->generateUniqueId();
 130
 131                 // Clean up a little
 132                 $this->removeNumberFormaters();
 133                 $this->removeSystemArray();
 134         }
 135
 136         /**
 137          * Creates an instance of the class TemplateEngine and prepares it for usage
 138          *
 139          * @param       $basePath               The local base path for all templates
 140          * @param       $langInstance   An instance of LanguageSystem (default)
 141          * @param       $ioInstance             An instance of FileIoHandler (default, middleware!)
 142          * @return      $tplInstance    An instance of TemplateEngine
 143          * @throws      BasePathIsEmptyException                If the provided $basePath is empty
 144          * @throws      InvalidBasePathStringException  If $basePath is no string
 145          * @throws      BasePathIsNoDirectoryException  If $basePath is no
 146          *                                                                                      directory or not found
 147          * @throws      BasePathReadProtectedException  If $basePath is
 148          *                                                                                      read-protected
 149          */
 150         public final static function createTemplateEngine ($basePath, ManageableLanguage  $langInstance, FileIoHandler $ioInstance) {
 151                 // Get a new instance
 152                 $tplInstance = new TemplateEngine();
 153
 154                 // Is the base path valid?
 155                 if (empty($basePath)) {
 156                         // Base path is empty
 157                         throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 158                 } elseif (!is_string($basePath)) {
 159                         // Is not a string
 160                         throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
 161                 } elseif (!is_dir($basePath)) {
 162                         // Is not a path
 163                         throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
 164                 } elseif (!is_readable($basePath)) {
 165                         // Is not readable
 166                         throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
 167                 }
 168
 169                 // Get configuration instance
 170                 $cfgInstance = FrameworkConfiguration::getInstance();
 171
 172                 // Set the base path
 173                 $tplInstance->setBasePath($basePath);
 174
 175                 // Initialize the variable stack
 176                 $tplInstance->initVariableStack();
 177
 178                 // Set the language and IO instances
 179                 $tplInstance->setLanguageInstance($langInstance);
 180                 $tplInstance->setFileIoInstance($ioInstance);
 181
 182                 // Set template extensions
 183                 $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
 184                 $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
 185
 186                 // Absolute output path for compiled templates
 187                 $tplInstance->setCompileOutputPath(PATH . $cfgInstance->readConfig('compile_output_path'));
 188
 189                 // Return the prepared instance
 190                 return $tplInstance;
 191         }
 192
 193         /**
 194          * Search for a variable in the stack
 195          *
 196          * @param               $var            The variable we are looking for
 197          * @return      $idx            FALSE means not found, >=0 means found on a specific index
 198          */
 199         private function isVariableAlreadySet ($var) {
 200                 // First everything is not found
 201                 $found = false;
 202
 203                 // Now search for it
 204                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
 205                         // Get current item
 206                         $currEntry = $idx->current();
 207
 208                         // Is the entry found?
 209                         if ($currEntry['name'] == $var) {
 210                                 // Found!
 211                                 $found = $idx->key();
 212                                 break;
 213                         }
 214                 }
 215
 216                 // Return the current position
 217                 return $found;
 218         }
 219
 220         /**
 221          * Return a content of a variable or null if not found
 222          *
 223          * @param       $var            The variable we are looking for
 224          * @return      $content        Content of the variable or null if not found
 225          */
 226         private function readVariable ($var) {
 227                 // First everything is not found
 228                 $content = null;
 229
 230                 // Now search for it
 231                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
 232                         // Get current item
 233                         $currEntry = $idx->current();
 234
 235                         // Is the entry found?
 236                         if ($currEntry['name'] == $var) {
 237                                 // Found!
 238                                 $content = $currEntry['value'];
 239                                 break;
 240                         }
 241                 }
 242
 243                 // Return the current position
 244                 return $content;
 245         }
 246
 247         /**
 248          * Add a variable to the stack
 249          *
 250          * @param               $var            The variable we are looking for
 251          * @param               $value  The value we want to store in the variable
 252          * @return      void
 253          */
 254         private function addVariable ($var, $value) {
 255                 // Add it to the stack
 256                 $this->varStack->append(array(
 257                         'name'  => trim($var),
 258                         'value' => trim($value)
 259                 ));
 260         }
 261
 262         /**
 263          * Modify an entry on the stack
 264          *
 265          * @param               $var            The variable we are looking for
 266          * @param               $value  The value we want to store in the variable
 267          * @return      void
 268          */
 269         private function modifyVariable ($var, $value) {
 270                 // It should be there so let's look again...
 271                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
 272                         // Get current entry
 273                         $currEntry = $idx->current();
 274
 275                         // Is this the requested variable?
 276                         if ($currEntry['name'] == $var) {
 277                                 // Change it to the other value
 278                                 $this->varStack->offsetSet($idx->key(), array(
 279                                         'name'  => $var,
 280                                         'value' => $value
 281                                 ));
 282                         }
 283                 }
 284         }
 285
 286         /**
 287          * Initialize the variable stack. This holds all variables for later
 288          * compilation.
 289          *
 290          * @return      void
 291          */
 292         public final function initVariableStack () {
 293                 $this->varStack = new FrameworkArrayObject("FakedVariableStack");
 294         }
 295
 296         /**
 297          * Setter for base path
 298          *
 299          * @param               $basePath               The local base path for all templates
 300          * @return      void
 301          */
 302         public final function setBasePath ($basePath) {
 303                 // Cast it
 304                 $basePath = (string) $basePath;
 305
 306                 // And set it
 307                 $this->basePath = $basePath;
 308         }
 309
 310         /**
 311          * Getter for base path
 312          *
 313          * @return      $basePath               The local base path for all templates
 314          */
 315         public final function getBasePath () {
 316                 // And set it
 317                 return $this->basePath;
 318         }
 319
 320         /**
 321          * Setter for template extension
 322          *
 323          * @param               $templateExtension      The file extension for all uncompiled
 324          *                                                      templates
 325          * @return      void
 326          */
 327         public final function setRawTemplateExtension ($templateExtension) {
 328                 // Cast it
 329                 $templateExtension = (string) $templateExtension;
 330
 331                 // And set it
 332                 $this->templateExtension = $templateExtension;
 333         }
 334
 335         /**
 336          * Setter for code template extension
 337          *
 338          * @param               $codeExtension          The file extension for all uncompiled
 339          *                                                      templates
 340          * @return      void
 341          */
 342         public final function setCodeTemplateExtension ($codeExtension) {
 343                 // Cast it
 344                 $codeExtension = (string) $codeExtension;
 345
 346                 // And set it
 347                 $this->codeExtension = $codeExtension;
 348         }
 349
 350         /**
 351          * Getter for template extension
 352          *
 353          * @return      $templateExtension      The file extension for all uncompiled
 354          *                                                      templates
 355          */
 356         public final function getRawTemplateExtension () {
 357                 // And set it
 358                 return $this->templateExtension;
 359         }
 360
 361         /**
 362          * Getter for code-template extension
 363          *
 364          * @return      $codeExtension          The file extension for all code-
 365          *                                                      templates
 366          */
 367         public final function getCodeTemplateExtension () {
 368                 // And set it
 369                 return $this->codeExtension;
 370         }
 371
 372         /**
 373          * Setter for path of compiled templates
 374          *
 375          * @param               $compileOutputPath              The local base path for all
 376          *                                                              compiled templates
 377          * @return      void
 378          */
 379         public final function setCompileOutputPath ($compileOutputPath) {
 380                 // Cast it
 381                 $compileOutputPath = (string) $compileOutputPath;
 382
 383                 // And set it
 384                 $this->compileOutputPath = $compileOutputPath;
 385         }
 386
 387         /**
 388          * Setter for template type. Only "html", "emails" and "compiled" should
 389          * be sent here
 390          *
 391          * @param               $templateType   The current template's type
 392          * @return      void
 393          */
 394         private final function setTemplateType ($templateType) {
 395                 // Cast it
 396                 $templateType = (string) $templateType;
 397
 398                 // And set it (only 2 letters)
 399                 $this->templateType = $templateType;
 400         }
 401
 402         /**
 403          * Getter for template type
 404          *
 405          * @return      $templateType   The current template's type
 406          */
 407         public final function getTemplateType () {
 408                 return $this->templateType;
 409         }
 410
 411         /**
 412          * Setter for the last loaded template's FQFN
 413          *
 414          * @param               $template               The last loaded template
 415          * @return      void
 416          */
 417         private final function setLastTemplate ($template) {
 418                 // Cast it to string
 419                 $template = (string) $template;
 420                 $this->lastTemplate = $template;
 421         }
 422
 423         /**
 424          * Getter for the last loaded template's FQFN
 425          *
 426          * @return      $template               The last loaded template
 427          */
 428         private final function getLastTemplate () {
 429                 return $this->lastTemplate;
 430         }
 431
 432         /**
 433          * Assign (add) a given variable with a value
 434          *
 435          * @param               $var            The variable we are looking for
 436          * @param               $value  The value we want to store in the variable
 437          * @return      void
 438          */
 439         public final function assignVariable ($var, $value) {
 440                 // First search for the variable if it was already added
 441                 $idx = $this->isVariableAlreadySet($var);
 442
 443                 // Was it found?
 444                 if ($idx === false) {
 445                         // Add it to the stack
 446                         $this->addVariable($var, $value);
 447                 } elseif (!empty($value)) {
 448                         // Modify the stack entry
 449                         $this->modifyVariable($var, $value);
 450                 }
 451         }
 452
 453         /**
 454          * Assign a given congfiguration variable with a value
 455          *
 456          * @param               $var            The configuration variable we are looking for
 457          * @param               $value  The value we want to store in the variable
 458          * @return      void
 459          */
 460         public final function assignConfigVariable ($var, $value) {
 461                 // Sweet and simple...
 462                 $this->configVariables[$var] = $value;
 463         }
 464
 465         /**
 466          * Removes a given variable
 467          *
 468          * @param               $var            The variable we are looking for
 469          * @return      void
 470          */
 471         public final function removeVariable ($var) {
 472                 // First search for the variable if it was already added
 473                 $idx = $this->isVariableAlreadySet($var);
 474
 475                 // Was it found?
 476                 if ($idx !== false) {
 477                         // Remove this variable
 478                         $this->varStack->offsetUnset($idx);
 479                 }
 480         }
 481
 482         /**
 483          * Private setter for raw template data
 484          *
 485          * @param               $rawTemplateData        The raw data from the template
 486          * @return      void
 487          */
 488         private final function setRawTemplateData ($rawTemplateData) {
 489                 // Cast it to string
 490                 $rawTemplateData = (string) $rawTemplateData;
 491
 492                 // And store it in this class
 493                 $this->rawTemplateData = $rawTemplateData;
 494         }
 495
 496         /**
 497          * Private setter for compiled templates
 498          */
 499         private final function setCompiledData ($compiledData) {
 500                 // Cast it to string
 501                 $compiledData = (string) $compiledData;
 502
 503                 // And store it in this class
 504                 $this->compiledData = $compiledData;
 505         }
 506
 507         /**
 508          * Private loader for all template types
 509          *
 510          * @param               $template               The template we shall load
 511          * @return      void
 512          */
 513         private final function loadTemplate ($template) {
 514                 // Cast it to string
 515                 $template = (string) $template;
 516
 517                 // Get extension for the template
 518                 $ext = $this->getRawTemplateExtension();
 519
 520                 // If we shall load a code-template we need to switch the file extension
 521                 if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) {
 522                         // Switch over to the code-template extension
 523                         $ext = $this->getCodeTemplateExtension();
 524                 }
 525
 526                 // Construct the FQFN for the template by honoring the current language
 527                 $fqfn = sprintf("%s%s/%s/%s%s",
 528                         $this->getBasePath(),
 529                         $this->getLanguageInstance()->getLanguageCode(),
 530                         $this->getTemplateType(),
 531                         $template,
 532                         $ext
 533                 );
 534
 535                 // Load the raw template data
 536                 $this->loadRawTemplateData($fqfn);
 537         }
 538
 539         /**
 540          * A private loader for raw template names
 541          *
 542          * @param               $fqfn   The full-qualified file name for a template
 543          * @return      void
 544          * @throws      NullPointerException    If $inputInstance is null
 545          * @throws      NoObjectException               If $inputInstance is not an object
 546          * @throws      MissingMethodException  If $inputInstance is missing a
 547          *                                                              required method
 548          */
 549         private function loadRawTemplateData ($fqfn) {
 550                 // Get a input/output instance from the middleware
 551                 $ioInstance = $this->getFileIoInstance();
 552
 553                 // Validate the instance
 554                 if (is_null($ioInstance)) {
 555                         // Throw exception
 556                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 557                 } elseif (!is_object($ioInstance)) {
 558                         // Throw another exception
 559                         throw new NoObjectException($ioInstance, self::EXCEPTION_IS_NO_OBJECT);
 560                 } elseif (!method_exists($ioInstance, 'loadFileContents')) {
 561                         // Throw yet another exception
 562                         throw new MissingMethodException(array($ioInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
 563                 }
 564
 565                 // Load the raw template
 566                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
 567
 568                 // Store the template's contents into this class
 569                 $this->setRawTemplateData($rawTemplateData);
 570
 571                 // Remember the template's FQFN
 572                 $this->setLastTemplate($fqfn);
 573         }
 574
 575         /**
 576          * Try to assign an extracted template variable as a "content" or "config"
 577          * variable.
 578          *
 579          * @param               $varName                The variable's name (shall be content or
 580          *                                              config) by default
 581          * @param               $var                    The variable we want to assign
 582          */
 583         private function assignTemplateVariable ($varName, $var) {
 584                 // Is it not a config variable?
 585                 if ($varName != "config") {
 586                         // Regular template variables
 587                         $this->assignVariable($var, "");
 588                 } else {
 589                         // Configuration variables
 590                         $this->assignConfigVariable($var, $this->getConfigInstance()->readConfig($var));
 591                 }
 592         }
 593
 594         /**
 595          * Extract variables from a given raw data stream
 596          *
 597          * @param       $rawData        The raw template data we shall analyze
 598          * @return      void
 599          */
 600         private function extractVariablesFromRawData ($rawData) {
 601                 // Cast to string
 602                 $rawData = (string) $rawData;
 603
 604                 // Search for variables
 605                 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
 606
 607                 // Did we find some variables?
 608                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
 609                         // Initialize all missing variables
 610                         foreach ($variableMatches[3] as $key=>$var) {
 611                                 // Try to assign it, empty strings are being ignored
 612                                 $this->assignTemplateVariable($variableMatches[1][$key], $var);
 613                         }
 614                 }
 615         }
 616
 617         /**
 618          * Main analysis of the loaded template
 619          *
 620          * @param               $templateMatches        Found template place-holders, see below
 621          * @return      void
 622          *
 623          *---------------------------------
 624          * Structure of $templateMatches:
 625          *---------------------------------
 626          * [0] => Array - An array with all full matches
 627          * [1] => Array - An array with left part (before the ":") of a match
 628          * [2] => Array - An array with right part of a match including ":"
 629          * [3] => Array - An array with right part of a match excluding ":"
 630          */
 631         private function analyzeTemplate (array $templateMatches) {
 632                 // Backup raw template data
 633                 $backup = $this->getRawTemplateData();
 634
 635                 // Initialize some arrays
 636                 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
 637
 638                 // Load all requested templates
 639                 foreach ($templateMatches[1] as $template) {
 640
 641                         // Load and compile only templates which we have not yet loaded
 642                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
 643                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
 644
 645                                 // Template not found, but maybe variable assigned?
 646                                 if ($this->isVariableAlreadySet($template) !== false) {
 647                                         // Use that content here
 648                                         $this->loadedRawData[$template] = $this->readVariable($template);
 649
 650                                         // Recursive protection:
 651                                         $this->loadedTemplates[] = $template;
 652                                 } else {
 653                                         // Then try to search for code-templates
 654                                         try {
 655                                                 // Load the code template and remember it's contents
 656                                                 $this->loadCodeTemplate($template);
 657                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 658
 659                                                 // Remember this template for recursion detection
 660                                                 // RECURSIVE PROTECTION!
 661                                                 $this->loadedTemplates[] = $template;
 662                                         } catch (FilePointerNotOpenedException $e) {
 663                                                 // Even this is not done... :/
 664                                                 $this->rawTemplates[] = $template;
 665                                         }
 666                                 }
 667
 668                         } // if ((!isset( ...
 669
 670                 } // for ($templateMatches ...
 671
 672                 // Restore the raw template data
 673                 $this->setRawTemplateData($backup);
 674         }
 675
 676         /**
 677          * Compile a given raw template code and remember it for later usage
 678          *
 679          * @param               $code           The raw template code
 680          * @param               $template               The template's name
 681          * @return      void
 682          */
 683         private function compileCode ($code, $template) {
 684                 // Is this template already compiled?
 685                 if (in_array($template, $this->compiledTemplates)) {
 686                         // Abort here...
 687                         return;
 688                 }
 689
 690                 // Remember this template being compiled
 691                 $this->compiledTemplates[] = $template;
 692
 693                 // Compile the loaded code in five steps:
 694                 //
 695                 // 1. Backup current template data
 696                 $backup = $this->getRawTemplateData();
 697
 698                 // 2. Set the current template's raw data as the new content
 699                 $this->setRawTemplateData($code);
 700
 701                 // 3. Compile the template data
 702                 $this->compileTemplate();
 703
 704                 // 4. Remember it's contents
 705                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 706
 707                 // 5. Restore the previous raw content from backup variable
 708                 $this->setRawTemplateData($backup);
 709         }
 710
 711         /**
 712          * Insert all given and loaded templates by running through all loaded
 713          * codes and searching for their place-holder in the main template
 714          *
 715          * @param               $templateMatches        See method analyzeTemplate()
 716          * @return      void
 717          */
 718         private function insertAllTemplates (array $templateMatches) {
 719                 // Run through all loaded codes
 720                 foreach ($this->loadedRawData as $template=>$code) {
 721
 722                         // Search for the template
 723                         $foundIndex = array_search($template, $templateMatches[1]);
 724
 725                         // Lookup the matching template replacement
 726                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
 727
 728                                 // Get the current raw template
 729                                 $rawData = $this->getRawTemplateData();
 730
 731                                 // Replace the space holder with the template code
 732                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
 733
 734                                 // Set the new raw data
 735                                 $this->setRawTemplateData($rawData);
 736
 737                         } // END - if
 738
 739                 } // END - foreach
 740         }
 741
 742         /**
 743          * Load all extra raw templates
 744          *
 745          * @return      void
 746          */
 747         private function loadExtraRawTemplates () {
 748                 // Are there some raw templates we need to load?
 749                 if (count($this->rawTemplates) > 0) {
 750                         // Try to load all raw templates
 751                         foreach ($this->rawTemplates as $key => $template) {
 752                                 try {
 753                                         // Load the template
 754                                         $this->loadWebTemplate($template);
 755
 756                                         // Remember it's contents
 757                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
 758
 759                                         // Remove it from the loader list
 760                                         unset($this->rawTemplates[$key]);
 761
 762                                         // Remember this template for recursion detection
 763                                         // RECURSIVE PROTECTION!
 764                                         $this->loadedTemplates[] = $template;
 765                                 } catch (FilePointerNotOpenedException $e) {
 766                                         // This template was never found. We silently ignore it
 767                                         unset($this->rawTemplates[$key]);
 768                                 }
 769                         }
 770                 }
 771         }
 772
 773         /**
 774          * Assign all found template variables
 775          *
 776          * @param               $varMatches     An array full of variable/value pairs.
 777          * @return      void
 778          */
 779         private function assignAllVariables (array $varMatches) {
 780                 // Search for all variables
 781                 foreach ($varMatches[1] as $key=>$var) {
 782
 783                         // Detect leading equals
 784                         if (substr($varMatches[2][$key], 0, 1) == "=") {
 785                                 // Remove and cast it
 786                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
 787                         }
 788
 789                         // Do we have some quotes left and right side? Then it is free text
 790                         if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
 791                                 // Free string detected! Which we can assign directly
 792                                 $this->assignVariable($var, $varMatches[3][$key]);
 793                         } elseif (!empty($varMatches[2][$key])) {
 794                                 // Non-string found so we need some deeper analysis...
 795                                 // @TODO Unfinished work or don't die here.
 796                                 die("Deeper analysis not yet implemented!");
 797                         }
 798
 799                 } // for ($varMatches ...
 800         }
 801         /**
 802          * Compiles all loaded raw templates
 803          *
 804          * @param               $templateMatches        See method analyzeTemplate() for details
 805          * @return      void
 806          */
 807         private function compileRawTemplateData (array $templateMatches) {
 808                 // Are some code-templates found which we need to compile?
 809                 if (count($this->loadedRawData) > 0) {
 810
 811                         // Then compile all!
 812                         foreach ($this->loadedRawData as $template=>$code) {
 813
 814                                 // Is this template already compiled?
 815                                 if (in_array($template, $this->compiledTemplates)) {
 816                                         // Then skip it
 817                                         continue;
 818                                 }
 819
 820                                 // Search for the template
 821                                 $foundIndex = array_search($template, $templateMatches[1]);
 822
 823                                 // Lookup the matching variable data
 824                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
 825
 826                                         // Split it up with another reg. exp. into variable=value pairs
 827                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
 828
 829                                         // Assign all variables
 830                                         $this->assignAllVariables($varMatches);
 831
 832                                 } // END - if (isset($templateMatches ...
 833
 834                                 // Compile the loaded template
 835                                 $this->compileCode($code, $template);
 836
 837                         } // END - foreach ($this->loadedRawData ...
 838
 839                         // Insert all templates
 840                         $this->insertAllTemplates($templateMatches);
 841
 842                 } // END - if (count($this->loadedRawData) ...
 843         }
 844
 845         /**
 846          * Inserts all raw templates into their respective variables
 847          *
 848          * @return      void
 849          */
 850         private function insertRawTemplates () {
 851                 // Load all templates
 852                 foreach ($this->rawTemplates as $template=>$content) {
 853                         // Set the template as a variable with the content
 854                         $this->assignVariable($template, $content);
 855                 }
 856         }
 857
 858         /**
 859          * Finalizes the compilation of all template variables
 860          *
 861          * @return      void
 862          */
 863         private function finalizeVariableCompilation () {
 864                 // Get the content
 865                 $content = $this->getRawTemplateData();
 866
 867                 // Walk through all variables
 868                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
 869                         // Get current entry
 870                         $currEntry = $idx->current();
 871
 872                         // Replace all [$var] or {?$var?} with the content
 873                         //* DEBUG: */ echo "name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
 874                         $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content);
 875                         $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content);
 876                         $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content);
 877                 } // END - for
 878
 879                 // Set the content back
 880                 $this->setRawTemplateData($content);
 881         }
 882
 883         /**
 884          * Getter for raw template data
 885          *
 886          * @return      $rawTemplateData        The raw data from the template
 887          */
 888         public final function getRawTemplateData () {
 889                 return $this->rawTemplateData;
 890         }
 891
 892         /**
 893          * Getter for compiled templates
 894          */
 895         public final function getCompiledData () {
 896                 return $this->compiledData;
 897         }
 898
 899         /**
 900          * Load a specified web template into the engine
 901          *
 902          * @param               $template               The web template we shall load which is
 903          *                                              located in "html" by default
 904          * @return      void
 905          */
 906         public final function loadWebTemplate ($template) {
 907                 // Set template type
 908                 $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
 909
 910                 // Load the special template
 911                 $this->loadTemplate($template);
 912         }
 913
 914         /**
 915          * Load a specified email template into the engine
 916          *
 917          * @param               $template               The email template we shall load which is
 918          *                                              located in "emails" by default
 919          * @return      void
 920          */
 921         public final function loadEmailTemplate ($template) {
 922                 // Set template type
 923                 $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
 924
 925                 // Load the special template
 926                 $this->loadTemplate($template);
 927         }
 928
 929         /**
 930          * Load a specified code template into the engine
 931          *
 932          * @param               $template               The code template we shall load which is
 933          *                                              located in "code" by default
 934          * @return      void
 935          */
 936         public final function loadCodeTemplate ($template) {
 937                 // Set template type
 938                 $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
 939
 940                 // Load the special template
 941                 $this->loadTemplate($template);
 942         }
 943
 944         /**
 945          * Compile all variables by inserting their respective values
 946          *
 947          * @return      void
 948          */
 949         public final function compileVariables () {
 950                 // Initialize the $content array
 951                 $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
 952                 $dummy = array();
 953
 954                 // Iterate through all variables
 955                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
 956
 957                         // Get current variable from the stack
 958                         $currVariable = $idx->current();
 959
 960                         // Transfer it's name/value combination to the $content array
 961                         //* DEBUG: */ echo $currVariable['name']."=<pre>".htmlentities($currVariable['value'])."</pre>\n";
 962                         $dummy[$currVariable['name']] = $currVariable['value'];
 963
 964                 }// END - if
 965
 966                 // Set the new variable (don't remove the second dollar !)
 967                 $$validVar = $dummy;
 968
 969                 // Prepare all configuration variables
 970                 $config = $this->configVariables;
 971
 972                 // Remove some variables
 973                 unset($idx);
 974                 unset($currVariable);
 975
 976                 // Run the compilation twice to get content from helper classes in
 977                 $cnt = 0;
 978                 while ($cnt < 3) {
 979                         // Finalize the compilation of template variables
 980                         $this->finalizeVariableCompilation();
 981
 982                         // Prepare the eval() command for comiling the template
 983                         $eval = sprintf("\$result = \"%s\";",
 984                                 addslashes($this->getRawTemplateData())
 985                         );
 986
 987                         // This loop does remove the backslashes (\) in PHP parameters
 988                         // @TODO Make this some nicer...
 989                         while (strpos($eval, "<?") !== false) {
 990                                 // Get left part before "<?"
 991                                 $evalLeft = substr($eval, 0, strpos($eval, "<?"));
 992
 993                                 // Get all from right of "<?"
 994                                 $evalRight = substr($eval, (strpos($eval, "<?") + 2));
 995
 996                                 // Is this a full PHP tag?
 997                                 if (substr(strtolower($evalRight), 0, 3) == "php") {
 998                                         // Remove "php" string from full PHP tag
 999                                         $evalRight = substr($evalRight, 3);
1000                                 } // END - if
1001
1002                                 // Cut middle part out and remove escapes
1003                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>")));
1004                                 $evalMiddle = stripslashes($evalMiddle);
1005
1006                                 // Remove the middle part from right one
1007                                 $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2));
1008
1009                                 // And put all together
1010                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1011                         } // END - while
1012
1013                         // Prepare PHP code for eval() command
1014                         $eval = str_replace(
1015                                 "<%php", "\";",
1016                                 str_replace(
1017                                         "%>", "\$result .= \"", $eval
1018                                 )
1019                         );
1020
1021                         // Debug message
1022                         if ((defined('DEBUG_EVAL')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
1023                                 $this->__toString(),
1024                                 htmlentities($eval)
1025                         ));
1026
1027                         // Run the constructed command. This will "compile" all variables in
1028                         eval($eval);
1029
1030                         // Set raw template data
1031                         $this->setRawTemplateData($result);
1032                         $cnt++;
1033                 }
1034
1035                 // Set the new content
1036                 $this->setCompiledData($result);
1037         }
1038
1039         /**
1040          * Compile all required templates into the current loaded one
1041          *
1042          * @return      void
1043          * @throws      UnexpectedTemplateTypeException If the template type is
1044          *                                                                                      not "code"
1045          * @throws      InvalidArrayCountException              If an unexpected array
1046          *                                                                                      count has been found
1047          */
1048         public final function compileTemplate () {
1049                 // We will only work with template type "code" from configuration
1050                 if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
1051                         // Abort here
1052                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1053                 } // END - if
1054
1055                 // Get the raw data.
1056                 $rawData = $this->getRawTemplateData();
1057
1058                 // Remove double spaces and trim leading/trailing spaces
1059                 $rawData = trim(str_replace("  ", " ", $rawData));
1060
1061                 // Search for raw variables
1062                 $this->extractVariablesFromRawData($rawData);
1063
1064                 // Search for code-tags which are {? ?}
1065                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1066
1067                 // Analyze the matches array
1068                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1069                         // Entries are found:
1070                         //
1071                         // The main analysis
1072                         $this->analyzeTemplate($templateMatches);
1073
1074                         // Compile raw template data
1075                         $this->compileRawTemplateData($templateMatches);
1076
1077                         // Are there some raw templates left for loading?
1078                         $this->loadExtraRawTemplates();
1079
1080                         // Are some raw templates found and loaded?
1081                         if (count($this->rawTemplates) > 0) {
1082
1083                                 // Insert all raw templates
1084                                 $this->insertRawTemplates();
1085
1086                                 // Remove the raw template content as well
1087                                 $this->setRawTemplateData("");
1088
1089                         } // END - if
1090
1091                 } // END - if($templateMatches ...
1092         }
1093
1094         /**
1095          * Output the compiled page to the outside world. In case of web templates
1096          * this would be vaild (X)HTML code. And in case of email templates this
1097          * would store a prepared email body inside the template engine.
1098          *
1099          * @return      void
1100          */
1101         public final function output () {
1102                 // Check which type of template we have
1103                 switch ($this->getTemplateType()) {
1104                 case "html": // Raw HTML templates can be send to the output buffer
1105                         // Quick-N-Dirty:
1106                         $this->getWebOutputInstance()->output($this->getCompiledData());
1107                         break;
1108
1109                 default: // Unknown type found
1110                         // Construct message
1111                         $msg = sprintf("[%s:] Unknown/unsupported template type <strong>%s</strong> detected.",
1112                                 $this->__toString(),
1113                                 $this->getTemplateType()
1114                         );
1115
1116                         if ((is_object($this->getDebugInstance())) && (method_exists($this->getDebugInstance(), 'output'))) {
1117                                 // Use debug output handler
1118                                 $this->getDebugInstance()->output($msg);
1119                                 die();
1120                         } else {
1121                                 // Put directly out
1122                                 // DO NOT REWRITE THIS TO app_die() !!!
1123                                 die($msg);
1124                         }
1125                         break;
1126                 }
1127         }
1128
1129         /**
1130          * Loads a given view helper (by name)
1131          *
1132          * @param       $helperName     The helper's name
1133          * @return      void
1134          * @throws      ViewHelperNotFoundException     If the given view helper was not found
1135          */
1136         protected function loadViewHelper ($helperName) {
1137                 // Make first character upper case, rest low
1138                 $helperName = ucfirst($helperName);
1139
1140                 // Is this view helper loaded?
1141                 if (!isset($this->helpers[$helperName])) {
1142                         // Create a class name
1143                         $className = "{$helperName}ViewHelper";
1144
1145                         // Does this class exists?
1146                         if (!class_exists($className)) {
1147                                 // Abort here!
1148                                 throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER);
1149                         }
1150
1151                         // Generate new instance
1152                         $eval = sprintf("\$this->helpers[%s] = %s::create%s();",
1153                                 $helperName,
1154                                 $className,
1155                                 $className
1156                         );
1157
1158                         // Run the code
1159                         eval($eval);
1160                 }
1161
1162                 // Return the requested instance
1163                 return $this->helpers[$helperName];
1164         }
1165
1166         /**
1167          * Assigns the last loaded raw template content with a given variable
1168          *
1169          * @param       $templateName   Name of the template we want to assign
1170          * @param       $variableName   Name of the variable we want to assign
1171          * @return      void
1172          */
1173         public function assignTemplateWithVariable ($templateName, $variableName) {
1174                 // Get the content from last loaded raw template
1175                 $content = $this->getRawTemplateData();
1176
1177                 // Assign the variable
1178                 $this->assignVariable($variableName, $content);
1179
1180                 // Purge raw content
1181                 $this->setRawTemplateData("");
1182         }
1183
1184         /**
1185          * Transfers the content of this template engine to a given response instance
1186          *
1187          * @param       $responseInstance       An instance of a response class
1188          * @return      void
1189          */
1190         public function transferToResponse (Responseable $responseInstance) {
1191                 // Get the content and set it in the response class
1192                 $responseInstance->writeToBody($this->getCompiledData());
1193         }
1194
1195         /**
1196          * Assigns all the application data with template variables
1197          *
1198          * @param       $appInstance    A manageable application instance
1199          * @return      void
1200          */
1201         public function assignApplicationData (ManageableApplication $appInstance) {
1202                 // Get long name and assign it
1203                 $this->assignVariable("app_full_name" , $appInstance->getAppName());
1204
1205                 // Get short name and assign it
1206                 $this->assignVariable("app_short_name", $appInstance->getAppShortName());
1207
1208                 // Get version number and assign it
1209                 $this->assignVariable("app_version"   , $appInstance->getAppVersion());
1210         }
1211 }
1212
1213 // [EOF]
1214 ?>