From 15fe7b71f4b03d6afa7fec7d8000b9b84b6a43cc Mon Sep 17 00:00:00 2001
From: mmakaay <mmakaay@3247d6aa-85f2-0310-9c31-93178ea70538>
Date: Fri, 7 Apr 2006 09:49:25 +0000
Subject: [PATCH] Added a new function: phorum_get_template_file(), which is
 used for retrieving input and output filenames for a given template name.
 Changed phorum_get_template() to use phorum_get_template_file() and a new
 version of include/templates.php.

---
 common.php | 58 ++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 43 insertions(+), 15 deletions(-)

diff --git a/common.php b/common.php
index 2a5168cdf..bce26dc00 100644
--- a/common.php
+++ b/common.php
@@ -609,8 +609,17 @@ function phorum_get_url()
     return $url;
 }
 
-// retrieve the appropriate template file name
-function phorum_get_template( $page, $is_include = false )
+/**
+ * Find out what input and output files to use for a template file.
+ * 
+ * @param $page - The template base name (e.g. "header", "css", etc.).
+ * @return $phpfile - The PHP file to include for the template base name.
+ * @return $tplfile - The file to use as template input. In case there's no
+ *                    .tpl file to pre-process, the value will be NULL.
+ *                    In that case, the $phpfile return value can be 
+ *                    included directly.
+ */ 
+function phorum_get_template_file( $page )
 {
     $PHORUM = $GLOBALS["PHORUM"];
 
@@ -618,29 +627,48 @@ function phorum_get_template( $page, $is_include = false )
         $PHORUM['template'] = $PHORUM['user']['user_template'];
     }
 
-    // If no user template is set or if the template folder cannot be found,
+    // If no user template is set or if the template file cannot be found,
     // fallback to the default template.
     if (empty($PHORUM["template"]) || !file_exists("./templates/{$PHORUM['template']}")) {
         $PHORUM["template"] = $PHORUM["default_template"];
     }
 
-    $tpl = "./templates/$PHORUM[template]/$page";
+    $tplbase = "./templates/$PHORUM[template]/$page";
+
     // check for straight PHP file
-    if ( file_exists( "$tpl.php" ) ) {
-        $phpfile = "$tpl.php";
+    if ( file_exists( "$tplbase.php" ) ) {
+        return array("$tplbase.php", NULL);
+    // not there, look for a template
     } else {
-        // not there, look for a template
-        $tplfile = "$tpl.tpl";
+        $tplfile = "$tplbase.tpl";
         $safetemplate = str_replace("-", "_", $PHORUM["template"]);
         $safepage = str_replace("-", "_", $page);
-        $phpfile = "$PHORUM[cache]/tpl-$safetemplate-$safepage-" .
-               ($is_include ? "include" : "toplevel") . "-" .
-               md5( dirname( __FILE__ ) ) . ".php";
+        $phpfile = "{$PHORUM["cache"]}/tpl-$safetemplate-$safepage-" .
+               md5(dirname(__FILE__)) . ".php";
 
-        if ( $is_include || !file_exists( $phpfile ) ) {
-            include_once "./include/templates.php";
-            phorum_import_template( $tplfile, $phpfile );
-        }
+        return array($phpfile, $tplfile);
+    }
+}
+
+/**
+ * Returns the PHP file to include for a template file. This function will
+ * automatically compile .tpl files if no compiled template is available.
+ *
+ * @param $page - The template base name (e.g. "header", "css", etc.).
+ * @param $is_include - Whether the template is an include or not (deprecated).
+ * @return $phpfile - The PHP file to include for the template base name.
+ */
+function phorum_get_template( $page )
+{
+    list ($phpfile, $tplfile) = phorum_get_template_file($page);
+
+    // No template to pre-process.
+    if ($tplfile == NULL) return $phpfile;
+
+    // Pre-process template if the output file isn't available.
+    if (! file_exists($phpfile)) {
+        include_once "./include/templates.php";
+        phorum_import_template($page, $tplfile, $phpfile);
     }
 
     return $phpfile;