framework/template.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright (c)2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Database-Driven Template System
  24 * template.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * Database-Driven Template System
  31 *
  32 * This framework is a backend to the database template engine and
  33 * contains all the parsing algorithms.
  34 *
  35 * Hooks:
  36 *               $this->pre_parse_hook - Name of the function to execute on
  37 *                                                               a template before the parsing occurs
  38 *
  39 * @author               Blue Static
  40 * @copyright    Copyright (c)2002 - [#]year[#], Blue Static
  41 * @version              $Revision$
  42 * @package              ISSO
  43 *
  44 */
  45 class Template
  46 {
  47         /**
  48         * Framework registry object
  49         * @var  object
  50         * @access       private
  51         */
  52         var $registry = null;
  53
  54         /**
  55         * Name of the database table templates are in
  56         * @var  string
  57         * @access       private
  58         */
  59         var $tablename = '';
  60
  61         /**
  62         * Name of the table column template names are in
  63         * @var  string
  64         * @access       private
  65         */
  66         var $namecolumn = '';
  67
  68         /**
  69         * Name of the table column templates are in
  70         * @var  string
  71         * @access       private
  72         */
  73         var $datacolumn = '';
  74
  75         /**
  76         * Additional WHERE clauses for the template fetch SQL
  77         * @var  string
  78         * @access       private
  79         */
  80         var $extrawhere = '';
  81
  82         /**
  83         * The name of the function phrases are fetched with
  84         * @var  string
  85         * @access       private
  86         */
  87         var $langcall = 'gettext';
  88
  89         /**
  90         * The name of the function phrases are sprintf() parsed with
  91         * @var  string
  92         * @access       private
  93         */
  94         var $langconst = 'sprintf';
  95
  96         /**
  97         * Array of pre-compiled templates that are stored to decrease server load
  98         * @var  array
  99         * @access       private
 100         */
 101         var $cache = array();
 102
 103         /**
 104         * A list of the number of times each template has been used
 105         * @var  array
 106         * @access       private
 107         */
 108         var $usage = array();
 109
 110         /**
 111         * A list of templates that weren't cached, but are still used
 112         * @var  array
 113         * @access       private
 114         */
 115         var $uncached = array();
 116
 117         /**
 118         * Whether or not the page has been flush()'d already
 119         * @var  bool
 120         * @access       private
 121         */
 122         var $doneflush = false;
 123
 124         /**
 125         * The name of a function that is called before template parsing of phrases and conditionals occurs
 126         * @var  string
 127         * @access       private
 128         */
 129         var $pre_parse_hook = ':=NO METHOD=:';
 130
 131         // ###################################################################
 132         /**
 133         * Constructor
 134         */
 135         function __construct(&$registry)
 136         {
 137                 $this->registry =& $registry;
 138         }
 139
 140         // ###################################################################
 141         /**
 142         * (PHP 4) Constructor
 143         */
 144         function Template(&$registry)
 145         {
 146                 $this->__construct($registry);
 147         }
 148
 149         // ###################################################################
 150         /**
 151         * Initializes the class and all subclasses under a common package name
 152         *
 153         * @access       protected
 154         *
 155         * @return       string  The package name
 156         */
 157         function init_as_package()
 158         {
 159                 return 'template';
 160         }
 161
 162         // ###################################################################
 163         /**
 164         * Sets tablename
 165         *
 166         * @access       public
 167         *
 168         * @param        string  Table name
 169         */
 170         function setTableName($name)
 171         {
 172                 $this->tablename = $name;
 173         }
 174
 175         // ###################################################################
 176         /**
 177         * Sets namecolumn
 178         *
 179         * @access       public
 180         *
 181         * @param        string  Name column name
 182         */
 183         function setNameColumn($name)
 184         {
 185                 $this->namecolumn = $name;
 186         }
 187
 188         // ###################################################################
 189         /**
 190         * Sets datacolumn
 191         *
 192         * @access       public
 193         *
 194         * @param        string  Data column name
 195         */
 196         function setDataColumn($name)
 197         {
 198                 $this->datacolumn = $name;
 199         }
 200
 201         // ###################################################################
 202         /**
 203         * Sets extrawhere
 204         *
 205         * @access       public
 206         *
 207         * @param        string  Extra WHERE SQL clause
 208         */
 209         function setExtraWhere($sql)
 210         {
 211                 $this->extrawhere = $sql;
 212         }
 213
 214         // ###################################################################
 215         /**
 216         * Sets the pre-parse hook
 217         *
 218         * @access       public
 219         *
 220         * @param        string  Method name
 221         */
 222         function setPreParseHook($name)
 223         {
 224                 $this->pre_parse_hook = $name;
 225         }
 226
 227         // ###################################################################
 228         /**
 229         * Takes an array of template names, loads them, and then stores a
 230         * parsed version for optimum speed.
 231         *
 232         * @access       public
 233         *
 234         * @param        array   List of template names to be cached
 235         */
 236         function cache($namearray)
 237         {
 238                 if (sizeof($this->cache) > 0)
 239                 {
 240                         trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
 241                 }
 242                 else
 243                 {
 244                         $templates = $this->registry->modules[ISSO_DB_LAYER]->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " IN ('" . implode("', '", $namearray) . "')" . ($this->extrawhere ? ' ' . $this->extrawhere : ''));
 245                         while ($template = $this->registry->modules[ISSO_DB_LAYER]->fetch_array($templates))
 246                         {
 247                                 $this->cache[ $template[ $this->namecolumn ] ] = $this->_parse($template[ $this->datacolumn ]);
 248                                 $this->usage[ $template[ $this->namecolumn ] ] = 0;
 249                         }
 250                 }
 251         }
 252
 253         // ###################################################################
 254         /**
 255         * Loads a template from the cache or the _load function and stores the
 256         * parsed version of it
 257         *
 258         * @access       public
 259         *
 260         * @param        string  The name of the template
 261         *
 262         * @return       string  A parsed and loaded template
 263         */
 264         function fetch($name)
 265         {
 266                 if (isset($this->cache["$name"]))
 267                 {
 268                         $template = $this->cache["$name"];
 269                 }
 270                 else
 271                 {
 272                         $this->uncached[] = $name;
 273                         $this->registry->debug("Manually loading template `$name`");
 274                         $template = $this->_load($name);
 275                         $template = $this->_parse($template);
 276                 }
 277
 278                 if (!isset($this->usage["$name"]))
 279                 {
 280                         $this->usage["$name"] = 0;
 281                 }
 282
 283                 $this->usage["$name"]++;
 284
 285                 return $template;
 286         }
 287
 288         // ###################################################################
 289         /**
 290         * Output a template fully compiled to the browser
 291         *
 292         * @access       public
 293         *
 294         * @param        string  Compiled and ready template
 295         */
 296         function flush($template)
 297         {
 298                 ob_start();
 299
 300                 if (empty($template))
 301                 {
 302                         trigger_error('There was no output to print', E_USER_ERROR);
 303                         exit;
 304                 }
 305
 306                 if ($this->doneflush)
 307                 {
 308                         trigger_error('A template has already been sent to the output buffer', E_USER_ERROR);
 309                         exit;
 310                 }
 311
 312                 $template = str_replace('</body>', $this->registry->construct_debug_block(true) . $this->registry->modules[ISSO_DB_LAYER]->dblink->ConstructHTMLDebugBlock() . '</body>', $template);
 313
 314                 print($template);
 315         }
 316
 317         // ###################################################################
 318         /**
 319         * Loads an additional template from the database
 320         *
 321         * @access       private
 322         *
 323         * @param        string  The name of the template
 324         *
 325         * @return       string  Template data from the database
 326         */
 327         function _load($name)
 328         {
 329                 if ($template = $this->registry->modules[ISSO_DB_LAYER]->query_first("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " = '$name'" . ($this->extrawhere ? ' ' . $this->extrawhere : '')))
 330                 {
 331                         return $template[ $this->datacolumn ];
 332                 }
 333                 else
 334                 {
 335                         trigger_error("The template '$name' could not be loaded", E_USER_ERROR);
 336                         exit;
 337                 }
 338         }
 339
 340         // ###################################################################
 341         /**
 342         * A wrapper for all the parsing functions and compiling functins
 343         *
 344         * @access       protected
 345         *
 346         * @param        string  Unparsed template data
 347         *
 348         * @return       string  Parsed template data
 349         */
 350         function _parse($template)
 351         {
 352                 $template = str_replace('"', '\"', $template);
 353
 354                 if (function_exists($this->pre_parse_hook))
 355                 {
 356                         $template = call_user_func($this->pre_parse_hook, $template);
 357                 }
 358
 359                 $template = $this->_parse_phrases($template);
 360                 $template = $this->_parse_conditionals($template);
 361                 return $template;
 362         }
 363
 364         // ###################################################################
 365         /**
 366         * Prepares language and locale information inside templates
 367         *
 368         * @access       private
 369         *
 370         * @param        string  Template data to be processed
 371         *
 372         * @return       string  Language-ready template data
 373         */
 374         function _parse_phrases($template)
 375         {
 376                 $tag_start = '<lang ';
 377                 $tag_start_end = '\">';
 378                 $tag_end = '</lang>';
 379
 380                 $location_start = -1;
 381                 $location_end = -1;
 382
 383                 while (1)
 384                 {
 385                         // Find the start language object tag
 386                         $location_start = strpos($template, $tag_start, $location_end + 1);
 387                         if ($location_start === false)
 388                         {
 389                                 break;
 390                         }
 391
 392                         // Find the end tag
 393                         $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
 394                         if ($location_end === false)
 395                         {
 396                                 break;
 397                         }
 398
 399                         // Extract the language object
 400                         $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
 401
 402                         // Find the close to the opening <lang>
 403                         $close_of_open = strpos($phrase_bunch, $tag_start_end);
 404                         if ($close_of_open === false)
 405                         {
 406                                 break;
 407                         }
 408
 409                         // Extract the opening tag so it can be parsed
 410                         $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
 411                         $init_tag = str_replace($tag_start, '', $init_tag);
 412                         $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
 413
 414                         // Get the args out of the tag
 415                         $args = preg_split('#([0-9].*?)=#', $init_tag);
 416                         foreach ($args AS $arg)
 417                         {
 418                                 if ($arg AND $arg != ' ')
 419                                 {
 420                                         $arg = trim($arg);
 421                                         $arg = substr($arg, 2);
 422                                         $arg = substr($arg, 0, strlen($arg) - 2);
 423                                         $arglist[] = $arg;
 424                                 }
 425                         }
 426
 427                         // Just get the phrase name
 428                         $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
 429
 430                         // Wrap the parsed data into the build function
 431                         $function_wrap = '" . ' . $this->langconst . '("' . /*str_replace(array('\"', "'"), array('"', "\'"),*/ $phrase_name/*)*/ . '", "' . implode('", "', $arglist) . '") . "';
 432
 433                         // Replace the fully-parsed string back into the template
 434                         $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
 435
 436                         unset($arglist);
 437                 }
 438
 439                 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
 440                 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ise', '$this->_phrase_string(\'$1\')', $template);
 441
 442                 return $template;
 443         }
 444
 445         // ###################################################################
 446         /**
 447         * Turns a localized phrase tag into a function call
 448         *
 449         * @access       private
 450         *
 451         * @param        string  Phrase text
 452         *
 453         * @return       string  Function call for phrase text
 454         */
 455         function _phrase_string($text)
 456         {
 457                 return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), $text) . '\') . "';
 458         }
 459
 460         // ###################################################################
 461         /**
 462         * Parser for in-line template conditionals
 463         *
 464         * @access       private
 465         *
 466         * @param        string  Template data awaiting processing
 467         *
 468         * @return       string  Parsed template data
 469         */
 470         function _parse_conditionals($template)
 471         {
 472                 // tag data
 473                 $tag_start = '<if condition=\"';
 474                 $tag_start_end = '\">';
 475                 $tag_else = '<else />';
 476                 $tag_end = '</if>';
 477
 478                 // tag stack
 479                 $stack = array();
 480
 481                 // the information about the current active tag
 482                 $tag_full = array();
 483                 $parsed = array();
 484
 485                 // start at 0
 486                 $offset = 0;
 487
 488                 while (1)
 489                 {
 490                         if (strpos($template, $tag_start) === false)
 491                         {
 492                                 break;
 493                         }
 494
 495                         for ($i = $offset; $i < strlen($template); $i++)
 496                         {
 497                                 // we've found ourselves a conditional!
 498                                 if (substr($template, $i, strlen($tag_start)) == $tag_start)
 499                                 {
 500                                         // push the position into the tag stack
 501                                         if ($tag_full)
 502                                         {
 503                                                 array_push($stack, $i);
 504                                         }
 505                                         else
 506                                         {
 507                                                 $tag_full['posi'] = $i;
 508                                         }
 509                                 }
 510                                 // locate else tags
 511                                 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
 512                                 {
 513                                         if (sizeof($stack) == 0 AND !isset($tag_full['else']))
 514                                         {
 515                                                 $tag_full['else'] = $i;
 516                                         }
 517                                 }
 518                                 // do we have an end tag?
 519                                 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
 520                                 {
 521                                         if (sizeof($stack) != 0)
 522                                         {
 523                                                 array_pop($stack);
 524                                                 continue;
 525                                         }
 526
 527                                         // calculate the position of the end tag
 528                                         $tag_full['posf'] = $i + strlen($tag_end) - 1;
 529
 530                                         // extract the entire conditional from the template
 531                                         $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
 532
 533                                         // remove the beginning tag
 534                                         $conditional = substr($fullspread, strlen($tag_start));
 535
 536                                         // find the end of the expression
 537                                         $temp_end = strpos($conditional, $tag_start_end);
 538
 539                                         // save the expression
 540                                         $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
 541
 542                                         // remove the expression from the conditional
 543                                         $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
 544
 545                                         // remove the tailing end tag
 546                                         $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
 547
 548                                         // handle the else
 549                                         if (isset($tag_full['else']))
 550                                         {
 551                                                 // now relative to the start of the <if>
 552                                                 $relpos = $tag_full['else'] - $tag_full['posi'];
 553
 554                                                 // calculate the length of the expression and opening tag
 555                                                 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
 556
 557                                                 // relative to the start of iftrue
 558                                                 $elsepos = $relpos - $length;
 559
 560                                                 $parsed[1] = substr($conditional, 0, $elsepos);
 561                                                 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
 562                                         }
 563                                         // no else to handle
 564                                         else
 565                                         {
 566                                                 $parsed[1] = $conditional;
 567                                                 $parsed[2] = '';
 568                                         }
 569                                         #var_dump($parsed);
 570
 571                                         // final parsed output
 572                                         $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
 573
 574                                         // replace the conditional
 575                                         $template = str_replace($fullspread, $parsed, $template);
 576
 577                                         // reset the parser
 578                                         $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
 579                                         $tag_full = array();
 580                                         $stack = array();
 581                                         $parsed = array();
 582                                         unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
 583                                         break;
 584                                 }
 585                         }
 586                 }
 587
 588                 return $template;
 589         }
 590 }
 591
 592 // ###################################################################
 593 /**
 594 * Debugging function used to print characters in a string that are
 595 * around a certain position.
 596 *
 597 * @access       private
 598 *
 599 * @param        string  The haystack string
 600 * @param        integer Position to print around
 601 */
 602 function print_around($str, $pos)
 603 {
 604         echo '>>> PA >>>>>>>>[';
 605         echo htmlspecialchars($str[ $pos - 5 ]);
 606         echo htmlspecialchars($str[ $pos - 4 ]);
 607         echo htmlspecialchars($str[ $pos - 3 ]);
 608         echo htmlspecialchars($str[ $pos - 2 ]);
 609         echo htmlspecialchars($str[ $pos - 1 ]);
 610         echo '(c)';
 611         echo htmlspecialchars($str[ $pos + 0 ]);
 612         echo htmlspecialchars($str[ $pos + 1 ]);
 613         echo htmlspecialchars($str[ $pos + 2 ]);
 614         echo htmlspecialchars($str[ $pos + 3 ]);
 615         echo htmlspecialchars($str[ $pos + 4 ]);
 616         echo htmlspecialchars($str[ $pos + 5 ]);
 617         echo ']<<<<<<<< PA <<<';
 618 }
 619