2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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
39 * @author Iris Studios, Inc.
40 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
48 * Framework registry object
55 * Name of the database table templates are in
62 * Name of the table column template names are in
69 * Name of the table column templates are in
76 * Additional WHERE clauses for the template fetch SQL
83 * The name of the function phrases are fetched with
87 var $langcall = '$GLOBALS[\'isso:null-framework\']->modules[\'localize\']->string';
90 * The name of the function phrases are sprintf() parsed with
94 var $langconst = 'sprintf';
97 * Array of pre-compiled templates that are stored to decrease server load
101 var $cache = array();
104 * A list of the number of times each template has been used
108 var $usage = array();
111 * A list of templates that weren't cached, but are still used
115 var $uncached = array();
118 * Whether or not the page has been flush()'d already
122 var $doneflush = false;
125 * The name of a function that is called before template parsing of phrases and conditionals occurs
129 var $pre_parse_hook = ':=NO METHOD=:';
132 * Fields array that is used in this module
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)
146 // ###################################################################
150 function __construct(&$registry)
152 $this->registry
=& $registry;
155 // ###################################################################
157 * (PHP 4) Constructor
159 function Template(&$registry)
161 $this->__construct($registry);
164 // ###################################################################
170 * @param string Field name
171 * @param mixed Value of the field
173 function set($name, $value)
175 $this->registry
->do_set($name, $value, 'template');
178 // ###################################################################
180 * Takes an array of template names, loads them, and then stores a
181 * parsed version for optimum speed.
185 * @param array List of template names to be cached
187 function cache($namearray)
189 $this->registry
->check_isso_fields();
191 if (sizeof($this->cache
) > 0)
193 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING
);
197 $templates = $this->registry
->modules
[ISSO_DB_LAYER
]->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " IN ('" . implode("', '", $namearray) . "')" . ($this->extrawhere
? $this->extrawhere
: ''));
198 while ($template = $this->registry
->modules
[ISSO_DB_LAYER
]->fetch_array($templates))
200 $this->cache
[ $template[ $this->namecolumn
] ] = $this->_parse($template[ $this->datacolumn
]);
201 $this->usage
[ $template[ $this->namecolumn
] ] = 0;
206 // ###################################################################
208 * Loads a template from the cache or the _load function and stores the
209 * parsed version of it
213 * @param string The name of the template
215 * @return string A parsed and loaded template
217 function fetch($name)
219 if (isset($this->cache
["$name"]))
221 $template = $this->cache["$name"];
225 $this->uncached
[] = $name;
226 $this->registry
->debug("Manually loading template `$name`");
227 $template = $this->_load($name);
228 $template = $this->_parse($template);
231 if (!isset($this->usage
["$name"]))
233 $this->usage["$name"] = 0;
236 $this->usage
["$name"]++;
241 // ###################################################################
243 * Output a template fully compiled to the browser
247 * @param string Compiled and ready template
249 function flush($template)
253 if (empty($template))
255 trigger_error('There was no output to print', E_USER_ERROR);
259 if ($this->registry->debug AND isset($_GET['query']))
261 if (is_array($this->registry->modules[ISSO_DB_LAYER]->history))
264 foreach ($this->registry->modules[ISSO_DB_LAYER]->history AS $query)
266 echo $query . "\n\n
<hr
/>\n\n";
273 if ($this->doneflush)
275 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR);
279 $template = str_replace('</body>', $this->registry->construct_debug_block(true) . '</body>', $template);
284 // ###################################################################
286 * Loads an additional template from the database
290 * @param string The name of the template
292 * @return string Template data from the database
294 function _load($name)
296 if ($template = $this->registry->modules[ISSO_DB_LAYER]->query("SELECT
* FROM
" . $this->tablename . " WHERE
" . $this->namecolumn . " = '$name'" . ($this->extrawhere ? $this->extrawhere : '')))
298 return $template[ $this->datacolumn ];
302 trigger_error("The template '$name' could not be loaded
", E_USER_ERROR);
307 // ###################################################################
309 * A wrapper for all the parsing functions and compiling functins
313 * @param string Unparsed template data
315 * @return string Parsed template data
317 function _parse($template)
319 $template = str_replace('"', '\"
', $template);
321 if (function_exists($this->pre_parse_hook))
323 $this->registry->debug("running pre-parse hook: {$this->pre_parse_hook}");
324 $template = call_user_func($this->pre_parse_hook, $template);
327 $template = $this->_parse_phrases($template);
328 $template = $this->_parse_conditionals($template);
332 // ###################################################################
334 * Prepares language and locale information inside templates
338 * @param string Template data to be processed
340 * @return string Language-ready template data
342 function _parse_phrases($template)
344 $tag_start = '<lang
';
345 $tag_start_end = '\"
>';
346 $tag_end = '</lang
>';
348 $location_start = -1;
351 // Process the empty phrase objects -- do this now so we don't have to worry about it when we
're parsing later
352 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ie', '$this->_phrase_string(\'$1\')', $template);
356 // Find the start language object tag
357 $location_start = strpos($template, $tag_start, $location_end +
1);
358 if ($location_start === false)
364 $location_end = strpos($template, $tag_end, $location_end +
strlen($tag_end));
365 if ($location_end === false)
370 // Extract the language object
371 $phrase_bunch = substr($template, $location_start, ($location_end +
strlen($tag_end)) - $location_start);
373 // Find the close to the opening <lang>
374 $close_of_open = strpos($phrase_bunch, $tag_start_end);
375 if ($close_of_open === false)
380 // Extract the opening tag so it can be parsed
381 $init_tag = substr($phrase_bunch, 0, ($close_of_open +
strlen($tag_start_end)));
382 $init_tag = str_replace($tag_start, '', $init_tag);
383 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
385 // Get the args out of the tag
386 $args = preg_split('#([0-9].*?)=#', $init_tag);
387 foreach ($args AS $arg)
389 if ($arg AND $arg != ' ')
392 $arg = substr($arg, 2);
393 $arg = substr($arg, 0, strlen($arg) - 2);
398 // Just get the phrase name
399 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
401 // Wrap the parsed data into the build function
402 $function_wrap = '" . ' . $this->langconst . '("' . /*str_replace(array('\"
', "'"), array('"', "\'"),*/ $phrase_name/*)*/ . '", "' . implode('", "', $arglist) . '") . "';
404 // Replace the fully-parsed string back into the template
405 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
413 // ###################################################################
415 * Turns a localized phrase tag into a function call
419 * @param string Phrase text
421 * @return string Function call for phrase text
423 function _phrase_string($text)
425 return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"', "'"), array('"', "\'
"), $text) . '\') . "';
428 // ###################################################################
430 * Parser for in-line template conditionals
434 * @param string Template data awaiting processing
436 * @return string Parsed template data
438 function _parse_conditionals($template)
441 $tag_start = '<if condition
=\"';
442 $tag_start_end = '\"
>';
443 $tag_else = '<else />';
449 // the information about the current active tag
458 if (strpos($template, $tag_start) === false)
463 for ($i = $offset; $i < strlen($template); $i++)
465 // we've found ourselves a conditional
!
466 if (substr($template, $i, strlen($tag_start)) == $tag_start)
468 // push the position into the tag stack
471 array_push($stack, $i);
475 $tag_full['posi'] = $i;
479 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
481 if (count($stack) == 0 AND !isset($tag_full['else']))
483 $tag_full['else'] = $i;
486 // do we have an end tag?
487 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
489 if (count($stack) != 0)
495 // calculate the position of the end tag
496 $tag_full['posf'] = $i +
strlen($tag_end) - 1;
498 // extract the entire conditional from the template
499 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] +
1);
501 // remove the beginning tag
502 $conditional = substr($fullspread, strlen($tag_start));
504 // find the end of the expression
505 $temp_end = strpos($conditional, $tag_start_end);
507 // save the expression
508 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
510 // remove the expression from the conditional
511 $conditional = substr($conditional, strlen($parsed[0]) +
strlen($tag_start_end));
513 // remove the tailing end tag
514 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
517 if (isset($tag_full['else']))
519 // now relative to the start of the <if>
520 $relpos = $tag_full['else'] - $tag_full['posi'];
522 // calculate the length of the expression and opening tag
523 $length = strlen($parsed[0]) +
strlen($tag_start) +
strlen($tag_start_end);
525 // relative to the start of iftrue
526 $elsepos = $relpos - $length;
528 $parsed[1] = substr($conditional, 0, $elsepos);
529 $parsed[2] = substr($conditional, $elsepos +
strlen($tag_else));
534 $parsed[1] = $conditional;
539 // final parsed output
540 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
542 // replace the conditional
543 $template = str_replace($fullspread, $parsed, $template);
546 $offset = $tag_full['posi'] +
strlen($tag_start) +
strlen($tag_start_end);
550 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
560 // ###################################################################
562 * Debugging function used to print characters in a string that are
563 * around a certain position.
567 * @param string The haystack string
568 * @param integer Position to print around
570 function print_around($str, $pos)
572 echo '>>> PA >>>>>>>>[';
573 echo htmlspecialchars($str[ $pos - 5 ]);
574 echo htmlspecialchars($str[ $pos - 4 ]);
575 echo htmlspecialchars($str[ $pos - 3 ]);
576 echo htmlspecialchars($str[ $pos - 2 ]);
577 echo htmlspecialchars($str[ $pos - 1 ]);
579 echo htmlspecialchars($str[ $pos +
0 ]);
580 echo htmlspecialchars($str[ $pos +
1 ]);
581 echo htmlspecialchars($str[ $pos +
2 ]);
582 echo htmlspecialchars($str[ $pos +
3 ]);
583 echo htmlspecialchars($str[ $pos +
4 ]);
584 echo htmlspecialchars($str[ $pos +
5 ]);
585 echo ']<<<<<<<< PA <<<';
588 /*=====================================================================*\
589 || ###################################################################
592 || ###################################################################
593 \*=====================================================================*/