template.php

   1 <?php
   2 /*=====================================================================*\
   3 || ################################################################### ||
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # --------------------------------------------------------------- # ||
   6 || # All parts of this file are ©2003-[#]year[#] Iris Studios, Inc. No     # ||
   7 || # part of this file may be reproduced in any way: part or whole.  # ||
   8 || # --------------------------------------------------------------- # ||
   9 || # ©2003 - [#]year[#] Iris Studios, Inc. | http://www.iris-studios.com   # ||
  10 || ################################################################### ||
  11 \*=====================================================================*/
  12
  13 $OBJECT = 'Database Template System';
  14 $CLASS = 'DB_Template';
  15 $OBJ = 'template';
  16
  17 /**
  18 * Database-Driven Template System
  19 *
  20 * This framework is a backend to the database template engine and
  21 * contains all the parsing algorithms.
  22 *
  23 * @author               Iris Studios, Inc.
  24 * @copyright    Copyright ©2003 - [#]year[#], Iris Studios, Inc.
  25 * @version              $Revision$
  26 *
  27 */
  28 class DB_Template
  29 {
  30         /**
  31         * Global environment variables
  32         *
  33         * This stores all of the cached and parsed template data
  34         *
  35         * @var  tablename       The name of the database table templates are in
  36         * @var  namecolumn      The name of the database column template names are in
  37         * @var  datacolumn      The name of the database column template data is stored in
  38         * @var  extrawhere      Additional information for the WHERE clause in template loading
  39         * @var  langcall        Function wrapper for phrase fetching system
  40         * @var  langconst       Function that constructs a phrase with sprintf()
  41         * @var  cache           Stores all fettched templates
  42         * @var  usage           Counter for template usage
  43         * @var  uncached        List of uncached templates
  44         * @var  doneflush       Variable to check and see if output has been sent
  45         */
  46         var $templatetable = '';
  47         var $namecolumn = '';
  48         var $datacolumn = '';
  49         var $extrawhere = '';
  50         var $langcall = 'fetch_phrase';
  51         var $langconst = 'construct_phrase';
  52         var $cache = array();
  53         var $usage = array();
  54         var $uncached = array();
  55         var $doneflush = false;
  56
  57         /**
  58         * Takes an array of template names, loads them, and then stores
  59         * a parsed version for optimum speed.
  60         *
  61         * @var  array           List of template names to be cached
  62         */
  63         function cache($namearray)
  64         {
  65                 global $_isso;
  66
  67                 if (sizeof($this->cache) > 0)
  68                 {
  69                         trigger_error('You cannot cache templates more than once per initialization', ERR_WARNING);
  70                 }
  71                 else
  72                 {
  73                         $templates = $_isso->db->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " IN ('" . implode("', '", $namearray) . "')" . iff($this->extrawhere, $this->extrawhere));
  74                         while ($template = $_isso->db->fetch_array($templates))
  75                         {
  76                                 $template = $this->_parse($template);
  77                                 $this->cache[ $template[ $this->namecolumn ] ] = $template[ $this->datacolumn ];
  78                                 $this->usage["$name"] = 0;
  79                         }
  80                 }
  81         }
  82
  83         /**
  84         * Loads a template from the cache or the _load function and
  85         * stores the parsed version of it
  86         *
  87         * @param        str             The name of the template
  88         *
  89         * @return       str             A parsed and loaded template
  90         */
  91         function fetch($name)
  92         {
  93                 global $_isso;
  94
  95                 if (isset($this->cache["$name"]))
  96                 {
  97                         $template = $this->cache["$name"];
  98                 }
  99                 else
 100                 {
 101                         $this->uncached[] = $name;
 102                         $_isso->debug("Manually loading template `$name`");
 103                         $template = $this->_load($name);
 104                         $template = $this->_parse($template);
 105                 }
 106
 107                 if (!isset($this->usage["$name"]))
 108                 {
 109                         $this->usage["$name"] = 0;
 110                 }
 111
 112                 $this->usage["$name"]++;
 113
 114                 return $template;
 115         }
 116
 117         /**
 118         * Output a template fully compiled to the browser
 119         *
 120         * @param        str             Compiled and ready template
 121         */
 122         function flush($template)
 123         {
 124                 global $_isso;
 125
 126                 ob_start();
 127
 128                 if (empty($template))
 129                 {
 130                         trigger_error('There was no output to print', ERR_FATAL);
 131                         exit;
 132                 }
 133
 134                 if ($_isso->debug AND isset($_GET['query']))
 135                 {
 136                         if (is_array($_isso->db->history))
 137                         {
 138                                 echo '<pre>';
 139                                 foreach ($_isso->db->history AS $query)
 140                                 {
 141                                         echo $query . "\n\n<hr />\n\n";
 142                                 }
 143                                 echo '</pre>';
 144                         }
 145                         exit;
 146                 }
 147
 148                 if ($this->doneflush)
 149                 {
 150                         trigger_error('A template has already been sent to the output buffer', ERR_FATAL);
 151                         exit;
 152                 }
 153
 154                 if ($_isso->debug)
 155                 {
 156                         $optlist = array();
 157                         foreach ($this->usage AS $name => $count)
 158                         {
 159                                 if (isset($this->uncached["$name"]))
 160                                 {
 161                                         $optlist[] = $name . '[' . $count . ']';
 162                                 }
 163                         }
 164
 165                         // --- START
 166                         $debug = "\n<ul>";
 167
 168                         // template usage
 169                         $sizeof = sizeof($this->uncached);
 170                         if ($sizeof > 0)
 171                         {
 172                                 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</li>";
 173                         }
 174
 175                         // source control
 176                         $scinfo = 'Not Under Source Control';
 177                         $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
 178                         foreach ($possiblescms AS $scm)
 179                         {
 180                                 if (defined(strtoupper($scm)))
 181                                 {
 182                                         $scinfo = constant(strtoupper($scm));
 183                                         break;
 184                                 }
 185                         }
 186                         $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
 187
 188                         // query information
 189                         $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($_isso->db->history) . " (<a href=\"" . $_SERVER['SCRIPT_URL'] . iff(strpos($_SERVER['SCRIPT_URL'], '?') !== false, '&amp;query=1', '?query=1') . "\">?<a/>)</li>";
 190
 191                         // debug notices
 192                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($_isso->debuginfo) . ")</option>";
 193                         foreach ((array)$_isso->debuginfo AS $msg)
 194                         {
 195                                 $debug .= "\n\t\t\t<option>$msg</option>";
 196                         }
 197                         $debug .= "\n\t</select>\n\t</li>";
 198
 199                         // loaded modules
 200                         $modules = $_isso->show_modules(true);
 201                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
 202                         foreach ($modules AS $mod)
 203                         {
 204                                 $debug .= "\n\t\t\t<option>$mod</option>";
 205                         }
 206                         $debug .= "\n\t</select>\n\t</li>";
 207
 208                         // --- END
 209                         $debug .= "\n</ul>";
 210
 211                         $debug = "\n<hr />\n" . $_isso->_message('Debug Information', $debug, 1, true);
 212                         $template = str_replace('</body>', "\n\n<!-- dev debug -->$debug\n<!-- / dev debug -->\n\n</body>", $template);
 213                 }
 214
 215                 print(stripslashes($template));
 216         }
 217
 218         /**
 219         * Loads an additional template from the database
 220         *
 221         * @param        str             The name of the template
 222         *
 223         * @return       str             Template data from the database
 224         */
 225         function _load($name)
 226         {
 227                 global $_isso;
 228                 if ($template = $_isso->db->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " = '$name'" . iff($this->extrawhere, $this->extrawhere)))
 229                 {
 230                         return $template[ $this->datacolumn ];
 231                 }
 232                 else
 233                 {
 234                         trigger_error("The template '$name' could not be loaded", ERR_FATAL);
 235                         exit;
 236                 }
 237         }
 238
 239         /**
 240         * A wrapper for all the parsing functions and compiling functins
 241         *
 242         * @param        str             Unparsed template data
 243         *
 244         * @return       str             Parsed template data
 245         */
 246         function _parse($template)
 247         {
 248                 $template = stripslashes($template);
 249                 $template = str_replace('"', '\"', $template);
 250                 $template = $this->_parse_phrases($template);
 251                 $template = $this->_parse_conditionals($template);
 252                 return $template;
 253         }
 254
 255         /**
 256         * Prepares language and locale information inside templates
 257         *
 258         * @param        str             Template data to be processed
 259         *
 260         * @return       str             Language-ready template data
 261         */
 262         function _parse_phrases($template)
 263         {
 264                 $tag_start = '<lang ';
 265                 $tag_start_end = '">';
 266                 $tag_end = '</lang>';
 267
 268                 $location_start = -1;
 269                 $location_end = -1;
 270
 271                 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
 272                 $template = preg_replace('#\{lang\.(.*?)\}#i', '" . ' . $this->langcall . '(\'$1\') . "', $template);
 273
 274                 while (1)
 275                 {
 276                         // Find the start language object tag
 277                         $location_start = strpos($template, $tag_start, $location_end + 1);
 278                         if ($location_start === false)
 279                         {
 280                                 break;
 281                         }
 282
 283                         // Find the end tag
 284                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 285                         if ($location_end === false)
 286                         {
 287                                 break;
 288                         }
 289
 290                         // Extract the language object
 291                         $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 292
 293                         // Find the close to the opening <lang>
 294                         $close_of_open = strpos($phrase_bunch, $tag_start_end);
 295                         if ($close_of_open === false)
 296                         {
 297                                 break;
 298                         }
 299
 300                         // Extract the opening tag so it can be parsed
 301                         $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
 302                         $init_tag = str_replace($tag_start, '', $init_tag);
 303                         $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
 304
 305                         // Get the args out of the tag
 306                         $args = preg_split('#([0-9].*?)=#', $init_tag);
 307                         foreach ($args AS $arg)
 308                         {
 309                                 if ($arg AND $arg != ' ')
 310                                 {
 311                                         $arg = trim($arg);
 312                                         $arg = substr($arg, 2);
 313                                         $arg = substr($arg, 0, strlen($arg) - 2);
 314                                         $arglist[] = $arg;
 315                                 }
 316                         }
 317
 318                         // Just get the phrase name
 319                         $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
 320
 321                         // Wrap the parsed data into the build function
 322                         $function_wrap = '" . ' . $this->langconst . '(\'' . $phrase_name . '\', "' . implode('", "', $arglist) . '") . "';
 323
 324                         // Replace the fully-parsed string back into the template
 325                         $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
 326
 327                         unset($arglist);
 328                 }
 329
 330                 return $template;
 331         }
 332
 333         /**
 334         * Parser for in-line template conditionals
 335         *
 336         * @param        str             Template data awaiting processing
 337         *
 338         * @return       str             Parsed template data
 339         */
 340         function _parse_conditionals($template)
 341         {
 342                 // Tag locations
 343                 $location_start = -1;
 344                 $location_end = -1;
 345
 346                 // Tag data
 347                 $tag_start = '<if condition=\\"';
 348                 $tag_start_end = '\\">';
 349                 $tag_else = '<else />';
 350                 $tag_end = '</if>';
 351
 352                 while (1)
 353                 {
 354                         // Finds the start tag: starts looking through the haystack one position
 355                         // after the old startpoint
 356                         $location_start = strpos($template, $tag_start, $location_start + 1);
 357                         if ($location_start === false)
 358                         {
 359                                 break;
 360                         }
 361
 362                         // Finds the end tag: starts looking through the haystack after the old end
 363                         // tag
 364                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 365                         if ($location_end === false)
 366                         {
 367                                 break;
 368                         }
 369
 370                         // Split the template expression out of the template data
 371                         $expression = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 372
 373                         // If we have a nested expression, work it out by setting
 374                         // the search counters to be one and two after the current
 375                         // start point
 376                         if (substr_count($expression, $tag_end) > 1)
 377                         {
 378                                 $location_start = $location_start + 1;
 379                                 $location_end = $location_start + 2;
 380                         }
 381
 382                         // Strip out the opening '<if expression="' part of the tag
 383                         $shell_removed = substr($expression, strlen($tag_start));
 384
 385                         // Get the position of the end of the '<if epxression="' tag
 386                         $shell_end = strpos($shell_removed, $tag_start_end);
 387
 388                         // Take the condition out of the mix
 389                         $expression_condition = stripslashes(substr($shell_removed, 0, $shell_end));
 390
 391                         // Now that we've safely stored the condition, parse out the rest of the data
 392                         $shell_removed = substr($shell_removed, $shell_end + strlen($tag_start_end));
 393
 394                         // Find the end tag and then take out the iftrue data
 395                         $parsed = str_replace($tag_end, '', $shell_removed);
 396
 397                         // Do we have an $tag_else
 398                         $location_else = strpos($parsed, $tag_else);
 399                         if ($location_else !== false)
 400                         {
 401                                 $data = explode($tag_else, $parsed);
 402
 403                                 // um... wtf?
 404                                 if (count($data) > 2)
 405                                 {
 406                                         trigger_error('Multiple else statements encountered while parsing conditionals in template', ERR_ERROR);
 407                                 }
 408
 409                                 // Set the data
 410                                 $iftrue = $data[0];
 411                                 $iffalse = $data[1];
 412                         }
 413                         // Nope, reassign variables
 414                         else
 415                         {
 416                                 $iftrue = $parsed;
 417                                 $iffalse = null;
 418                         }
 419
 420                         // Put the condition and iftrue in the iff() function
 421                         $parsed_expression = '" . iff(' . stripslashes($expression_condition) . ',"' . $iftrue . '","' . $iffalse . '") . "';
 422
 423                         // Parse the iff()'d expression back into the template data
 424                         $template = substr_replace($template, $parsed_expression, $location_start, $location_end + strlen($tag_end) - $location_start);
 425                 }
 426
 427                 // Repeat this process until it can't find any more
 428                 // expressions, then send back the parsed template data
 429                 // for final output
 430                 return $template;
 431         }
 432 }
 433
 434 /*=====================================================================*\
 435 || ###################################################################
 436 || # $HeadURL$
 437 || # $Id$
 438 || ###################################################################
 439 \*=====================================================================*/
 440 ?>