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