inc/classes/main/template/class_BaseTemplateEngine.php

   1 <?php
   2 /**
   3  * A generic template engine
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseTemplateEngine extends BaseFrameworkSystem {
  25         /**
  26          * The local path name where all templates and sub folders for special
  27          * templates are stored. We will internally determine the language plus
  28          * "html" for web templates or "emails" for email templates
  29          */
  30         private $templateBasePath = '';
  31
  32         /**
  33          * Template type
  34          */
  35         private $templateType = 'html';
  36
  37         /**
  38          * The extension for web and email templates (not compiled templates)
  39          */
  40         private $templateExtension = '.tpl';
  41
  42         /**
  43          * The extension for code templates (not compiled templates)
  44          */
  45         private $codeExtension = '.ctp';
  46
  47         /**
  48          * Path relative to $templateBasePath and language code for compiled code-templates
  49          */
  50         private $compileOutputPath = 'templates/_compiled/';
  51
  52         /**
  53          * The path name for all templates
  54          */
  55         private $genericBasePath = 'templates/';
  56
  57         /**
  58          * The raw (maybe uncompiled) template
  59          */
  60         private $rawTemplateData = '';
  61
  62         /**
  63          * Template data with compiled-in variables
  64          */
  65         private $compiledData = '';
  66
  67         /**
  68          * The last loaded template's FQFN for debugging the engine
  69          */
  70         private $lastTemplate = '';
  71
  72         /**
  73          * The variable stack for the templates
  74          */
  75         private $varStack = array();
  76
  77         /**
  78          * Loaded templates for recursive protection and detection
  79          */
  80         private $loadedTemplates = array();
  81
  82         /**
  83          * Compiled templates for recursive protection and detection
  84          */
  85         private $compiledTemplates = array();
  86
  87         /**
  88          * Loaded raw template data
  89          */
  90         private $loadedRawData = null;
  91
  92         /**
  93          * Raw templates which are linked in code templates
  94          */
  95         private $rawTemplates = null;
  96
  97         /**
  98          * A regular expression for variable=value pairs
  99          */
 100         private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
 101
 102         /**
 103          * A regular expression for filtering out code tags
 104          *
 105          * E.g.: {?template:variable=value;var2=value2;[...]?}
 106          */
 107         private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
 108
 109         /**
 110          * Loaded helpers
 111          */
 112         private $helpers = array();
 113
 114         /**
 115          * Current variable group
 116          */
 117         private $currGroup = 'general';
 118
 119         /**
 120          * All template groups except "general"
 121          */
 122         private $varGroups = array();
 123
 124         /**
 125          * Code begin
 126          */
 127         private $codeBegin = '<?php';
 128
 129         /**
 130          * Code end
 131          */
 132         private $codeEnd = '?>';
 133
 134         /**
 135          * Language support is enabled by default
 136          */
 137         private $languageSupport = true;
 138
 139         // Exception codes for the template engine
 140         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x110;
 141         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
 142         const EXCEPTION_INVALID_VIEW_HELPER           = 0x112;
 143
 144         /**
 145          * Protected constructor
 146          *
 147          * @param       $className      Name of the class
 148          * @return      void
 149          */
 150         protected function __construct ($className) {
 151                 // Call parent constructor
 152                 parent::__construct($className);
 153         }
 154
 155         /**
 156          * Search for a variable in the stack
 157          *
 158          * @param       $var    The variable we are looking for
 159          * @return      $idx    FALSE means not found, >=0 means found on a specific index
 160          */
 161         private function isVariableAlreadySet ($var) {
 162                 // First everything is not found
 163                 $found = false;
 164
 165                 // Is the group there?
 166                 if (isset($this->varStack[$this->currGroup])) {
 167                         // Now search for it
 168                         foreach ($this->varStack[$this->currGroup] as $idx => $currEntry) {
 169                                 //* DEBUG: */ echo __METHOD__.":currGroup={$this->currGroup},idx={$idx},currEntry={$currEntry['name']},var={$var}<br />\n";
 170                                 // Is the entry found?
 171                                 if ($currEntry['name'] == $var) {
 172                                         // Found!
 173                                         //* DEBUG: */ echo __METHOD__.":FOUND!<br />\n";
 174                                         $found = $idx;
 175                                         break;
 176                                 } // END - if
 177                         } // END - foreach
 178                 } // END - if
 179
 180                 // Return the current position
 181                 return $found;
 182         }
 183
 184         /**
 185          * Return a content of a variable or null if not found
 186          *
 187          * @param       $var            The variable we are looking for
 188          * @return      $content        Content of the variable or null if not found
 189          */
 190         protected function readVariable ($var) {
 191                 // First everything is not found
 192                 $content = null;
 193
 194                 // Get variable index
 195                 $found = $this->isVariableAlreadySet($var);
 196
 197                 // Is the variable found?
 198                 if ($found !== false) {
 199                         // Read it
 200                         $found = $this->varStack[$this->currGroup][$found]['value'];
 201                 } // END - if
 202
 203                 //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."<br />\n";
 204
 205                 // Return the current position
 206                 return $found;
 207         }
 208
 209         /**
 210          * Add a variable to the stack
 211          *
 212          * @param       $var    The variable we are looking for
 213          * @param       $value  The value we want to store in the variable
 214          * @return      void
 215          */
 216         private function addVariable ($var, $value) {
 217                 // Set general variable group
 218                 $this->setVariableGroup('general');
 219
 220                 // Add it to the stack
 221                 $this->addGroupVariable($var, $value);
 222         }
 223
 224         /**
 225          * Returns all variables of current group or empty array
 226          *
 227          * @return      $result         Wether array of found variables or empty array
 228          */
 229         private function readCurrentGroup () {
 230                 // Default is not found
 231                 $result = array();
 232
 233                 // Is the group there?
 234                 if (isset($this->varStack[$this->currGroup])) {
 235                         // Then use it
 236                         $result = $this->varStack[$this->currGroup];
 237                 } // END - if
 238
 239                 // Return result
 240                 return $result;
 241         }
 242
 243         /**
 244          * Settter for variable group
 245          *
 246          * @param       $groupName      Name of variable group
 247          * @param       $add            Wether add this group
 248          * @retur4n     void
 249          */
 250         public function setVariableGroup ($groupName, $add = true) {
 251                 // Set group name
 252                 //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."<br />\n";
 253                 $this->currGroup = $groupName;
 254
 255                 // Skip group 'general'
 256                 if (($groupName != 'general') && ($add === true)) {
 257                         $this->varGroups[$groupName] = 'OK';
 258                 } // END - if
 259         }
 260
 261
 262         /**
 263          * Adds a variable to current group
 264          *
 265          * @param       $var    Variable to set
 266          * @param       $value  Value to store in variable
 267          * @return      void
 268          */
 269         public function addGroupVariable ($var, $value) {
 270                 //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."<br />\n";
 271
 272                 // Get current variables in group
 273                 $currVars = $this->readCurrentGroup();
 274
 275                 // Append our variable
 276                 $currVars[] = array(
 277                         'name'  => $var,
 278                         'value' => $value
 279                 );
 280
 281                 // Add it to the stack
 282                 $this->varStack[$this->currGroup] = $currVars;
 283         }
 284
 285         /**
 286          * Modify an entry on the stack
 287          *
 288          * @param       $var    The variable we are looking for
 289          * @param       $value  The value we want to store in the variable
 290          * @return      void
 291          */
 292         private function modifyVariable ($var, $value) {
 293                 // Get index for variable
 294                 $idx = $this->isVariableAlreadySet($var);
 295
 296                 // Is the variable set?
 297                 if ($idx !== false) {
 298                         // Then modify it
 299                         $this->varStack[$this->currGroup][$idx]['value'] = $value;
 300                 } // END - if
 301         }
 302
 303         /**
 304          * Setter for template type. Only 'html', 'emails' and 'compiled' should
 305          * be sent here
 306          *
 307          * @param       $templateType   The current template's type
 308          * @return      void
 309          */
 310         protected final function setTemplateType ($templateType) {
 311                 $this->templateType = (string) $templateType;
 312         }
 313
 314         /**
 315          * Setter for the last loaded template's FQFN
 316          *
 317          * @param       $template       The last loaded template
 318          * @return      void
 319          */
 320         private final function setLastTemplate ($template) {
 321                 $this->lastTemplate = (string) $template;
 322         }
 323
 324         /**
 325          * Getter for the last loaded template's FQFN
 326          *
 327          * @return      $template       The last loaded template
 328          */
 329         private final function getLastTemplate () {
 330                 return $this->lastTemplate;
 331         }
 332
 333         /**
 334          * Setter for base path
 335          *
 336          * @param               $templateBasePath               The relative base path for all templates
 337          * @return      void
 338          */
 339         public final function setTemplateBasePath ($templateBasePath) {
 340                 // And set it
 341                 $this->templateBasePath = (string) $templateBasePath;
 342         }
 343
 344         /**
 345          * Getter for base path
 346          *
 347          * @return      $templateBasePath               The relative base path for all templates
 348          */
 349         public final function getTemplateBasePath () {
 350                 // And set it
 351                 return $this->templateBasePath;
 352         }
 353
 354         /**
 355          * Getter for generic base path
 356          *
 357          * @return      $templateBasePath               The relative base path for all templates
 358          */
 359         public final function getGenericBasePath () {
 360                 // And set it
 361                 return $this->genericBasePath;
 362         }
 363
 364         /**
 365          * Setter for template extension
 366          *
 367          * @param               $templateExtension      The file extension for all uncompiled
 368          *                                                      templates
 369          * @return      void
 370          */
 371         public final function setRawTemplateExtension ($templateExtension) {
 372                 // And set it
 373                 $this->templateExtension = (string) $templateExtension;
 374         }
 375
 376         /**
 377          * Setter for code template extension
 378          *
 379          * @param               $codeExtension          The file extension for all uncompiled
 380          *                                                      templates
 381          * @return      void
 382          */
 383         public final function setCodeTemplateExtension ($codeExtension) {
 384                 // And set it
 385                 $this->codeExtension = (string) $codeExtension;
 386         }
 387
 388         /**
 389          * Getter for template extension
 390          *
 391          * @return      $templateExtension      The file extension for all uncompiled
 392          *                                                      templates
 393          */
 394         public final function getRawTemplateExtension () {
 395                 // And set it
 396                 return $this->templateExtension;
 397         }
 398
 399         /**
 400          * Getter for code-template extension
 401          *
 402          * @return      $codeExtension          The file extension for all code-
 403          *                                                      templates
 404          */
 405         public final function getCodeTemplateExtension () {
 406                 // And set it
 407                 return $this->codeExtension;
 408         }
 409
 410         /**
 411          * Setter for path of compiled templates
 412          *
 413          * @param       $compileOutputPath      The local base path for all compiled
 414          *                                                              templates
 415          * @return      void
 416          */
 417         public final function setCompileOutputPath ($compileOutputPath) {
 418                 // And set it
 419                 $this->compileOutputPath = (string) $compileOutputPath;
 420         }
 421
 422         /**
 423          * Getter for template type
 424          *
 425          * @return      $templateType   The current template's type
 426          */
 427         public final function getTemplateType () {
 428                 return $this->templateType;
 429         }
 430
 431         /**
 432          * Assign (add) a given variable with a value
 433          *
 434          * @param       $var    The variable we are looking for
 435          * @param       $value  The value we want to store in the variable
 436          * @return      void
 437          * @throws      EmptyVariableException  If the variable name is left empty
 438          */
 439         public final function assignVariable ($var, $value) {
 440                 // Trim spaces of variable name
 441                 $var = trim($var);
 442
 443                 // Empty variable found?
 444                 if (empty($var)) {
 445                         // Throw an exception
 446                         throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 447                 } // END - if
 448
 449                 // First search for the variable if it was already added
 450                 $idx = $this->isVariableAlreadySet($var);
 451
 452                 // Was it found?
 453                 if ($idx === false) {
 454                         // Add it to the stack
 455                         //* DEBUG: */ echo "ADD: ".$var."<br />\n";
 456                         $this->addVariable($var, $value);
 457                 } elseif (!empty($value)) {
 458                         // Modify the stack entry
 459                         //* DEBUG: */ echo "MOD: ".$var."<br />\n";
 460                         $this->modifyVariable($var, $value);
 461                 }
 462         }
 463
 464         /**
 465          * Removes a given variable
 466          *
 467          * @param       $var    The variable we are looking for
 468          * @return      void
 469          */
 470         public final function removeVariable ($var) {
 471                 // First search for the variable if it was already added
 472                 $idx = $this->isVariableAlreadySet($var);
 473
 474                 // Was it found?
 475                 if ($idx !== false) {
 476                         // Remove this variable
 477                         $this->varStack->offsetUnset($idx);
 478                 }
 479         }
 480
 481         /**
 482          * Private setter for raw template data
 483          *
 484          * @param       $rawTemplateData        The raw data from the template
 485          * @return      void
 486          */
 487         protected final function setRawTemplateData ($rawTemplateData) {
 488                 // And store it in this class
 489                 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($rawTemplateData).' Bytes set.<br />\n';
 490                 //* DEBUG: */ echo $this->currGroup.' variables: '.count($this->varStack[$this->currGroup]).', groups='.count($this->varStack).'<br />\n';
 491                 $this->rawTemplateData = (string) $rawTemplateData;
 492         }
 493
 494         /**
 495          * Getter for raw template data
 496          *
 497          * @return      $rawTemplateData        The raw data from the template
 498          */
 499         public final function getRawTemplateData () {
 500                 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->rawTemplateData).' Bytes read.<br />\n';
 501                 return $this->rawTemplateData;
 502         }
 503
 504         /**
 505          * Private setter for compiled templates
 506          *
 507          * @return      void
 508          */
 509         private final function setCompiledData ($compiledData) {
 510                 // And store it in this class
 511                 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($compiledData).' Bytes set.<br />\n';
 512                 $this->compiledData = (string) $compiledData;
 513         }
 514
 515         /**
 516          * Getter for compiled templates
 517          *
 518          * @return      $compiledData   Compiled template data
 519          */
 520         public final function getCompiledData () {
 521                 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.<br />\n';
 522                 return $this->compiledData;
 523         }
 524
 525         /**
 526          * Private loader for all template types
 527          *
 528          * @param       $template       The template we shall load
 529          * @param       $extOther       An other extension to use
 530          * @return      void
 531          * @throws      FileIoException If the template was not found
 532          */
 533         protected function loadTemplate ($template, $extOther = '') {
 534                 // Get extension for the template if empty
 535                 if (empty($extOther)) {
 536                         // None provided, so get the raw one
 537                         $ext = $this->getRawTemplateExtension();
 538                 } else {
 539                         // Then use it!
 540                         $ext = (string) $extOther;
 541                 }
 542
 543                 // Is language support enabled?
 544                 if ($this->isLanguageSupportEnabled()) {
 545                         // Construct the FQFN for the template by honoring the current language
 546                         $fqfn = sprintf("%s%s%s%s/%s/%s%s",
 547                                 $this->getConfigInstance()->getConfigEntry('base_path'),
 548                                 $this->getTemplateBasePath(),
 549                                 $this->getGenericBasePath(),
 550                                 $this->getLanguageInstance()->getLanguageCode(),
 551                                 $this->getTemplateType(),
 552                                 (string) $template,
 553                                 $ext
 554                         );
 555                 } else {
 556                         // Construct the FQFN for the template without language
 557                         $fqfn = sprintf("%s%s%s%s/%s%s",
 558                                 $this->getConfigInstance()->getConfigEntry('base_path'),
 559                                 $this->getTemplateBasePath(),
 560                                 $this->getGenericBasePath(),
 561                                 $this->getTemplateType(),
 562                                 (string) $template,
 563                                 $ext
 564                         );
 565                 }
 566
 567                 // First try this
 568                 try {
 569                         // Load the raw template data
 570                         $this->loadRawTemplateData($fqfn);
 571                 } catch (FileIoException $e) {
 572                         // If we shall load a code-template we need to switch the file extension
 573                         if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
 574                                 // Switch over to the code-template extension and try it again
 575                                 $ext = $this->getCodeTemplateExtension();
 576
 577                                 // Try it again...
 578                                 $this->loadTemplate($template, $ext);
 579                         } else {
 580                                 // Throw it again
 581                                 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
 582                         }
 583                 }
 584
 585         }
 586
 587         /**
 588          * A private loader for raw template names
 589          *
 590          * @param       $fqfn   The full-qualified file name for a template
 591          * @return      void
 592          */
 593         private function loadRawTemplateData ($fqfn) {
 594                 // Get a input/output instance from the middleware
 595                 $ioInstance = $this->getFileIoInstance();
 596
 597                 // Some debug code to look on the file which is being loaded
 598                 //* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."<br />\n";
 599
 600                 // Load the raw template
 601                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
 602
 603                 // Store the template's contents into this class
 604                 $this->setRawTemplateData($rawTemplateData);
 605
 606                 // Remember the template's FQFN
 607                 $this->setLastTemplate($fqfn);
 608         }
 609
 610         /**
 611          * Try to assign an extracted template variable as a "content" or 'config'
 612          * variable.
 613          *
 614          * @param       $varName        The variable's name (shall be content orconfig) by
 615          *                                              default
 616          * @param       $var            The variable we want to assign
 617          */
 618         private function assignTemplateVariable ($varName, $var) {
 619                 // Is it not a config variable?
 620                 if ($varName != 'config') {
 621                         // Regular template variables
 622                         $this->assignVariable($var, '');
 623                 } else {
 624                         // Configuration variables
 625                         $this->assignConfigVariable($var);
 626                 }
 627         }
 628
 629         /**
 630          * Extract variables from a given raw data stream
 631          *
 632          * @param       $rawData        The raw template data we shall analyze
 633          * @return      void
 634          */
 635         private function extractVariablesFromRawData ($rawData) {
 636                 // Cast to string
 637                 $rawData = (string) $rawData;
 638
 639                 // Search for variables
 640                 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
 641
 642                 // Did we find some variables?
 643                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
 644                         // Initialize all missing variables
 645                         foreach ($variableMatches[3] as $key => $var) {
 646                                 // Variable name
 647                                 $varName = $variableMatches[1][$key];
 648
 649                                 // Workarround: Do not assign empty variables
 650                                 if (!empty($var)) {
 651                                         // Try to assign it, empty strings are being ignored
 652                                         $this->assignTemplateVariable($varName, $var);
 653                                 } // END - if
 654                         } // END - foreach
 655                 } // END - if
 656         }
 657
 658         /**
 659          * Main analysis of the loaded template
 660          *
 661          * @param       $templateMatches        Found template place-holders, see below
 662          * @return      void
 663          *
 664          *---------------------------------
 665          * Structure of $templateMatches:
 666          *---------------------------------
 667          * [0] => Array - An array with all full matches
 668          * [1] => Array - An array with left part (before the ':') of a match
 669          * [2] => Array - An array with right part of a match including ':'
 670          * [3] => Array - An array with right part of a match excluding ':'
 671          */
 672         private function analyzeTemplate (array $templateMatches) {
 673                 // Backup raw template data
 674                 $backup = $this->getRawTemplateData();
 675
 676                 // Initialize some arrays
 677                 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
 678
 679                 // Load all requested templates
 680                 foreach ($templateMatches[1] as $template) {
 681
 682                         // Load and compile only templates which we have not yet loaded
 683                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
 684                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
 685
 686                                 // Template not found, but maybe variable assigned?
 687                                 //* DEBUG: */ echo __METHOD__.":template={$template}<br />\n";
 688                                 if ($this->isVariableAlreadySet($template) !== false) {
 689                                         // Use that content here
 690                                         $this->loadedRawData[$template] = $this->readVariable($template);
 691
 692                                         // Recursive protection:
 693                                         $this->loadedTemplates[] = $template;
 694                                 } elseif (isset($this->varStack['config'][$template])) {
 695                                         // Use that content here
 696                                         $this->loadedRawData[$template] = $this->varStack['config'][$template];
 697
 698                                         // Recursive protection:
 699                                         $this->loadedTemplates[] = $template;
 700                                 } else {
 701                                         // Then try to search for code-templates
 702                                         try {
 703                                                 // Load the code template and remember it's contents
 704                                                 $this->loadCodeTemplate($template);
 705                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 706
 707                                                 // Remember this template for recursion detection
 708                                                 // RECURSIVE PROTECTION!
 709                                                 $this->loadedTemplates[] = $template;
 710                                         } catch (FileIoException $e) {
 711                                                 // Even this is not done... :/
 712                                                 $this->rawTemplates[] = $template;
 713                                         }
 714                                 }
 715                         } // END - if
 716                 } // END - foreach
 717
 718                 // Restore the raw template data
 719                 $this->setRawTemplateData($backup);
 720         }
 721
 722         /**
 723          * Compile a given raw template code and remember it for later usage
 724          *
 725          * @param       $code           The raw template code
 726          * @param       $template       The template's name
 727          * @return      void
 728          */
 729         private function compileCode ($code, $template) {
 730                 // Is this template already compiled?
 731                 if (in_array($template, $this->compiledTemplates)) {
 732                         // Abort here...
 733                         return;
 734                 } // END - if
 735
 736                 // Remember this template being compiled
 737                 $this->compiledTemplates[] = $template;
 738
 739                 // Compile the loaded code in five steps:
 740                 //
 741                 // 1. Backup current template data
 742                 $backup = $this->getRawTemplateData();
 743
 744                 // 2. Set the current template's raw data as the new content
 745                 $this->setRawTemplateData($code);
 746
 747                 // 3. Compile the template data
 748                 $this->compileTemplate();
 749
 750                 // 4. Remember it's contents
 751                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 752
 753                 // 5. Restore the previous raw content from backup variable
 754                 $this->setRawTemplateData($backup);
 755         }
 756
 757         /**
 758          * Insert all given and loaded templates by running through all loaded
 759          * codes and searching for their place-holder in the main template
 760          *
 761          * @param       $templateMatches        See method analyzeTemplate()
 762          * @return      void
 763          */
 764         private function insertAllTemplates (array $templateMatches) {
 765                 // Run through all loaded codes
 766                 foreach ($this->loadedRawData as $template => $code) {
 767
 768                         // Search for the template
 769                         $foundIndex = array_search($template, $templateMatches[1]);
 770
 771                         // Lookup the matching template replacement
 772                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
 773
 774                                 // Get the current raw template
 775                                 $rawData = $this->getRawTemplateData();
 776
 777                                 // Replace the space holder with the template code
 778                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
 779
 780                                 // Set the new raw data
 781                                 $this->setRawTemplateData($rawData);
 782                         } // END - if
 783                 } // END - foreach
 784         }
 785
 786         /**
 787          * Load all extra raw templates
 788          *
 789          * @return      void
 790          */
 791         private function loadExtraRawTemplates () {
 792                 // Are there some raw templates we need to load?
 793                 if (count($this->rawTemplates) > 0) {
 794                         // Try to load all raw templates
 795                         foreach ($this->rawTemplates as $key => $template) {
 796                                 try {
 797                                         // Load the template
 798                                         $this->loadWebTemplate($template);
 799
 800                                         // Remember it's contents
 801                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
 802
 803                                         // Remove it from the loader list
 804                                         unset($this->rawTemplates[$key]);
 805
 806                                         // Remember this template for recursion detection
 807                                         // RECURSIVE PROTECTION!
 808                                         $this->loadedTemplates[] = $template;
 809                                 } catch (FileIoException $e) {
 810                                         // This template was never found. We silently ignore it
 811                                         unset($this->rawTemplates[$key]);
 812                                 }
 813                         } // END - foreach
 814                 } // END - if
 815         }
 816
 817         /**
 818          * Assign all found template variables
 819          *
 820          * @param       $varMatches             An array full of variable/value pairs.
 821          * @return      void
 822          * @todo        Unfinished work or don't die here.
 823          */
 824         private function assignAllVariables (array $varMatches) {
 825                 // Search for all variables
 826                 foreach ($varMatches[1] as $key => $var) {
 827
 828                         // Detect leading equals
 829                         if (substr($varMatches[2][$key], 0, 1) == '=') {
 830                                 // Remove and cast it
 831                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
 832                         } // END - if
 833
 834                         // Do we have some quotes left and right side? Then it is free text
 835                         if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
 836                                 // Free string detected! Which we can assign directly
 837                                 $this->assignVariable($var, $varMatches[3][$key]);
 838                         } elseif (!empty($varMatches[2][$key])) {
 839                                 // @TODO Non-string found so we need some deeper analysis...
 840                                 ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
 841                         }
 842
 843                 } // for ($varMatches ...
 844         }
 845         /**
 846          * Compiles all loaded raw templates
 847          *
 848          * @param       $templateMatches        See method analyzeTemplate() for details
 849          * @return      void
 850          */
 851         private function compileRawTemplateData (array $templateMatches) {
 852                 // Are some code-templates found which we need to compile?
 853                 if (count($this->loadedRawData) > 0) {
 854
 855                         // Then compile all!
 856                         foreach ($this->loadedRawData as $template => $code) {
 857
 858                                 // Is this template already compiled?
 859                                 if (in_array($template, $this->compiledTemplates)) {
 860                                         // Then skip it
 861                                         continue;
 862                                 }
 863
 864                                 // Search for the template
 865                                 $foundIndex = array_search($template, $templateMatches[1]);
 866
 867                                 // Lookup the matching variable data
 868                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
 869
 870                                         // Split it up with another reg. exp. into variable=value pairs
 871                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
 872
 873                                         // Assign all variables
 874                                         $this->assignAllVariables($varMatches);
 875
 876                                 } // END - if (isset($templateMatches ...
 877
 878                                 // Compile the loaded template
 879                                 $this->compileCode($code, $template);
 880
 881                         } // END - foreach ($this->loadedRawData ...
 882
 883                         // Insert all templates
 884                         $this->insertAllTemplates($templateMatches);
 885
 886                 } // END - if (count($this->loadedRawData) ...
 887         }
 888
 889         /**
 890          * Inserts all raw templates into their respective variables
 891          *
 892          * @return      void
 893          */
 894         private function insertRawTemplates () {
 895                 // Load all templates
 896                 foreach ($this->rawTemplates as $template => $content) {
 897                         // Set the template as a variable with the content
 898                         $this->assignVariable($template, $content);
 899                 }
 900         }
 901
 902         /**
 903          * Finalizes the compilation of all template variables
 904          *
 905          * @return      void
 906          */
 907         private function finalizeVariableCompilation () {
 908                 // Get the content
 909                 $content = $this->getRawTemplateData();
 910                 //* DEBUG: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')<br />\n';
 911
 912                 // Walk through all variables
 913                 foreach ($this->varStack['general'] as $currEntry) {
 914                         //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=<pre>'.htmlentities($currEntry['value']).'</pre>\n';
 915                         // Replace all [$var] or {?$var?} with the content
 916                         // @TODO Old behaviour, will become obsolete!
 917                         $content = str_replace("\$content[".$currEntry['name'].']', $currEntry['value'], $content);
 918
 919                         // @TODO Yet another old way
 920                         $content = str_replace('['.$currEntry['name'].']', $currEntry['value'], $content);
 921
 922                         // The new behaviour
 923                         $content = str_replace('{?'.$currEntry['name'].'?}', $currEntry['value'], $content);
 924                 } // END - for
 925
 926                 //* DEBUG: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')<br />\n';
 927
 928                 // Set the content back
 929                 $this->setRawTemplateData($content);
 930         }
 931
 932         /**
 933          * Load a specified web template into the engine
 934          *
 935          * @param       $template       The web template we shall load which is located in
 936          *                                              'html' by default
 937          * @return      void
 938          */
 939         public function loadWebTemplate ($template) {
 940                 // Set template type
 941                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
 942
 943                 // Load the special template
 944                 $this->loadTemplate($template);
 945         }
 946
 947         /**
 948          * Assign a given congfiguration variable with a value
 949          *
 950          * @param       $var    The configuration variable we want to assign
 951          * @return      void
 952          */
 953         public function assignConfigVariable ($var) {
 954                 // Sweet and simple...
 955                 //* DEBUG: */ echo __METHOD__.':var={$var}<br />\n';
 956                 $this->varStack['config'][$var] = $this->getConfigInstance()->getConfigEntry($var);
 957         }
 958
 959         /**
 960          * Load a specified email template into the engine
 961          *
 962          * @param       $template       The email template we shall load which is located in
 963          *                                              'emails' by default
 964          * @return      void
 965          * @deprecated
 966          * @see         See loadCodeTemplate()
 967          */
 968         public function loadEmailTemplate ($template) {
 969                 // Set template type
 970                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('email_template_type'));
 971
 972                 // Load the special template
 973                 $this->loadTemplate($template);
 974         }
 975
 976         /**
 977          * Load a specified code template into the engine
 978          *
 979          * @param       $template       The code template we shall load which is
 980          *                                              located in 'code' by default
 981          * @return      void
 982          */
 983         public function loadCodeTemplate ($template) {
 984                 // Set template type
 985                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
 986
 987                 // Load the special template
 988                 $this->loadTemplate($template);
 989         }
 990
 991         /**
 992          * Compile all variables by inserting their respective values
 993          *
 994          * @return      void
 995          * @todo        Make this code some nicer...
 996          */
 997         public final function compileVariables () {
 998                 // Initialize the $content array
 999                 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1000                 $dummy = array();
1001
1002                 // Iterate through all general variables
1003                 foreach ($this->varStack['general'] as $currVariable) {
1004                         // Transfer it's name/value combination to the $content array
1005                         //* DEBUG: */ echo $currVariable['name'].'=<pre>'.htmlentities($currVariable['value']).'</pre>\n';
1006                         $dummy[$currVariable['name']] = $currVariable['value'];
1007                 }// END - if
1008
1009                 // Set the new variable (don't remove the second dollar!)
1010                 $$validVar = $dummy;
1011
1012                 // Prepare all configuration variables
1013                 $config = null;
1014                 if (isset($this->varStack['config'])) {
1015                         $config = $this->varStack['config'];
1016                 } // END - if
1017
1018                 // Remove some variables
1019                 unset($idx);
1020                 unset($currVariable);
1021
1022                 // Run the compilation three times to get content from helper classes in
1023                 $cnt = 0;
1024                 while ($cnt < 3) {
1025                         // Finalize the compilation of template variables
1026                         $this->finalizeVariableCompilation();
1027
1028                         // Prepare the eval() command for comiling the template
1029                         $eval = sprintf("\$result = \"%s\";",
1030                                 addslashes($this->getRawTemplateData())
1031                         );
1032
1033                         // This loop does remove the backslashes (\) in PHP parameters
1034                         while (strpos($eval, $this->codeBegin) !== false) {
1035                                 // Get left part before "<?"
1036                                 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1037
1038                                 // Get all from right of "<?"
1039                                 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1040
1041                                 // Cut middle part out and remove escapes
1042                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1043                                 $evalMiddle = stripslashes($evalMiddle);
1044
1045                                 // Remove the middle part from right one
1046                                 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1047
1048                                 // And put all together
1049                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1050                         } // END - while
1051
1052                         // Prepare PHP code for eval() command
1053                         $eval = str_replace(
1054                                 "<%php", "\";",
1055                                 str_replace(
1056                                         "%>",
1057                                         "\n\$result .= \"",
1058                                         $eval
1059                                 )
1060                         );
1061
1062                         // Run the constructed command. This will "compile" all variables in
1063                         eval($eval);
1064
1065                         // Goes something wrong?
1066                         if ((!isset($result)) || (empty($result))) {
1067                                 // Output eval command
1068                                 $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1069
1070                                 // Output backtrace here
1071                                 $this->debugBackTrace();
1072                         } // END - if
1073
1074                         // Set raw template data
1075                         $this->setRawTemplateData($result);
1076                         $cnt++;
1077                 } // END - while
1078
1079                 // Final variable assignment
1080                 $this->finalizeVariableCompilation();
1081
1082                 // Set the new content
1083                 $this->setCompiledData($this->getRawTemplateData());
1084         }
1085
1086         /**
1087          * Compile all required templates into the current loaded one
1088          *
1089          * @return      void
1090          * @throws      UnexpectedTemplateTypeException If the template type is
1091          *                                                                                      not "code"
1092          * @throws      InvalidArrayCountException              If an unexpected array
1093          *                                                                                      count has been found
1094          */
1095         public function compileTemplate () {
1096                 // We will only work with template type "code" from configuration
1097                 if ($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('code_template_type')) {
1098                         // Abort here
1099                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1100                 } // END - if
1101
1102                 // Get the raw data.
1103                 $rawData = $this->getRawTemplateData();
1104
1105                 // Remove double spaces and trim leading/trailing spaces
1106                 $rawData = trim(str_replace('  ', ' ', $rawData));
1107
1108                 // Search for raw variables
1109                 $this->extractVariablesFromRawData($rawData);
1110
1111                 // Search for code-tags which are {? ?}
1112                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1113
1114                 // Analyze the matches array
1115                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1116                         // Entries are found:
1117                         //
1118                         // The main analysis
1119                         $this->analyzeTemplate($templateMatches);
1120
1121                         // Compile raw template data
1122                         $this->compileRawTemplateData($templateMatches);
1123
1124                         // Are there some raw templates left for loading?
1125                         $this->loadExtraRawTemplates();
1126
1127                         // Are some raw templates found and loaded?
1128                         if (count($this->rawTemplates) > 0) {
1129
1130                                 // Insert all raw templates
1131                                 $this->insertRawTemplates();
1132
1133                                 // Remove the raw template content as well
1134                                 $this->setRawTemplateData('');
1135
1136                         } // END - if
1137
1138                 } // END - if($templateMatches ...
1139         }
1140
1141         /**
1142          * A old deprecated method
1143          *
1144          * @return      void
1145          * @deprecated
1146          * @see         BaseTemplateEngine::transferToResponse
1147          */
1148         public function output () {
1149                 // Check which type of template we have
1150                 switch ($this->getTemplateType()) {
1151                         case 'html': // Raw HTML templates can be send to the output buffer
1152                                 // Quick-N-Dirty:
1153                                 $this->getWebOutputInstance()->output($this->getCompiledData());
1154                                 break;
1155
1156                         default: // Unknown type found
1157                                 // Construct message
1158                                 $msg = sprintf("[%s-&gt;%s] Unknown/unsupported template type <span class=\"data\">%s</span> detected.",
1159                                         $this->__toString(),
1160                                         __FUNCTION__,
1161                                         $this->getTemplateType()
1162                                 );
1163
1164                                 // Write the problem to the world...
1165                                 $this->debugOutput($msg);
1166                                 break;
1167                 } // END - switch
1168         }
1169
1170         /**
1171          * Loads a given view helper (by name)
1172          *
1173          * @param       $helperName             The helper's name
1174          * @return      void
1175          */
1176         protected function loadViewHelper ($helperName) {
1177                 // Make first character upper case, rest low
1178                 $helperName = $this->convertToClassName($helperName);
1179
1180                 // Is this view helper loaded?
1181                 if (!isset($this->helpers[$helperName])) {
1182                         // Create a class name
1183                         $className = "{$helperName}ViewHelper";
1184
1185                         // Generate new instance
1186                         $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1187                 } // END - if
1188
1189                 // Return the requested instance
1190                 return $this->helpers[$helperName];
1191         }
1192
1193         /**
1194          * Assigns the last loaded raw template content with a given variable
1195          *
1196          * @param       $templateName   Name of the template we want to assign
1197          * @param       $variableName   Name of the variable we want to assign
1198          * @return      void
1199          */
1200         public function assignTemplateWithVariable ($templateName, $variableName) {
1201                 // Get the content from last loaded raw template
1202                 $content = $this->getRawTemplateData();
1203
1204                 // Assign the variable
1205                 $this->assignVariable($variableName, $content);
1206
1207                 // Purge raw content
1208                 $this->setRawTemplateData('');
1209         }
1210
1211         /**
1212          * Transfers the content of this template engine to a given response instance
1213          *
1214          * @param       $responseInstance       An instance of a response class
1215          * @return      void
1216          */
1217         public function transferToResponse (Responseable $responseInstance) {
1218                 // Get the content and set it in response class
1219                 $responseInstance->writeToBody($this->getCompiledData());
1220         }
1221
1222         /**
1223          * Assigns all the application data with template variables
1224          *
1225          * @param       $appInstance    A manageable application instance
1226          * @return      void
1227          */
1228         public function assignApplicationData (ManageableApplication $appInstance) {
1229                 // Get long name and assign it
1230                 $this->assignVariable('app_full_name' , $appInstance->getAppName());
1231
1232                 // Get short name and assign it
1233                 $this->assignVariable('app_short_name', $appInstance->getAppShortName());
1234
1235                 // Get version number and assign it
1236                 $this->assignVariable('app_version'   , $appInstance->getAppVersion());
1237
1238                 // Assign extra application-depending data
1239                 $appInstance->assignExtraTemplateData($this);
1240         }
1241
1242         /**
1243          * "Compiles" a variable by replacing {?var?} with it's content
1244          *
1245          * @param       $rawCode        Raw code to compile
1246          * @return      $rawCode        Compile code with inserted variable value
1247          */
1248         public function compileRawCode ($rawCode) {
1249                 // Find the variables
1250                 //* DEBUG: */ echo "rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
1251                 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1252
1253                 // Compile all variables
1254                 //* DEBUG: */ echo "<pre>".print_r($varMatches, true)."</pre>";
1255                 foreach ($varMatches[0] as $match) {
1256                         // Add variable tags around it
1257                         $varCode = '{?' . $match . '?}';
1258
1259                         // Is the variable found in code? (safes some calls)
1260                         if (strpos($rawCode, $varCode) !== false) {
1261                                 // Replace the variable with it's value, if found
1262                                 //* DEBUG: */ echo __METHOD__.": match=".$match."<br />\n";
1263                                 $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode);
1264                         } // END - if
1265                 } // END - foreach
1266
1267                 // Return the compiled data
1268                 return $rawCode;
1269         }
1270
1271         /**
1272          * Getter for variable group array
1273          *
1274          * @return      $vargroups      All variable groups
1275          */
1276         public final function getVariableGroups () {
1277                 return $this->varGroups;
1278         }
1279
1280         /**
1281          * Renames a variable in code and in stack
1282          *
1283          * @param       $oldName        Old name of variable
1284          * @param       $newName        New name of variable
1285          * @return      void
1286          */
1287         public function renameVariable ($oldName, $newName) {
1288                 //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
1289                 // Get raw template code
1290                 $rawData = $this->getRawTemplateData();
1291
1292                 // Replace it
1293                 $rawData = str_replace($oldName, $newName, $rawData);
1294
1295                 // Set the code back
1296                 $this->setRawTemplateData($rawData);
1297         }
1298
1299         /**
1300          * Renders the given XML content
1301          *
1302          * @param       $content        Valid XML content or if not set the current loaded raw content
1303          * @return      void
1304          * @throws      XmlParserException      If an XML error was found
1305          */
1306         public function renderXmlContent ($content = null) {
1307                 // Is the content set?
1308                 if (is_null($content)) {
1309                         // Get current content
1310                         $content = $this->getRawTemplateData();
1311                 } // END - if
1312
1313                 // Get a XmlParser instance
1314                 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1315
1316                 // Parse the XML document
1317                 $parserInstance->parseXmlContent($content);
1318         }
1319
1320         /**
1321          * Enables or disables language support
1322          *
1323          * @param       $languageSupport        New language support setting
1324          * @return      void
1325          */
1326         public final function enableLanguageSupport ($languageSupport = true) {
1327                 $this->languageSupport = (bool) $languageSupport;
1328         }
1329
1330         /**
1331          * Checks wether language support is enabled
1332          *
1333          * @return      $languageSupport        Wether language support is enabled or disabled
1334          */
1335         public final function isLanguageSupportEnabled () {
1336                 return $this->languageSupport;
1337         }
1338 }
1339
1340 // [EOF]
1341 ?>