]> git.mxchange.org Git - shipsimu.git/blobdiff - inc/classes/main/template/class_TemplateEngine.php
The 'key' for encryption can now be taken from fixed or daily-changed extra salt
[shipsimu.git] / inc / classes / main / template / class_TemplateEngine.php
index e1c3bcee1e5fdeb743f6738e685ca67fa246cd1d..23ac8b4a0fa35e4749feb8b00e9acbf8edf789c4 100644 (file)
@@ -7,7 +7,7 @@
  * @version            0.0.0
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.ship-simu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -109,9 +109,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        private $helpers = array();
 
        // Exception codes for the template engine
-       const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0xa00;
-       const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0xa01;
-       const EXCEPTION_INVALID_VIEW_HELPER           = 0xa02;
+       const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x020;
+       const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x021;
+       const EXCEPTION_INVALID_VIEW_HELPER           = 0x022;
 
        /**
         * Protected constructor
@@ -283,6 +283,42 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                }
        }
 
+       /**
+        * Setter for template type. Only "html", "emails" and "compiled" should
+        * be sent here
+        *
+        * @param       $templateType   The current template's type
+        * @return      void
+        */
+       private final function setTemplateType ($templateType) {
+               // Cast it
+               $templateType = (string) $templateType;
+
+               // And set it (only 2 letters)
+               $this->templateType = $templateType;
+       }
+
+       /**
+        * Setter for the last loaded template's FQFN
+        *
+        * @param       $template       The last loaded template
+        * @return      void
+        */
+       private final function setLastTemplate ($template) {
+               // Cast it to string
+               $template = (string) $template;
+               $this->lastTemplate = $template;
+       }
+
+       /**
+        * Getter for the last loaded template's FQFN
+        *
+        * @return      $template       The last loaded template
+        */
+       private final function getLastTemplate () {
+               return $this->lastTemplate;
+       }
+
        /**
         * Initialize the variable stack. This holds all variables for later
         * compilation.
@@ -372,8 +408,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        /**
         * Setter for path of compiled templates
         *
-        * @param               $compileOutputPath              The local base path for all
-        *                                                              compiled templates
+        * @param       $compileOutputPath      The local base path for all compiled
+        *                                                              templates
         * @return      void
         */
        public final function setCompileOutputPath ($compileOutputPath) {
@@ -384,21 +420,6 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                $this->compileOutputPath = $compileOutputPath;
        }
 
-       /**
-        * Setter for template type. Only "html", "emails" and "compiled" should
-        * be sent here
-        *
-        * @param               $templateType   The current template's type
-        * @return      void
-        */
-       private final function setTemplateType ($templateType) {
-               // Cast it
-               $templateType = (string) $templateType;
-
-               // And set it (only 2 letters)
-               $this->templateType = $templateType;
-       }
-
        /**
         * Getter for template type
         *
@@ -408,32 +429,11 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                return $this->templateType;
        }
 
-       /**
-        * Setter for the last loaded template's FQFN
-        *
-        * @param               $template               The last loaded template
-        * @return      void
-        */
-       private final function setLastTemplate ($template) {
-               // Cast it to string
-               $template = (string) $template;
-               $this->lastTemplate = $template;
-       }
-
-       /**
-        * Getter for the last loaded template's FQFN
-        *
-        * @return      $template               The last loaded template
-        */
-       private final function getLastTemplate () {
-               return $this->lastTemplate;
-       }
-
        /**
         * Assign (add) a given variable with a value
         *
-        * @param               $var            The variable we are looking for
-        * @param               $value  The value we want to store in the variable
+        * @param       $var    The variable we are looking for
+        * @param       $value  The value we want to store in the variable
         * @return      void
         */
        public final function assignVariable ($var, $value) {
@@ -450,22 +450,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                }
        }
 
