https://src.bluestatic.org / isso.git / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Adding do_get() to the kernel and get() to all the modules that have set().
[isso.git] / template.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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 Iris Studios, Inc.
40 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
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 = '$GLOBALS[\'isso:null-framework\']->modules[\'localize\']->string';
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 * Fields array that is used in this module
133 * @var array
134 * @access private
135 */
136 var $fields = array(
137 'tablename' => array(REQ_YES, null, false),
138 'namecolumn' => array(REQ_YES, null, false),
139 'datacolumn' => array(REQ_YES, null, false),
140 'extrawhere' => array(REQ_NO, null, false),
141 'langcall' => array(REQ_YES, null, true),
142 'langconst' => array(REQ_YES, null, true),
143 'pre_parse_hook' => array(REQ_NO, null, false)
144 );
145
146 // ###################################################################
147 /**
148 * Constructor
149 */
150 function __construct(&$registry)
151 {
152 $this->registry =& $registry;
153 }
154
155 // ###################################################################
156 /**
157 * (PHP 4) Constructor
158 */
159 function Template(&$registry)
160 {
161 $this->__construct($registry);
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 echo '<pre>';
277 foreach ($this->registry->modules[ISSO_DB_LAYER]->history AS $query)
278 {
279 echo $query . "\n\n<hr />\n\n";
280 }
281 echo '</pre>';
282 }
283 exit;
284 }
285
286 if ($this->doneflush)
287 {
288 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR);
289 exit;
290 }
291
292 $template = str_replace('</body>', $this->registry->construct_debug_block(true) . '</body>', $template);
293
294 print($template);
295 }
296
297 // ###################################################################
298 /**
299 * Loads an additional template from the database
300 *
301 * @access private
302 *
303 * @param string The name of the template
304 *
305 * @return string Template data from the database
306 */
307 function _load($name)
308 {
309 if ($template = $this->registry->modules[ISSO_DB_LAYER]->query("SELECT * FROM " . $this->tablename . " WHERE " . $this->namecolumn . " = '$name'" . ($this->extrawhere ? $this->extrawhere : '')))
310 {
311 return $template[ $this->datacolumn ];
312 }
313 else
314 {
315 trigger_error("The template '$name' could not be loaded", E_USER_ERROR);
316 exit;
317 }
318 }
319
320 // ###################################################################
321 /**
322 * A wrapper for all the parsing functions and compiling functins
323 *
324 * @access protected
325 *
326 * @param string Unparsed template data
327 *
328 * @return string Parsed template data
329 */
330 function _parse($template)
331 {
332 $this->registry->check_isso_fields(get_class($this));
333
334 $template = str_replace('"', '\"', $template);
335
336 if (function_exists($this->pre_parse_hook))
337 {
338 $this->registry->debug("running pre-parse hook: {$this->pre_parse_hook}");
339 $template = call_user_func($this->pre_parse_hook, $template);
340 }
341
342 $template = $this->_parse_phrases($template);
343 $template = $this->_parse_conditionals($template);
344 return $template;
345 }
346
347 // ###################################################################
348 /**
349 * Prepares language and locale information inside templates
350 *
351 * @access private
352 *
353 * @param string Template data to be processed
354 *
355 * @return string Language-ready template data
356 */
357 function _parse_phrases($template)
358 {
359 $tag_start = '<lang ';
360 $tag_start_end = '\">';
361 $tag_end = '</lang>';
362
363 $location_start = -1;
364 $location_end = -1;
365
366 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
367 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ie', '$this->_phrase_string(\'$1\')', $template);
368
369 while (1)
370 {
371 // Find the start language object tag
372 $location_start = strpos($template, $tag_start, $location_end + 1);
373 if ($location_start === false)
374 {
375 break;
376 }
377
378 // Find the end tag
379 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
380 if ($location_end === false)
381 {
382 break;
383 }
384
385 // Extract the language object
386 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
387
388 // Find the close to the opening <lang>
389 $close_of_open = strpos($phrase_bunch, $tag_start_end);
390 if ($close_of_open === false)
391 {
392 break;
393 }
394
395 // Extract the opening tag so it can be parsed
396 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
397 $init_tag = str_replace($tag_start, '', $init_tag);
398 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
399
400 // Get the args out of the tag
401 $args = preg_split('#([0-9].*?)=#', $init_tag);
402 foreach ($args AS $arg)
403 {
404 if ($arg AND $arg != ' ')
405 {
406 $arg = trim($arg);
407 $arg = substr($arg, 2);
408 $arg = substr($arg, 0, strlen($arg) - 2);
409 $arglist[] = $arg;
410 }
411 }
412
413 // Just get the phrase name
414 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
415
416 // Wrap the parsed data into the build function
417 $function_wrap = '" . ' . $this->langconst . '("' . /*str_replace(array('\"', "'"), array('"', "\'"),*/ $phrase_name/*)*/ . '", "' . implode('", "', $arglist) . '") . "';
418
419 // Replace the fully-parsed string back into the template
420 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
421
422 unset($arglist);
423 }
424
425 return $template;
426 }
427
428 // ###################################################################
429 /**
430 * Turns a localized phrase tag into a function call
431 *
432 * @access private
433 *
434 * @param string Phrase text
435 *
436 * @return string Function call for phrase text
437 */
438 function _phrase_string($text)
439 {
440 return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), $text) . '\') . "';
441 }
442
443 // ###################################################################
444 /**
445 * Parser for in-line template conditionals
446 *
447 * @access private
448 *
449 * @param string Template data awaiting processing
450 *
451 * @return string Parsed template data
452 */
453 function _parse_conditionals($template)
454 {
455 // tag data
456 $tag_start = '<if condition=\"';
457 $tag_start_end = '\">';
458 $tag_else = '<else />';
459 $tag_end = '</if>';
460
461 // tag stack
462 $stack = array();
463
464 // the information about the current active tag
465 $tag_full = array();
466 $parsed = array();
467
468 // start at 0
469 $offset = 0;
470
471 while (1)
472 {
473 if (strpos($template, $tag_start) === false)
474 {
475 break;
476 }
477
478 for ($i = $offset; $i < strlen($template); $i++)
479 {
480 // we've found ourselves a conditional!
481 if (substr($template, $i, strlen($tag_start)) == $tag_start)
482 {
483 // push the position into the tag stack
484 if ($tag_full)
485 {
486 array_push($stack, $i);
487 }
488 else
489 {
490 $tag_full['posi'] = $i;
491 }
492 }
493 // locate else tags
494 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
495 {
496 if (count($stack) == 0 AND !isset($tag_full['else']))
497 {
498 $tag_full['else'] = $i;
499 }
500 }
501 // do we have an end tag?
502 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
503 {
504 if (count($stack) != 0)
505 {
506 array_pop($stack);
507 continue;
508 }
509
510 // calculate the position of the end tag
511 $tag_full['posf'] = $i + strlen($tag_end) - 1;
512
513 // extract the entire conditional from the template
514 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
515
516 // remove the beginning tag
517 $conditional = substr($fullspread, strlen($tag_start));
518
519 // find the end of the expression
520 $temp_end = strpos($conditional, $tag_start_end);
521
522 // save the expression
523 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
524
525 // remove the expression from the conditional
526 $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
527
528 // remove the tailing end tag
529 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
530
531 // handle the else
532 if (isset($tag_full['else']))
533 {
534 // now relative to the start of the <if>
535 $relpos = $tag_full['else'] - $tag_full['posi'];
536
537 // calculate the length of the expression and opening tag
538 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
539
540 // relative to the start of iftrue
541 $elsepos = $relpos - $length;
542
543 $parsed[1] = substr($conditional, 0, $elsepos);
544 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
545 }
546 // no else to handle
547 else
548 {
549 $parsed[1] = $conditional;
550 $parsed[2] = '';
551 }
552 #var_dump($parsed);
553
554 // final parsed output
555 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
556
557 // replace the conditional
558 $template = str_replace($fullspread, $parsed, $template);
559
560 // reset the parser
561 $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
562 $tag_full = array();
563 $stack = array();
564 $parsed = array();
565 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
566 break;
567 }
568 }
569 }
570
571 return $template;
572 }
573 }
574
575 // ###################################################################
576 /**
577 * Debugging function used to print characters in a string that are
578 * around a certain position.
579 *
580 * @access private
581 *
582 * @param string The haystack string
583 * @param integer Position to print around
584 */
585 function print_around($str, $pos)
586 {
587 echo '>>> PA >>>>>>>>[';
588 echo htmlspecialchars($str[ $pos - 5 ]);
589 echo htmlspecialchars($str[ $pos - 4 ]);
590 echo htmlspecialchars($str[ $pos - 3 ]);
591 echo htmlspecialchars($str[ $pos - 2 ]);
592 echo htmlspecialchars($str[ $pos - 1 ]);
593 echo '©';
594 echo htmlspecialchars($str[ $pos + 0 ]);
595 echo htmlspecialchars($str[ $pos + 1 ]);
596 echo htmlspecialchars($str[ $pos + 2 ]);
597 echo htmlspecialchars($str[ $pos + 3 ]);
598 echo htmlspecialchars($str[ $pos + 4 ]);
599 echo htmlspecialchars($str[ $pos + 5 ]);
600 echo ']<<<<<<<< PA <<<';
601 }
602
603 /*=====================================================================*\
604 || ###################################################################
605 || # $HeadURL$
606 || # $Id$
607 || ###################################################################
608 \*=====================================================================*/
609 ?>
The PHP framework used in Blue Static's web applications that provides common functionality through shared classes.