Template.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright ©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 (template.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 require_once('ISSO/Functions.php');
  29
  30 /**
  31 * File-Based Template System
  32 *
  33 * This framework merely replaces the template loading functions with
  34 * file-system based ones. It has an optional caching system in which
  35 * template data will remain stored in the database as long as the filesystem
  36 * file is modified. To do this, pass a table name to setDatabaseCache() and make sure
  37 * there's a DB module that has access to a table with this schema:
  38 *
  39 * CREATE TABLE template (filename VARCHAR (250) NOT NULL, template TEXT NOT NULL, timestamp INT NOT NULL);
  40 *
  41 * @author               Blue Static
  42 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  43 * @version              $Revision$
  44 * @package              ISSO
  45 *
  46 */
  47 class BSTemplate
  48 {
  49         /**
  50         * The path, from the path of the application, where templates are stored
  51         * @var  string
  52         */
  53         private $templateDir = '';
  54
  55         /**
  56         * The extension all the template files have
  57         * @var  string
  58         */
  59         private $extension = 'tpl';
  60
  61         /**
  62         * The database table name for the template cache
  63         * @var string
  64         */
  65         private $dbCacheTable = null;
  66
  67         /**
  68         * The name of the function phrases are fetched with
  69         * @var  string
  70         */
  71         private $langcall = 'gettext';
  72
  73         /**
  74         * The name of the function phrases are sprintf() parsed with
  75         * @var  string
  76         */
  77         private $langconst = 'sprintf';
  78
  79         /**
  80         * Array of pre-compiled templates that are stored to decrease server load
  81         * @var  array
  82         */
  83         protected $cache = array();
  84
  85         /**
  86         * A list of the number of times each template has been used
  87         * @var  array
  88         */
  89         protected $usage = array();
  90
  91         /**
  92         * A list of templates that weren't cached, but are still used
  93         * @var  array
  94         */
  95         protected $uncached = array();
  96
  97         /**
  98         * Whether or not the page has been flush()'d already
  99         * @var  bool
 100         */
 101         private $doneflush = false;
 102
 103         /**
 104         * The name of a function that is called before template parsing of phrases and conditionals occurs
 105         * @var  string
 106         */
 107         private $preParseHook = ':undefined:';
 108
 109         // ###################################################################
 110         /**
 111         * Sets the template directory name
 112         *
 113         * @param        string  Template directory name
 114         */
 115         public function setTemplateDirectory($dir)
 116         {
 117                 $this->templateDir = BSFunctions::FetchSourcePath($dir);
 118         }
 119
 120         // ###################################################################
 121         /**
 122         * Sets the file extension for the templates
 123         *
 124         * @param        string  File extension
 125         */
 126         public function setExtension($ext)
 127         {
 128                 $this->extension = $ext;
 129         }
 130
 131         // ###################################################################
 132         /**
 133         * Sets the name of the table to access for the datbase cache
 134         *
 135         * @param        string  DB table name
 136         */
 137         public function setDatabaseCache($table)
 138         {
 139                 $this->dbCacheTable = $table;
 140         }
 141
 142         // ###################################################################
 143         /**
 144         * Sets the pre-parse hook method which is called before any other
 145         * processing is done on the template.
 146         *
 147         * @param        string  Method name
 148         */
 149         public function setPreParseHook($hook)
 150         {
 151                 $this->preParseHook = $hook;
 152         }
 153
 154         // ###################################################################
 155         /**
 156         * Takes an array of template names, loads them, and then stores a
 157         * parsed version for optimum speed.
 158         *
 159         * @param        array   List of template names to be cached
 160         */
 161         public function cache($namearray)
 162         {
 163                 if (sizeof($this->cache) > 0)
 164                 {
 165                         throw new Exception('You cannot cache templates more than once per initialization');
 166                 }
 167                 else
 168                 {
 169                         $dbCache = array();
 170                         if ($this->dbCacheTable)
 171                         {
 172                                 $db =& BSApp::GetType('Db');
 173                                 $cache = $db->query("SELECT * FROM {$this->dbCacheTable} WHERE filename IN ('" . implode("', '", $namearray) . "')");
 174                                 while ($tpl = $db->fetchArray($cache))
 175                                 {
 176                                         $time = filemtime($this->templateDir . $tpl['filename'] . '.' . $this->extension);
 177                                         $template = $tpl['template'];
 178                                         if ($time > $tpl['timestamp'])
 179                                         {
 180                                                 $template = $this->_parseTemplate($this->_loadTemplate($tpl['filename']));
 181                                                 $db->query("UPDATE {$this->dbCacheTable} SET template = '" . $db->escapeString($template) . "', timestamp = " . TIMENOW . " WHERE filename = '" . $tpl['filename'] . "'");
 182                                                 $tpl['template'] = $template;
 183                                         }
 184                                         $dbCache["$tpl[filename]"] = $template;
 185                                 }
 186                         }
 187                         foreach ($namearray AS $name)
 188                         {
 189                                 if ($this->dbCacheTable)
 190                                 {
 191                                         if (isset($dbCache["$name"]))
 192                                         {
 193                                                 $template = $dbCache["$name"];
 194                                         }
 195                                         else
 196                                         {
 197                                                 $template = $this->_parseTemplate($this->_loadTemplate($name));
 198                                                 $db->query("INSERT INTO {$this->dbCacheTable} (filename, template, timestamp) VALUES ('$name', '" . $db->escapeString($template) . "', " . TIMENOW . ")");
 199                                         }
 200                                 }
 201                                 else
 202                                 {
 203                                         $template = $this->_parseTemplate($this->_loadTemplate($name));
 204                                 }
 205
 206                                 $this->cache["$name"] = $template;
 207                                 $this->usage["$name"] = 0;
 208                         }
 209                 }
 210         }
 211
 212         // ###################################################################
 213         /**
 214         * Loads a template from the cache or the _load function and stores the
 215         * parsed version of it
 216         *
 217         * @param        string  The name of the template
 218         *
 219         * @return       string  A parsed and loaded template
 220         */
 221         public function fetch($name)
 222         {
 223                 if (isset($this->cache["$name"]))
 224                 {
 225                         $template = $this->cache["$name"];
 226                 }
 227                 else
 228                 {
 229                         $this->uncached[] = $name;
 230                         BSApp::Debug("Manually loading template '$name'");
 231                         $template = $this->_loadTemplate($name);
 232                         $template = $this->_parseTemplate($template);
 233                 }
 234
 235                 if (!isset($this->usage["$name"]))
 236                 {
 237                         $this->usage["$name"] = 0;
 238                 }
 239
 240                 $this->usage["$name"]++;
 241
 242                 return $template;
 243         }
 244
 245         // ###################################################################
 246         /**
 247         * Output a template fully compiled to the browser
 248         *
 249         * @param        string  Compiled and ready template
 250         */
 251         public function flush($template)
 252         {
 253                 ob_start();
 254
 255                 if (empty($template))
 256                 {
 257                         throw new Exception('There was no output to print');
 258                 }
 259
 260                 if ($this->doneflush)
 261                 {
 262                         throw new Exception('A template has already been sent to the output buffer');
 263                 }
 264
 265                 $debugBlock = '';
 266                 if (BSApp::GetDebug())
 267                 {
 268                         $debugBlock .= "\n<div align=\"center\">Executed in " . round(BSFunctions::FetchMicrotimeDiff($_SERVER['REQUEST_TIME']), 10) . ' seconds</div>';
 269                         $debugBlock .= "\n<br /><div align=\"center\">" . BSApp::GetDebugList() . "</div>";
 270
 271                         $optlist = array();
 272                         $usage = array();
 273                         foreach ($this->usage AS $name => $count)
 274                         {
 275                                 if (in_array($name, $this->uncached))
 276                                 {
 277                                         $optlist[] = $name . '[' . $count . ']';
 278                                 }
 279                                 $usage[] = $name . " ($count)";
 280                         }
 281                         $sizeof = sizeof($this->uncached);
 282                         if ($sizeof > 0)
 283                         {
 284                                 $debugBlock .= "<br /><div style=\"color: red\" align=\"center\"><strong>Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</div>\n";
 285                         }
 286
 287                         $debugBlock .= (sizeof($this->uncached) < 1 ? "<br />\n" : '') . "<div align=\"center\"><select><option>Template Usage (" . array_sum($this->usage) . ")</option>";
 288                         foreach ($usage AS $tpl)
 289                         {
 290                                 $debugBlock .= "<option>--- $tpl</option>";
 291                         }
 292                         $debugBlock .= "</select></div>\n";
 293
 294                         if (BSApp::GetType('Db'))
 295                         {
 296                                 $queries = BSApp::GetType('Db')->getHistory();
 297
 298                                 $debugBlock .= "<br />\n" . '<table cellpadding="4" cellspacing="1" border="0" align="center" width="30%" style="background-color: rgb(60, 60, 60); color: white">' . "\n\t" . '<tr><td><strong>Query Debug</strong></td></tr>';
 299
 300                                 foreach ($queries AS $query)
 301                                 {
 302                                         $debugBlock .= "\n\t<tr style=\"background-color: rgb(230, 230, 230); color: black\">";
 303                                         $debugBlock .= "\n\t\t<td>";
 304                                         $debugBlock .= "\n\t\t\t$query[query]\n\n\t\t\t<div style=\"font-size: 9px;\">($query[time])</div>\n<!--\n$query[trace]\n-->\n\t\t</td>\n\t</tr>";
 305                                 }
 306
 307                                 $debugBlock .= "\n</table>\n\n\n";
 308                         }
 309                 }
 310
 311                 $template = str_replace('</body>', $debugBlock . '</body>', $template);
 312
 313                 print($template);
 314         }
 315
 316         // ###################################################################
 317         /**
 318         * Loads an additional template from the database
 319         *
 320         * @param        string  The name of the template
 321         *
 322         * @return       string  Template data from the database
 323         */
 324         protected function _loadTemplate($name)
 325         {
 326                 $path = $this->templateDir . $name . '.' . $this->extension;
 327                 if (is_file($path) AND is_readable($path))
 328                 {
 329                         return @file_get_contents($path);
 330                 }
 331                 else
 332                 {
 333                         throw new Exception("Could not load the template '$path'");
 334                 }
 335         }
 336
 337         // ###################################################################
 338         /**
 339         * A wrapper for all the parsing functions and compiling functins
 340         *
 341         * @param        string  Unparsed template data
 342         *
 343         * @return       string  Parsed template data
 344         */
 345         protected function _parseTemplate($template)
 346         {
 347                 $template = str_replace('"', '\"', $template);
 348
 349                 if (function_exists($this->preParseHook))
 350                 {
 351                         $template = call_user_func($this->preParseHook, $template);
 352                 }
 353
 354                 $template = $this->_parseBlocksAndTokens($template);
 355                 $template = $this->_parsePhrases($template);
 356                 $template = $this->_parseConditionals($template);
 357                 return $template;
 358         }
 359
 360         // ###################################################################
 361         /**
 362         * Parses anything with curly braces {} (including phrases)
 363         *
 364         * @param        string  Template data
 365         *
 366         * @return       string  Parsed template data
 367         */
 368         private function _parseBlocksAndTokens($template)
 369         {
 370                 $stack = array();
 371                 $tokens = array();
 372
 373                 while (1)
 374                 {
 375                         for ($i = 0; $i < strlen($template); $i++)
 376                         {
 377                                 // we've run through the template and there's nothing in the stack--done
 378                                 if ($i == strlen($template) - 1 AND sizeof($stack) == 0)
 379                                 {
 380                                         return $template;
 381                                 }
 382
 383                                 if ($template[$i] == '{')
 384                                 {
 385                                         // ignore escaped sequences
 386                                         if ($template[$i - 1] != '\\')
 387                                         {
 388                                                 array_push($stack, $i);
 389                                         }
 390                                 }
 391                                 else if ($template[$i] == '}')
 392                                 {
 393                                         // there's no stack so it was probably escaped
 394                                         if (sizeof($stack) == 0)
 395                                         {
 396                                                 continue;
 397                                         }
 398                                         // we're good and nested
 399                                         else if (sizeof($stack) == 1)
 400                                         {
 401                                                 $open = array_pop($stack);
 402                                                 $token = substr($template, $open, $i - $open + 1);
 403                                                 $template = str_replace($token, $this->_parseToken($token), $template);
 404                                                 break;
 405                                         }
 406                                         // just pop it off
 407                                         else
 408                                         {
 409                                                 array_pop($stack);
 410                                         }
 411                                 }
 412                         }
 413                 }
 414         }
 415
 416         // ###################################################################
 417         /**
 418         * Parses a curly brace token {}
 419         *
 420         * @param        string  Token
 421         *
 422         * @return       string  Parsed value
 423         */
 424         private function _parseToken($token)
 425         {
 426                 // knock of the braces
 427                 $token = substr($token, 1, strlen($token) - 2);
 428
 429                 // language token
 430                 if ($token[0] == '@' AND $token[1] == '\\' AND $token[2] == '"')
 431                 {
 432                         return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), substr($token, 3, strlen($token) - 5)) . '\')' . ' . "';
 433                 }
 434                 // normal PHP code
 435                 else
 436                 {
 437                         return '" . (' . $token . ') . "';
 438                 }
 439         }
 440
 441         // ###################################################################
 442         /**
 443         * Prepares language and locale information inside templates
 444         *
 445         * @param        string  Template data to be processed
 446         *
 447         * @return       string  Language-ready template data
 448         */
 449         private function _parsePhrases($template)
 450         {
 451                 $tagStart = '<lang ';
 452                 $tagEnd = '</lang>';
 453
 454                 $start = -1; // start of open tag
 455                 $end = -1; // start of the close tag
 456                 $varEnd = -1; // end of the open tag
 457
 458                 while ($start <= strlen($template))
 459                 {
 460                         // reset
 461                         $varMap = array(); // storage for all the substitution indices
 462
 463                         // Find the start language object tag
 464                         $start = strpos($template, $tagStart, $end + 1);
 465                         if ($start === false)
 466                         {
 467                                 break;
 468                         }
 469
 470                         // look ahead to parse out all the variables
 471                         $i = $start + strlen($tagStart); // current position
 472                         $capture = ''; // current capture
 473                         $capturePos = $i; // the place to start capturing
 474                         $varNum = -1; // variable placeholder index
 475                         while ($i < strlen($template))
 476                         {
 477                                 if ($template[$i] == '=')
 478                                 {
 479                                         // backtrack to find the previous variable substitution
 480                                         $backPos = $i;
 481                                         while ($backPos >= $start)
 482                                         {
 483                                                 if ($template[$backPos] == '"')
 484                                                 {
 485                                                         // startPosition + length(startTag) + length(=\")
 486                                                         $varMap[intval($varNum)] = BSFunctions::Substring($template, $capturePos + 3, $backPos - 1);
 487                                                         // remove our old substitution from the capture
 488                                                         $capture = BSFunctions::Substring($template, $backPos + 1, $i);
 489                                                         break;
 490                                                 }
 491                                                 $backPos--;
 492                                         }
 493
 494                                         // do we have a valid index?
 495                                         if (intval($capture) > 0)
 496                                         {
 497                                                 // set aside the index and restart capturing
 498                                                 $varNum = $capture;
 499                                                 $capture = '';
 500                                                 $capturePos = $i;
 501                                         }
 502                                         else
 503                                         {
 504                                                 throw new Exception('Invalid language variable index "' . $capture . '"');
 505                                         }
 506                                 }
 507                                 else if ($template[$i] == '>' AND $template[$i - 1] == '"')
 508                                 {
 509                                         // the final variable substitution
 510                                         $varMap[intval($varNum)] = BSFunctions::Substring($template, $capturePos + 3, $i - 2);
 511                                         $varEnds = $i;
 512                                         break;
 513                                 }
 514
 515                                 $capture .= $template[$i];
 516                                 $i++;
 517                         }
 518
 519                         // locate the end tag
 520                         $end = strpos($template, $tagEnd, $i);
 521                         if ($end === false)
 522                         {
 523                                 break;
 524                         }
 525
 526                         // this is the string that gets variable replacement
 527                         $str = BSFunctions::Substring($template, $varEnds + 1, $end);
 528
 529                         // create the complete varmap
 530
 531                         for ($i = max(array_keys($varMap)); $i > 0; $i--)
 532                         {
 533                                 if (!isset($varMap[$i]))
 534                                 {
 535                                         $varMap[$i] = '<strong>[MISSING SUBSTITUTION INDEX: ' . $i . ']</strong>';
 536                                 }
 537                         }
 538
 539                         // put all the keys in corresponding argument order
 540                         ksort($varMap);
 541
 542                         // FINALLY, construct the call to sprintf()
 543                         $template = substr_replace($template, '" . ' . $this->langconst . '(\'' . $str . '\', "' . implode('", "', $varMap) . '") . "', $start, ($end + strlen($tagEnd)) - $start);
 544                 }
 545
 546                 return $template;
 547         }
 548
 549         // ###################################################################
 550         /**
 551         * Parser for in-line template conditionals
 552         *
 553         * @param        string  Template data awaiting processing
 554         *
 555         * @return       string  Parsed template data
 556         */
 557         private function _parseConditionals($template)
 558         {
 559                 // tag data
 560                 $tag_start = '<if condition=\"';
 561                 $tag_start_end = '\">';
 562                 $tag_else = '<else />';
 563                 $tag_end = '</if>';
 564
 565                 // tag stack
 566                 $stack = array();
 567
 568                 // the information about the current active tag
 569                 $tag_full = array();
 570                 $parsed = array();
 571
 572                 // start at 0
 573                 $offset = 0;
 574
 575                 while (1)
 576                 {
 577                         if (strpos($template, $tag_start) === false)
 578                         {
 579                                 break;
 580                         }
 581
 582                         for ($i = $offset; $i < strlen($template); $i++)
 583                         {
 584                                 // we've found ourselves a conditional!
 585                                 if (substr($template, $i, strlen($tag_start)) == $tag_start)
 586                                 {
 587                                         // push the position into the tag stack
 588                                         if ($tag_full)
 589                                         {
 590                                                 array_push($stack, $i);
 591                                         }
 592                                         else
 593                                         {
 594                                                 $tag_full['posi'] = $i;
 595                                         }
 596                                 }
 597                                 // locate else tags
 598                                 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
 599                                 {
 600                                         if (sizeof($stack) == 0 AND !isset($tag_full['else']))
 601                                         {
 602                                                 $tag_full['else'] = $i;
 603                                         }
 604                                 }
 605                                 // do we have an end tag?
 606                                 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
 607                                 {
 608                                         if (sizeof($stack) != 0)
 609                                         {
 610                                                 array_pop($stack);
 611                                                 continue;
 612                                         }
 613
 614                                         // calculate the position of the end tag
 615                                         $tag_full['posf'] = $i + strlen($tag_end) - 1;
 616
 617                                         // extract the entire conditional from the template
 618                                         $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
 619
 620                                         // remove the beginning tag
 621                                         $conditional = substr($fullspread, strlen($tag_start));
 622
 623                                         // find the end of the expression
 624                                         $temp_end = strpos($conditional, $tag_start_end);
 625
 626                                         // save the expression
 627                                         $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
 628
 629                                         // remove the expression from the conditional
 630                                         $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
 631
 632                                         // remove the tailing end tag
 633                                         $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
 634
 635                                         // handle the else
 636                                         if (isset($tag_full['else']))
 637                                         {
 638                                                 // now relative to the start of the <if>
 639                                                 $relpos = $tag_full['else'] - $tag_full['posi'];
 640
 641                                                 // calculate the length of the expression and opening tag
 642                                                 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
 643
 644                                                 // relative to the start of iftrue
 645                                                 $elsepos = $relpos - $length;
 646
 647                                                 $parsed[1] = substr($conditional, 0, $elsepos);
 648                                                 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
 649                                         }
 650                                         // no else to handle
 651                                         else
 652                                         {
 653                                                 $parsed[1] = $conditional;
 654                                                 $parsed[2] = '';
 655                                         }
 656
 657                                         // final parsed output
 658                                         $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
 659
 660                                         // replace the conditional
 661                                         $template = str_replace($fullspread, $parsed, $template);
 662
 663                                         // reset the parser
 664                                         $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
 665                                         $tag_full = array();
 666                                         $stack = array();
 667                                         $parsed = array();
 668                                         unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
 669                                         break;
 670                                 }
 671                         }
 672                 }
 673
 674                 return $template;
 675         }
 676 }
 677
 678 // ###################################################################
 679 /**
 680 * Debugging function used to print characters in a string that are
 681 * around a certain position.
 682 *
 683 * @access       private
 684 *
 685 * @param        string  The haystack string
 686 * @param        integer Position to print around
 687 */
 688 function print_around($str, $pos)
 689 {
 690         echo '>>> PA >>>>>>>>[';
 691         echo htmlspecialchars($str[ $pos - 5 ]);
 692         echo htmlspecialchars($str[ $pos - 4 ]);
 693         echo htmlspecialchars($str[ $pos - 3 ]);
 694         echo htmlspecialchars($str[ $pos - 2 ]);
 695         echo htmlspecialchars($str[ $pos - 1 ]);
 696         echo '©';
 697         echo htmlspecialchars($str[ $pos + 0 ]);
 698         echo htmlspecialchars($str[ $pos + 1 ]);
 699         echo htmlspecialchars($str[ $pos + 2 ]);
 700         echo htmlspecialchars($str[ $pos + 3 ]);
 701         echo htmlspecialchars($str[ $pos + 4 ]);
 702         echo htmlspecialchars($str[ $pos + 5 ]);
 703         echo ']<<<<<<<< PA <<<';
 704 }
 705
 706 /*=====================================================================*\
 707 || ###################################################################
 708 || # $HeadURL$
 709 || # $Id$
 710 || ###################################################################
 711 \*=====================================================================*/
 712 ?>