2 /*=====================================================================*\
3 || ################################################################### ||
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # --------------------------------------------------------------- # ||
6 || # Copyright ©2002-[#]year[#] by Iris Studios, Inc. All Rights Reserved. # ||
7 || # This file may not be reproduced in any way without permission. # ||
8 || # --------------------------------------------------------------- # ||
9 || # User License Agreement at http://www.iris-studios.com/license/ # ||
10 || ################################################################### ||
11 \*=====================================================================*/
14 * Database-Driven Template System
20 $OBJECT = 'Database Template System';
21 $CLASS = 'DB_Template';
25 * Database-Driven Template System
27 * This framework is a backend to the database template engine and
28 * contains all the parsing algorithms.
30 * @author Iris Studios, Inc.
31 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
39 * Name of the database table templates are in
43 var $templatetable = '';
46 * Name of the table column template names are in
48 * @see $templatetable, _load()
53 * Name of the table column templates are in
55 * @see templatetable, _load()
60 * Additional WHERE clauses for the template fetch SQL
62 * @see _load(), cache()
67 * The name of the function phrases are fetched with
69 * @see _parse_phrases()
71 var $langcall = '$_isso->lang->string';
74 * The name of the function phrases are sprintf() parsed with
76 * @see _parse_phrases()
78 var $langconst = 'sprintf';
81 * Array of pre-compiled templates that are stored to decrease server load
88 * A list of the number of times each template has been used
95 * A list of templates that weren't cached, but are still used
99 var $uncached = array();
102 * Whether or not the page has been flush()'d already
106 var $doneflush = false;
109 * Takes an array of template names, loads them, and then stores
110 * a parsed version for optimum speed.
112 * @param array List of template names to be cached
114 function cache($namearray)
118 if (sizeof($this->cache
) > 0)
120 trigger_error('You cannot cache templates more than once per initialization', ERR_WARNING
);
124 $templates = $_isso->db
->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " IN ('" . implode("', '", $namearray) . "')" . (($this->extrawhere
) ? $this->extrawhere
: ''));
125 while ($template = $_isso->db
->fetch_array($templates))
127 $template = $this->_parse($template);
128 $this->cache
[ $template[ $this->namecolumn
] ] = $template[ $this->datacolumn
];
129 $this->usage
["$name"] = 0;
135 * Loads a template from the cache or the _load function and
136 * stores the parsed version of it
138 * @param str The name of the template
140 * @return str A parsed and loaded template
142 function fetch($name)
146 if (isset($this->cache["$name"]))
148 $template = $this->cache
["$name"];
152 $this->uncached[] = $name;
153 $_isso->debug("Manually loading template `
$name`
");
154 $template = $this->_load($name);
155 $template = $this->_parse($template);
158 if (!isset($this->usage["$name"]))
160 $this->usage
["$name"] = 0;
163 $this->usage["$name"]++
;
169 * Output a template fully compiled to the browser
171 * @param str Compiled and ready template
173 function flush($template)
179 if (empty($template))
181 trigger_error('There was no output to print', E_USER_ERROR
);
185 if ($_isso->debug
AND isset($_GET['query']))
187 if (is_array($_isso->db
->history
))
190 foreach ($_isso->db
->history
AS $query)
192 echo $query . "\n\n<hr />\n\n";
199 if ($this->doneflush
)
201 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR
);
213 foreach ($this->usage
AS $name => $count)
215 if (in_array($name, $this->uncached
))
217 $optlist[] = $name . '[' . $count . ']';
219 $usage[] = $name . " ($count)";
222 $sizeof = sizeof($this->uncached
);
225 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
229 $scinfo = 'Not Under Source Control';
230 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
231 foreach ($possiblescms AS $scm)
233 if (defined(strtoupper($scm)))
235 $scinfo = constant(strtoupper($scm));
239 if (strpos($scinfo, 'RCSfile:') !== false)
243 else if (strpos($scinfo, ',v ') !== false)
248 else if (strpos($scinfo, 'URL:') !== false)
252 else if (strpos($scinfo, 'https://') !== false OR strpos($scinfo, 'http://') !== false)
256 // not found so just return it
257 // try a SVN ID tag as we can't really tell if we're using it
260 $test = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
261 if ($test == '$' . 'Id
: $')
263 $scinfo = 'Not Under Source Control';
274 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
275 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
276 $scinfo = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}/[0-9]{2}/[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} (.+?) (.+?) \$#', '\\1 - CVS \\2', $scinfo);
278 else if ($type == 'svn')
280 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
281 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
282 $scinfo = preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
286 $scinfo = 'Not Under Source Control';
291 $scinfo = trim($scinfo);
292 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
295 if (isset($_isso->db
) AND is_object($_isso->db
))
297 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($_isso->db
->history
) . " (<a href=\"" . $_isso->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false) ? '&query=1' : '?query=1') . "\">?</a>)</li>";
300 // total execution time
301 if (defined('ISSO_MT_START'))
303 $_isso->load('functions');
304 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($_isso->funct
->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
308 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($_isso->debuginfo
) . ")</option>";
309 foreach ((array)$_isso->debuginfo
AS $msg)
311 $debug .= "\n\t\t\t<option>--- $msg</option>";
313 $debug .= "\n\t\t</select>\n\t</li>";
316 $modules = $_isso->show_modules(true);
317 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
318 foreach ($modules AS $mod)
320 $debug .= "\n\t\t\t<option>--- $mod</option>";
322 $debug .= "\n\t\t</select>\n\t</li>";
325 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->usage
) . ")</option>";
326 foreach ($usage AS $tpl)
328 $debug .= "\n\t\t\t<option>--- $tpl</option>";
330 $debug .= "\n\t\t</select>\n\t</li>";
335 $debug = "\n<hr />\n" . $_isso->_message('Debug Information', $debug, 1, true);
336 $template = str_replace('</body>', "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n</body>", $template);
339 print(stripslashes($template));
343 * Loads an additional template from the database
345 * @param str The name of the template
347 * @return str Template data from the database
349 function _load($name)
352 if ($template = $_isso->db
->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " = '$name'" . (($this->extrawhere) ? $this->extrawhere : '')))
354 return $template[ $this->datacolumn ];
358 trigger_error("The template
'$name' could not be loaded", E_USER_ERROR);
364 * A wrapper for all the parsing functions and compiling functins
366 * @param str Unparsed template data
368 * @return str Parsed template data
370 function _parse($template)
372 $template = stripslashes($template);
373 $template = str_replace('"', '\"', $template);
374 $template = $this->_parse_phrases($template);
375 $template = $this->_parse_conditionals($template);
380 * Prepares language and locale information inside templates
382 * @param str Template data to be processed
384 * @return str Language-ready template data
386 function _parse_phrases($template)
388 $tag_start = '<lang ';
389 $tag_start_end = '\">';
390 $tag_end = '</lang>';
392 $location_start = -1;
395 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
396 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#i', '" . ' . $this->langcall . '(\'$1\') . "', $template);
400 // Find the start language object tag
401 $location_start = strpos($template, $tag_start, $location_end + 1);
402 if ($location_start === false)
408 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
409 if ($location_end === false)
414 // Extract the language object
415 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
417 // Find the close to the opening <lang>
418 $close_of_open = strpos($phrase_bunch, $tag_start_end);
419 if ($close_of_open === false)
424 // Extract the opening tag so it can be parsed
425 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
426 $init_tag = str_replace($tag_start, '', $init_tag);
427 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
429 // Get the args out of the tag
430 $args = preg_split('#([0-9].*?)=#', $init_tag);
431 foreach ($args AS $arg)
433 if ($arg AND $arg != ' ')
436 $arg = substr($arg, 2);
437 $arg = substr($arg, 0, strlen($arg) - 2);
442 // Just get the phrase name
443 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
445 // Wrap the parsed data into the build function
446 $function_wrap = '" . ' . $this->langconst . '("' . $phrase_name . '", "' . implode('", "', $arglist) . '") . "';
448 // Replace the fully-parsed string back into the template
449 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
458 * Parser for in-line template conditionals
460 * @param str Template data awaiting processing
462 * @return str Parsed template data
464 function _parse_conditionals($template)
469 $tag_start = '<if condition=\"';
470 $tag_start_end = '\">';
471 $tag_else = '<else />';
477 // the information about the current active tag
486 if (strpos($template, $tag_start) === false)
491 for ($i = $offset; $i < strlen($template); $i++)
493 // we've found ourselves a conditional!
494 if (substr($template, $i, strlen($tag_start)) == $tag_start)
496 // push the position into the tag stack
499 array_push($stack, $i);
503 $tag_full['posi'] = $i;
507 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
509 if (count($stack) == 0 AND !isset($tag_full['else']))
511 $tag_full['else'] = $i;
514 // do we have an end tag?
515 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
517 if (count($stack) != 0)
523 // calculate the position of the end tag
524 $tag_full['posf'] = $i + strlen($tag_end) - 1;
526 // extract the entire conditional from the template
527 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
529 // remove the beginning tag
530 $conditional = substr($fullspread, strlen($tag_start));
532 // find the end of the expression
533 $temp_end = strpos($conditional, $tag_start_end);
535 // save the expression
536 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
538 // remove the expression from the conditional
539 $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
541 // remove the tailing end tag
542 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
545 if (isset($tag_full['else']))
547 // now relative to the start of the <if>
548 $relpos = $tag_full['else'] - $tag_full['posi'];
550 // calculate the length of the expression and opening tag
551 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
553 // relative to the start of iftrue
554 $elsepos = $relpos - $length;
556 $parsed[1] = substr($conditional, 0, $elsepos);
557 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
562 $parsed[1] = $conditional;
567 // final parsed output
568 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
570 // replace the conditional
571 $template = str_replace($fullspread, $parsed, $template);
574 $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
578 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
589 * Debugging function used to print characters
590 * in a string that are around a certain position.
592 * @param string The haystack string
593 * @param integer Position to print around
595 function print_around($str, $pos)
597 echo '>>> PA >>>>>>>>[';
598 echo htmlspecialchars($str[ $pos - 5 ]);
599 echo htmlspecialchars($str[ $pos - 4 ]);
600 echo htmlspecialchars($str[ $pos - 3 ]);
601 echo htmlspecialchars($str[ $pos - 2 ]);
602 echo htmlspecialchars($str[ $pos - 1 ]);
604 echo htmlspecialchars($str[ $pos + 0 ]);
605 echo htmlspecialchars($str[ $pos + 1 ]);
606 echo htmlspecialchars($str[ $pos + 2 ]);
607 echo htmlspecialchars($str[ $pos + 3 ]);
608 echo htmlspecialchars($str[ $pos + 4 ]);
609 echo htmlspecialchars($str[ $pos + 5 ]);
610 echo ']<<<<<<<< PA <<<';
613 /*=====================================================================*\
614 || ###################################################################
617 || ###################################################################
618 \*=====================================================================*/