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