5 * This file contains an abstract (PHP 4, so "abstract" is relative)
6 * class meant to define the basic template interface for the
7 * SquirrelMail core application. Subclasses should extend this
8 * class with any custom functionality needed to interface a target
9 * templating engine with SquirrelMail.
11 * @copyright © 2003-2006 The SquirrelMail Project Team
12 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
14 * @package squirrelmail
15 * @subpackage Template
20 /** load template functions */
21 require(SM_PATH
. 'functions/template/general_util.php');
24 * The SquirrelMail Template class.
26 * Basic template class for capturing values and pluging them into a template.
27 * This class uses a similar API to Smarty.
29 * Methods that must be implemented by subclasses are as follows (see method
30 * stubs below for further information about expected behavior):
40 * @author Paul Lesniewski <paul at squirrelmail.org>
41 * @package squirrelmail
53 var $template_set_id = '';
56 * The template set base directory (relative path from
57 * the main SquirrelMail directory (SM_PATH))
62 var $template_dir = '';
65 * The template engine (please use constants defined in constants.php)
70 var $template_engine = '';
73 * The fall-back template ID
78 var $fallback_template_set_id = '';
81 * The fall-back template directory (relative
82 * path from the main SquirrelMail directory (SM_PATH))
87 var $fallback_template_dir = '';
90 * The fall-back template engine (please use
91 * constants defined in constants.php)
96 var $fallback_template_engine = '';
99 * Template file cache. Structured as an array, whose keys
100 * are all the template file names (with path information relative
101 * to the template set's base directory, e.g., "css/style.css")
102 * found in all parent template sets including the ultimate fall-back
103 * template set. Array values are sub-arrays with the
104 * following key-value pairs:
106 * PATH -- file path, relative to SM_PATH
107 * SET_ID -- the ID of the template set that this file belongs to
108 * ENGINE -- the engine needed to render this template file
111 var $template_file_cache = array();
114 * Extra template engine class objects for rendering templates
115 * that require a different engine than the one for the current
116 * template set. Keys should be the name of the template engine,
117 * values are the corresponding class objects.
122 var $other_template_engine_objects = array();
127 * Please do not call directly. Use Template::construct_template().
129 * @param string $template_set_id the template ID
132 function Template($template_set_id) {
133 //FIXME: find a way to test that this is ONLY ever called
134 // from the construct_template() method (I doubt it
135 // is worth the trouble to parse the current stack trace)
137 // trigger_error('Please do not use default Template() constructor. Instead, use Template::construct_template().', E_USER_ERROR);
139 $this->set_up_template($template_set_id);
146 * This method should always be called instead of trying
147 * to get a Template object from the normal/default constructor,
148 * and is necessary in order to control the return value.
150 * @param string $template_set_id the template ID
152 * @return object The correct Template object for the given template set
157 function construct_template($template_set_id) {
159 $template = new Template($template_set_id);
160 $template->override_plugins();
161 return $template->get_template_engine_subclass();
166 * Set up internal attributes
168 * This method does most of the work for setting up
169 * newly constructed objects.
171 * @param string $template_set_id the template ID
174 function set_up_template($template_set_id) {
176 // FIXME: do we want to place any restrictions on the ID like
177 // making sure no slashes included?
180 $this->template_set_id
= $template_set_id;
183 $this->fallback_template_set_id
= Template
::get_fallback_template_set();
186 // set up template directories
189 = Template
::calculate_template_file_directory($this->template_set_id
);
190 $this->fallback_template_dir
191 = Template
::calculate_template_file_directory($this->fallback_template_set_id
);
194 // determine template engine
195 // FIXME: assuming PHP template engine may not necessarily be a good thing
197 $this->template_engine
= Template
::get_template_config($this->template_set_id
,
202 // get template file cache
204 $this->template_file_cache
= Template
::cache_template_file_hierarchy();
209 * Determine what the ultimate fallback template set is.
211 * NOTE that if the fallback setting cannot be found in the
212 * main SquirrelMail configuration settings that the value
213 * of $default is returned.
215 * @param string $default The template set ID to use if
216 * the fallback setting cannot be
217 * found in SM config (optional;
218 * defaults to "default").
220 * @return string The ID of the fallback template set.
225 function get_fallback_template_set($default='default') {
227 // FIXME: do we want to place any restrictions on the ID such as
228 // making sure no slashes included?
230 // values are in main SM config file
232 global $templateset_fallback, $aTemplateSet;
233 $aTemplateSet = (!isset($aTemplateSet) ||
!is_array($aTemplateSet)
234 ?
array() : $aTemplateSet);
235 $templateset_fallback = (!isset($templateset_fallback)
236 ?
$default : $templateset_fallback);
238 // iterate through all template sets, is this a valid skin ID?
241 foreach ($aTemplateSet as $aTemplate) {
242 if ($aTemplate['ID'] === $templateset_fallback) {
249 return $templateset_fallback;
251 // FIXME: note that it is possible for $default to
252 // point to an invalid (nonexistent) template set
253 // and that error will not be caught here
260 * Determine what the default template set is.
262 * NOTE that if the default setting cannot be found in the
263 * main SquirrelMail configuration settings that the value
264 * of $default is returned.
266 * @param string $default The template set ID to use if
267 * the default setting cannot be
268 * found in SM config (optional;
269 * defaults to "default").
271 * @return string The ID of the default template set.
276 function get_default_template_set($default='default') {
278 // FIXME: do we want to place any restrictions on the ID such as
279 // making sure no slashes included?
281 // values are in main SM config file
283 global $templateset_default, $aTemplateSet;
284 $aTemplateSet = (!isset($aTemplateSet) ||
!is_array($aTemplateSet)
285 ?
array() : $aTemplateSet);
286 $templateset_default = (!isset($templateset_default)
287 ?
$default : $templateset_default);
289 // iterate through all template sets, is this a valid skin ID?
292 foreach ($aTemplateSet as $aTemplate) {
293 if ($aTemplate['ID'] === $templateset_default) {
300 return $templateset_default;
302 // FIXME: note that it is possible for $default to
303 // point to an invalid (nonexistent) template set
304 // and that error will not be caught here
311 * Allow template set to override plugin configuration by either
312 * adding or removing plugins.
315 function override_plugins() {
317 global $disable_plugins, $plugins, $squirrelmail_plugin_hooks;
318 if ($disable_plugins) return;
320 $add_plugins = Template
::get_template_config($this->template_set_id
,
321 'add_plugins', array());
322 $remove_plugins = Template
::get_template_config($this->template_set_id
,
323 'remove_plugins', array());
325 //FIXME (?) we assume $add_plugins and $remove_plugins are arrays -- we could
326 // error check here, or just assume that template authors or admins
327 // won't screw up their config files
330 // disable all plugins? (can still add some by using $add_plugins)
332 if (in_array('*', $remove_plugins)) {
334 $squirrelmail_plugin_hooks = array();
335 $remove_plugins = array();
339 foreach ($add_plugins as $plugin_name) {
340 // add plugin to global plugin array
342 $plugins[] = $plugin_name;
345 // enable plugin -- emulate code from use_plugin() function
346 // in SquirrelMail core, but also need to call the
347 // "squirrelmail_plugin_init_<plugin_name>" function, which
348 // in static configuration is not called (this inconsistency
349 // could be a source of anomalous-seeming bugs in poorly
352 if (file_exists(SM_PATH
. "plugins/$plugin_name/setup.php")) {
353 include_once(SM_PATH
. "plugins/$plugin_name/setup.php");
355 $function = "squirrelmail_plugin_init_$plugin_name";
356 if (function_exists($function))
361 foreach ($remove_plugins as $plugin_name) {
362 // remove plugin from both global plugin & plugin hook arrays
364 $plugin_key = array_search($plugin_name, $plugins);
365 if (!is_null($plugin_key) && $plugin_key !== FALSE) {
366 unset($plugins[$plugin_key]);
367 if (is_array($squirrelmail_plugin_hooks))
368 foreach (array_keys($squirrelmail_plugin_hooks) as $hookName) {
369 unset($squirrelmail_plugin_hooks[$hookName][$plugin_name]);
377 * Instantiate and return correct subclass for this template
378 * set's templating engine.
380 * @param string $template_set_id The template set whose engine
381 * is to be used as an override
382 * (if not given, this template
383 * set's engine is used) (optional).
385 * @return object The Template subclass object for the template engine.
388 function get_template_engine_subclass($template_set_id='') {
390 if (empty($template_set_id)) $template_set_id = $this->template_set_id
;
391 // FIXME: assuming PHP template engine may not necessarily be a good thing
392 $engine = Template
::get_template_config($template_set_id,
393 'template_engine', SQ_PHP_TEMPLATE
);
396 $engine_class_file = SM_PATH
. 'class/template/'
397 . $engine . 'Template.class.php';
399 if (!file_exists($engine_class_file)) {
400 trigger_error('Unknown template engine (' . $engine
401 . ') was specified in template configuration file',
405 $engine_class = $engine . 'Template';
406 require_once($engine_class_file);
407 return new $engine_class($template_set_id);
412 * Determine the relative template directory path for
413 * the given template ID.
415 * @param string $template_set_id The template ID from which to build
418 * @return string The relative template path (based off of SM_PATH)
423 function calculate_template_file_directory($template_set_id) {
425 return 'templates/' . $template_set_id . '/';
430 * Determine the relative images directory path for
431 * the given template ID.
433 * @param string $template_set_id The template ID from which to build
436 * @return string The relative images path (based off of SM_PATH)
441 function calculate_template_images_directory($template_set_id) {
443 return 'templates/' . $template_set_id . '/images/';
448 * Return the relative template directory path for this template set.
450 * @return string The relative path to the template directory based
451 * from the main SquirrelMail directory (SM_PATH).
454 function get_template_file_directory() {
456 return $this->template_dir
;
461 * Return the template ID for the fallback template set.
463 * @return string The ID of the fallback template set.
466 function get_fallback_template_set_id() {
468 return $this->fallback_template_set_id
;
473 * Return the relative template directory path for the
474 * fallback template set.
476 * @return string The relative path to the fallback template
477 * directory based from the main SquirrelMail
478 * directory (SM_PATH).
481 function get_fallback_template_file_directory() {
483 return $this->fallback_template_dir
;
488 * Get template set config setting
490 * Given a template set ID and setting name, returns the
491 * setting's value. Note that settings are cached in
492 * session, so "live" changes to template configuration
493 * won't be reflected until the user logs out and back
496 * @param string $template_set_id The template set for which
497 * to look up the setting.
498 * @param string $setting The name of the setting to
500 * @param mixed $default When the requested setting
501 * is not found, the contents
502 * of this value are returned
503 * instead (optional; default
505 * NOTE that unlike sqGetGlobalVar(),
506 * this function will also return
507 * the default value if the
508 * requested setting is found
510 * @param boolean $live_config When TRUE, the target template
511 * set's configuration file is
512 * reloaded every time this
513 * method is called. Default
514 * behavior is to only load the
515 * configuration file if it had
516 * never been loaded before, but
517 * not again after that (optional;
518 * default FALSE). Use with care!
519 * Should mostly be used for
522 * @return mixed The desired setting's value or if not found,
523 * the contents of $default are returned.
528 function get_template_config($template_set_id, $setting,
529 $default=NULL, $live_config=FALSE) {
531 sqGetGlobalVar('template_configuration_settings',
532 $template_configuration_settings,
536 if ($live_config) unset($template_configuration_settings[$template_set_id]);
539 // NOTE: could use isset() instead of empty() below, but
540 // this function is designed to replace empty values
541 // as well as non-existing values with $default
543 if (!empty($template_configuration_settings[$template_set_id][$setting]))
544 return $template_configuration_settings[$template_set_id][$setting];
547 // if template set configuration has been loaded, but this
548 // setting is not known, return $default
550 if (!empty($template_configuration_settings[$template_set_id]))
554 // otherwise (template set configuration has not been loaded before),
555 // load it into session and return the desired setting after that
557 $template_config_file = SM_PATH
558 . Template
::calculate_template_file_directory($template_set_id)
561 if (!file_exists($template_config_file)) {
563 trigger_error('No template configuration file was found where expected: ("'
564 . $template_config_file . '")', E_USER_ERROR
);
568 // we require() the file to let PHP do the variable value
569 // parsing for us, and read the file in manually so we can
570 // know what variable names are used in the config file
571 // (settings can be different depending on specific requirements
572 // of different template engines)... the other way this may
573 // be accomplished is to somehow diff the symbol table
574 // before/after the require(), but anyway, this code should
575 // only run once for this template set...
577 require($template_config_file);
578 $file_contents = implode("\n", file($template_config_file));
581 // note that this assumes no template settings have
582 // a string in them that looks like a variable name like $x
583 // also note that this will attempt to grab things like
584 // $Id found in CVS headers, so we try to adjust for that
585 // by checking that the variable is actually set
587 preg_match_all('/\$(\w+)/', $file_contents, $variables, PREG_PATTERN_ORDER
);
588 foreach ($variables[1] as $variable) {
589 if (isset($
$variable))
590 $template_configuration_settings[$template_set_id][$variable]
594 sqsession_register($template_configuration_settings,
595 'template_configuration_settings');
597 // NOTE: could use isset() instead of empty() below, but
598 // this function is designed to replace empty values
599 // as well as non-existing values with $default
601 if (!empty($template_configuration_settings[$template_set_id][$setting]))
602 return $template_configuration_settings[$template_set_id][$setting];
611 * Obtain template file hierarchy from cache.
613 * If the file hierarchy does not exist in session, it is
614 * constructed and stored in session before being returned
617 * @param boolean $regenerate_cache When TRUE, the file hierarchy
618 * is reloaded and stored fresh
619 * (optional; default FALSE).
620 * @param array $additional_files Must be in same form as the
621 * files in the file hierarchy
622 * cache. These are then added
623 * to the cache (optional; default
624 * empty - no additional files).
626 * @return array Template file hierarchy array, whose keys
627 * are all the template file names (with path
628 * information relative to the template set's
629 * base directory, e.g., "css/style.css")
630 * found in all parent template sets including
631 * the ultimate fall-back template set.
632 * Array values are sub-arrays with the
633 * following key-value pairs:
635 * PATH -- file path, relative to SM_PATH
636 * SET_ID -- the ID of the template set that this file belongs to
637 * ENGINE -- the engine needed to render this template file
642 function cache_template_file_hierarchy($regenerate_cache=FALSE,
643 $additional_files=array()) {
645 sqGetGlobalVar('template_file_hierarchy', $template_file_hierarchy,
646 SQ_SESSION
, array());
649 if ($regenerate_cache) unset($template_file_hierarchy);
651 if (!empty($template_file_hierarchy)) {
653 // have to add additional files if given before returning
655 if (!empty($additional_files)) {
656 $template_file_hierarchy = array_merge($template_file_hierarchy,
658 sqsession_register($template_file_hierarchy,
659 'template_file_hierarchy');
662 return $template_file_hierarchy;
666 // nothing in cache apparently, so go build it now
668 // FIXME: not sure if there is any possibility that
669 // this could be called when $sTemplateID has
670 // yet to be defined... throw error for now,
671 // but if the error occurs, it's a coding error
672 // rather than a configuration error
675 if (empty($sTemplateID)) {
677 trigger_error('Template set ID unknown', E_USER_ERROR
);
681 $template_file_hierarchy = Template
::catalog_template_files($sTemplateID);
683 // additional files, if any
685 if (!empty($additional_files)) {
686 $template_file_hierarchy = array_merge($template_file_hierarchy,
690 sqsession_register($template_file_hierarchy,
691 'template_file_hierarchy');
693 return $template_file_hierarchy;
700 * Traverse template hierarchy and catalogue all template
701 * files (for storing in cache).
703 * Paths to all files in all parent, grand-parent, great grand
704 * parent, etc. template sets (including the fallback template)
705 * are catalogued; for identically named files, the file earlier
706 * in the hierarchy (closest to this template set) is used.
708 * @param string $template_set_id The template set in which to
710 * @param array $file_list The file list so far to be added
711 * to (allows recursive behavior)
712 * (optional; default empty array).
713 * @param string $directory The directory in which to search for
714 * files (must be given as full path).
715 * If empty, starts at top-level template
716 * set directory (optional; default empty).
717 * NOTE! Use with care, as behavior is
718 * unpredictable if directory given is not
719 * part of correct template set.
721 * @return mixed The top-level caller will have an array of template
722 * files returned to it; recursive calls to this function
723 * do not receive any return value at all. The format
724 * of the template file array is as described for the
725 * Template class attribute $template_file_cache
730 function catalog_template_files($template_set_id, $file_list=array(), $directory='') {
732 $template_base_dir = SM_PATH
733 . Template
::calculate_template_file_directory($template_set_id);
735 if (empty($directory)) {
736 $directory = $template_base_dir;
739 $files_and_dirs = list_files($directory, '', FALSE, TRUE, FALSE, TRUE);
741 // recurse for all the subdirectories in the template set
743 foreach ($files_and_dirs['DIRECTORIES'] as $dir) {
744 $file_list = Template
::catalog_template_files($template_set_id, $file_list, $dir);
747 // place all found files in the cache
748 // FIXME: assuming PHP template engine may not necessarily be a good thing
750 $engine = Template
::get_template_config($template_set_id,
751 'template_engine', SQ_PHP_TEMPLATE
);
752 foreach ($files_and_dirs['FILES'] as $file) {
754 // remove the part of the file path corresponding to the
755 // template set's base directory
757 $relative_file = substr($file, strlen($template_base_dir));
760 * only put file in cache if not already found in earlier template
761 * PATH should be relative to SquirrelMail top directory
763 if (!isset($file_list[$relative_file])) {
764 $file_list[$relative_file] = array(
765 'PATH' => substr($file,strlen(SM_PATH
)),
766 'SET_ID' => $template_set_id,
774 // now if we are currently at the top-level of the template
775 // set base directory, we need to move on to the parent
776 // template set, if any
778 if ($directory == $template_base_dir) {
780 // use fallback when we run out of parents
782 $fallback_id = Template
::get_fallback_template_set();
783 $parent_id = Template
::get_template_config($template_set_id,
784 'parent_template_set',
787 // were we already all the way to the last level? just exit
789 // note that this code allows the fallback set to have
790 // a parent, too, but can result in endless loops
791 // if ($parent_id == $template_set_id) {
793 if ($fallback_id == $template_set_id) {
797 $file_list = Template
::catalog_template_files($parent_id, $file_list);
806 * Look for a template file in a plugin; add to template
807 * file cache if found.
809 * The file is searched for in the following order:
811 * - A directory for the current template set within the plugin:
812 * SM_PATH/plugins/<plugin name>/templates/<template name>/
813 * - In a directory for one of the current template set's ancestor
814 * (inherited) template sets within the plugin:
815 * SM_PATH/plugins/<plugin name>/templates/<parent template name>/
816 * - In a directory for the fallback template set within the plugin:
817 * SM_PATH/plugins/<plugin name>/templates/<fallback template name>/
819 * @param string $plugin The name of the plugin
820 * @param string $file The name of the template file
821 * @param string $template_set_id The ID of the template for which
822 * to start looking for the file
823 * (optional; default is current
826 * @return boolean TRUE if the template file was found, FALSE otherwise.
829 function find_and_cache_plugin_template_file($plugin, $file, $template_set_id='') {
831 if (empty($template_set_id))
832 $template_set_id = $this->template_set_id
;
834 $file_path = SM_PATH
. 'plugins/' . $plugin . '/'
835 . $this->calculate_template_file_directory($template_set_id)
838 if (file_exists($file_path)) {
839 // FIXME: assuming PHP template engine may not necessarily be a good thing
840 $engine = $this->get_template_config($template_set_id,
841 'template_engine', SQ_PHP_TEMPLATE
);
842 $file_list = array('plugins/' . $plugin . '/' . $file => array(
843 'PATH' => substr($file_path, strlen(SM_PATH
)),
844 'SET_ID' => $template_set_id,
848 $this->template_file_cache
849 = $this->cache_template_file_hierarchy(FALSE, $file_list);
854 // not found yet, try parent template set
855 // (use fallback when we run out of parents)
857 $fallback_id = $this->get_fallback_template_set();
858 $parent_id = $this->get_template_config($template_set_id,
859 'parent_template_set',
862 // were we already all the way to the last level? just exit
864 // note that this code allows the fallback set to have
865 // a parent, too, but can result in endless loops
866 // if ($parent_id == $template_set_id) {
868 if ($fallback_id == $template_set_id) {
872 return $this->find_and_cache_plugin_template_file($plugin, $file, $parent_id);
877 * Find the right template file.
879 * The template file is taken from the template file cache, thus
880 * the file is taken from the current template, one of its
881 * ancestors or the fallback template.
883 * Note that it is perfectly acceptable to load template files from
884 * template subdirectories. For example, JavaScript templates found
885 * in the js/ subdirectory would be loaded by passing
886 * "js/<javascript file name>" as the $filename.
888 * Note that the caller can also ask for ALL files in a directory
889 * (and those in the same directory for all ancestor template sets)
890 * by giving a $filename that is a directory name (ending with a
893 * If not found and the file is a plugin template file (indicated
894 * by the presence of "plugins/" on the beginning of $filename),
895 * the target plugin is searched for a substitue template file
896 * before just returning nothing.
898 * Plugin authors must note that the $filename MUST be prefaced
899 * with "plugins/<plugin name>/" in order to correctly resolve the
902 * @param string $filename The name of the template file,
903 * possibly prefaced with
904 * "plugins/<plugin name>/"
905 * indicating that it is a plugin
906 * template, or ending with a
907 * slash, indicating that all files
908 * for that directory name should
910 * @param boolean $directories_ok When TRUE, directory names
911 * are acceptable search values,
912 * and when returning a list of
913 * directory contents, sub-directory
914 * names will also be included
915 * (optional; default FALSE).
916 * NOTE that empty directories
917 * are NOT included in the cache!
918 * @param boolean $directories_only When TRUE, only directory names
919 * are included in the returned
920 * results. (optional; default
921 * FALSE). Setting this argument
922 * to TRUE forces $directories_ok
924 * NOTE that empty directories
925 * are NOT included in the cache!
927 * @return mixed The full path to the template file or a list
928 * of all files in the given directory if $filename
929 * ends with a slash; if not found, an empty string
930 * is returned. The caller is responsible for
931 * throwing errors or other actions if template
935 function get_template_file_path($filename,
936 $directories_ok=FALSE,
937 $directories_only=FALSE) {
939 if ($directories_only) $directories_ok = TRUE;
942 // only looking for directory listing first...
944 // return list of all files in a directory (and that
947 if ($filename{strlen($filename) - 1} == '/') {
949 $return_array = array();
950 foreach ($this->template_file_cache
as $file => $file_info) {
952 // only want files in the requested directory
953 // (AND not in a subdirectory!)
955 if (!$directories_only && strpos($file, $filename) === 0
956 && strpos($file, '/', strlen($filename)) === FALSE)
957 $return_array[] = SM_PATH
. $file_info['PATH'];
959 // directories too? detect by finding any
960 // array key that matches a file in a sub-directory
961 // of the directory being processed
963 if ($directories_ok && strpos($file, $filename) === 0
964 && ($pos = strpos($file, '/', strlen($filename))) !== FALSE
965 && strpos($file, '/', $pos +
1) === FALSE) {
966 $directory_name = SM_PATH
967 . substr($file_info['PATH'],
969 strrpos($file_info['PATH'], '/'));
970 if (!in_array($directory_name, $return_array))
971 $return_array[] = $directory_name;
975 return $return_array;
980 // just looking for singular file or directory below...
982 // figure out what to do with files not found
984 if ($directories_only ||
empty($this->template_file_cache
[$filename]['PATH'])) {
986 // if looking for directories...
987 // have to iterate through cache and detect
988 // directory by matching any file inside of it
990 if ($directories_ok) {
991 foreach ($this->template_file_cache
as $file => $file_info) {
992 if (strpos($file, $filename) === 0
993 && ($pos = strpos($file, '/', strlen($filename))) !== FALSE
994 && strpos($file, '/', $pos +
1) === FALSE) {
995 return SM_PATH
. substr($file_info['PATH'],
997 strrpos($file_info['PATH'], '/'));
1001 if ($directories_only) return '';
1004 // plugins get one more chance
1006 if (strpos($filename, 'plugins/') === 0) {
1008 $plugin_name = substr($filename, 8, strpos($filename, '/', 8) - 8);
1009 $file = substr($filename, strlen($plugin_name) +
9);
1011 if (!$this->find_and_cache_plugin_template_file($plugin_name, $file))
1013 //FIXME: technically I guess we should check for directories
1014 // here too, but that's overkill (no need) presently
1015 // (plugin-provided alternate stylesheet dirs?!? bah.)
1019 // nothing... return empty string (yes, the else is intentional!)
1025 return SM_PATH
. $this->template_file_cache
[$filename]['PATH'];
1030 * Get template engine needed to render given template file.
1032 * If at all possible, just returns a reference to $this, but
1033 * some template files may require a different engine, thus
1034 * an object for that engine (which will subsequently be kept
1035 * in this object for future use) is returned.
1037 * @param string $filename The name of the template file,
1039 * @return object The needed template object to render the template.
1042 function get_rendering_template_engine_object($filename) {
1044 // for files that we cannot find engine info for,
1045 // just return $this
1047 if (empty($this->template_file_cache
[$filename]['ENGINE']))
1051 // otherwise, compare $this' engine to the file's engine
1053 $engine = $this->template_file_cache
[$filename]['ENGINE'];
1054 if ($this->template_engine
== $engine)
1058 // need to load another engine... if already instantiated,
1059 // and stored herein, return that
1060 // FIXME: this assumes same engine setup in all template
1061 // set config files that have same engine in common
1062 // (but keeping a separate class object for every
1063 // template set seems like overkill... for now we
1064 // won't do that unless it becomes a problem)
1066 if (!empty($this->other_template_engine_objects
[$engine])) {
1067 $rendering_engine = $this->other_template_engine_objects
[$engine];
1070 // otherwise, instantiate new engine object, add to cache
1074 $template_set_id = $this->template_file_cache
[$filename]['SET_ID'];
1075 $this->other_template_engine_objects
[$engine]
1076 = $this->get_template_engine_subclass($template_set_id);
1077 $rendering_engine = $this->other_template_engine_objects
[$engine];
1081 // now, need to copy over all the assigned variables
1082 // from $this to the rendering engine (YUCK! -- we need
1083 // to discourage template authors from creating
1084 // situations where engine changes occur)
1086 $rendering_engine->clear_all_assign();
1087 $rendering_engine->assign($this->get_template_vars());
1090 // finally ready to go
1092 return $rendering_engine;
1097 * Return all JavaScript files provided by the template.
1099 * All files found in the template set's "js" directory (and
1100 * that of its ancestors) with the extension ".js" are returned.
1102 * @param boolean $full_path When FALSE, only the file names
1103 * are included in the return array;
1104 * otherwise, path information is
1105 * included (relative to SM_PATH)
1106 * (OPTIONAL; default only file names)
1108 * @return array The required file names/paths.
1111 function get_javascript_includes($full_path=FALSE) {
1113 // since any page from a parent template set
1114 // could end up being loaded, we have to load
1115 // all js files from ancestor template sets,
1116 // not just this set
1118 //$directory = SM_PATH . $this->get_template_file_directory() . 'js';
1119 //$js_files = list_files($directory, '.js', !$full_path);
1121 $js_files = $this->get_template_file_path('js/');
1124 // parse out .js files only
1126 $return_array = array();
1127 foreach ($js_files as $file) {
1129 if (substr($file, strlen($file) - 3) != '.js') continue;
1132 $return_array[] = $file;
1134 $return_array[] = basename($file);
1139 return $return_array;
1144 * Return all alternate stylesheets provided by template.
1146 * All (non-empty) directories found in the template set's
1147 * "css/alternates" directory (and that of its ancestors)
1150 * Note that prettified names are constructed herein by
1151 * taking the directory name, changing underscores to spaces
1152 * and capitalizing each word in the resultant name.
1154 * @param boolean $full_path When FALSE, only the file names
1155 * are included in the return array;
1156 * otherwise, path information is
1157 * included (relative to SM_PATH)
1158 * (OPTIONAL; default only file names)
1160 * @return array A list of the available alternate stylesheets,
1161 * where the keys are the file names (formatted
1162 * according to $full_path) for the stylesheets,
1163 * and the values are the prettified version of
1164 * the file names for display to the user.
1167 function get_alternative_stylesheets($full_path=FALSE) {
1169 // since any page from a parent template set
1170 // could end up being loaded, we will load
1171 // all alternate css files from ancestor
1172 // template sets, not just this set
1174 $css_directories = $this->get_template_file_path('css/alternates/', TRUE, TRUE);
1179 $return_array = array();
1180 foreach ($css_directories as $directory) {
1182 // CVS directories are not wanted
1184 if (strpos($directory, '/CVS') === strlen($directory) - 4) continue;
1186 $pretty_name = ucwords(str_replace('_', ' ', basename($directory)));
1189 $return_array[$directory] = $pretty_name;
1191 $return_array[basename($directory)] = $pretty_name;
1196 return $return_array;
1201 * Return all standard stylsheets provided by the template.
1203 * All files found in the template set's "css" directory (and
1204 * that of its ancestors) with the extension ".css" except
1205 * "rtl.css" (which is dealt with separately) are returned.
1207 * @param boolean $full_path When FALSE, only the file names
1208 * are included in the return array;
1209 * otherwise, path information is
1210 * included (relative to SM_PATH)
1211 * (OPTIONAL; default only file names)
1213 * @return array The required file names/paths.
1216 function get_stylesheets($full_path=FALSE) {
1218 // since any page from a parent template set
1219 // could end up being loaded, we have to load
1220 // all css files from ancestor template sets,
1221 // not just this set
1223 //$directory = SM_PATH . $this->get_template_file_directory() . 'css';
1224 //$css_files = list_files($directory, '.css', !$full_path);
1226 $css_files = $this->get_template_file_path('css/');
1229 // need to leave out "rtl.css"
1231 $return_array = array();
1232 foreach ($css_files as $file) {
1234 if (substr($file, strlen($file) - 4) != '.css') continue;
1235 if (strtolower(basename($file)) == 'rtl.css') continue;
1238 $return_array[] = $file;
1240 $return_array[] = basename($file);
1246 // return sheets for the current template set
1247 // last so we can enable any custom overrides
1248 // of styles in ancestor sheets
1250 return array_reverse($return_array);
1255 * Generate links to all this template set's standard stylesheets
1257 * Subclasses can override this function if stylesheets are
1258 * created differently for the template set's target output
1261 * @return string The stylesheet links as they should be sent
1265 function fetch_standard_stylesheet_links()
1268 $sheets = $this->get_stylesheets(TRUE);
1269 return $this->fetch_external_stylesheet_links($sheets);
1274 * Push out any other stylesheet links as provided (for
1275 * stylesheets not included with the current template set)
1277 * Subclasses can override this function if stylesheets are
1278 * created differently for the template set's target output
1281 * @param mixed $sheets List of the desired stylesheets
1282 * (file path to be used in stylesheet
1283 * href attribute) to output (or single
1284 * stylesheet file path).
1285 FIXME: We could make the incoming array more complex so it can
1286 also contain the other parameters for create_css_link()
1287 such as $name, $alt, $mtype, and $xhtml_end
1290 * @return string The stylesheet links as they should be sent
1294 function fetch_external_stylesheet_links($sheets)
1297 if (!is_array($sheets)) $sheets = array($sheets);
1300 foreach ($sheets as $sheet) {
1301 $output .= create_css_link($sheet);
1309 * Send HTTP header(s) to browser.
1311 * Subclasses can override this function if headers are
1312 * managed differently in the template set's target output
1315 * @param mixed $headers A list of (or a single) header
1319 function header($headers)
1322 if (!is_array($headers)) $headers = array($headers);
1324 foreach ($headers as $header) {
1331 * Generate a link to the right-to-left stylesheet for
1332 * this template set by getting the "rtl.css" file from
1333 * this template set, its parent (or grandparent, etc.)
1334 * template set, the fall-back template set, or finally,
1335 * fall back to SquirrelMail's own "rtl.css" if need be.
1337 * Subclasses can override this function if stylesheets are
1338 * created differently for the template set's target output
1341 * @return string The stylesheet link as it should be sent
1345 function fetch_right_to_left_stylesheet_link()
1348 // get right template file
1350 $sheet = $this->get_template_file_path('css/rtl.css');
1352 // fall back to SquirrelMail's own default stylesheet
1354 if (empty($sheet)) {
1355 $sheet = SM_PATH
. 'css/rtl.css';
1358 return create_css_link($sheet);
1363 * Display the template
1365 * @param string $file The template file to use
1368 function display($file)
1371 echo $this->fetch($file);
1376 * Applies the template and returns the resultant content string.
1378 * @param string $file The template file to use
1380 * @return string The template contents after applying the given template
1383 function fetch($file) {
1385 // get right template file
1387 $template = $this->get_template_file_path($file);
1390 // special case stylesheet.tpl falls back to SquirrelMail's
1391 // own default stylesheet
1393 if (empty($template) && $file == 'css/stylesheet.tpl') {
1394 $template = SM_PATH
. 'css/default.css';
1398 if (empty($template)) {
1400 trigger_error('The template "' . htmlspecialchars($file)
1401 . '" could not be fetched!', E_USER_ERROR
);
1405 $aPluginOutput = array();
1406 // At this moment concat_hook_function can return string and arrays.
1407 // In php 4.3.x a notice will be raised when a string is passed as $aPluginOutput
1408 // TODO, only return an arrays by concat_hook_function.
1409 $mixedOutput = concat_hook_function('template_construct_' . $file,
1410 $temp=array(&$aPluginOutput, &$this));
1411 if (is_array($mixedOutput)) {
1412 $aPluginOutput = $mixedOutput;
1414 $this->assign('plugin_output', $aPluginOutput);
1416 //$output = $this->apply_template($template);
1417 $rendering_engine = $this->get_rendering_template_engine_object($file);
1418 $output = $rendering_engine->apply_template($template);
1420 // CAUTION: USE OF THIS HOOK IS HIGHLY DISCOURAGED AND CAN
1421 // RESULT IN NOTICABLE PERFORMANCE DEGREDATION. Plugins
1422 // using this hook will probably be rejected by the
1423 // SquirrelMail team.
1425 do_hook('template_output', $output);
1434 * Assigns values to template variables
1436 * Note: this is an abstract method that must be implemented by subclass.
1438 * @param array|string $tpl_var the template variable name(s)
1439 * @param mixed $value the value to assign
1442 function assign($tpl_var, $value = NULL) {
1444 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the assign() method.', E_USER_ERROR
);
1449 * Assigns values to template variables by reference
1451 * Note: this is an abstract method that must be implemented by subclass.
1453 * @param string $tpl_var the template variable name
1454 * @param mixed $value the referenced value to assign
1457 function assign_by_ref($tpl_var, &$value) {
1459 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the assign_by_ref() method.', E_USER_ERROR
);
1464 * Clears the values of all assigned varaiables.
1467 function clear_all_assign() {
1469 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the clear_all_assign() method.', E_USER_ERROR
);
1474 * Returns assigned variable value(s).
1476 * @param string $varname If given, the value of that variable
1477 * is returned, assuming it has been
1478 * previously assigned. If not specified
1479 * an array of all assigned variables is
1480 * returned. (optional)
1482 * @return mixed Desired single variable value or list of all
1483 * assigned variable values.
1486 function get_template_vars($varname=NULL) {
1488 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the get_template_vars() method.', E_USER_ERROR
);
1493 * Appends values to template variables
1495 * Note: this is an abstract method that must be implemented by subclass.
1497 * @param array|string $tpl_var the template variable name(s)
1498 * @param mixed $value the value to append
1499 * @param boolean $merge when $value is given as an array,
1500 * this indicates whether or not that
1501 * array itself should be appended as
1502 * a new template variable value or if
1503 * that array's values should be merged
1504 * into the existing array of template
1508 function append($tpl_var, $value = NULL, $merge = FALSE) {
1510 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the append() method.', E_USER_ERROR
);
1515 * Appends values to template variables by reference
1517 * Note: this is an abstract method that must be implemented by subclass.
1519 * @param string $tpl_var the template variable name
1520 * @param mixed $value the referenced value to append
1521 * @param boolean $merge when $value is given as an array,
1522 * this indicates whether or not that
1523 * array itself should be appended as
1524 * a new template variable value or if
1525 * that array's values should be merged
1526 * into the existing array of template
1530 function append_by_ref($tpl_var, &$value, $merge = FALSE) {
1532 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the append_by_ref() method.', E_USER_ERROR
);
1537 * Applys the template and generates final output destined
1538 * for the user's browser
1540 * Note: this is an abstract method that must be implemented by subclass.
1542 * @param string $filepath The full file path to the template to be applied
1544 * @return string The output for the given template
1547 function apply_template($filepath) {
1549 trigger_error('Template subclass (' . $this->template_engine
. 'Template.class.php) needs to implement the apply_template() method.', E_USER_ERROR
);