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