template.php

   1 <?php
   2 /*=====================================================================*\
   3 || ################################################################### ||
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # --------------------------------------------------------------- # ||
   6 || # Copyright ©2002-[#]year[#] by Iris Studios, Inc. All Rights Reserved. # ||
   7 || # This file may not be reproduced in any way without permission.  # ||
   8 || # --------------------------------------------------------------- # ||
   9 || # User License Agreement at http://www.iris-studios.com/license/  # ||
  10 || ################################################################### ||
  11 \*=====================================================================*/
  12
  13 /**
  14 * Database-Driven Template System
  15 * template.php
  16 *
  17 * @package      ISSO
  18 */
  19
  20 $OBJECT = 'Database Template System';
  21 $CLASS = 'DB_Template';
  22 $OBJ = 'template';
  23
  24 /**
  25 * Database-Driven Template System
  26 *
  27 * This framework is a backend to the database template engine and
  28 * contains all the parsing algorithms.
  29 *
  30 * @author               Iris Studios, Inc.
  31 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  32 * @version              $Revision$
  33 * @package              ISSO
  34 *
  35 */
  36 class DB_Template
  37 {
  38         /**
  39         * Name of the database table templates are in
  40         * @var  str
  41         * @see  _load()
  42         */
  43         var $templatetable = '';
  44
  45         /**
  46         * Name of the table column template names are in
  47         * @var  str
  48         * @see  $templatetable, _load()
  49         */
  50         var $namecolumn = '';
  51
  52         /**
  53         * Name of the table column templates are in
  54         * @var  str
  55         * @see  templatetable, _load()
  56         */
  57         var $datacolumn = '';
  58
  59         /**
  60         * Additional WHERE clauses for the template fetch SQL
  61         * @var  str
  62         * @see  _load(), cache()
  63         */
  64         var $extrawhere = '';
  65
  66         /**
  67         * The name of the function phrases are fetched with
  68         * @var  str
  69         * @see  _parse_phrases()
  70         */
  71         var $langcall = 'fetch_phrase';
  72
  73         /**
  74         * The name of the function phrases are sprintf() parsed with
  75         * @var  str
  76         * @see  _parse_phrases()
  77         */
  78         var $langconst = 'construct_phrase';
  79
  80         /**
  81         * Array of pre-compiled templates that are stored to decrease server load
  82         * @var  array
  83         * @see  cache()
  84         */
  85         var $cache = array();
  86
  87         /**
  88         * A list of the number of times each template has been used
  89         * @var  array
  90         * @see  fetch()
  91         */
  92         var $usage = array();
  93
  94         /**
  95         * A list of templates that weren't cached, but are still used
  96         * @var  array
  97         * @see  fetch()
  98         */
  99         var $uncached = array();
 100
 101         /**
 102         * Whether or not the page has been flush()'d already
 103         * @var  bool
 104         * @see  flush()
 105         */
 106         var $doneflush = false;
 107
 108         /**
 109         * Takes an array of template names, loads them, and then stores
 110         * a parsed version for optimum speed.
 111         *
 112         * @param        array           List of template names to be cached
 113         */
 114         function cache($namearray)
 115         {
 116                 global $_isso;
 117
 118                 if (sizeof($this->cache) > 0)
 119                 {
 120                         trigger_error('You cannot cache templates more than once per initialization', ERR_WARNING);
 121                 }
 122                 else
 123                 {
 124                         $templates = $_isso->db->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " IN ('" . implode("', '", $namearray) . "')" . (($this->extrawhere) ? $this->extrawhere : ''));
 125                         while ($template = $_isso->db->fetch_array($templates))
 126                         {
 127                                 $template = $this->_parse($template);
 128                                 $this->cache[ $template[ $this->namecolumn ] ] = $template[ $this->datacolumn ];
 129                                 $this->usage["$name"] = 0;
 130                         }
 131                 }
 132         }
 133
 134         /**
 135         * Loads a template from the cache or the _load function and
 136         * stores the parsed version of it
 137         *
 138         * @param        str             The name of the template
 139         *
 140         * @return       str             A parsed and loaded template
 141         */
 142         function fetch($name)
 143         {
 144                 global $_isso;
 145
 146                 if (isset($this->cache["$name"]))
 147                 {
 148                         $template = $this->cache["$name"];
 149                 }
 150                 else
 151                 {
 152                         $this->uncached[] = $name;
 153                         $_isso->debug("Manually loading template `$name`");
 154                         $template = $this->_load($name);
 155                         $template = $this->_parse($template);
 156                 }
 157
 158                 if (!isset($this->usage["$name"]))
 159                 {
 160                         $this->usage["$name"] = 0;
 161                 }
 162
 163                 $this->usage["$name"]++;
 164
 165                 return $template;
 166         }
 167
 168         /**
 169         * Output a template fully compiled to the browser
 170         *
 171         * @param        str             Compiled and ready template
 172         */
 173         function flush($template)
 174         {
 175                 global $_isso;
 176
 177                 ob_start();
 178
 179                 if (empty($template))
 180                 {
 181                         trigger_error('There was no output to print', E_USER_ERROR);
 182                         exit;
 183                 }
 184
 185                 if ($_isso->debug AND isset($_GET['query']))
 186                 {
 187                         if (is_array($_isso->db->history))
 188                         {
 189                                 echo '<pre>';
 190                                 foreach ($_isso->db->history AS $query)
 191                                 {
 192                                         echo $query . "\n\n<hr />\n\n";
 193                                 }
 194                                 echo '</pre>';
 195                         }
 196                         exit;
 197                 }
 198
 199                 if ($this->doneflush)
 200                 {
 201                         trigger_error('A template has already been sent to the output buffer', E_USER_ERROR);
 202                         exit;
 203                 }
 204
 205                 if ($_isso->debug)
 206                 {
 207                         // --- START
 208                         $debug = "\n<ul>";
 209
 210                         // templates
 211                         $optlist = array();
 212                         $usage = array();
 213                         foreach ($this->usage AS $name => $count)
 214                         {
 215                                 if (in_array($name, $this->uncached))
 216                                 {
 217                                         $optlist[] = $name . '[' . $count . ']';
 218                                 }
 219                                 $usage[] = $name . " ($count)";
 220                         }
 221
 222                         $sizeof = sizeof($this->uncached);
 223                         if ($sizeof > 0)
 224                         {
 225                                 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</li>";
 226                         }
 227
 228                         // source control
 229                         $scinfo = 'Not Under Source Control';
 230                         $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
 231                         foreach ($possiblescms AS $scm)
 232                         {
 233                                 if (defined(strtoupper($scm)))
 234                                 {
 235                                         $scinfo = constant(strtoupper($scm));
 236
 237                                         $type = '';
 238                                         // CVS
 239                                         if (strpos($scinfo, 'RCSfile:') !== false)
 240                                         {
 241                                                 $type = 'cvs';
 242                                         }
 243                                         else if (strpos($scinfo, ',v ') !== false)
 244                                         {
 245                                                 $type = 'cvs';
 246                                         }
 247                                         // SVN
 248                                         else if (strpos($scinfo, 'URL:') !== false)
 249                                         {
 250                                                 $type = 'svn';
 251                                         }
 252                                         else if (strpos($scinfo, 'https://') !== false OR strpos($scinfo, 'http://') !== false)
 253                                         {
 254                                                 $type= 'svn';
 255                                         }
 256                                         // not found so just return it
 257                                         // try a SVN ID tag as we can't really tell if we're using it
 258                                         else
 259                                         {
 260                                                 $test = 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);
 261                                                 if ($test == '$' . 'Id: $')
 262                                                 {
 263                                                         $scinfo = 'Not Under Source Control';
 264                                                 }
 265                                                 else
 266                                                 {
 267                                                         $scinfo = $test;
 268                                                 }
 269                                                 break;
 270                                         }
 271
 272                                         if ($type == 'cvs')
 273                                         {
 274                                                 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
 275                                                 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
 276                                                 $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);
 277                                         }
 278                                         else if ($type == 'svn')
 279                                         {
 280                                                 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
 281                                                 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
 282                                                 $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);
 283                                         }
 284                                         else
 285                                         {
 286                                                 $scinfo = 'Not Under Source Control';
 287                                         }
 288                                         break;
 289                                 }
 290                         }
 291                         $scinfo = trim($scinfo);
 292                         $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
 293
 294                         // query information
 295                         $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($_isso->db->history) . " (<a href=\"" . $_isso->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false) ? '&amp;query=1' : '?query=1') . "\">?<a/>)</li>";
 296
 297                         // debug notices
 298                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($_isso->debuginfo) . ")</option>";
 299                         foreach ((array)$_isso->debuginfo AS $msg)
 300                         {
 301                                 $debug .= "\n\t\t\t<option>--- $msg</option>";
 302                         }
 303                         $debug .= "\n\t\t</select>\n\t</li>";
 304
 305                         // loaded modules
 306                         $modules = $_isso->show_modules(true);
 307                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
 308                         foreach ($modules AS $mod)
 309                         {
 310                                 $debug .= "\n\t\t\t<option>--- $mod</option>";
 311                         }
 312                         $debug .= "\n\t\t</select>\n\t</li>";
 313
 314                         // template usage
 315                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->usage) . ")</option>";
 316                         foreach ($usage AS $tpl)
 317                         {
 318                                 $debug .= "\n\t\t\t<option>--- $tpl</option>";
 319                         }
 320                         $debug .= "\n\t\t</select>\n\t</li>";
 321
 322                         // --- END
 323                         $debug .= "\n</ul>";
 324
 325                         $debug = "\n<hr />\n" . $_isso->_message('Debug Information', $debug, 1, true);
 326                         $template = str_replace('</body>', "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n</body>", $template);
 327                 }
 328
 329                 print(stripslashes($template));
 330         }
 331
 332         /**
 333         * Loads an additional template from the database
 334         *
 335         * @param        str             The name of the template
 336         *
 337         * @return       str             Template data from the database
 338         */
 339         function _load($name)
 340         {
 341                 global $_isso;
 342                 if ($template = $_isso->db->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " = '$name'" . (($this->extrawhere) ? $this->extrawhere : '')))
 343                 {
 344                         return $template[ $this->datacolumn ];
 345                 }
 346                 else
 347                 {
 348                         trigger_error("The template '$name' could not be loaded", E_USER_ERROR);
 349                         exit;
 350                 }
 351         }
 352
 353         /**
 354         * A wrapper for all the parsing functions and compiling functins
 355         *
 356         * @param        str             Unparsed template data
 357         *
 358         * @return       str             Parsed template data
 359         */
 360         function _parse($template)
 361         {
 362                 $template = stripslashes($template);
 363                 $template = str_replace('"', '\"', $template);
 364                 $template = $this->_parse_phrases($template);
 365                 $template = $this->_parse_conditionals($template);
 366                 return $template;
 367         }
 368
 369         /**
 370         * Prepares language and locale information inside templates
 371         *
 372         * @param        str             Template data to be processed
 373         *
 374         * @return       str             Language-ready template data
 375         */
 376         function _parse_phrases($template)
 377         {
 378                 $tag_start = '<lang ';
 379                 $tag_start_end = '">';
 380                 $tag_end = '</lang>';
 381
 382                 $location_start = -1;
 383                 $location_end = -1;
 384
 385                 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
 386                 $template = preg_replace('#\{lang\.(.*?)\}#i', '" . ' . $this->langcall . '(\'$1\') . "', $template);
 387
 388                 while (1)
 389                 {
 390                         // Find the start language object tag
 391                         $location_start = strpos($template, $tag_start, $location_end + 1);
 392                         if ($location_start === false)
 393                         {
 394                                 break;
 395                         }
 396
 397                         // Find the end tag
 398                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 399                         if ($location_end === false)
 400                         {
 401                                 break;
 402                         }
 403
 404                         // Extract the language object
 405                         $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 406
 407                         // Find the close to the opening <lang>
 408                         $close_of_open = strpos($phrase_bunch, $tag_start_end);
 409                         if ($close_of_open === false)
 410                         {
 411                                 break;
 412                         }
 413
 414                         // Extract the opening tag so it can be parsed
 415                         $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
 416                         $init_tag = str_replace($tag_start, '', $init_tag);
 417                         $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
 418
 419                         // Get the args out of the tag
 420                         $args = preg_split('#([0-9].*?)=#', $init_tag);
 421                         foreach ($args AS $arg)
 422                         {
 423                                 if ($arg AND $arg != ' ')
 424                                 {
 425                                         $arg = trim($arg);
 426                                         $arg = substr($arg, 2);
 427                                         $arg = substr($arg, 0, strlen($arg) - 2);
 428                                         $arglist[] = $arg;
 429                                 }
 430                         }
 431
 432                         // Just get the phrase name
 433                         $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
 434
 435                         // Wrap the parsed data into the build function
 436                         $function_wrap = '" . ' . $this->langconst . '(\'' . $phrase_name . '\', "' . implode('", "', $arglist) . '") . "';
 437
 438                         // Replace the fully-parsed string back into the template
 439                         $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
 440
 441                         unset($arglist);
 442                 }
 443
 444                 return $template;
 445         }
 446
 447         /**
 448         * Parser for in-line template conditionals
 449         *
 450         * @param        str             Template data awaiting processing
 451         *
 452         * @return       str             Parsed template data
 453         */
 454         function _parse_conditionals($template)
 455         {
 456                 global $_isso;
 457
 458                 // tag data
 459                 $tag_start = '<if condition=\"';
 460                 $tag_start_end = '\">';
 461                 $tag_else = '<else />';
 462                 $tag_end = '</if>';
 463
 464                 // tag stack
 465                 $stack = array();
 466                 $parsed = array();
 467
 468                 for ($i = 0; $i < strlen($template); $i++)
 469                 {
 470                         // we've found ourselves a conditional!
 471                         if (substr($template, $i, strlen($tag_start)) == $tag_start)
 472                         {
 473                                 // push the position into the tag stack
 474                                 array_push($stack, $i);
 475
 476                                 //echo "OPEN `$i`: " . print_r($stack, true);
 477                         }
 478                         // do we have an end tag?
 479                         else if (substr($template, $i, strlen($tag_end)) == $tag_end)
 480                         {
 481                                 // calculate the position of the end tag
 482                                 $end = $i + strlen($tag_end);
 483
 484                                 // find the most recently opened condition
 485                                 $last = array_pop($stack);
 486
 487                                 // how deep are we nested?
 488                                 $depth = count($stack);
 489
 490                                 //echo "CLOSE `$last`: " . print_r($stack, true);
 491
 492                                 // get the full conditional
 493                                 $fullspread = substr($template, $last, $end - $last);
 494
 495                                 // remove the beginning tag
 496                                 $conditional = substr($fullspread, strlen($tag_start));
 497
 498                                 // find the end of the expression
 499                                 $temp_end = strpos($conditional, $tag_start_end);
 500
 501                                 // save the expression
 502                                 $expression = stripslashes(substr($conditional, 0, $temp_end));
 503
 504                                 // remove the expression from the broken conditional
 505                                 $conditional = substr($conditional, strlen($expression) + strlen($tag_start_end));
 506
 507                                 // remove the tailing end tag
 508                                 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
 509
 510                                 // save all the data for later so we can do a quick replacement
 511                                 $parsed["$depth"]["$last"] = array(
 512                                         'raw' => $fullspread,
 513                                         'parsed' => ''
 514                                 );
 515
 516                                 if (substr_count($conditional, $tag_else) == 0)
 517                                 {
 518                                         $parsed["$depth"]["$last"]['parsed'] = '" . ((' . stripslashes($expression) . ') ? "' . $conditional . '" : "") . "';
 519                                 }
 520                                 else
 521                                 {
 522                                         $parsed["$depth"]["$last"]['parsed'] = '" . ((' . stripslashes($expression) . ') ? "' . $conditional . '") . "';
 523                                 }
 524                         }
 525                 }
 526
 527                 // sort so the top-most ones are done first
 528                 ksort($parsed);
 529                 foreach ($parsed AS $depth => $conditionals)
 530                 {
 531                         // sort so we do them in order
 532                         ksort($conditionals);
 533                         foreach ($conditionals AS $block)
 534                         {
 535                                 // replace the old with the new
 536                                 $template = str_replace($block['raw'], $block['parsed'], $template);
 537                         }
 538                 }
 539                 // hackish way to get end tags working
 540                 $template = str_replace($tag_else, '" : "', $template);
 541
 542                 return $template;
 543         }
 544 }
 545
 546 /*=====================================================================*\
 547 || ###################################################################
 548 || # $HeadURL$
 549 || # $Id$
 550 || ###################################################################
 551 \*=====================================================================*/
 552 ?>