-       /**
-        * Assign a given congfiguration variable with a value
-        *
-        * @param               $var            The configuration variable we are looking for
-        * @param               $value  The value we want to store in the variable
-        * @return      void
-        */
-       public final function assignConfigVariable ($var, $value) {
-               // Sweet and simple...
-               $this->configVariables[$var] = $value;
-       }
-
        /**
         * Removes a given variable
         *
-        * @param               $var            The variable we are looking for
+        * @param       $var    The variable we are looking for
         * @return      void
         */
        public final function removeVariable ($var) {
@@ -482,7 +470,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        /**
         * Private setter for raw template data
         *
-        * @param               $rawTemplateData        The raw data from the template
+        * @param       $rawTemplateData        The raw data from the template
         * @return      void
         */
        private final function setRawTemplateData ($rawTemplateData) {
@@ -495,6 +483,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 
        /**
         * Private setter for compiled templates
+        *
+        * @return      void
         */
        private final function setCompiledData ($compiledData) {
                // Cast it to string
@@ -507,10 +497,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        /**
         * Private loader for all template types
         *
-        * @param               $template               The template we shall load
+        * @param       $template       The template we shall load
         * @return      void
         */
-       private final function loadTemplate ($template) {
+       private function loadTemplate ($template) {
                // Cast it to string
                $template = (string) $template;
 
@@ -539,12 +529,12 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        /**
         * A private loader for raw template names
         *
-        * @param               $fqfn   The full-qualified file name for a template
+        * @param       $fqfn   The full-qualified file name for a template
         * @return      void
         * @throws      NullPointerException    If $inputInstance is null
         * @throws      NoObjectException               If $inputInstance is not an object
         * @throws      MissingMethodException  If $inputInstance is missing a
-        *                                                              required method
+        *                                                                      required method
         */
        private function loadRawTemplateData ($fqfn) {
                // Get a input/output instance from the middleware
@@ -576,9 +566,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * Try to assign an extracted template variable as a "content" or "config"
         * variable.
         *
-        * @param               $varName                The variable's name (shall be content or
-        *                                              config) by default
-        * @param               $var                    The variable we want to assign
+        * @param       $varName        The variable's name (shall be content orconfig) by
+        *                                              default
+        * @param       $var            The variable we want to assign
         */
        private function assignTemplateVariable ($varName, $var) {
                // Is it not a config variable?
@@ -587,7 +577,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                        $this->assignVariable($var, "");
                } else {
                        // Configuration variables
-                       $this->assignConfigVariable($var, $this->getConfigInstance()->readConfig($var));
+                       $this->assignConfigVariable($var);
                }
        }
 
@@ -610,14 +600,14 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                        foreach ($variableMatches[3] as $key=>$var) {
                                // Try to assign it, empty strings are being ignored
                                $this->assignTemplateVariable($variableMatches[1][$key], $var);
-                       }
-               }
+                       } // END - foreach
+               } // END - if
        }
 
        /**
         * Main analysis of the loaded template
         *
-        * @param               $templateMatches        Found template place-holders, see below
+        * @param       $templateMatches        Found template place-holders, see below
         * @return      void
         *
         *---------------------------------
@@ -659,6 +649,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                                                // Remember this template for recursion detection
                                                // RECURSIVE PROTECTION!
                                                $this->loadedTemplates[] = $template;
+                                       } catch (FileIsMissingException $e) {
+                                               // Even this is not done... :/
+                                               $this->rawTemplates[] = $template;
                                        } catch (FilePointerNotOpenedException $e) {
                                                // Even this is not done... :/
                                                $this->rawTemplates[] = $template;
@@ -676,8 +669,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        /**
         * Compile a given raw template code and remember it for later usage
         *
-        * @param               $code           The raw template code
-        * @param               $template               The template's name
+        * @param       $code           The raw template code
+        * @param       $template       The template's name
         * @return      void
         */
        private function compileCode ($code, $template) {
@@ -712,7 +705,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * Insert all given and loaded templates by running through all loaded
         * codes and searching for their place-holder in the main template
         *
-        * @param               $templateMatches        See method analyzeTemplate()
+        * @param       $templateMatches        See method analyzeTemplate()
         * @return      void
         */
        private function insertAllTemplates (array $templateMatches) {
@@ -762,6 +755,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                                        // Remember this template for recursion detection
                                        // RECURSIVE PROTECTION!
                                        $this->loadedTemplates[] = $template;
+                               } catch (FileIsMissingException $e) {
+                                       // This template was never found. We silently ignore it
+                                       unset($this->rawTemplates[$key]);
                                } catch (FilePointerNotOpenedException $e) {
                                        // This template was never found. We silently ignore it
                                        unset($this->rawTemplates[$key]);
@@ -775,6 +771,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         *
         * @param               $varMatches     An array full of variable/value pairs.
         * @return      void
+        * @todo        Unfinished work or don't die here.
         */
        private function assignAllVariables (array $varMatches) {
                // Search for all variables
@@ -792,7 +789,6 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                                $this->assignVariable($var, $varMatches[3][$key]);
                        } elseif (!empty($varMatches[2][$key])) {
                                // Non-string found so we need some deeper analysis...
-                               // @TODO Unfinished work or don't die here.
                                die("Deeper analysis not yet implemented!");
                        }
 
@@ -903,7 +899,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         *                                              located in "html" by default
         * @return      void
         */
-       public final function loadWebTemplate ($template) {
+       public function loadWebTemplate ($template) {
                // Set template type
                $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
 
@@ -911,6 +907,17 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                $this->loadTemplate($template);
        }
 
+       /**
+        * Assign a given congfiguration variable with a value
+        *
+        * @param       $var    The configuration variable we want to assign
+        * @return      void
+        */
+       public function assignConfigVariable ($var) {
+               // Sweet and simple...
+               $this->configVariables[$var] = $this->getConfigInstance()->readConfig($var);
+       }
+
        /**
         * Load a specified email template into the engine
         *
@@ -918,7 +925,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         *                                              located in "emails" by default
         * @return      void
         */
-       public final function loadEmailTemplate ($template) {
+       public function loadEmailTemplate ($template) {
                // Set template type
                $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
 
@@ -933,7 +940,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         *                                              located in "code" by default
         * @return      void
         */
-       public final function loadCodeTemplate ($template) {
+       public function loadCodeTemplate ($template) {
                // Set template type
                $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
 
@@ -945,6 +952,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * Compile all variables by inserting their respective values
         *
         * @return      void
+        * @todo        Make this code some nicer...
         */
        public final function compileVariables () {
                // Initialize the $content array
@@ -985,7 +993,6 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                        );
 
                        // This loop does remove the backslashes (\) in PHP parameters
-                       // @TODO Make this some nicer...
                        while (strpos($eval, "<?") !== false) {
                                // Get left part before "<?"
                                $evalLeft = substr($eval, 0, strpos($eval, "<?"));
@@ -1011,21 +1018,28 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                        } // END - while
 
                        // Prepare PHP code for eval() command
+                       $evalLength = strlen($eval);
                        $eval = str_replace(
                                "<%php", "\";",
                                str_replace(
-                                       "%>", "\$result .= \"", $eval
+                                       "%>", "\n\$result .= \"", $eval
                                )
                        );
 
-                       // Debug message
-                       if ((defined('DEBUG_EVAL')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
-                               $this->__toString(),
-                               htmlentities($eval)
-                       ));
+                       // Did something change?
+                       if (strlen($eval) != $eval) {
+                               // Run the constructed command. This will "compile" all variables in
+                               @eval($eval);
+                       } // END - if
 
-                       // Run the constructed command. This will "compile" all variables in
-                       eval($eval);
+                       // Goes something wrong?
+                       if (!isset($result)) {
+                               // Output eval command
+                               $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
+
+                               // Output backtrace here
+                               $this->debugBacktrace();
+                       } // END - if
 
                        // Set raw template data
                        $this->setRawTemplateData($result);
@@ -1113,15 +1127,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                                $this->getTemplateType()
                        );
 
-                       if ((is_object($this->getDebugInstance())) && (method_exists($this->getDebugInstance(), 'output'))) {
-                               // Use debug output handler
-                               $this->getDebugInstance()->output($msg);
-                               die();
-                       } else {
-                               // Put directly out
-                               // DO NOT REWRITE THIS TO app_die() !!!
-                               die($msg);
-                       }
+                       // Write the problem to the world...
+                       $this->debugOutput($msg);
                        break;
                }
        }