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