]> src.bluestatic.org Git - isso.git/blob - Template.php
Updating makepo.sh.php to reflect the new way ScanDir() works
[isso.git] / 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 /**
29 * Database-Driven Template System
30 *
31 * This framework is a backend to the database template engine and
32 * contains all the parsing algorithms.
33 *
34 * @author Blue Static
35 * @copyright Copyright ©2002 - [#]year[#], Blue Static
36 * @version $Revision$
37 * @package ISSO
38 *
39 */
40 class BSTemplate
41 {
42 /**
43 * The database object to use
44 * @var object
45 */
46 private $db;
47
48 /**
49 * Name of the database table templates are in
50 * @var string
51 */
52 private $tableName = '';
53
54 /**
55 * Name of the table column template names are in
56 * @var string
57 */
58 private $nameColumn = '';
59
60 /**
61 * Name of the table column templates are in
62 * @var string
63 */
64 private $dataColumn = '';
65
66 /**
67 * Additional WHERE clauses for the template fetch SQL
68 * @var string
69 */
70 private $extraWhere = '';
71
72 /**
73 * The name of the function phrases are fetched with
74 * @var string
75 */
76 private $langcall = 'gettext';
77
78 /**
79 * The name of the function phrases are sprintf() parsed with
80 * @var string
81 */
82 private $langconst = 'sprintf';
83
84 /**
85 * Array of pre-compiled templates that are stored to decrease server load
86 * @var array
87 */
88 protected $cache = array();
89
90 /**
91 * A list of the number of times each template has been used
92 * @var array
93 */
94 protected $usage = array();
95
96 /**
97 * A list of templates that weren't cached, but are still used
98 * @var array
99 */
100 protected $uncached = array();
101
102 /**
103 * Whether or not the page has been flush()'d already
104 * @var bool
105 */
106 private $doneflush = false;
107
108 /**
109 * The name of a function that is called before template parsing of phrases and conditionals occurs
110 * @var string
111 */
112 private $preParseHook = ':undefined:';
113
114 // ###################################################################
115 /**
116 * Constructor: check required modules
117 */
118 public function __construct()
119 {
120 BSRegister::RequiredModules(array('Db'));
121 }
122
123 // ###################################################################
124 /**
125 * Sets the database object to use
126 *
127 * @param object Database object
128 */
129 public function setDatabase($db)
130 {
131 $this->db = $db;
132 }
133
134 // ###################################################################
135 /**
136 * Sets the table name and column information
137 *
138 * @param string The database table name
139 * @param string Name of the column that stores the name of the template
140 * @param string Name of the column that stores template data
141 */
142 public function setDatabaseTable($tableName, $nameColumn, $dataColumn)
143 {
144 $this->tableName = $tableName;
145 $this->nameColumn = $nameColumn;
146 $this->dataColumn = $dataColumn;
147 }
148
149 // ###################################################################
150 /**
151 * Sets the pre-parse hook method which is called before any other
152 * processing is done on the template.
153 *
154 * @param string Method name
155 */
156 public function setPreParseHook($hook)
157 {
158 $this->preParseHook = $hook;
159 }
160
161 // ###################################################################
162 /**
163 * Takes an array of template names, loads them, and then stores a
164 * parsed version for optimum speed.
165 *
166 * @param array List of template names to be cached
167 */
168 public function cache($namearray)
169 {
170 if (sizeof($this->cache) > 0)
171 {
172 trigger_error('You cannot cache templates more than once per initialization');
173 }
174 else
175 {
176 $templates = $this->db->query("SELECT * FROM " . $this->tableName . " WHERE " . $this->nameColumn . " IN ('" . implode("', '", $namearray) . "')" . ($this->extrawhere ? ' ' . $this->extrawhere : ''));
177 while ($template = $this->db->fetch_array($templates))
178 {
179 $this->cache[ $template[ $this->nameColumn ] ] = $this->_parse($template[ $this->dataColumn ]);
180 $this->usage[ $template[ $this->nameColumn ] ] = 0;
181 }
182 }
183 }
184
185 // ###################################################################
186 /**
187 * Loads a template from the cache or the _load function and stores the
188 * parsed version of it
189 *
190 * @param string The name of the template
191 *
192 * @return string A parsed and loaded template
193 */
194 public function fetch($name)
195 {
196 if (isset($this->cache["$name"]))
197 {
198 $template = $this->cache["$name"];
199 }
200 else
201 {
202 $this->uncached[] = $name;
203 BSRegister::Debug("Manually loading template '$name'");
204 $template = $this->_loadTemplate($name);
205 $template = $this->_parseTemplate($template);
206 }
207
208 if (!isset($this->usage["$name"]))
209 {
210 $this->usage["$name"] = 0;
211 }
212
213 $this->usage["$name"]++;
214
215 return $template;
216 }
217
218 // ###################################################################
219 /**
220 * Output a template fully compiled to the browser
221 *
222 * @param string Compiled and ready template
223 */
224 public function flush($template)
225 {
226 ob_start();
227
228 if (empty($template))
229 {
230 trigger_error('There was no output to print');
231 exit;
232 }
233
234 if ($this->doneflush)
235 {
236 trigger_error('A template has already been sent to the output buffer');
237 exit;
238 }
239
240 $debugBlock = '';
241 if (BSRegister::GetDebug())
242 {
243 if (defined('SVN') AND preg_match('#^\$Id:?#', constant('SVN')))
244 {
245 $debugBlock .= preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', "\n<br />\n" . '<div align="center"><strong>\1</strong> &mdash; r\2</div>', constant('SVN'));
246 }
247
248 if (defined('ISSO_MT_START'))
249 {
250 $debugBlock .= "\n<div align=\"center\">Executed in " . round(BSFunctions::FetchMicrotimeDiff(ISSO_MT_START), 10) . ' seconds</div>';
251 }
252
253 $debugBlock .= "\n<br /><div align=\"center\">" . BSRegister::GetDebugList() . "</div>";
254
255 $optlist = array();
256 $usage = array();
257 foreach ($this->usage AS $name => $count)
258 {
259 if (in_array($name, $this->uncached))
260 {
261 $optlist[] = $name . '[' . $count . ']';
262 }
263 $usage[] = $name . " ($count)";
264 }
265 $sizeof = sizeof($this->uncached);
266 if ($sizeof > 0)
267 {
268 $debugBlock .= "<br /><div style=\"color: red\" align=\"center\"><strong>Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</div>\n";
269 }
270
271 $debugBlock .= (sizeof($this->uncached) < 1 ? "<br />\n" : '') . "<div align=\"center\"><select><option>Template Usage (" . array_sum($this->usage) . ")</option>";
272 foreach ($usage AS $tpl)
273 {
274 $debugBlock .= "<option>--- $tpl</option>";
275 }
276 $debugBlock .= "</select></div>\n";
277
278 if (BSRegister::GetType('Db'))
279 {
280 $queries = BSRegister::GetType('Db')->getHistory();
281
282 $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>';
283
284 foreach ($queries AS $query)
285 {
286 $debugBlock .= "\n\t<tr style=\"background-color: rgb(230, 230, 230); color: black\">";
287 $debugBlock .= "\n\t\t<td>";
288 $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>";
289 }
290
291 $debugBlock .= "\n</table>\n\n\n";
292 }
293 }
294
295 $template = str_replace('</body>', $debugBlock . '</body>', $template);
296
297 print($template);
298 }
299
300 // ###################################################################
301 /**
302 * Loads an additional template from the database
303 *
304 * @param string The name of the template
305 *
306 * @return string Template data from the database
307 */
308 protected function _loadTemplate($name)
309 {
310 if ($template = $this->db->queryFirst("SELECT * FROM " . $this->tableName . " WHERE " . $this->nameColumn . " = '$name'" . ($this->extrawhere ? ' ' . $this->extrawhere : '')))
311 {
312 return $template[ $this->dataColumn ];
313 }
314 else
315 {
316 trigger_error("The template '$name' could not be loaded");
317 exit;
318 }
319 }
320
321 // ###################################################################
322 /**
323 * A wrapper for all the parsing functions and compiling functins
324 *
325 * @param string Unparsed template data
326 *
327 * @return string Parsed template data
328 */
329 protected function _parseTemplate($template)
330 {
331 $template = str_replace('"', '\"', $template);
332
333 if (function_exists($this->preParseHook))
334 {
335 $template = call_user_func($this->preParseHook, $template);
336 }
337
338 $template = $this->_parseBlocksAndTokens($template);
339 $template = $this->_parsePhrases($template);
340 $template = $this->_parseConditionals($template);
341 return $template;
342 }
343
344 // ###################################################################
345 /**
346 * Parses anything with curly braces {} (including phrases)
347 *
348 * @param string Template data
349 *
350 * @return string Parsed template data
351 */
352 private function _parseBlocksAndTokens($template)
353 {
354 $stack = array();
355 $tokens = array();
356
357 while (1)
358 {
359 for ($i = 0; $i < strlen($template); $i++)
360 {
361 // we've run through the template and there's nothing in the stack--done
362 if ($i == strlen($template) - 1 AND sizeof($stack) == 0)
363 {
364 return $template;
365 }
366
367 if ($template[$i] == '{')
368 {
369 // ignore escaped sequences
370 if ($template[$i - 1] != '\\')
371 {
372 array_push($stack, $i);
373 }
374 }
375 else if ($template[$i] == '}')
376 {
377 // there's no stack so it was probably escaped
378 if (sizeof($stack) == 0)
379 {
380 continue;
381 }
382 // we're good and nested
383 else if (sizeof($stack) == 1)
384 {
385 $open = array_pop($stack);
386 $token = substr($template, $open, $i - $open + 1);
387 $template = str_replace($token, $this->_parseToken($token), $template);
388 break;
389 }
390 // just pop it off
391 else
392 {
393 array_pop($stack);
394 }
395 }
396 }
397 }
398 }
399
400 // ###################################################################
401 /**
402 * Parses a curly brace token {}
403 *
404 * @param string Token
405 *
406 * @return string Parsed value
407 */
408 private function _parseToken($token)
409 {
410 // knock of the braces
411 $token = substr($token, 1, strlen($token) - 2);
412
413 // language token
414 if ($token[0] == '@' AND $token[1] == '\\' AND $token[2] == '"')
415 {
416 return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), substr($token, 3, strlen($token) - 5)) . '\')' . ' . "';
417 }
418 // normal PHP code
419 else
420 {
421 return '" . (' . $token . ') . "';
422 }
423 }
424
425 // ###################################################################
426 /**
427 * Prepares language and locale information inside templates
428 *
429 * @param string Template data to be processed
430 *
431 * @return string Language-ready template data
432 */
433 private function _parsePhrases($template)
434 {
435 $tag_start = '<lang ';
436 $tag_start_end = '\">';
437 $tag_end = '</lang>';
438
439 $location_start = -1;
440 $location_end = -1;
441
442 while (1)
443 {
444 // Find the start language object tag
445 $location_start = strpos($template, $tag_start, $location_end + 1);
446 if ($location_start === false)
447 {
448 break;
449 }
450
451 // Find the end tag
452 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
453 if ($location_end === false)
454 {
455 break;
456 }
457
458 // Extract the language object
459 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
460
461 // Find the close to the opening <lang>
462 $close_of_open = strpos($phrase_bunch, $tag_start_end);
463 if ($close_of_open === false)
464 {
465 break;
466 }
467
468 // Extract the opening tag so it can be parsed
469 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
470 $init_tag = str_replace($tag_start, '', $init_tag);
471 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
472
473 // Get the args out of the tag
474 $args = preg_split('#([0-9].*?)=#', $init_tag);
475 foreach ($args AS $arg)
476 {
477 if ($arg AND $arg != ' ')
478 {
479 $arg = trim($arg);
480 $arg = substr($arg, 2);
481 $arg = substr($arg, 0, strlen($arg) - 2);
482 $arglist[] = $arg;
483 }
484 }
485
486 // Just get the phrase name
487 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
488
489 // Wrap the parsed data into the build function
490 $function_wrap = '" . ' . $this->langconst . '("' . $phrase_name . '", "' . implode('", "', $arglist) . '") . "';
491
492 // Replace the fully-parsed string back into the template
493 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
494
495 unset($arglist);
496 }
497
498 return $template;
499 }
500
501 // ###################################################################
502 /**
503 * Parser for in-line template conditionals
504 *
505 * @param string Template data awaiting processing
506 *
507 * @return string Parsed template data
508 */
509 private function _parseConditionals($template)
510 {
511 // tag data
512 $tag_start = '<if condition=\"';
513 $tag_start_end = '\">';
514 $tag_else = '<else />';
515 $tag_end = '</if>';
516
517 // tag stack
518 $stack = array();
519
520 // the information about the current active tag
521 $tag_full = array();
522 $parsed = array();
523
524 // start at 0
525 $offset = 0;
526
527 while (1)
528 {
529 if (strpos($template, $tag_start) === false)
530 {
531 break;
532 }
533
534 for ($i = $offset; $i < strlen($template); $i++)
535 {
536 // we've found ourselves a conditional!
537 if (substr($template, $i, strlen($tag_start)) == $tag_start)
538 {
539 // push the position into the tag stack
540 if ($tag_full)
541 {
542 array_push($stack, $i);
543 }
544 else
545 {
546 $tag_full['posi'] = $i;
547 }
548 }
549 // locate else tags
550 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
551 {
552 if (sizeof($stack) == 0 AND !isset($tag_full['else']))
553 {
554 $tag_full['else'] = $i;
555 }
556 }
557 // do we have an end tag?
558 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
559 {
560 if (sizeof($stack) != 0)
561 {
562 array_pop($stack);
563 continue;
564 }
565
566 // calculate the position of the end tag
567 $tag_full['posf'] = $i + strlen($tag_end) - 1;
568
569 // extract the entire conditional from the template
570 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
571
572 // remove the beginning tag
573 $conditional = substr($fullspread, strlen($tag_start));
574
575 // find the end of the expression
576 $temp_end = strpos($conditional, $tag_start_end);
577
578 // save the expression
579 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
580
581 // remove the expression from the conditional
582 $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
583
584 // remove the tailing end tag
585 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
586
587 // handle the else
588 if (isset($tag_full['else']))
589 {
590 // now relative to the start of the <if>
591 $relpos = $tag_full['else'] - $tag_full['posi'];
592
593 // calculate the length of the expression and opening tag
594 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
595
596 // relative to the start of iftrue
597 $elsepos = $relpos - $length;
598
599 $parsed[1] = substr($conditional, 0, $elsepos);
600 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
601 }
602 // no else to handle
603 else
604 {
605 $parsed[1] = $conditional;
606 $parsed[2] = '';
607 }
608
609 // final parsed output
610 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
611
612 // replace the conditional
613 $template = str_replace($fullspread, $parsed, $template);
614
615 // reset the parser
616 $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
617 $tag_full = array();
618 $stack = array();
619 $parsed = array();
620 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
621 break;
622 }
623 }
624 }
625
626 return $template;
627 }
628 }
629
630 // ###################################################################
631 /**
632 * Debugging function used to print characters in a string that are
633 * around a certain position.
634 *
635 * @access private
636 *
637 * @param string The haystack string
638 * @param integer Position to print around
639 */
640 function print_around($str, $pos)
641 {
642 echo '>>> PA >>>>>>>>[';
643 echo htmlspecialchars($str[ $pos - 5 ]);
644 echo htmlspecialchars($str[ $pos - 4 ]);
645 echo htmlspecialchars($str[ $pos - 3 ]);
646 echo htmlspecialchars($str[ $pos - 2 ]);
647 echo htmlspecialchars($str[ $pos - 1 ]);
648 echo '©';
649 echo htmlspecialchars($str[ $pos + 0 ]);
650 echo htmlspecialchars($str[ $pos + 1 ]);
651 echo htmlspecialchars($str[ $pos + 2 ]);
652 echo htmlspecialchars($str[ $pos + 3 ]);
653 echo htmlspecialchars($str[ $pos + 4 ]);
654 echo htmlspecialchars($str[ $pos + 5 ]);
655 echo ']<<<<<<<< PA <<<';
656 }
657
658 /*=====================================================================*\
659 || ###################################################################
660 || # $HeadURL$
661 || # $Id$
662 || ###################################################################
663 \*=====================================================================*/
664 ?>