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