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
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 = '$GLOBALS[\'isso:null-framework\']->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 __construct(&$registry)
114 $this->registry
=& $registry;
118 * (PHP 4) Constructor
120 function Template(&$registry)
122 $this->__construct($registry);
126 * Takes an array of template names, loads them, and then stores
127 * a parsed version for optimum speed.
131 * @param array List of template names to be cached
133 function cache($namearray)
135 if (sizeof($this->cache
) > 0)
137 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING
);
141 $templates = $this->registry
->modules
['db_mysql']->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " IN ('" . implode("', '", $namearray) . "')" . ($this->extrawhere
? $this->extrawhere
: ''));
142 while ($template = $this->registry
->modules
['db_mysql']->fetch_array($templates))
144 $this->cache
[ $template[ $this->namecolumn
] ] = $this->_parse($template[ $this->datacolumn
]);
145 $this->usage
["$name"] = 0;
151 * Loads a template from the cache or the _load function and
152 * stores the parsed version of it
156 * @param string The name of the template
158 * @return string A parsed and loaded template
160 function fetch($name)
162 if (isset($this->cache["$name"]))
164 $template = $this->cache
["$name"];
168 $this->uncached[] = $name;
169 $this->registry->debug("Manually loading template `
$name`
");
170 $template = $this->_load($name);
171 $template = $this->_parse($template);
174 if (!isset($this->usage["$name"]))
176 $this->usage
["$name"] = 0;
179 $this->usage["$name"]++
;
185 * Output a template fully compiled to the browser
189 * @param string Compiled and ready template
191 function flush($template)
195 if (empty($template))
197 trigger_error('There was no output to print', E_USER_ERROR
);
201 if ($this->registry
->debug
AND isset($_GET['query']))
203 if (is_array($this->registry
->modules
['db_mysql']->history
))
206 foreach ($this->registry
->modules
['db_mysql']->history
AS $query)
208 echo $query . "\n\n<hr />\n\n";
215 if ($this->doneflush
)
217 trigger_error('A template has already been sent to the output buffer', E_USER_ERROR
);
221 if ($this->registry
->debug
)
229 foreach ($this->usage
AS $name => $count)
231 if (in_array($name, $this->uncached
))
233 $optlist[] = $name . '[' . $count . ']';
235 $usage[] = $name . " ($count)";
238 $sizeof = sizeof($this->uncached
);
241 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
245 $scinfo = 'Not Under Source Control';
246 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
247 foreach ($possiblescms AS $scm)
249 if (defined(strtoupper($scm)))
251 $scinfo = constant(strtoupper($scm));
255 if (strpos($scinfo, 'RCSfile:') !== false)
259 else if (strpos($scinfo, ',v ') !== false)
264 else if (strpos($scinfo, 'URL:') !== false)
268 else if (strpos($scinfo, 'https://') !== false OR strpos($scinfo, 'http://') !== false)
272 // not found so just return it
273 // try a SVN ID tag as we can't really tell if we're using it
276 $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);
277 if ($test == '$' . 'Id
: $')
279 $scinfo = 'Not Under Source Control';
290 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
291 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
292 $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);
294 else if ($type == 'svn')
296 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
297 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
298 $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);
302 $scinfo = 'Not Under Source Control';
307 $scinfo = trim($scinfo);
308 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
311 if (is_object($this->registry
->modules
['db_mysql']))
313 $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>";
316 // total execution time
317 if (defined('ISSO_MT_START'))
319 $this->registry
->load('functions', 'functions');
320 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->registry
->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
324 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->registry
->debuginfo
) . ")</option>";
325 foreach ((array)$this->registry
->debuginfo
AS $msg)
327 $debug .= "\n\t\t\t<option>--- $msg</option>";
329 $debug .= "\n\t\t</select>\n\t</li>";
332 $modules = $this->registry
->show_modules(true);
333 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
334 foreach ($modules AS $mod)
336 $debug .= "\n\t\t\t<option>--- $mod</option>";
338 $debug .= "\n\t\t</select>\n\t</li>";
341 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->usage
) . ")</option>";
342 foreach ($usage AS $tpl)
344 $debug .= "\n\t\t\t<option>--- $tpl</option>";
346 $debug .= "\n\t\t</select>\n\t</li>";
351 $debug = "\n<hr />\n" . $this->registry
->message('Debug Information', $debug, 1, true, false);
352 $template = str_replace('</body>', "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n</body>", $template);
359 * Loads an additional template from the database
363 * @param string The name of the template
365 * @return string Template data from the database
367 function _load($name)
369 if ($template = $this->registry
->modules
['db_mysql']->query("SELECT * FROM " . $this->tablename
. " WHERE " . $this->namecolumn
. " = '$name'" . ($this->extrawhere ? $this->extrawhere : '')))
371 return $template[ $this->datacolumn ];
375 trigger_error("The template
'$name' could not be loaded", E_USER_ERROR);
381 * A wrapper for all the parsing functions and compiling functins
385 * @param string Unparsed template data
387 * @return string Parsed template data
389 function _parse($template)
391 $template = str_replace('"', '\"', $template);
392 $template = $this->_parse_phrases($template);
393 $template = $this->_parse_conditionals($template);
398 * Prepares language and locale information inside templates
402 * @param string Template data to be processed
404 * @return string Language-ready template data
406 function _parse_phrases($template)
408 $tag_start = '<lang ';
409 $tag_start_end = '\">';
410 $tag_end = '</lang>';
412 $location_start = -1;
415 // Process the empty phrase objects -- do this now so we don't have to worry about it when we're parsing later
416 $template = preg_replace('#\{@\\\"(.*?)\\\"\}#ie', '$this->_phrase_string(\'$1\')', $template);
420 // Find the start language object tag
421 $location_start = strpos($template, $tag_start, $location_end + 1);
422 if ($location_start === false)
428 $location_end = strpos($template, $tag_end, $location_end + strlen($tag_end));
429 if ($location_end === false)
434 // Extract the language object
435 $phrase_bunch = substr($template, $location_start, ($location_end + strlen($tag_end)) - $location_start);
437 // Find the close to the opening <lang>
438 $close_of_open = strpos($phrase_bunch, $tag_start_end);
439 if ($close_of_open === false)
444 // Extract the opening tag so it can be parsed
445 $init_tag = substr($phrase_bunch, 0, ($close_of_open + strlen($tag_start_end)));
446 $init_tag = str_replace($tag_start, '', $init_tag);
447 $init_tag = substr($init_tag, 0, strlen($init_tag) - 1);
449 // Get the args out of the tag
450 $args = preg_split('#([0-9].*?)=#', $init_tag);
451 foreach ($args AS $arg)
453 if ($arg AND $arg != ' ')
456 $arg = substr($arg, 2);
457 $arg = substr($arg, 0, strlen($arg) - 2);
462 // Just get the phrase name
463 $phrase_name = preg_replace('#<lang(.*?)>(.*?)</lang>#i', '$2', $phrase_bunch);
465 // Wrap the parsed data into the build function
466 $function_wrap = '" . ' . $this->langconst . '("' . /*str_replace(array('\"', "'"), array('"', "\'
"),*/ $phrase_name/*)*/ . '", "' . implode('", "', $arglist) . '") . "';
468 // Replace the fully-parsed string back into the template
469 $template = substr_replace($template, $function_wrap, $location_start, $location_end + strlen($tag_end) - $location_start);
478 * Turns a localized phrase tag into a function call
482 * @param string Phrase text
484 * @return string Function call for phrase text
486 function _phrase_string($text)
488 return '" . ' . $this->langcall . '(\'' . str_replace(array('\\\"
', "'"), array('"', "\'"), $text) . '\'
) . "';
492 * Parser for in-line template conditionals
496 * @param string Template data awaiting processing
498 * @return string Parsed template data
500 function _parse_conditionals($template)
503 $tag_start = '<if condition=\"';
504 $tag_start_end = '\">';
505 $tag_else = '<else />';
511 // the information about the current active tag
520 if (strpos($template, $tag_start) === false)
525 for ($i = $offset; $i < strlen($template); $i++)
527 // we've found ourselves a conditional!
528 if (substr($template, $i, strlen($tag_start)) == $tag_start)
530 // push the position into the tag stack
533 array_push($stack, $i);
537 $tag_full['posi'] = $i;
541 else if (substr($template, $i, strlen($tag_else)) == $tag_else)
543 if (count($stack) == 0 AND !isset($tag_full['else']))
545 $tag_full['else'] = $i;
548 // do we have an end tag?
549 else if (substr($template, $i, strlen($tag_end)) == $tag_end)
551 if (count($stack) != 0)
557 // calculate the position of the end tag
558 $tag_full['posf'] = $i + strlen($tag_end) - 1;
560 // extract the entire conditional from the template
561 $fullspread = substr($template, $tag_full['posi'], $tag_full['posf'] - $tag_full['posi'] + 1);
563 // remove the beginning tag
564 $conditional = substr($fullspread, strlen($tag_start));
566 // find the end of the expression
567 $temp_end = strpos($conditional, $tag_start_end);
569 // save the expression
570 $parsed[0] = stripslashes(substr($conditional, 0, $temp_end));
572 // remove the expression from the conditional
573 $conditional = substr($conditional, strlen($parsed[0]) + strlen($tag_start_end));
575 // remove the tailing end tag
576 $conditional = substr($conditional, 0, strlen($conditional) - strlen($tag_end));
579 if (isset($tag_full['else']))
581 // now relative to the start of the <if>
582 $relpos = $tag_full['else'] - $tag_full['posi'];
584 // calculate the length of the expression and opening tag
585 $length = strlen($parsed[0]) + strlen($tag_start) + strlen($tag_start_end);
587 // relative to the start of iftrue
588 $elsepos = $relpos - $length;
590 $parsed[1] = substr($conditional, 0, $elsepos);
591 $parsed[2] = substr($conditional, $elsepos + strlen($tag_else));
596 $parsed[1] = $conditional;
601 // final parsed output
602 $parsed = '" . ((' . stripslashes($parsed[0]) . ') ? "' . $parsed[1] . '" : "' . $parsed[2] . '") . "';
604 // replace the conditional
605 $template = str_replace($fullspread, $parsed, $template);
608 $offset = $tag_full['posi'] + strlen($tag_start) + strlen($tag_start_end);
612 unset($fullspread, $conditional, $temp_end, $relpos, $length, $elsepos);
623 * Debugging function used to print characters
624 * in a string that are around a certain position.
628 * @param string The haystack string
629 * @param integer Position to print around
631 function print_around($str, $pos)
633 echo '>>> PA >>>>>>>>[';
634 echo htmlspecialchars($str[ $pos - 5 ]);
635 echo htmlspecialchars($str[ $pos - 4 ]);
636 echo htmlspecialchars($str[ $pos - 3 ]);
637 echo htmlspecialchars($str[ $pos - 2 ]);
638 echo htmlspecialchars($str[ $pos - 1 ]);
640 echo htmlspecialchars($str[ $pos + 0 ]);
641 echo htmlspecialchars($str[ $pos + 1 ]);
642 echo htmlspecialchars($str[ $pos + 2 ]);
643 echo htmlspecialchars($str[ $pos + 3 ]);
644 echo htmlspecialchars($str[ $pos + 4 ]);
645 echo htmlspecialchars($str[ $pos + 5 ]);
646 echo ']<<<<<<<< PA <<<';
649 /*=====================================================================*\
650 || ###################################################################
653 || ###################################################################
654 \*=====================================================================*/