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.
35 * @author Iris Studios, Inc.
36 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
44 * Framework registry object
50 * Name of the database table templates are in
53 var $templatetable = '';
56 * Name of the table column template names are in
62 * Name of the table column templates are in
68 * Additional WHERE clauses for the template fetch SQL
74 * The name of the function phrases are fetched with
77 var $langcall = '$this->registry->modules[\'localize\']->string';
80 * The name of the function phrases are sprintf() parsed with
83 var $langconst = 'sprintf';
86 * Array of pre-compiled templates that are stored to decrease server load
92 * A list of the number of times each template has been used
98 * A list of templates that weren't cached, but are still used
101 var $uncached = array();
104 * Whether or not the page has been flush()'d already
107 var $doneflush = false;
112 function Template(&$registry)
114 $this->registry
=& $registry;
118 * Takes an array of template names, loads them, and then stores
119 * a parsed version for optimum speed.
121 * @param array List of template names to be cached
123 function cache($namearray)
125 if (sizeof($this->cache
) > 0)
127 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING
);
131 $templates = $this->registry
->modules
['db_mysql']->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " IN ('" . implode("', '", $namearray) . "')" . (($this->extrawhere
) ? $this->extrawhere
: ''));
132 while ($template = $this->registry
->modules
['db_mysql']->fetch_array($templates))
134 $template = $this->_parse($template);
135 $this->cache
[ $template[ $this->namecolumn
] ] = $template[ $this->datacolumn
];
136 $this->usage
["$name"] = 0;
142 * Loads a template from the cache or the _load function and
143 * stores the parsed version of it
145 * @param string The name of the template
147 * @return string A parsed and loaded template
149 function fetch($name)
151 if (isset($this->cache["$name"]))
153 $template = $this->cache
["$name"];
157 $this->uncached[] = $name;
158 $this->registry->debug("Manually loading template `
$name`
");
159 $template = $this->_load($name);
160 $template = $this->_parse($template);
163 if (!isset($this->usage["$name"]))
165 $this->usage
["$name"] = 0;
168 $this->usage["$name"]++
;
174 * Output a template fully compiled to the browser
176 * @param string Compiled and ready template
178 function flush($template)
182 if (empty($template))
184 trigger_error('There was no output to print', E_USER_ERROR
);
188 if ($this->registry
->debug
AND isset($_GET['query']))
190 if (is_array($this->registry
->modules
['db_mysql']->history
))
193 foreach ($this->registry
->modules
['db_mysql']->history
AS $query)
195 echo $query . "\n\n<hr />\n\n";
202 if ($this->doneflush
)
204 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR
);
208 if ($this->registry
->debug
)
216 foreach ($this->usage
AS $name => $count)
218 if (in_array($name, $this->uncached
))
220 $optlist[] = $name . '[' . $count . ']';
222 $usage[] = $name . " ($count)";
225 $sizeof = sizeof($this->uncached
);
228 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
232 $scinfo = 'Not Under Source Control';
233 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
234 foreach ($possiblescms AS $scm)
236 if (defined(strtoupper($scm)))
238 $scinfo = constant(strtoupper($scm));
242 if (strpos($scinfo, 'RCSfile:') !== false)
246 else if (strpos($scinfo, ',v ') !== false)
251 else if (strpos($scinfo, 'URL:') !== false)
255 else if (strpos($scinfo, 'https://') !== false OR strpos($scinfo, 'http://') !== false)
259 // not found so just return it
260 // try a SVN ID tag as we can't really tell if we're using it
263 $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);
264 if ($test == '$' . 'Id
: $')
266 $scinfo = 'Not Under Source Control';
277 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
278 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
279 $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);
281 else if ($type == 'svn')
283 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
284 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
285 $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);
289 $scinfo = 'Not Under Source Control';
294 $scinfo = trim($scinfo);
295 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
298 if (is_object($this->registry
->modules
['db_mysql']))
300 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($this->registry
->modules
['db_mysql']->history
) . " (<a href=\"" . $this->registry
->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false) ? '&query=1' : '?query=1') . "\">?</a>)</li>";
303 // total execution time
304 if (defined('ISSO_MT_START'))
306 $this->registry
->load('functions', 'functions');
307 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->registry
->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
311 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->registry
->debuginfo
) . ")</option>";
312 foreach ((array)$this->registry
->debuginfo
AS $msg)
314 $debug .= "\n\t\t\t<option>--- $msg</option>";
316 $debug .= "\n\t\t</select>\n\t</li>";
319 $modules = $this->registry
->show_modules(true);
320 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
321 foreach ($modules AS $mod)
323 $debug .= "\n\t\t\t<option>--- $mod</option>";
325 $debug .= "\n\t\t</select>\n\t</li>";
328 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->usage
) . ")</option>";
329 foreach ($usage AS $tpl)
331 $debug .= "\n\t\t\t<option>--- $tpl</option>";
333 $debug .= "\n\t\t</select>\n\t</li>";
338 $debug = "\n<hr />\n" . $this->registry
->_message('Debug Information', $debug, 1, true);
339 $template = str_replace('</body>', "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n</body>", $template);
342 print(stripslashes($template));
346 * Loads an additional template from the database
348 * @param string The name of the template
350 * @return string Template data from the database
352 function _load($name)
354 if ($template = $this->registry
->modules
['db_mysql']->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " = '$name'" . (($this->extrawhere) ? $this->extrawhere : '')))
356 return $template[ $this->datacolumn ];
360 trigger_error("The template
'$name' could not be loaded", E_USER_ERROR);
366 * A wrapper for all the parsing functions and compiling functins
368 * @param string Unparsed template data
370 * @return string Parsed template data
372 function _parse($template)
374 $template = stripslashes($template);
375 $template = str_replace('"', '\"', $template);
376 $template = $this->_parse_phrases($template);
377 $template = $this->_parse_conditionals($template);
382 * Prepares language and locale information inside templates
384 * @param string Template data to be processed
386 * @return string Language-ready template data
388 function _parse_phrases($template)
390 $tag_start = '<lang ';
391 $tag_start_end = '\">';
392 $tag_end = '</lang>';
394 $location_start = -1;
397 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
398 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#i', '" . ' . $this->langcall . '(\'$1\') . "', $template);
402 // Find the start language object tag
403 $location_start = strpos($template, $tag_start, $location_end + 1);
404 if ($location_start === false)
410 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
411 if ($location_end === false)
416 // Extract the language object
417 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
419 // Find the close to the opening <lang>
420 $close_of_open = strpos($phrase_bunch, $tag_start_end);
421 if ($close_of_open === false)
426 // Extract the opening tag so it can be parsed
427 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
428 $init_tag = str_replace($tag_start, '', $init_tag);
429 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
431 // Get the args out of the tag
432 $args = preg_split('#([0-9].*?)=#', $init_tag);
433 foreach ($args AS $arg)
435 if ($arg AND $arg != ' ')
438 $arg = substr($arg, 2);
439 $arg = substr($arg, 0, strlen($arg) - 2);
444 // Just get the phrase name
445 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
447 // Wrap the parsed data into the build function
448 $function_wrap = '" . ' . $this->langconst . '("' . $phrase_name . '", "' . implode('", "', $arglist) . '") . "';
450 // Replace the fully-parsed string back into the template
451 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
460 * Parser for in-line template conditionals
462 * @param string Template data awaiting processing
464 * @return string Parsed template data
466 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 \*=====================================================================*/