Improved logger.
[core.git] / inc / classes / main / template / class_BaseTemplateEngine.php
1 <?php
2 /**
3  * A generic template engine
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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          * A regular expression to find template comments like <!-- Comment here //-->
111          */
112         private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
113
114         /**
115          * Loaded helpers
116          */
117         private $helpers = array();
118
119         /**
120          * Current variable group
121          */
122         private $currGroup = 'general';
123
124         /**
125          * All template groups except "general"
126          */
127         private $varGroups = array();
128
129         /**
130          * Code begin
131          */
132         private $codeBegin = '<?php';
133
134         /**
135          * Code end
136          */
137         private $codeEnd = '?>';
138
139         /**
140          * Language support is enabled by default
141          */
142         private $languageSupport = TRUE;
143
144         /**
145          * XML compacting is disabled by default
146          */
147         private $xmlCompacting = FALSE;
148
149         // Exception codes for the template engine
150         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x110;
151         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
152         const EXCEPTION_INVALID_VIEW_HELPER           = 0x112;
153         const EXCEPTION_VARIABLE_IS_MISSING           = 0x113;
154
155         /**
156          * Protected constructor
157          *
158          * @param       $className      Name of the class
159          * @return      void
160          */
161         protected function __construct ($className) {
162                 // Call parent constructor
163                 parent::__construct($className);
164
165                 // Init file I/O instance
166                 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
167
168                 // Set it
169                 $this->setFileIoInstance($ioInstance);
170         }
171
172         /**
173          * Search for a variable in the stack
174          *
175          * @param       $variableName   The variable we are looking for
176          * @param       $variableGroup  Optional variable group to look in
177          * @return      $index                  FALSE means not found, >=0 means found on a specific index
178          */
179         private function getVariableIndex ($variableName, $variableGroup = NULL) {
180                 // Replace all dashes to underscores to match variables with configuration entries
181                 $variableName = trim($this->convertDashesToUnderscores($variableName));
182
183                 // First everything is not found
184                 $found = FALSE;
185
186                 // If the stack is NULL, use the current group
187                 if (is_null($variableGroup)) {
188                         // Use current group
189                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
190                         $variableGroup = $this->currGroup;
191                 } // END - if
192
193                 // Is the group there?
194                 if ($this->isVarStackSet($variableGroup)) {
195                         // Now search for it
196                         foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
197                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
198                                 // Is the entry found?
199                                 if ($currEntry['name'] == $variableName) {
200                                         // Found!
201                                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
202                                         $found = $index;
203                                         break;
204                                 } // END - if
205                         } // END - foreach
206                 } // END - if
207
208                 // Return the current position
209                 return $found;
210         }
211
212         /**
213          * Checks whether the given variable group is set
214          *
215          * @param       $variableGroup  Variable group to check
216          * @return      $isSet                  Whether the given variable group is set
217          */
218         protected final function isVarStackSet ($variableGroup) {
219                 // Check it
220                 $isSet = isset($this->varStack[$variableGroup]);
221
222                 // Return result
223                 return $isSet;
224         }
225
226         /**
227          * Getter for given variable group
228          *
229          * @param       $variableGroup  Variable group to check
230          * @return      $varStack               Found variable group
231          */
232         public final function getVarStack ($variableGroup) {
233                 return $this->varStack[$variableGroup];
234         }
235
236         /**
237          * Setter for given variable group
238          *
239          * @param       $variableGroup  Variable group to check
240          * @param       $varStack               Variable stack to check
241          * @return      void
242          */
243         protected final function setVarStack ($variableGroup, array $varStack) {
244                 $this->varStack[$variableGroup]  = $varStack;
245         }
246
247         /**
248          * Return a content of a variable or null if not found
249          *
250          * @param       $variableName   The variable we are looking for
251          * @param       $variableGroup  Optional variable group to look in
252          * @return      $content                Content of the variable or null if not found
253          */
254         protected function readVariable ($variableName, $variableGroup = NULL) {
255                 // Replace all dashes to underscores to match variables with configuration entries
256                 $variableName = trim($this->convertDashesToUnderscores($variableName));
257
258                 // First everything is not found
259                 $content = NULL;
260
261                 // If the stack is NULL, use the current group
262                 if (is_null($variableGroup)) {
263                         // Use current group
264                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
265                         $variableGroup = $this->currGroup;
266                 } // END - if
267
268                 // Get variable index
269                 $found = $this->getVariableIndex($variableName, $variableGroup);
270
271                 // Is the variable found?
272                 if ($found !== FALSE) {
273                         // Read it
274                         $content = $this->getVariableValue($variableGroup, $found);
275                 } // END - if
276
277                 // Return the current position
278                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
279                 return $content;
280         }
281
282         /**
283          * Add a variable to the stack
284          *
285          * @param       $variableName   Name of variable to add
286          * @param       $value                  Value we want to store in the variable
287          * @return      void
288          */
289         private function addVariable ($variableName, $value) {
290                 // Set general variable group
291                 $this->setVariableGroup('general');
292
293                 // Add it to the stack
294                 $this->addGroupVariable($variableName, $value);
295         }
296
297         /**
298          * Returns all variables of current group or empty array
299          *
300          * @return      $result         Whether array of found variables or empty array
301          */
302         private function readCurrentGroup () {
303                 // Default is not found
304                 $result = array();
305
306                 // Is the group there?
307                 if ($this->isVarStackSet($this->currGroup)) {
308                         // Then use it
309                         $result = $this->getVarStack($this->currGroup);
310                 } // END - if
311
312                 // Return result
313                 return $result;
314         }
315
316         /**
317          * Settter for variable group
318          *
319          * @param       $groupName      Name of variable group
320          * @param       $add            Whether add this group
321          * @return      void
322          */
323         public function setVariableGroup ($groupName, $add = TRUE) {
324                 // Set group name
325                 //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
326                 $this->currGroup = $groupName;
327
328                 // Skip group 'general'
329                 if (($groupName != 'general') && ($add === TRUE)) {
330                         $this->varGroups[$groupName] = 'OK';
331                 } // END - if
332         }
333
334
335         /**
336          * Adds a variable to current group
337          *
338          * @param       $variableName   Variable to set
339          * @param       $value                  Value to store in variable
340          * @return      void
341          */
342         public function addGroupVariable ($variableName, $value) {
343                 // Replace all dashes to underscores to match variables with configuration entries
344                 $variableName = trim($this->convertDashesToUnderscores($variableName));
345
346                 // Debug message
347                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
348
349                 // Get current variables in group
350                 $currVars = $this->readCurrentGroup();
351
352                 // Append our variable
353                 array_push($currVars, $this->generateVariableArray($variableName, $value));
354
355                 // Add it to the stack
356                 $this->setVarStack($this->currGroup, $currVars);
357         }
358
359         /**
360          * Getter for variable value, throws a NoVariableException if the variable is not found
361          *
362          * @param       $varGroup       Variable group to use
363          * @param       $index          Index in variable array
364          * @return      $value          Value to set
365          */
366         private function getVariableValue ($varGroup, $index) {
367                 // Return it
368                 return $this->varStack[$varGroup][$index]['value'];
369         }
370
371         /**
372          * Modify an entry on the stack
373          *
374          * @param       $variableName   The variable we are looking for
375          * @param       $value                  The value we want to store in the variable
376          * @return      void
377          * @throws      NoVariableException     If the given variable is not found
378          */
379         private function modifyVariable ($variableName, $value) {
380                 // Replace all dashes to underscores to match variables with configuration entries
381                 $variableName = trim($this->convertDashesToUnderscores($variableName));
382
383                 // Get index for variable
384                 $index = $this->getVariableIndex($variableName);
385
386                 // Is the variable set?
387                 if ($index === FALSE) {
388                         // Unset variables cannot be modified
389                         throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
390                 } // END - if
391
392                 // Then modify it
393                 $this->setVariableValue($this->currGroup, $index, $value);
394         }
395
396         /**
397          * Sets a variable value for given variable group and index
398          *
399          * @param       $varGroup       Variable group to use
400          * @param       $index          Index in variable array
401          * @param       $value          Value to set
402          * @return      void
403          */
404         private function setVariableValue ($varGroup, $index, $value) {
405                 $this->varStack[$varGroup][$index]['value'] = $value;
406         }
407
408         /**
409          * Sets a variable within given group. This method does detect if the
410          * variable is already set. If so, the variable got modified, otherwise
411          * added.
412          *
413          * @param       $varGroup               Variable group to use
414          * @param       $variableName   Variable to set
415          * @param       $value                  Value to set
416          * @return      void
417          */
418         protected function setVariable ($varGroup, $variableName, $value) {
419                 // Replace all dashes to underscores to match variables with configuration entries
420                 $variableName = trim($this->convertDashesToUnderscores($variableName));
421
422                 // Get index for variable
423                 $index = $this->getVariableIndex($variableName);
424
425                 // Is the variable set?
426                 if ($index === FALSE) {
427                         // Is the stack there?
428                         if (!isset($this->varStack[$varGroup])) {
429                                 // Then initialize it here
430                                 $this->varStack[$varGroup] = array();
431                         } // END - if
432
433                         // Not found, add it
434                         array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value));
435                 } else {
436                         // Then modify it
437                         $this->setVariableValue($this->currGroup, $index, $value);
438                 }
439         }
440
441         /**
442          * "Generates" (better returns) an array for all variables for given
443          * variable/value pay.
444          *
445          * @param       $variableName   Variable to set
446          * @param       $value                  Value to set
447          * @return      $varData                Variable data array
448          */
449         private function generateVariableArray ($variableName, $value) {
450                 // Replace all dashes to underscores to match variables with configuration entries
451                 $variableName = trim($this->convertDashesToUnderscores($variableName));
452
453                 // Generate the temporary array
454                 $varData = array(
455                         'name'  => $variableName,
456                         'value' => $value
457                 );
458
459                 // And return it
460                 return $varData;
461         }
462
463         /**
464          * Setter for template type. Only 'html', 'emails' and 'compiled' should
465          * be sent here
466          *
467          * @param       $templateType   The current template's type
468          * @return      void
469          */
470         protected final function setTemplateType ($templateType) {
471                 $this->templateType = (string) $templateType;
472         }
473
474         /**
475          * Setter for the last loaded template's FQFN
476          *
477          * @param       $template       The last loaded template
478          * @return      void
479          */
480         private final function setLastTemplate ($template) {
481                 $this->lastTemplate = (string) $template;
482         }
483
484         /**
485          * Getter for the last loaded template's FQFN
486          *
487          * @return      $template       The last loaded template
488          */
489         private final function getLastTemplate () {
490                 return $this->lastTemplate;
491         }
492
493         /**
494          * Setter for base path
495          *
496          * @param               $templateBasePath               The relative base path for all templates
497          * @return      void
498          */
499         public final function setTemplateBasePath ($templateBasePath) {
500                 // And set it
501                 $this->templateBasePath = (string) $templateBasePath;
502         }
503
504         /**
505          * Getter for base path
506          *
507          * @return      $templateBasePath               The relative base path for all templates
508          */
509         public final function getTemplateBasePath () {
510                 // And set it
511                 return $this->templateBasePath;
512         }
513
514         /**
515          * Getter for generic base path
516          *
517          * @return      $templateBasePath               The relative base path for all templates
518          */
519         public final function getGenericBasePath () {
520                 // And set it
521                 return $this->genericBasePath;
522         }
523
524         /**
525          * Setter for template extension
526          *
527          * @param               $templateExtension      The file extension for all uncompiled
528          *                                                      templates
529          * @return      void
530          */
531         public final function setRawTemplateExtension ($templateExtension) {
532                 // And set it
533                 $this->templateExtension = (string) $templateExtension;
534         }
535
536         /**
537          * Setter for code template extension
538          *
539          * @param               $codeExtension          The file extension for all uncompiled
540          *                                                      templates
541          * @return      void
542          */
543         public final function setCodeTemplateExtension ($codeExtension) {
544                 // And set it
545                 $this->codeExtension = (string) $codeExtension;
546         }
547
548         /**
549          * Getter for template extension
550          *
551          * @return      $templateExtension      The file extension for all uncompiled
552          *                                                      templates
553          */
554         public final function getRawTemplateExtension () {
555                 // And set it
556                 return $this->templateExtension;
557         }
558
559         /**
560          * Getter for code-template extension
561          *
562          * @return      $codeExtension          The file extension for all code-
563          *                                                      templates
564          */
565         public final function getCodeTemplateExtension () {
566                 // And set it
567                 return $this->codeExtension;
568         }
569
570         /**
571          * Setter for path of compiled templates
572          *
573          * @param       $compileOutputPath      The local base path for all compiled
574          *                                                              templates
575          * @return      void
576          */
577         public final function setCompileOutputPath ($compileOutputPath) {
578                 // And set it
579                 $this->compileOutputPath = (string) $compileOutputPath;
580         }
581
582         /**
583          * Getter for template type
584          *
585          * @return      $templateType   The current template's type
586          */
587         public final function getTemplateType () {
588                 return $this->templateType;
589         }
590
591         /**
592          * Unsets the given offset in the variable group
593          *
594          * @param       $index                  Index to unset
595          * @param       $variableGroup  Variable group (default: currGroup)
596          * @return      void
597          */
598         protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
599                 // Is the variable group not set?
600                 if (is_null($variableGroup)) {
601                         // Then set it to current
602                         $variableGroup = $this->currGroup;
603                 } // END - if
604
605                 // Is the entry there?
606                 if (!isset($this->varStack[$variableGroup][$index])) {
607                         // Abort here, we need fixing!
608                         $this->debugInstance();
609                 } // END - if
610
611                 // Remove it
612                 unset($this->varStack[$variableGroup][$index]);
613         }
614
615         /**
616          * Private setter for raw template data
617          *
618          * @param       $rawTemplateData        The raw data from the template
619          * @return      void
620          */
621         protected final function setRawTemplateData ($rawTemplateData) {
622                 // And store it in this class
623                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
624                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
625                 $this->rawTemplateData = (string) $rawTemplateData;
626         }
627
628         /**
629          * Getter for raw template data
630          *
631          * @return      $rawTemplateData        The raw data from the template
632          */
633         public final function getRawTemplateData () {
634                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.');
635                 return $this->rawTemplateData;
636         }
637
638         /**
639          * Private setter for compiled templates
640          *
641          * @return      void
642          */
643         private final function setCompiledData ($compiledData) {
644                 // And store it in this class
645                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($compiledData) . ' Bytes set.');
646                 $this->compiledData = (string) $compiledData;
647         }
648
649         /**
650          * Getter for compiled templates
651          *
652          * @return      $compiledData   Compiled template data
653          */
654         public final function getCompiledData () {
655                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.');
656                 return $this->compiledData;
657         }
658
659         /**
660          * Private loader for all template types
661          *
662          * @param       $template       The template we shall load
663          * @param       $extOther       An other extension to use
664          * @return      void
665          * @throws      FileIoException If the template was not found
666          */
667         protected function loadTemplate ($template, $extOther = '') {
668                 // Get extension for the template if empty
669                 if (empty($extOther)) {
670                         // None provided, so get the raw one
671                         $ext = $this->getRawTemplateExtension();
672                 } else {
673                         // Then use it!
674                         $ext = (string) $extOther;
675                 }
676
677                 // Is language support enabled?
678                 if ($this->isLanguageSupportEnabled()) {
679                         // Construct the FQFN for the template by honoring the current language
680                         $fqfn = sprintf('%s%s%s%s/%s/%s%s',
681                                 $this->getConfigInstance()->getConfigEntry('base_path'),
682                                 $this->getTemplateBasePath(),
683                                 $this->getGenericBasePath(),
684                                 $this->getLanguageInstance()->getLanguageCode(),
685                                 $this->getTemplateType(),
686                                 (string) $template,
687                                 $ext
688                         );
689                 } else {
690                         // Construct the FQFN for the template without language
691                         $fqfn = sprintf('%s%s%s%s/%s%s',
692                                 $this->getConfigInstance()->getConfigEntry('base_path'),
693                                 $this->getTemplateBasePath(),
694                                 $this->getGenericBasePath(),
695                                 $this->getTemplateType(),
696                                 (string) $template,
697                                 $ext
698                         );
699                 }
700
701                 // First try this
702                 try {
703                         // Load the raw template data
704                         $this->loadRawTemplateData($fqfn);
705                 } catch (FileIoException $e) {
706                         // If we shall load a code-template we need to switch the file extension
707                         if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
708                                 // Switch over to the code-template extension and try it again
709                                 $ext = $this->getCodeTemplateExtension();
710
711                                 // Try it again...
712                                 $this->loadTemplate($template, $ext);
713                         } else {
714                                 // Throw it again
715                                 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
716                         }
717                 }
718
719         }
720
721         /**
722          * A private loader for raw template names
723          *
724          * @param       $fqfn   The full-qualified file name for a template
725          * @return      void
726          */
727         private function loadRawTemplateData ($fqfn) {
728                 // Get a input/output instance from the middleware
729                 $ioInstance = $this->getFileIoInstance();
730
731                 // Some debug code to look on the file which is being loaded
732                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: FQFN=' . $fqfn);
733
734                 // Load the raw template
735                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
736
737                 // Store the template's contents into this class
738                 $this->setRawTemplateData($rawTemplateData);
739
740                 // Remember the template's FQFN
741                 $this->setLastTemplate($fqfn);
742         }
743
744         /**
745          * Try to assign an extracted template variable as a "content" or 'config'
746          * variable.
747          *
748          * @param       $varName                The variable's name (shall be content or config)
749          *                                                      by default
750          * @param       $variableName   The variable we want to assign
751          * @return      void
752          */
753         private function assignTemplateVariable ($varName, $var) {
754                 // Replace all dashes to underscores to match variables with configuration entries
755                 $variableName = trim($this->convertDashesToUnderscores($variableName));
756
757                 // Debug message
758                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: varName=' . $varName . ',variableName=' . $variableName);
759
760                 // Is it not a config variable?
761                 if ($varName != 'config') {
762                         // Regular template variables
763                         $this->assignVariable($variableName, '');
764                 } else {
765                         // Configuration variables
766                         $this->assignConfigVariable($variableName);
767                 }
768         }
769
770         /**
771          * Extract variables from a given raw data stream
772          *
773          * @param       $rawData        The raw template data we shall analyze
774          * @return      void
775          */
776         private function extractVariablesFromRawData ($rawData) {
777                 // Cast to string
778                 $rawData = (string) $rawData;
779
780                 // Search for variables
781                 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
782
783                 // Debug message
784                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE));
785
786                 // Did we find some variables?
787                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
788                         // Initialize all missing variables
789                         foreach ($variableMatches[3] as $key => $var) {
790                                 // Variable name
791                                 $varName = $variableMatches[1][$key];
792
793                                 // Workarround: Do not assign empty variables
794                                 if (!empty($var)) {
795                                         // Try to assign it, empty strings are being ignored
796                                         $this->assignTemplateVariable($varName, $var);
797                                 } // END - if
798                         } // END - foreach
799                 } // END - if
800         }
801
802         /**
803          * Main analysis of the loaded template
804          *
805          * @param       $templateMatches        Found template place-holders, see below
806          * @return      void
807          *
808          *---------------------------------
809          * Structure of $templateMatches:
810          *---------------------------------
811          * [0] => Array - An array with all full matches
812          * [1] => Array - An array with left part (before the ':') of a match
813          * [2] => Array - An array with right part of a match including ':'
814          * [3] => Array - An array with right part of a match excluding ':'
815          */
816         private function analyzeTemplate (array $templateMatches) {
817                 // Backup raw template data
818                 $backup = $this->getRawTemplateData();
819
820                 // Initialize some arrays
821                 if (is_null($this->loadedRawData)) {
822                         // Initialize both
823                         $this->loadedRawData = array();
824                         $this->rawTemplates = array();
825                 } // END - if
826
827                 // Load all requested templates
828                 foreach ($templateMatches[1] as $template) {
829                         // Load and compile only templates which we have not yet loaded
830                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
831                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
832                                 // Debug message
833                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template);
834
835                                 // Template not found, but maybe variable assigned?
836                                 if ($this->getVariableIndex($template, 'config') !== FALSE) {
837                                         // Use that content here
838                                         $this->loadedRawData[$template] = $this->readVariable($template, 'config');
839
840                                         // Recursive protection:
841                                         array_push($this->loadedTemplates, $template);
842                                 } elseif ($this->getVariableIndex($template) !== FALSE) {
843                                         // Use that content here
844                                         $this->loadedRawData[$template] = $this->readVariable($template);
845
846                                         // Recursive protection:
847                                         array_push($this->loadedTemplates, $template);
848                                 } else {
849                                         // Then try to search for code-templates
850                                         try {
851                                                 // Load the code template and remember it's contents
852                                                 $this->loadCodeTemplate($template);
853                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
854
855                                                 // Remember this template for recursion detection
856                                                 // RECURSIVE PROTECTION!
857                                                 array_push($this->loadedTemplates, $template);
858                                         } catch (FileIoException $e) {
859                                                 // Even this is not done... :/
860                                                 array_push($this->rawTemplates, $template);
861                                         }
862                                 }
863                         } // END - if
864                 } // END - foreach
865
866                 // Restore the raw template data
867                 $this->setRawTemplateData($backup);
868         }
869
870         /**
871          * Compile a given raw template code and remember it for later usage
872          *
873          * @param       $code           The raw template code
874          * @param       $template       The template's name
875          * @return      void
876          */
877         private function compileCode ($code, $template) {
878                 // Is this template already compiled?
879                 if (in_array($template, $this->compiledTemplates)) {
880                         // Abort here...
881                         return;
882                 } // END - if
883
884                 // Remember this template being compiled
885                 array_push($this->compiledTemplates, $template);
886
887                 // Compile the loaded code in five steps:
888                 //
889                 // 1. Backup current template data
890                 $backup = $this->getRawTemplateData();
891
892                 // 2. Set the current template's raw data as the new content
893                 $this->setRawTemplateData($code);
894
895                 // 3. Compile the template data
896                 $this->compileTemplate();
897
898                 // 4. Remember it's contents
899                 $this->loadedRawData[$template] = $this->getRawTemplateData();
900
901                 // 5. Restore the previous raw content from backup variable
902                 $this->setRawTemplateData($backup);
903         }
904
905         /**
906          * Insert all given and loaded templates by running through all loaded
907          * codes and searching for their place-holder in the main template
908          *
909          * @param       $templateMatches        See method analyzeTemplate()
910          * @return      void
911          */
912         private function insertAllTemplates (array $templateMatches) {
913                 // Run through all loaded codes
914                 foreach ($this->loadedRawData as $template => $code) {
915
916                         // Search for the template
917                         $foundIndex = array_search($template, $templateMatches[1]);
918
919                         // Lookup the matching template replacement
920                         if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
921
922                                 // Get the current raw template
923                                 $rawData = $this->getRawTemplateData();
924
925                                 // Replace the space holder with the template code
926                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
927
928                                 // Set the new raw data
929                                 $this->setRawTemplateData($rawData);
930                         } // END - if
931                 } // END - foreach
932         }
933
934         /**
935          * Load all extra raw templates
936          *
937          * @return      void
938          */
939         private function loadExtraRawTemplates () {
940                 // Are there some raw templates we need to load?
941                 if (count($this->rawTemplates) > 0) {
942                         // Try to load all raw templates
943                         foreach ($this->rawTemplates as $key => $template) {
944                                 try {
945                                         // Load the template
946                                         $this->loadWebTemplate($template);
947
948                                         // Remember it's contents
949                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
950
951                                         // Remove it from the loader list
952                                         unset($this->rawTemplates[$key]);
953
954                                         // Remember this template for recursion detection
955                                         // RECURSIVE PROTECTION!
956                                         array_push($this->loadedTemplates, $template);
957                                 } catch (FileIoException $e) {
958                                         // This template was never found. We silently ignore it
959                                         unset($this->rawTemplates[$key]);
960                                 }
961                         } // END - foreach
962                 } // END - if
963         }
964
965         /**
966          * Assign all found template variables
967          *
968          * @param       $varMatches             An array full of variable/value pairs.
969          * @return      void
970          * @todo        Unfinished work or don't die here.
971          */
972         private function assignAllVariables (array $varMatches) {
973                 // Debug message
974                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches()=' . count($varMatches));
975
976                 // Search for all variables
977                 foreach ($varMatches[1] as $key => $var) {
978                         // Replace all dashes to underscores to match variables with configuration entries
979                         $var = trim($this->convertDashesToUnderscores($var));
980
981                         // Debug message
982                         self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var);
983
984                         // Detect leading equals
985                         if (substr($varMatches[2][$key], 0, 1) == '=') {
986                                 // Remove and cast it
987                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
988                         } // END - if
989
990                         // Do we have some quotes left and right side? Then it is free text
991                         if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
992                                 // Free string detected! Which we can assign directly
993                                 $this->assignVariable($var, $varMatches[3][$key]);
994                         } elseif (!empty($varMatches[2][$key])) {
995                                 // @TODO Non-string found so we need some deeper analysis...
996                                 ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
997                         }
998                 } // END - foreach
999         }
1000
1001         /**
1002          * Compiles all loaded raw templates
1003          *
1004          * @param       $templateMatches        See method analyzeTemplate() for details
1005          * @return      void
1006          */
1007         private function compileRawTemplateData (array $templateMatches) {
1008                 // Debug message
1009                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:loadedRawData()= ' .count($this->loadedRawData));
1010
1011                 // Are some code-templates found which we need to compile?
1012                 if (count($this->loadedRawData) > 0) {
1013                         // Then compile all!
1014                         foreach ($this->loadedRawData as $template => $code) {
1015                                 // Debug message
1016                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1017
1018                                 // Is this template already compiled?
1019                                 if (in_array($template, $this->compiledTemplates)) {
1020                                         // Then skip it
1021                                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Template ' . $template . ' already compiled. SKIPPED!');
1022                                         continue;
1023                                 } // END - if
1024
1025                                 // Search for the template
1026                                 $foundIndex = array_search($template, $templateMatches[1]);
1027
1028                                 // Lookup the matching variable data
1029                                 if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
1030                                         // Split it up with another reg. exp. into variable=value pairs
1031                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1032                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches=' . print_r($varMatches, TRUE));
1033
1034                                         // Assign all variables
1035                                         $this->assignAllVariables($varMatches);
1036                                 } // END - if (isset($templateMatches ...
1037
1038                                 // Compile the loaded template
1039                                 $this->compileCode($code, $template);
1040                         } // END - foreach ($this->loadedRawData ...
1041
1042                         // Insert all templates
1043                         $this->insertAllTemplates($templateMatches);
1044                 } // END - if (count($this->loadedRawData) ...
1045         }
1046
1047         /**
1048          * Inserts all raw templates into their respective variables
1049          *
1050          * @return      void
1051          */
1052         private function insertRawTemplates () {
1053                 // Load all templates
1054                 foreach ($this->rawTemplates as $template => $content) {
1055                         // Set the template as a variable with the content
1056                         $this->assignVariable($template, $content);
1057                 }
1058         }
1059
1060         /**
1061          * Finalizes the compilation of all template variables
1062          *
1063          * @return      void
1064          */
1065         private function finalizeVariableCompilation () {
1066                 // Get the content
1067                 $content = $this->getRawTemplateData();
1068                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content before=' . strlen($content) . ' (' . md5($content) . ')');
1069
1070                 // Do we have the stack?
1071                 if (!$this->isVarStackSet('general')) {
1072                         // Abort here silently
1073                         // @TODO This silent abort should be logged, maybe.
1074                         return;
1075                 } // END - if
1076
1077                 // Walk through all variables
1078                 foreach ($this->getVarStack('general') as $currEntry) {
1079                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1080                         // Replace all [$var] or {?$var?} with the content
1081                         // @TODO Old behaviour, will become obsolete!
1082                         $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1083
1084                         // @TODO Yet another old way
1085                         $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1086
1087                         // The new behaviour
1088                         $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1089                 } // END - for
1090
1091                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content after=' . strlen($content) . ' (' . md5($content) . ')');
1092
1093                 // Set the content back
1094                 $this->setRawTemplateData($content);
1095         }
1096
1097         /**
1098          * Load a specified web template into the engine
1099          *
1100          * @param       $template       The web template we shall load which is located in
1101          *                                              'html' by default
1102          * @return      void
1103          */
1104         public function loadWebTemplate ($template) {
1105                 // Set template type
1106                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1107
1108                 // Load the special template
1109                 $this->loadTemplate($template);
1110         }
1111
1112         /**
1113          * Assign (add) a given variable with a value
1114          *
1115          * @param       $variableName   The variable we are looking for
1116          * @param       $value                  The value we want to store in the variable
1117          * @return      void
1118          * @throws      EmptyVariableException  If the variable name is left empty
1119          */
1120         public final function assignVariable ($variableName, $value) {
1121                 // Replace all dashes to underscores to match variables with configuration entries
1122                 $variableName = trim($this->convertDashesToUnderscores($variableName));
1123
1124                 // Empty variable found?
1125                 if (empty($variableName)) {
1126                         // Throw an exception
1127                         throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
1128                 } // END - if
1129
1130                 // First search for the variable if it was already added
1131                 $index = $this->getVariableIndex($variableName);
1132
1133                 // Was it found?
1134                 if ($index === FALSE) {
1135                         // Add it to the stack
1136                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1137                         $this->addVariable($variableName, $value);
1138                 } elseif (!empty($value)) {
1139                         // Modify the stack entry
1140                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1141                         $this->modifyVariable($variableName, $value);
1142                 }
1143         }
1144
1145         /**
1146          * Removes a given variable
1147          *
1148          * @param       $variableName   The variable we are looking for
1149          * @param       $variableGroup  Name of variable group (default: 'general')
1150          * @return      void
1151          */
1152         public final function removeVariable ($variableName, $variableGroup = 'general') {
1153                 // First search for the variable if it was already added
1154                 $index = $this->getVariableIndex($variableName, $variableGroup);
1155
1156                 // Was it found?
1157                 if ($index !== FALSE) {
1158                         // Remove this variable
1159                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
1160                         $this->unsetVariableStackOffset($index, $variableGroup);
1161                 } // END - if
1162         }
1163
1164         /**
1165          * Assigns the last loaded raw template content with a given variable
1166          *
1167          * @param       $templateName   Name of the template we want to assign
1168          * @param       $variableName   Name of the variable we want to assign
1169          * @return      void
1170          */
1171         public function assignTemplateWithVariable ($templateName, $variableName) {
1172                 // Get the content from last loaded raw template
1173                 $content = $this->getRawTemplateData();
1174
1175                 // Assign the variable
1176                 $this->assignVariable($variableName, $content);
1177
1178                 // Purge raw content
1179                 $this->setRawTemplateData('');
1180         }
1181
1182         /**
1183          * Assign a given congfiguration variable with a value
1184          *
1185          * @param       $variableName   The configuration variable we want to assign
1186          * @return      void
1187          */
1188         public function assignConfigVariable ($variableName) {
1189                 // Replace all dashes to underscores to match variables with configuration entries
1190                 $variableName = trim($this->convertDashesToUnderscores($variableName));
1191
1192                 // Sweet and simple...
1193                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1194                 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1195         }
1196
1197         /**
1198          * Injects an array of config variables into the stack of currently loaded
1199          * template. This method should only be used in very rare circumstances,
1200          * e.g. when you have to copy a whole set of variables into the template
1201          * engine. Before you use this method, please make sure you have considered
1202          * all other possiblities.
1203          *
1204          * @param       $variables      An array with variables to be injected
1205          * @return      void
1206          */
1207         public function injectConfigVariables (array $variables) {
1208                 // "Inject" all
1209                 foreach ($variables as $name => $value) {
1210                         // Set variable with name for 'config' group
1211                         $this->setVariable('config', $name, $value);
1212                 } // END - foreach
1213         }
1214
1215         /**
1216          * Assigns all the application data with template variables
1217          *
1218          * @param       $applicationInstance    A manageable application instance
1219          * @return      void
1220          */
1221         public function assignApplicationData (ManageableApplication $applicationInstance) {
1222                 // Get long name and assign it
1223                 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1224
1225                 // Get short name and assign it
1226                 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1227
1228                 // Get version number and assign it
1229                 $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
1230
1231                 // Assign extra application-depending data
1232                 $applicationInstance->assignExtraTemplateData($this);
1233         }
1234
1235         /**
1236          * Load a specified code template into the engine
1237          *
1238          * @param       $template       The code template we shall load which is
1239          *                                              located in 'code' by default
1240          * @return      void
1241          */
1242         public function loadCodeTemplate ($template) {
1243                 // Set template type
1244                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1245
1246                 // Load the special template
1247                 $this->loadTemplate($template);
1248         }
1249
1250         /**
1251          * Compiles configuration place-holders in all variables. This 'walks'
1252          * through the variable group 'general'. It interprets all values from that
1253          * variables as configuration entries after compiling them.
1254          *
1255          * @return      void
1256          */
1257         public final function compileConfigInVariables () {
1258                 // Do we have the stack?
1259                 if (!$this->isVarStackSet('general')) {
1260                         // Abort here silently
1261                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!');
1262                         return;
1263                 } // END - if
1264
1265                 // Iterate through all general variables
1266                 foreach ($this->getVarStack('general') as $index => $currVariable) {
1267                         // Compile the value
1268                         $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
1269
1270                         // Debug message
1271                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currVariable['name'] . ',value=' . $value);
1272
1273                         // Remove it from stack
1274                         $this->removeVariable($currVariable['name'], 'general');
1275                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1276
1277                         // Is it a configuration key?
1278                         if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
1279                                 // The value itself is a configuration entry
1280                                 $this->assignConfigVariable($value);
1281                         } else {
1282                                 // Re-assign the value directly
1283                                 $this->setVariable('config', $currVariable['name'], $value);
1284                         }
1285                 } // END - foreach
1286         }
1287
1288         /**
1289          * Compile all variables by inserting their respective values
1290          *
1291          * @return      void
1292          * @todo        Make this code some nicer...
1293          */
1294         public final function compileVariables () {
1295                 // Initialize the $content array
1296                 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1297                 $dummy = array();
1298
1299                 // Iterate through all general variables
1300                 foreach ($this->getVarStack('general') as $currVariable) {
1301                         // Transfer it's name/value combination to the $content array
1302                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1303                         $dummy[$currVariable['name']] = $currVariable['value'];
1304                 }// END - if
1305
1306                 // Set the new variable (don't remove the second dollar!)
1307                 $$validVar = $dummy;
1308
1309                 // Remove some variables
1310                 unset($index);
1311                 unset($currVariable);
1312
1313                 // Run the compilation three times to get content from helper classes in
1314                 $cnt = 0;
1315                 while ($cnt < 3) {
1316                         // Finalize the compilation of template variables
1317                         $this->finalizeVariableCompilation();
1318
1319                         // Prepare the eval() command for comiling the template
1320                         $eval = sprintf('$result = "%s";',
1321                                 addslashes($this->getRawTemplateData())
1322                         );
1323
1324                         // This loop does remove the backslashes (\) in PHP parameters
1325                         while (strpos($eval, $this->codeBegin) !== FALSE) {
1326                                 // Get left part before "<?"
1327                                 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1328
1329                                 // Get all from right of "<?"
1330                                 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1331
1332                                 // Cut middle part out and remove escapes
1333                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1334                                 $evalMiddle = stripslashes($evalMiddle);
1335
1336                                 // Remove the middle part from right one
1337                                 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1338
1339                                 // And put all together
1340                                 $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
1341                         } // END - while
1342
1343                         // Prepare PHP code for eval() command
1344                         $eval = str_replace(
1345                                 '<%php', '";',
1346                                 str_replace(
1347                                         '%>',
1348                                         "\n\$result .= \"",
1349                                         $eval
1350                                 )
1351                         );
1352
1353                         // Run the constructed command. This will "compile" all variables in
1354                         eval($eval);
1355
1356                         // Goes something wrong?
1357                         if ((!isset($result)) || (empty($result))) {
1358                                 // Output eval command
1359                                 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, TRUE)), TRUE);
1360
1361                                 // Output backtrace here
1362                                 $this->debugBackTrace();
1363                         } // END - if
1364
1365                         // Set raw template data
1366                         $this->setRawTemplateData($result);
1367                         $cnt++;
1368                 } // END - while
1369
1370                 // Final variable assignment
1371                 $this->finalizeVariableCompilation();
1372
1373                 // Set the new content
1374                 $this->setCompiledData($this->getRawTemplateData());
1375         }
1376
1377         /**
1378          * Compile all required templates into the current loaded one
1379          *
1380          * @return      void
1381          * @throws      UnexpectedTemplateTypeException If the template type is
1382          *                                                                                      not "code"
1383          * @throws      InvalidArrayCountException              If an unexpected array
1384          *                                                                                      count has been found
1385          */
1386         public function compileTemplate () {
1387                 // Get code type to make things shorter
1388                 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1389
1390                 // We will only work with template type "code" from configuration
1391                 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1392                         // Abort here
1393                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1394                 } // END - if
1395
1396                 // Get the raw data.
1397                 $rawData = $this->getRawTemplateData();
1398
1399                 // Remove double spaces and trim leading/trailing spaces
1400                 $rawData = trim(str_replace('  ', ' ', $rawData));
1401
1402                 // Search for raw variables
1403                 $this->extractVariablesFromRawData($rawData);
1404
1405                 // Search for code-tags which are {? ?}
1406                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1407
1408                 // Debug message
1409                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:templateMatches=' . print_r($templateMatches , TRUE));
1410
1411                 // Analyze the matches array
1412                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1413                         // Entries are found:
1414                         //
1415                         // The main analysis
1416                         $this->analyzeTemplate($templateMatches);
1417
1418                         // Compile raw template data
1419                         $this->compileRawTemplateData($templateMatches);
1420
1421                         // Are there some raw templates left for loading?
1422                         $this->loadExtraRawTemplates();
1423
1424                         // Are some raw templates found and loaded?
1425                         if (count($this->rawTemplates) > 0) {
1426                                 // Insert all raw templates
1427                                 $this->insertRawTemplates();
1428
1429                                 // Remove the raw template content as well
1430                                 $this->setRawTemplateData('');
1431                         } // END - if
1432                 } // END - if($templateMatches ...
1433         }
1434
1435         /**
1436          * Loads a given view helper (by name)
1437          *
1438          * @param       $helperName             The helper's name
1439          * @return      void
1440          */
1441         protected function loadViewHelper ($helperName) {
1442                 // Make first character upper case, rest low
1443                 $helperName = $this->convertToClassName($helperName);
1444
1445                 // Is this view helper loaded?
1446                 if (!isset($this->helpers[$helperName])) {
1447                         // Create a class name
1448                         $className = $helperName . 'ViewHelper';
1449
1450                         // Generate new instance
1451                         $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1452                 } // END - if
1453
1454                 // Return the requested instance
1455                 return $this->helpers[$helperName];
1456         }
1457
1458         /**
1459          * Transfers the content of this template engine to a given response instance
1460          *
1461          * @param       $responseInstance       An instance of a response class
1462          * @return      void
1463          */
1464         public function transferToResponse (Responseable $responseInstance) {
1465                 // Get the content and set it in response class
1466                 $responseInstance->writeToBody($this->getCompiledData());
1467         }
1468
1469         /**
1470          * "Compiles" a variable by replacing {?var?} with it's content
1471          *
1472          * @param       $rawCode                        Raw code to compile
1473          * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
1474          * @return      $rawCode        Compile code with inserted variable value
1475          */
1476         public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
1477                 // Find the variables
1478                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1479                 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1480
1481                 // Compile all variables
1482                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:<pre>' . print_r($varMatches, TRUE) . '</pre>');
1483                 foreach ($varMatches[0] as $match) {
1484                         // Add variable tags around it
1485                         $varCode = '{?' . $match . '?}';
1486
1487                         // Debug message
1488                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varCode=' . $varCode);
1489
1490                         // Is the variable found in code? (safes some calls)
1491                         if (strpos($rawCode, $varCode) !== FALSE) {
1492                                 // Debug message
1493                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1494
1495                                 // Use $match as new value or $value from read variable?
1496                                 if ($setMatchAsCode === TRUE) {
1497                                         // Insert match
1498                                         $rawCode = str_replace($varCode, $match, $rawCode);
1499                                 } else {
1500                                         // Read the variable
1501                                         $value = $this->readVariable($match);
1502
1503                                         // Insert value
1504                                         $rawCode = str_replace($varCode, $value, $rawCode);
1505                                 }
1506                         } // END - if
1507                 } // END - foreach
1508
1509                 // Return the compiled data
1510                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1511                 return $rawCode;
1512         }
1513
1514         /**
1515          * Getter for variable group array
1516          *
1517          * @return      $vargroups      All variable groups
1518          */
1519         public final function getVariableGroups () {
1520                 return $this->varGroups;
1521         }
1522
1523         /**
1524          * Renames a variable in code and in stack
1525          *
1526          * @param       $oldName        Old name of variable
1527          * @param       $newName        New name of variable
1528          * @return      void
1529          */
1530         public function renameVariable ($oldName, $newName) {
1531                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName);
1532                 // Get raw template code
1533                 $rawData = $this->getRawTemplateData();
1534
1535                 // Replace it
1536                 $rawData = str_replace($oldName, $newName, $rawData);
1537
1538                 // Set the code back
1539                 $this->setRawTemplateData($rawData);
1540         }
1541
1542         /**
1543          * Renders the given XML content
1544          *
1545          * @param       $content        Valid XML content or if not set the current loaded raw content
1546          * @return      void
1547          * @throws      XmlParserException      If an XML error was found
1548          */
1549         public function renderXmlContent ($content = NULL) {
1550                 // Is the content set?
1551                 if (is_null($content)) {
1552                         // Get current content
1553                         $content = $this->getRawTemplateData();
1554                 } // END - if
1555
1556                 // Get a XmlParser instance
1557                 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1558
1559                 // Check if we have XML compacting enabled
1560                 if ($this->isXmlCompactingEnabled()) {
1561                         // Yes, so get a decorator class for transparent compacting
1562                         $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1563                 } // END - if
1564
1565                 // Parse the XML document
1566                 $parserInstance->parseXmlContent($content);
1567         }
1568
1569         /**
1570          * Enables or disables language support
1571          *
1572          * @param       $languageSupport        New language support setting
1573          * @return      void
1574          */
1575         public final function enableLanguageSupport ($languageSupport = TRUE) {
1576                 $this->languageSupport = (bool) $languageSupport;
1577         }
1578
1579         /**
1580          * Checks whether language support is enabled
1581          *
1582          * @return      $languageSupport        Whether language support is enabled or disabled
1583          */
1584         public final function isLanguageSupportEnabled () {
1585                 return $this->languageSupport;
1586         }
1587
1588         /**
1589          * Enables or disables XML compacting
1590          *
1591          * @param       $xmlCompacting  New XML compacting setting
1592          * @return      void
1593          */
1594         public final function enableXmlCompacting ($xmlCompacting = TRUE) {
1595                 $this->xmlCompacting = (bool) $xmlCompacting;
1596         }
1597
1598         /**
1599          * Checks whether XML compacting is enabled
1600          *
1601          * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
1602          */
1603         public final function isXmlCompactingEnabled () {
1604                 return $this->xmlCompacting;
1605         }
1606
1607         /**
1608          * Removes all commentd, tabs and new-line characters to compact the content
1609          *
1610          * @param       $uncompactedContent             The uncompacted content
1611          * @return      $compactedContent               The compacted content
1612          */
1613         public function compactContent ($uncompactedContent) {
1614                 // First, remove all tab/new-line/revert characters
1615                 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1616
1617                 // Then regex all comments like <!-- //--> away
1618                 preg_match_all($this->regExpComments, $compactedContent, $matches);
1619
1620                 // Do we have entries?
1621                 if (isset($matches[0][0])) {
1622                         // Remove all
1623                         foreach ($matches[0] as $match) {
1624                                 // Remove the match
1625                                 $compactedContent = str_replace($match, '', $compactedContent);
1626                         } // END - foreach
1627                 } // END - if
1628
1629                 // Set the content again
1630                 $this->setRawTemplateData($compactedContent);
1631
1632                 // Return compacted content
1633                 return $compactedContent;
1634         }
1635 }
1636
1637 // [EOF]
1638 ?>