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                         // --- START
 157                         $debug = "\n<ul>";
 158
 159                         // templates
 160                         $optlist = array();
 161                         $usage = array();
 162                         foreach ($this->usage AS $name => $count)
 163                         {
 164                                 if (in_array($name, $this->uncached))
 165                                 {
 166                                         $optlist[] = $name . '[' . $count . ']';
 167                                 }
 168                                 $usage[] = $name . " ($count)";
 169                         }
 170
 171                         $sizeof = sizeof($this->uncached);
 172                         if ($sizeof > 0)
 173                         {
 174                                 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</li>";
 175                         }
 176
 177                         // source control
 178                         $scinfo = 'Not Under Source Control';
 179                         $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
 180                         foreach ($possiblescms AS $scm)
 181                         {
 182                                 if (defined(strtoupper($scm)))
 183                                 {
 184                                         $scinfo = constant(strtoupper($scm));
 185
 186                                         $type = '';
 187                                         // CVS
 188                                         if (strpos($scinfo, 'RCSfile:') !== false)
 189                                         {
 190                                                 $type = 'cvs';
 191                                         }
 192                                         else if (strpos($scinfo, ',v ') !== false)
 193                                         {
 194                                                 $type = 'cvs';
 195                                         }
 196                                         // SVN
 197                                         else if (strpos($scinfo, 'URL:') !== false)
 198                                         {
 199                                                 $type = 'svn';
 200                                         }
 201                                         else if (strpos($scinfo, 'https://') !== false OR strpos($scinfo, 'http://') !== false)
 202                                         {
 203                                                 $type= 'svn';
 204                                         }
 205                                         // not found so just return it
 206                                         // try a SVN ID tag as we can't really tell if we're using it
 207                                         else
 208                                         {
 209                                                 $scinfo = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
 210                                                 break;
 211                                         }
 212
 213                                         if ($type == 'cvs')
 214                                         {
 215                                                 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
 216                                                 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
 217                                                 $scinfo = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}/[0-9]{2}/[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} (.+?) (.+?) \$#', '\\1 - CVS \\2', $scinfo);
 218                                         }
 219                                         else if ($type == 'svn')
 220                                         {
 221                                                 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
 222                                                 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
 223                                                 $scinfo = preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
 224                                         }
 225                                         break;
 226                                 }
 227                         }
 228                         $scinfo = trim($scinfo);
 229                         $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
 230
 231                         // query information
 232                         $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($_isso->db->history) . " (<a href=\"" . $_SERVER['REQUEST_URI'] . iff(strpos($_SERVER['REQUEST_URI'], '?') !== false, '&amp;query=1', '?query=1') . "\">?<a/>)</li>";
 233
 234                         // debug notices
 235                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($_isso->debuginfo) . ")</option>";
 236                         foreach ((array)$_isso->debuginfo AS $msg)
 237                         {
 238                                 $debug .= "\n\t\t\t<option>--- $msg</option>";
 239                         }
 240                         $debug .= "\n\t\t</select>\n\t</li>";
 241
 242                         // loaded modules
 243                         $modules = $_isso->show_modules(true);
 244                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
 245                         foreach ($modules AS $mod)
 246                         {
 247                                 $debug .= "\n\t\t\t<option>--- $mod</option>";
 248                         }
 249                         $debug .= "\n\t\t</select>\n\t</li>";
 250
 251                         // template usage
 252                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->usage) . ")</option>";
 253                         foreach ($usage AS $tpl)
 254                         {
 255                                 $debug .= "\n\t\t\t<option>--- $tpl</option>";
 256                         }
 257                         $debug .= "\n\t\t</select>\n\t</li>";
 258
 259                         // --- END
 260                         $debug .= "\n</ul>";
 261
 262                         $debug = "\n<hr />\n" . $_isso->_message('Debug Information', $debug, 1, true);
 263                         $template = str_replace('</body>', "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n</body>", $template);
 264                 }
 265
 266                 print(stripslashes($template));
 267         }
 268
 269         /**
 270         * Loads an additional template from the database
 271         *
 272         * @param        str             The name of the template
 273         *
 274         * @return       str             Template data from the database
 275         */
 276         function _load($name)
 277         {
 278                 global $_isso;
 279                 if ($template = $_isso->db->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " = '$name'" . iff($this->extrawhere, $this->extrawhere)))
 280                 {
 281                         return $template[ $this->datacolumn ];
 282                 }
 283                 else
 284                 {
 285                         trigger_error("The template '$name' could not be loaded", ERR_FATAL);
 286                         exit;
 287                 }
 288         }
 289
 290         /**
 291         * A wrapper for all the parsing functions and compiling functins
 292         *
 293         * @param        str             Unparsed template data
 294         *
 295         * @return       str             Parsed template data
 296         */
 297         function _parse($template)
 298         {
 299                 $template = stripslashes($template);
 300                 $template = str_replace('"', '\"', $template);
 301                 $template = $this->_parse_phrases($template);
 302                 $template = $this->_parse_conditionals($template);
 303                 return $template;
 304         }
 305
 306         /**
 307         * Prepares language and locale information inside templates
 308         *
 309         * @param        str             Template data to be processed
 310         *
 311         * @return       str             Language-ready template data
 312         */
 313         function _parse_phrases($template)
 314         {
 315                 $tag_start = '<lang ';
 316                 $tag_start_end = '">';
 317                 $tag_end = '</lang>';
 318
 319                 $location_start = -1;
 320                 $location_end = -1;
 321
 322                 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
 323                 $template = preg_replace('#\{lang\.(.*?)\}#i', '" . ' . $this->langcall . '(\'$1\') . "', $template);
 324
 325                 while (1)
 326                 {
 327                         // Find the start language object tag
 328                         $location_start = strpos($template, $tag_start, $location_end + 1);
 329                         if ($location_start === false)
 330                         {
 331                                 break;
 332                         }
 333
 334                         // Find the end tag
 335                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 336                         if ($location_end === false)
 337                         {
 338                                 break;
 339                         }
 340
 341                         // Extract the language object
 342                         $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 343
 344                         // Find the close to the opening <lang>
 345                         $close_of_open = strpos($phrase_bunch, $tag_start_end);
 346                         if ($close_of_open === false)
 347                         {
 348                                 break;
 349                         }
 350
 351                         // Extract the opening tag so it can be parsed
 352                         $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
 353                         $init_tag = str_replace($tag_start, '', $init_tag);
 354                         $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
 355
 356                         // Get the args out of the tag
 357                         $args = preg_split('#([0-9].*?)=#', $init_tag);
 358                         foreach ($args AS $arg)
 359                         {
 360                                 if ($arg AND $arg != ' ')
 361                                 {
 362                                         $arg = trim($arg);
 363                                         $arg = substr($arg, 2);
 364                                         $arg = substr($arg, 0, strlen($arg) - 2);
 365                                         $arglist[] = $arg;
 366                                 }
 367                         }
 368
 369                         // Just get the phrase name
 370                         $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
 371
 372                         // Wrap the parsed data into the build function
 373                         $function_wrap = '" . ' . $this->langconst . '(\'' . $phrase_name . '\', "' . implode('", "', $arglist) . '") . "';
 374
 375                         // Replace the fully-parsed string back into the template
 376                         $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
 377
 378                         unset($arglist);
 379                 }
 380
 381                 return $template;
 382         }
 383
 384         /**
 385         * Parser for in-line template conditionals
 386         *
 387         * @param        str             Template data awaiting processing
 388         *
 389         * @return       str             Parsed template data
 390         */
 391         function _parse_conditionals($template)
 392         {
 393                 // Tag locations
 394                 $location_start = -1;
 395                 $location_end = -1;
 396
 397                 // Tag data
 398                 $tag_start = '<if condition=\\"';
 399                 $tag_start_end = '\\">';
 400                 $tag_else = '<else />';
 401                 $tag_end = '</if>';
 402
 403                 while (1)
 404                 {
 405                         // Finds the start tag: starts looking through the haystack one position
 406                         // after the old startpoint
 407                         $location_start = strpos($template, $tag_start, $location_start + 1);
 408                         if ($location_start === false)
 409                         {
 410                                 break;
 411                         }
 412
 413                         // Finds the end tag: starts looking through the haystack after the old end
 414                         // tag
 415                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 416                         if ($location_end === false)
 417                         {
 418                                 break;
 419                         }
 420
 421                         // Split the template expression out of the template data
 422                         $expression = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 423
 424                         // If we have a nested expression, work it out by setting
 425                         // the search counters to be one and two after the current
 426                         // start point
 427                         if (substr_count($expression, $tag_end) > 1)
 428                         {
 429                                 $location_start = $location_start + 1;
 430                                 $location_end = $location_start + 2;
 431                         }
 432
 433                         // Strip out the opening '<if expression="' part of the tag
 434                         $shell_removed = substr($expression, strlen($tag_start));
 435
 436                         // Get the position of the end of the '<if epxression="' tag
 437                         $shell_end = strpos($shell_removed, $tag_start_end);
 438
 439                         // Take the condition out of the mix
 440                         $expression_condition = stripslashes(substr($shell_removed, 0, $shell_end));
 441
 442                         // Now that we've safely stored the condition, parse out the rest of the data
 443                         $shell_removed = substr($shell_removed, $shell_end + strlen($tag_start_end));
 444
 445                         // Find the end tag and then take out the iftrue data
 446                         $parsed = str_replace($tag_end, '', $shell_removed);
 447
 448                         // Do we have an $tag_else
 449                         $location_else = strpos($parsed, $tag_else);
 450                         if ($location_else !== false)
 451                         {
 452                                 $data = explode($tag_else, $parsed);
 453
 454                                 // um... wtf?
 455                                 if (count($data) > 2)
 456                                 {
 457                                         trigger_error('Multiple else statements encountered while parsing conditionals in template', ERR_ALERT);
 458                                 }
 459
 460                                 // Set the data
 461                                 $iftrue = $data[0];
 462                                 $iffalse = $data[1];
 463                         }
 464                         // Nope, reassign variables
 465                         else
 466                         {
 467                                 $iftrue = $parsed;
 468                                 $iffalse = null;
 469                         }
 470
 471                         // Put the condition and iftrue in the iff() function
 472                         $parsed_expression = '" . iff(' . stripslashes($expression_condition) . ',"' . $iftrue . '","' . $iffalse . '") . "';
 473
 474                         // Parse the iff()'d expression back into the template data
 475                         $template = substr_replace($template, $parsed_expression, $location_start, $location_end + strlen($tag_end) - $location_start);
 476                 }
 477
 478                 // Repeat this process until it can't find any more
 479                 // expressions, then send back the parsed template data
 480                 // for final output
 481                 return $template;
 482         }
 483 }
 484
 485 /*=====================================================================*\
 486 || ###################################################################
 487 || # $HeadURL$
 488 || # $Id$
 489 || ###################################################################
 490 \*=====================================================================*/
 491 ?>