diff options
Diffstat (limited to 'webmail/program/include/rcube_html_page.php')
| -rw-r--r-- | webmail/program/include/rcube_html_page.php | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/webmail/program/include/rcube_html_page.php b/webmail/program/include/rcube_html_page.php new file mode 100644 index 0000000..fffe490 --- /dev/null +++ b/webmail/program/include/rcube_html_page.php @@ -0,0 +1,323 @@ +<?php + +/* + +-----------------------------------------------------------------------+ + | program/include/rcube_html_page.php | + | | + | This file is part of the Roundcube PHP suite | + | Copyright (C) 2005-2011 The Roundcube Dev Team | + | | + | Licensed under the GNU General Public License version 3 or | + | any later version with exceptions for skins & plugins. | + | See the README file for a full license statement. | + | | + | CONTENTS: | + | Class to build XHTML page output | + | | + +-----------------------------------------------------------------------+ + | Author: Thomas Bruederli <roundcube@gmail.com> | + +-----------------------------------------------------------------------+ + + $Id$ + +*/ + +/** + * Class for HTML page creation + * + * @package HTML + */ +class rcube_html_page +{ + protected $scripts_path = ''; + protected $script_files = array(); + protected $css_files = array(); + protected $scripts = array(); + protected $charset = RCMAIL_CHARSET; + protected $default_template = "<html>\n<head><title></title></head>\n<body></body>\n</html>"; + + protected $title = ''; + protected $header = ''; + protected $footer = ''; + protected $body = ''; + protected $base_path = ''; + + + /** Constructor */ + public function __construct() {} + + /** + * Link an external script file + * + * @param string File URL + * @param string Target position [head|foot] + */ + public function include_script($file, $position='head') + { + static $sa_files = array(); + + if (!preg_match('|^https?://|i', $file) && $file[0] != '/') { + $file = $this->scripts_path . $file; + if ($fs = @filemtime($file)) { + $file .= '?s=' . $fs; + } + } + + if (in_array($file, $sa_files)) { + return; + } + + $sa_files[] = $file; + + if (!is_array($this->script_files[$position])) { + $this->script_files[$position] = array(); + } + + $this->script_files[$position][] = $file; + } + + /** + * Add inline javascript code + * + * @param string JS code snippet + * @param string Target position [head|head_top|foot] + */ + public function add_script($script, $position='head') + { + if (!isset($this->scripts[$position])) { + $this->scripts[$position] = "\n" . rtrim($script); + } + else { + $this->scripts[$position] .= "\n" . rtrim($script); + } + } + + /** + * Link an external css file + * + * @param string File URL + */ + public function include_css($file) + { + $this->css_files[] = $file; + } + + /** + * Add HTML code to the page header + * + * @param string $str HTML code + */ + public function add_header($str) + { + $this->header .= "\n" . $str; + } + + /** + * Add HTML code to the page footer + * To be added right befor </body> + * + * @param string $str HTML code + */ + public function add_footer($str) + { + $this->footer .= "\n" . $str; + } + + /** + * Setter for page title + * + * @param string $t Page title + */ + public function set_title($t) + { + $this->title = $t; + } + + /** + * Setter for output charset. + * To be specified in a meta tag and sent as http-header + * + * @param string $charset Charset + */ + public function set_charset($charset) + { + $this->charset = $charset; + } + + /** + * Getter for output charset + * + * @return string Output charset + */ + public function get_charset() + { + return $this->charset; + } + + /** + * Reset all saved properties + */ + public function reset() + { + $this->script_files = array(); + $this->scripts = array(); + $this->title = ''; + $this->header = ''; + $this->footer = ''; + $this->body = ''; + } + + /** + * Process template and write to stdOut + * + * @param string HTML template + * @param string Base for absolute paths + */ + public function write($templ='', $base_path='') + { + $output = empty($templ) ? $this->default_template : trim($templ); + + // set default page title + if (empty($this->title)) { + $this->title = 'Roundcube Mail'; + } + + // replace specialchars in content + $page_title = Q($this->title, 'show', FALSE); + $page_header = ''; + $page_footer = ''; + + // include meta tag with charset + if (!empty($this->charset)) { + if (!headers_sent()) { + header('Content-Type: text/html; charset=' . $this->charset); + } + $page_header = '<meta http-equiv="content-type"'; + $page_header.= ' content="text/html; charset='; + $page_header.= $this->charset . '" />'."\n"; + } + + // definition of the code to be placed in the document header and footer + if (is_array($this->script_files['head'])) { + foreach ($this->script_files['head'] as $file) { + $page_header .= html::script($file); + } + } + + $head_script = $this->scripts['head_top'] . $this->scripts['head']; + if (!empty($head_script)) { + $page_header .= html::script(array(), $head_script); + } + + if (!empty($this->header)) { + $page_header .= $this->header; + } + + // put docready commands into page footer + if (!empty($this->scripts['docready'])) { + $this->add_script('$(document).ready(function(){ ' . $this->scripts['docready'] . "\n});", 'foot'); + } + + if (is_array($this->script_files['foot'])) { + foreach ($this->script_files['foot'] as $file) { + $page_footer .= html::script($file); + } + } + + if (!empty($this->footer)) { + $page_footer .= $this->footer . "\n"; + } + + if (!empty($this->scripts['foot'])) { + $page_footer .= html::script(array(), $this->scripts['foot']); + } + + // find page header + if ($hpos = stripos($output, '</head>')) { + $page_header .= "\n"; + } + else { + if (!is_numeric($hpos)) { + $hpos = stripos($output, '<body'); + } + if (!is_numeric($hpos) && ($hpos = stripos($output, '<html'))) { + while ($output[$hpos] != '>') { + $hpos++; + } + $hpos++; + } + $page_header = "<head>\n<title>$page_title</title>\n$page_header\n</head>\n"; + } + + // add page hader + if ($hpos) { + $output = substr_replace($output, $page_header, $hpos, 0); + } + else { + $output = $page_header . $output; + } + + // add page footer + if (($fpos = strripos($output, '</body>')) || ($fpos = strripos($output, '</html>'))) { + $output = substr_replace($output, $page_footer."\n", $fpos, 0); + } + else { + $output .= "\n".$page_footer; + } + + // add css files in head, before scripts, for speed up with parallel downloads + if (!empty($this->css_files) && + (($pos = stripos($output, '<script ')) || ($pos = stripos($output, '</head>'))) + ) { + $css = ''; + foreach ($this->css_files as $file) { + $css .= html::tag('link', array('rel' => 'stylesheet', + 'type' => 'text/css', 'href' => $file, 'nl' => true)); + } + $output = substr_replace($output, $css, $pos, 0); + } + + $this->base_path = $base_path; + + // correct absolute paths in images and other tags + // add timestamp to .js and .css filename + $output = preg_replace_callback( + '!(src|href|background)=(["\']?)([a-z0-9/_.-]+)(["\'\s>])!i', + array($this, 'file_callback'), $output); + + // trigger hook with final HTML content to be sent + $hook = rcmail::get_instance()->plugins->exec_hook("send_page", array('content' => $output)); + if (!$hook['abort']) { + if ($this->charset != RCMAIL_CHARSET) { + echo rcube_charset_convert($hook['content'], RCMAIL_CHARSET, $this->charset); + } + else { + echo $hook['content']; + } + } + } + + /** + * Callback function for preg_replace_callback in write() + * + * @return string Parsed string + */ + private function file_callback($matches) + { + $file = $matches[3]; + + // correct absolute paths + if ($file[0] == '/') { + $file = $this->base_path . $file; + } + + // add file modification timestamp + if (preg_match('/\.(js|css)$/', $file)) { + if ($fs = @filemtime($file)) { + $file .= '?s=' . $fs; + } + } + + return $matches[1] . '=' . $matches[2] . $file . $matches[4]; + } +} |