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 (template.php)
29 * Database-Driven Template System
31 * This framework is a backend to the database template engine and
32 * contains all the parsing algorithms.
35 * @copyright Copyright ©2002 - [#]year[#], Blue Static
43 * The database object to use
49 * Name of the database table templates are in
52 private $tableName = '';
55 * Name of the table column template names are in
58 private $nameColumn = '';
61 * Name of the table column templates are in
64 private $dataColumn = '';
67 * Additional WHERE clauses for the template fetch SQL
70 private $extraWhere = '';
73 * The name of the function phrases are fetched with
76 private $langcall = 'gettext';
79 * The name of the function phrases are sprintf() parsed with
82 private $langconst = 'sprintf';
85 * Array of pre-compiled templates that are stored to decrease server load
88 private $cache = array();
91 * A list of the number of times each template has been used
94 private $usage = array();
97 * A list of templates that weren't cached, but are still used
100 private $uncached = array();
103 * Whether or not the page has been flush()'d already
106 private $doneflush = false;
109 * The name of a function that is called before template parsing of phrases and conditionals occurs
112 private $preParseHook = ':undefined:';
114 // ###################################################################
116 * Constructor: check required modules
118 public function __construct()
120 BSRegister
::RequiredModules(array('Db'));
123 // ###################################################################
125 * Sets the database object to use
127 * @param object Database object
129 public function setDatabase($db)
134 // ###################################################################
136 * Sets the table name and column information
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
142 public function setDatabaseTable($tableName, $nameColumn, $dataColumn)
144 $this->tableName
= $tableName;
145 $this->nameColumn
= $nameColumn;
146 $this->dataColumn
= $dataColumn;
149 // ###################################################################
151 * Sets the pre-parse hook method which is called before any other
152 * processing is done on the template.
154 * @param string Method name
156 public function setPreParseHook($hook)
158 $this->preParseHook
= $hook;
161 // ###################################################################
163 * Takes an array of template names, loads them, and then stores a
164 * parsed version for optimum speed.
166 * @param array List of template names to be cached
168 public function cache($namearray)
170 if (sizeof($this->cache
) > 0)
172 trigger_error('You cannot cache templates more than once per initialization');
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))
179 $this->cache
[ $template[ $this->nameColumn
] ] = $this->_parse($template[ $this->dataColumn
]);
180 $this->usage
[ $template[ $this->nameColumn
] ] = 0;
185 // ###################################################################
187 * Loads a template from the cache or the _load function and stores the
188 * parsed version of it
190 * @param string The name of the template
192 * @return string A parsed and loaded template
194 public function fetch($name)
196 if (isset($this->cache
["$name"]))
198 $template = $this->cache["$name"];
202 $this->uncached
[] = $name;
203 BSRegister
::Debug("Manually loading template `$name`");
204 $template = $this->_loadTemplate($name);
205 $template = $this->_parseTemplate($template);
208 if (!isset($this->usage
["$name"]))
210 $this->usage["$name"] = 0;
213 $this->usage
["$name"]++;
218 // ###################################################################
220 * Output a template fully compiled to the browser
222 * @param string Compiled and ready template
224 public function flush($template)
228 if (empty($template))
230 trigger_error('There was no output to print');
234 if (BSRegister::GetDebug() AND isset($_GET['query']))
236 if (is_array($this->registry->modules[ISSO_DB_LAYER]->history))
238 foreach ($this->registry->modules[ISSO_DB_LAYER]->history AS $query)
240 echo $this->registry->modules[ISSO_DB_LAYER]->construct_query_debug($query);
246 if ($this->doneflush)
248 trigger_error('A template has already been sent to the output buffer');
252 $template = str_replace('</body>', $this->registry->construct_debug_block(true) . '</body>', $template);
257 // ###################################################################
259 * Loads an additional template from the database
261 * @param string The name of the template
263 * @return string Template data from the database
265 private function _loadTemplate($name)
267 if ($template = $this->db->query_first("SELECT
* FROM
" . $this->tableName . " WHERE
" . $this->nameColumn . " = '$name'" . ($this->extrawhere ? ' ' . $this->extrawhere : '')))
269 return $template[ $this->dataColumn ];
273 trigger_error("The template '$name' could not be loaded
");
278 // ###################################################################
280 * A wrapper for all the parsing functions and compiling functins
282 * @param string Unparsed template data
284 * @return string Parsed template data
286 protected function _parseTemplate($template)
288 $template = str_replace('"', '\"
', $template);
290 if (function_exists($this->preParseHook))
292 $template = call_user_func($this->preParseHook, $template);
295 $template = $this->_parsePhrases($template);
296 $template = $this->_parseConditionals($template);
300 // ###################################################################
302 * Prepares language and locale information inside templates
304 * @param string Template data to be processed
306 * @return string Language-ready template data
308 private function _parsePhrases($template)
310 $tag_start = '<lang
';
311 $tag_start_end = '\"
>';
312 $tag_end = '</lang
>';
314 $location_start = -1;
319 // Find the start language object tag
320 $location_start = strpos($template, $tag_start, $location_end + 1);
321 if ($location_start === false)
327 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
328 if ($location_end === false)
333 // Extract the language object
334 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
336 // Find the close to the opening <lang>
337 $close_of_open = strpos($phrase_bunch, $tag_start_end);
338 if ($close_of_open === false)
343 // Extract the opening tag so it can be parsed
344 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
345 $init_tag = str_replace($tag_start, '', $init_tag);
346 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
348 // Get the args out of the tag
349 $args = preg_split('#([0-9].*?)=#', $init_tag);
350 foreach ($args AS $arg)
352 if ($arg AND $arg != ' ')
355 $arg = substr($arg, 2);
356 $arg = substr($arg, 0, strlen($arg) - 2);
361 // Just get the phrase name
362 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
364 // Wrap the parsed data into the build function
365 $function_wrap = '" . ' . $this->langconst . '("' . $phrase_name . '", "' . implode('", "', $arglist) . '") . "';
367 // Replace the fully-parsed string back into the template
368 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
373 // Process the empty phrase objects -- do this now so we don't have to worry about it when we
're parsing later
374 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ise', '$this->_templateString(\'$1\')', $template);
379 // ###################################################################
381 * Turns a localized phrase tag into a function call
383 * @param string Phrase text
385 * @return string Function call for phrase text
387 private function _templateString($text)
389 return '" . ' . $this->langcall
. '(\'' . str_replace(array('\\\"', "'"), array('"', "\'"), $text) . '\') . "';
392 // ###################################################################
394 * Parser for in-line template conditionals
396 * @param string Template data awaiting processing
398 * @return string Parsed template data
400 private function _parseConditionals($template)
403 $tag_start = '<if condition=\"';
404 $tag_start_end = '\">';
405 $tag_else = '<else />';
411 // the information about the current active tag
420 if (strpos($template, $tag_start) === false)
425 for ($i = $offset; $i < strlen($template); $i++
)
427 // we've found ourselves a conditional!
428 if (substr($template, $i, strlen($tag_start)) == $tag_start)
430 // push the position into the tag stack
433 array_push($stack, $i);
437 $tag_full['posi'] = $i;
441 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
443 if (sizeof($stack) == 0 AND !isset($tag_full['else']))
445 $tag_full['else'] = $i;
448 // do we have an end tag?
449 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
451 if (sizeof($stack) != 0)
457 // calculate the position of the end tag
458 $tag_full['posf'] = $i +
strlen($tag_end) - 1;
460 // extract the entire conditional from the template
461 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] +
1);
463 // remove the beginning tag
464 $conditional = substr($fullspread, strlen($tag_start));
466 // find the end of the expression
467 $temp_end = strpos($conditional, $tag_start_end);
469 // save the expression
470 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
472 // remove the expression from the conditional
473 $conditional = substr($conditional, strlen($parsed[0]) +
strlen($tag_start_end));
475 // remove the tailing end tag
476 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
479 if (isset($tag_full['else']))
481 // now relative to the start of the <if>
482 $relpos = $tag_full['else'] - $tag_full['posi'];
484 // calculate the length of the expression and opening tag
485 $length = strlen($parsed[0]) +
strlen($tag_start) +
strlen($tag_start_end);
487 // relative to the start of iftrue
488 $elsepos = $relpos - $length;
490 $parsed[1] = substr($conditional, 0, $elsepos);
491 $parsed[2] = substr($conditional, $elsepos +
strlen($tag_else));
496 $parsed[1] = $conditional;
500 // final parsed output
501 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
503 // replace the conditional
504 $template = str_replace($fullspread, $parsed, $template);
507 $offset = $tag_full['posi'] +
strlen($tag_start) +
strlen($tag_start_end);
511 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
521 // ###################################################################
523 * Debugging function used to print characters in a string that are
524 * around a certain position.
528 * @param string The haystack string
529 * @param integer Position to print around
531 function print_around($str, $pos)
533 echo '>>> PA >>>>>>>>[';
534 echo htmlspecialchars($str[ $pos - 5 ]);
535 echo htmlspecialchars($str[ $pos - 4 ]);
536 echo htmlspecialchars($str[ $pos - 3 ]);
537 echo htmlspecialchars($str[ $pos - 2 ]);
538 echo htmlspecialchars($str[ $pos - 1 ]);
540 echo htmlspecialchars($str[ $pos +
0 ]);
541 echo htmlspecialchars($str[ $pos +
1 ]);
542 echo htmlspecialchars($str[ $pos +
2 ]);
543 echo htmlspecialchars($str[ $pos +
3 ]);
544 echo htmlspecialchars($str[ $pos +
4 ]);
545 echo htmlspecialchars($str[ $pos +
5 ]);
546 echo ']<<<<<<<< PA <<<';
549 /*=====================================================================*\
550 || ###################################################################
553 || ###################################################################
554 \*=====================================================================*/