2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
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.
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
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 \*=====================================================================*/
23 * Database-Driven Template System
30 * Database-Driven Template System
32 * This framework is a backend to the database template engine and
33 * contains all the parsing algorithms.
36 * $this->pre_parse_hook - Name of the function to execute on
37 * a template before the parsing occurs
40 * @copyright Copyright ©2002 - [#]year[#], Blue Static
48 * Framework registry object
51 private $registry = null;
54 * Name of the database table templates are in
57 private $tablename = '';
60 * Name of the table column template names are in
63 private $namecolumn = '';
66 * Name of the table column templates are in
69 private $datacolumn = '';
72 * Additional WHERE clauses for the template fetch SQL
75 private $extrawhere = '';
78 * The name of the function phrases are fetched with
81 private $langcall = '$GLOBALS[\'isso:callback\']->modules[\'localize\']->string';
84 * The name of the function phrases are sprintf() parsed with
87 private $langconst = 'sprintf';
90 * Array of pre-compiled templates that are stored to decrease server load
93 private $cache = array();
96 * A list of the number of times each template has been used
99 private $usage = array();
102 * A list of templates that weren't cached, but are still used
105 private $uncached = array();
108 * Whether or not the page has been flush()'d already
111 private $doneflush = false;
114 * The name of a function that is called before template parsing of phrases and conditionals occurs
117 private $pre_parse_hook = ':=NO METHOD=:';
120 * Fields array that is used in this module
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)
133 // ###################################################################
137 public function __construct(&$registry)
139 $this->registry
=& $registry;
142 // ###################################################################
144 * Initializes the class and all subclasses under a common package name
146 * @return string The package name
148 protected function init_as_package()
153 // ###################################################################
157 * @param string Field name
158 * @param mixed Value of the field
160 public function set($name, $value)
162 $this->registry
->do_set($name, $value, 'template');
165 // ###################################################################
169 * @param string Field name
171 * @return mixed Value of the field
173 public function get($fieldname)
175 return $this->registry
->do_get($fieldname, 'template');
178 // ###################################################################
180 * Takes an array of template names, loads them, and then stores a
181 * parsed version for optimum speed.
183 * @param array List of template names to be cached
185 public function cache($namearray)
187 if (sizeof($this->cache
) > 0)
189 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING
);
193 $templates = $this->registry
->modules
[ISSO_DB_LAYER
]->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " IN ('" . implode("', '", $namearray) . "')" . ($this->extrawhere
? ' ' . $this->extrawhere
: ''));
194 while ($template = $this->registry
->modules
[ISSO_DB_LAYER
]->fetch_array($templates))
196 $this->cache
[ $template[ $this->namecolumn
] ] = $this->_parse($template[ $this->datacolumn
]);
197 $this->usage
[ $template[ $this->namecolumn
] ] = 0;
202 // ###################################################################
204 * Loads a template from the cache or the _load function and stores the
205 * parsed version of it
207 * @param string The name of the template
209 * @return string A parsed and loaded template
211 public function fetch($name)
213 if (isset($this->cache
["$name"]))
215 $template = $this->cache["$name"];
219 $this->uncached
[] = $name;
220 $this->registry
->debug("Manually loading template `$name`");
221 $template = $this->_load($name);
222 $template = $this->_parse($template);
225 if (!isset($this->usage
["$name"]))
227 $this->usage["$name"] = 0;
230 $this->usage
["$name"]++;
235 // ###################################################################
237 * Output a template fully compiled to the browser
239 * @param string Compiled and ready template
241 public function flush($template)
245 if (empty($template))
247 trigger_error('There was no output to print', E_USER_ERROR);
251 if ($this->registry->debug AND isset($_GET['query']))
253 if (is_array($this->registry->modules[ISSO_DB_LAYER]->history))
255 foreach ($this->registry->modules[ISSO_DB_LAYER]->history AS $query)
257 echo $this->registry->modules[ISSO_DB_LAYER]->construct_query_debug($query);
263 if ($this->doneflush)
265 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR);
269 $template = str_replace('</body>', $this->registry->construct_debug_block(true) . '</body>', $template);
274 // ###################################################################
276 * Loads an additional template from the database
278 * @param string The name of the template
280 * @return string Template data from the database
282 private function _load($name)
284 if ($template = $this->registry->modules[ISSO_DB_LAYER]->query_first("SELECT
* FROM
" . $this->tablename . " WHERE
" . $this->namecolumn . " = '$name'" . ($this->extrawhere ? ' ' . $this->extrawhere : '')))
286 return $template[ $this->datacolumn ];
290 trigger_error("The template '$name' could not be loaded
", E_USER_ERROR);
295 // ###################################################################
297 * A wrapper for all the parsing functions and compiling functins
299 * @param string Unparsed template data
301 * @return string Parsed template data
303 protected function _parse($template)
305 $this->registry->check_isso_fields(get_class($this));
307 $template = str_replace('"', '\"
', $template);
309 if (function_exists($this->pre_parse_hook))
311 $template = call_user_func($this->pre_parse_hook, $template);
314 $template = $this->_parse_phrases($template);
315 $template = $this->_parse_conditionals($template);
319 // ###################################################################
321 * Prepares language and locale information inside templates
323 * @param string Template data to be processed
325 * @return string Language-ready template data
327 private function _parse_phrases($template)
329 $tag_start = '<lang
';
330 $tag_start_end = '\"
>';
331 $tag_end = '</lang
>';
333 $location_start = -1;
338 // Find the start language object tag
339 $location_start = strpos($template, $tag_start, $location_end + 1);
340 if ($location_start === false)
346 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
347 if ($location_end === false)
352 // Extract the language object
353 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
355 // Find the close to the opening <lang>
356 $close_of_open = strpos($phrase_bunch, $tag_start_end);
357 if ($close_of_open === false)
362 // Extract the opening tag so it can be parsed
363 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
364 $init_tag = str_replace($tag_start, '', $init_tag);
365 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
367 // Get the args out of the tag
368 $args = preg_split('#([0-9].*?)=#', $init_tag);
369 foreach ($args AS $arg)
371 if ($arg AND $arg != ' ')
374 $arg = substr($arg, 2);
375 $arg = substr($arg, 0, strlen($arg) - 2);
380 // Just get the phrase name
381 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
383 // Wrap the parsed data into the build function
384 $function_wrap = '" . ' . $this->langconst . '("' . /*str_replace(array('\"
', "'"), array('"', "\'"),*/ $phrase_name/*)*/ . '", "' . implode('", "', $arglist) . '") . "';
386 // Replace the fully-parsed string back into the template
387 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
392 // Process the empty phrase objects -- do this now so we don't have to worry about it when we
're parsing later
393 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ise', '$this->_phrase_string(\'$1\')', $template);
398 // ###################################################################
400 * Turns a localized phrase tag into a function call
402 * @param string Phrase text
404 * @return string Function call for phrase text
406 private function _phrase_string($text)
408 return '" . ' . $this->langcall
. '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), $text) . '\') . "';
411 // ###################################################################
413 * Parser for in-line template conditionals
415 * @param string Template data awaiting processing
417 * @return string Parsed template data
419 private function _parse_conditionals($template)
422 $tag_start = '<if condition=\"';
423 $tag_start_end = '\">';
424 $tag_else = '<else />';
430 // the information about the current active tag
439 if (strpos($template, $tag_start) === false)
444 for ($i = $offset; $i < strlen($template); $i++
)
446 // we've found ourselves a conditional!
447 if (substr($template, $i, strlen($tag_start)) == $tag_start)
449 // push the position into the tag stack
452 array_push($stack, $i);
456 $tag_full['posi'] = $i;
460 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
462 if (sizeof($stack) == 0 AND !isset($tag_full['else']))
464 $tag_full['else'] = $i;
467 // do we have an end tag?
468 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
470 if (sizeof($stack) != 0)
476 // calculate the position of the end tag
477 $tag_full['posf'] = $i +
strlen($tag_end) - 1;
479 // extract the entire conditional from the template
480 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] +
1);
482 // remove the beginning tag
483 $conditional = substr($fullspread, strlen($tag_start));
485 // find the end of the expression
486 $temp_end = strpos($conditional, $tag_start_end);
488 // save the expression
489 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
491 // remove the expression from the conditional
492 $conditional = substr($conditional, strlen($parsed[0]) +
strlen($tag_start_end));
494 // remove the tailing end tag
495 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
498 if (isset($tag_full['else']))
500 // now relative to the start of the <if>
501 $relpos = $tag_full['else'] - $tag_full['posi'];
503 // calculate the length of the expression and opening tag
504 $length = strlen($parsed[0]) +
strlen($tag_start) +
strlen($tag_start_end);
506 // relative to the start of iftrue
507 $elsepos = $relpos - $length;
509 $parsed[1] = substr($conditional, 0, $elsepos);
510 $parsed[2] = substr($conditional, $elsepos +
strlen($tag_else));
515 $parsed[1] = $conditional;
520 // final parsed output
521 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
523 // replace the conditional
524 $template = str_replace($fullspread, $parsed, $template);
527 $offset = $tag_full['posi'] +
strlen($tag_start) +
strlen($tag_start_end);
531 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
541 // ###################################################################
543 * Debugging function used to print characters in a string that are
544 * around a certain position.
548 * @param string The haystack string
549 * @param integer Position to print around
551 function print_around($str, $pos)
553 echo '>>> PA >>>>>>>>[';
554 echo htmlspecialchars($str[ $pos - 5 ]);
555 echo htmlspecialchars($str[ $pos - 4 ]);
556 echo htmlspecialchars($str[ $pos - 3 ]);
557 echo htmlspecialchars($str[ $pos - 2 ]);
558 echo htmlspecialchars($str[ $pos - 1 ]);
560 echo htmlspecialchars($str[ $pos +
0 ]);
561 echo htmlspecialchars($str[ $pos +
1 ]);
562 echo htmlspecialchars($str[ $pos +
2 ]);
563 echo htmlspecialchars($str[ $pos +
3 ]);
564 echo htmlspecialchars($str[ $pos +
4 ]);
565 echo htmlspecialchars($str[ $pos +
5 ]);
566 echo ']<<<<<<<< PA <<<';
569 /*=====================================================================*\
570 || ###################################################################
573 || ###################################################################
574 \*=====================================================================*/