/system/core/Output.php
PHP | 963 lines | 480 code | 153 blank | 330 comment | 65 complexity | b64eecf87115e45976de029d74eb1b24 MD5 | raw file
Possible License(s): CC-BY-SA-3.0
- <?php
- /**
- * CodeIgniter
- *
- * An open source application development framework for PHP 5.2.4 or newer
- *
- * NOTICE OF LICENSE
- *
- * Licensed under the Open Software License version 3.0
- *
- * This source file is subject to the Open Software License (OSL 3.0) that is
- * bundled with this package in the files license.txt / license.rst. It is
- * also available through the world wide web at this URL:
- * http://opensource.org/licenses/OSL-3.0
- * If you did not receive a copy of the license and are unable to obtain it
- * through the world wide web, please send an email to
- * licensing@ellislab.com so we can send you a copy immediately.
- *
- * @package CodeIgniter
- * @author EllisLab Dev Team
- * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
- * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
- * @link http://codeigniter.com
- * @since Version 1.0
- * @filesource
- */
- defined('BASEPATH') OR exit('No direct script access allowed');
- /**
- * Output Class
- *
- * Responsible for sending final output to the browser.
- *
- * @package CodeIgniter
- * @subpackage Libraries
- * @category Output
- * @author EllisLab Dev Team
- * @link http://codeigniter.com/user_guide/libraries/output.html
- */
- class CI_Output {
- /**
- * Final output string
- *
- * @var string
- */
- public $final_output;
- /**
- * Cache expiration time
- *
- * @var int
- */
- public $cache_expiration = 0;
- /**
- * List of server headers
- *
- * @var array
- */
- public $headers = array();
- /**
- * List of mime types
- *
- * @var array
- */
- public $mimes = array();
- /**
- * Mime-type for the current page
- *
- * @var string
- */
- protected $mime_type = 'text/html';
- /**
- * Enable Profiler flag
- *
- * @var bool
- */
- public $enable_profiler = FALSE;
- /**
- * php.ini zlib.output_compression flag
- *
- * @var bool
- */
- protected $_zlib_oc = FALSE;
- /**
- * CI output compression flag
- *
- * @var bool
- */
- protected $_compress_output = FALSE;
- /**
- * List of profiler sections
- *
- * @var array
- */
- protected $_profiler_sections = array();
- /**
- * Parse markers flag
- *
- * Whether or not to parse variables like {elapsed_time} and {memory_usage}.
- *
- * @var bool
- */
- public $parse_exec_vars = TRUE;
- /**
- * Class constructor
- *
- * Determines whether zLib output compression will be used.
- *
- * @return void
- */
- public function __construct()
- {
- $this->_zlib_oc = (bool) ini_get('zlib.output_compression');
- $this->_compress_output = (
- $this->_zlib_oc === FALSE
- && config_item('compress_output') === TRUE
- && extension_loaded('zlib')
- );
- // Get mime types for later
- $this->mimes =& get_mimes();
- log_message('debug', 'Output Class Initialized');
- }
- // --------------------------------------------------------------------
- /**
- * Get Output
- *
- * Returns the current output string.
- *
- * @return string
- */
- public function get_output()
- {
- return $this->final_output;
- }
- // --------------------------------------------------------------------
- /**
- * Set Output
- *
- * Sets the output string.
- *
- * @param string $output Output data
- * @return CI_Output
- */
- public function set_output($output)
- {
- $this->final_output = $output;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Append Output
- *
- * Appends data onto the output string.
- *
- * @param string $output Data to append
- * @return CI_Output
- */
- public function append_output($output)
- {
- $this->final_output .= $output;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Header
- *
- * Lets you set a server header which will be sent with the final output.
- *
- * Note: If a file is cached, headers will not be sent.
- * @todo We need to figure out how to permit headers to be cached.
- *
- * @param string $header Header
- * @param bool $replace Whether to replace the old header value, if already set
- * @return CI_Output
- */
- public function set_header($header, $replace = TRUE)
- {
- // If zlib.output_compression is enabled it will compress the output,
- // but it will not modify the content-length header to compensate for
- // the reduction, causing the browser to hang waiting for more data.
- // We'll just skip content-length in those cases.
- if ($this->_zlib_oc && strncasecmp($header, 'content-length', 14) === 0)
- {
- return $this;
- }
- $this->headers[] = array($header, $replace);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Content-Type Header
- *
- * @param string $mime_type Extension of the file we're outputting
- * @param string $charset Character set (default: NULL)
- * @return CI_Output
- */
- public function set_content_type($mime_type, $charset = NULL)
- {
- if (strpos($mime_type, '/') === FALSE)
- {
- $extension = ltrim($mime_type, '.');
- // Is this extension supported?
- if (isset($this->mimes[$extension]))
- {
- $mime_type =& $this->mimes[$extension];
- if (is_array($mime_type))
- {
- $mime_type = current($mime_type);
- }
- }
- }
- $this->mime_type = $mime_type;
- if (empty($charset))
- {
- $charset = config_item('charset');
- }
- $header = 'Content-Type: '.$mime_type
- .(empty($charset) ? '' : '; charset='.$charset);
- $this->headers[] = array($header, TRUE);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Get Current Content-Type Header
- *
- * @return string 'text/html', if not already set
- */
- public function get_content_type()
- {
- for ($i = 0, $c = count($this->headers); $i < $c; $i++)
- {
- if (sscanf($this->headers[$i][0], 'Content-Type: %[^;]', $content_type) === 1)
- {
- return $content_type;
- }
- }
- return 'text/html';
- }
- // --------------------------------------------------------------------
- /**
- * Get Header
- *
- * @param string $header_name
- * @return string
- */
- public function get_header($header)
- {
- // Combine headers already sent with our batched headers
- $headers = array_merge(
- // We only need [x][0] from our multi-dimensional array
- array_map('array_shift', $this->headers),
- headers_list()
- );
- if (empty($headers) OR empty($header))
- {
- return NULL;
- }
- for ($i = 0, $c = count($headers); $i < $c; $i++)
- {
- if (strncasecmp($header, $headers[$i], $l = strlen($header)) === 0)
- {
- return trim(substr($headers[$i], $l+1));
- }
- }
- return NULL;
- }
- // --------------------------------------------------------------------
- /**
- * Set HTTP Status Header
- *
- * As of version 1.7.2, this is an alias for common function
- * set_status_header().
- *
- * @param int $code Status code (default: 200)
- * @param string $text Optional message
- * @return CI_Output
- */
- public function set_status_header($code = 200, $text = '')
- {
- set_status_header($code, $text);
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Enable/disable Profiler
- *
- * @param bool $val TRUE to enable or FALSE to disable
- * @return CI_Output
- */
- public function enable_profiler($val = TRUE)
- {
- $this->enable_profiler = is_bool($val) ? $val : TRUE;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Profiler Sections
- *
- * Allows override of default/config settings for
- * Profiler section display.
- *
- * @param array $sections Profiler sections
- * @return CI_Output
- */
- public function set_profiler_sections($sections)
- {
- if (isset($sections['query_toggle_count']))
- {
- $this->_profiler_sections['query_toggle_count'] = (int) $sections['query_toggle_count'];
- unset($sections['query_toggle_count']);
- }
- foreach ($sections as $section => $enable)
- {
- $this->_profiler_sections[$section] = ($enable !== FALSE);
- }
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Set Cache
- *
- * @param int $time Cache expiration time in seconds
- * @return CI_Output
- */
- public function cache($time)
- {
- $this->cache_expiration = is_numeric($time) ? $time : 0;
- return $this;
- }
- // --------------------------------------------------------------------
- /**
- * Display Output
- *
- * Processes sends the sends finalized output data to the browser along
- * with any server headers and profile data. It also stops benchmark
- * timers so the page rendering speed and memory usage can be shown.
- *
- * Note: All "view" data is automatically put into $this->final_output
- * by controller class.
- *
- * @uses CI_Output::$final_output
- * @param string $output Output data override
- * @return void
- */
- public function _display($output = '')
- {
- // Note: We use load_class() because we can't use $CI =& get_instance()
- // since this function is sometimes called by the caching mechanism,
- // which happens before the CI super object is available.
- $BM =& load_class('Benchmark', 'core');
- $CFG =& load_class('Config', 'core');
- // Grab the super object if we can.
- if (class_exists('CI_Controller', FALSE))
- {
- $CI =& get_instance();
- }
- // --------------------------------------------------------------------
- // Set the output data
- if ($output === '')
- {
- $output =& $this->final_output;
- }
- // --------------------------------------------------------------------
- // Is minify requested?
- if ($CFG->item('minify_output') === TRUE)
- {
- $output = $this->minify($output, $this->mime_type);
- }
- // --------------------------------------------------------------------
- // Do we need to write a cache file? Only if the controller does not have its
- // own _output() method and we are not dealing with a cache file, which we
- // can determine by the existence of the $CI object above
- if ($this->cache_expiration > 0 && isset($CI) && ! method_exists($CI, '_output'))
- {
- $this->_write_cache($output);
- }
- // --------------------------------------------------------------------
- // Parse out the elapsed time and memory usage,
- // then swap the pseudo-variables with the data
- $elapsed = $BM->elapsed_time('total_execution_time_start', 'total_execution_time_end');
- if ($this->parse_exec_vars === TRUE)
- {
- $memory = round(memory_get_usage() / 1024 / 1024, 2).'MB';
- $output = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsed, $memory), $output);
- }
- // --------------------------------------------------------------------
- // Is compression requested?
- if (isset($CI) // This means that we're not serving a cache file, if we were, it would already be compressed
- && $this->_compress_output === TRUE
- && isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE)
- {
- ob_start('ob_gzhandler');
- }
- // --------------------------------------------------------------------
- // Are there any server headers to send?
- if (count($this->headers) > 0)
- {
- foreach ($this->headers as $header)
- {
- @header($header[0], $header[1]);
- }
- }
- // --------------------------------------------------------------------
- // Does the $CI object exist?
- // If not we know we are dealing with a cache file so we'll
- // simply echo out the data and exit.
- if ( ! isset($CI))
- {
- if ($this->_compress_output === TRUE)
- {
- if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE)
- {
- header('Content-Encoding: gzip');
- header('Content-Length: '.strlen($output));
- }
- else
- {
- // User agent doesn't support gzip compression,
- // so we'll have to decompress our cache
- $output = gzinflate(substr($output, 10, -8));
- }
- }
- echo $output;
- log_message('debug', 'Final output sent to browser');
- log_message('debug', 'Total execution time: '.$elapsed);
- return;
- }
- // --------------------------------------------------------------------
- // Do we need to generate profile data?
- // If so, load the Profile class and run it.
- if ($this->enable_profiler === TRUE)
- {
- $CI->load->library('profiler');
- if ( ! empty($this->_profiler_sections))
- {
- $CI->profiler->set_sections($this->_profiler_sections);
- }
- // If the output data contains closing </body> and </html> tags
- // we will remove them and add them back after we insert the profile data
- $output = preg_replace('|</body>.*?</html>|is', '', $output, -1, $count).$CI->profiler->run();
- if ($count > 0)
- {
- $output .= '</body></html>';
- }
- }
- // Does the controller contain a function named _output()?
- // If so send the output there. Otherwise, echo it.
- if (method_exists($CI, '_output'))
- {
- $CI->_output($output);
- }
- else
- {
- echo $output; // Send it to the browser!
- }
- log_message('debug', 'Final output sent to browser');
- log_message('debug', 'Total execution time: '.$elapsed);
- }
- // --------------------------------------------------------------------
- /**
- * Write Cache
- *
- * @param string $output Output data to cache
- * @return void
- */
- public function _write_cache($output)
- {
- $CI =& get_instance();
- $path = $CI->config->item('cache_path');
- $cache_path = ($path === '') ? APPPATH.'cache/' : $path;
- if ( ! is_dir($cache_path) OR ! is_really_writable($cache_path))
- {
- log_message('error', 'Unable to write cache file: '.$cache_path);
- return;
- }
- $uri = $CI->config->item('base_url')
- .$CI->config->item('index_page')
- .$CI->uri->uri_string();
- $cache_path .= md5($uri);
- if ( ! $fp = @fopen($cache_path, 'w+b'))
- {
- log_message('error', 'Unable to write cache file: '.$cache_path);
- return;
- }
- if (flock($fp, LOCK_EX))
- {
- // If output compression is enabled, compress the cache
- // itself, so that we don't have to do that each time
- // we're serving it
- if ($this->_compress_output === TRUE)
- {
- $output = gzencode($output);
- if ($this->get_header('content-type') === NULL)
- {
- $this->set_content_type($this->mime_type);
- }
- }
- $expire = time() + ($this->cache_expiration * 60);
- // Put together our serialized info.
- $cache_info = serialize(array(
- 'expire' => $expire,
- 'headers' => $this->headers
- ));
- $output = $cache_info.'ENDCI--->'.$output;
- for ($written = 0, $length = strlen($output); $written < $length; $written += $result)
- {
- if (($result = fwrite($fp, substr($output, $written))) === FALSE)
- {
- break;
- }
- }
- flock($fp, LOCK_UN);
- }
- else
- {
- log_message('error', 'Unable to secure a file lock for file at: '.$cache_path);
- return;
- }
- fclose($fp);
- if (is_int($result))
- {
- @chmod($cache_path, 0666);
- log_message('debug', 'Cache file written: '.$cache_path);
- // Send HTTP cache-control headers to browser to match file cache settings.
- $this->set_cache_header($_SERVER['REQUEST_TIME'], $expire);
- }
- else
- {
- @unlink($cache_path);
- log_message('error', 'Unable to write the complete cache content at: '.$cache_path);
- }
- }
- // --------------------------------------------------------------------
- /**
- * Update/serve cached output
- *
- * @uses CI_Config
- * @uses CI_URI
- *
- * @param object &$CFG CI_Config class instance
- * @param object &$URI CI_URI class instance
- * @return bool TRUE on success or FALSE on failure
- */
- public function _display_cache(&$CFG, &$URI)
- {
- $cache_path = ($CFG->item('cache_path') === '') ? APPPATH.'cache/' : $CFG->item('cache_path');
- // Build the file path. The file name is an MD5 hash of the full URI
- $uri = $CFG->item('base_url').$CFG->item('index_page').$URI->uri_string;
- $filepath = $cache_path.md5($uri);
- if ( ! file_exists($filepath) OR ! $fp = @fopen($filepath, 'rb'))
- {
- return FALSE;
- }
- flock($fp, LOCK_SH);
- $cache = (filesize($filepath) > 0) ? fread($fp, filesize($filepath)) : '';
- flock($fp, LOCK_UN);
- fclose($fp);
- // Look for embedded serialized file info.
- if ( ! preg_match('/^(.*)ENDCI--->/', $cache, $match))
- {
- return FALSE;
- }
- $cache_info = unserialize($match[1]);
- $expire = $cache_info['expire'];
- $last_modified = filemtime($cache_path);
- // Has the file expired?
- if ($_SERVER['REQUEST_TIME'] >= $expire && is_really_writable($cache_path))
- {
- // If so we'll delete it.
- @unlink($filepath);
- log_message('debug', 'Cache file has expired. File deleted.');
- return FALSE;
- }
- else
- {
- // Or else send the HTTP cache control headers.
- $this->set_cache_header($last_modified, $expire);
- }
- // Add headers from cache file.
- foreach ($cache_info['headers'] as $header)
- {
- $this->set_header($header[0], $header[1]);
- }
- // Display the cache
- $this->_display(substr($cache, strlen($match[0])));
- log_message('debug', 'Cache file is current. Sending it to browser.');
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Delete cache
- *
- * @param string $uri URI string
- * @return bool
- */
- public function delete_cache($uri = '')
- {
- $CI =& get_instance();
- $cache_path = $CI->config->item('cache_path');
- if ($cache_path === '')
- {
- $cache_path = APPPATH.'cache/';
- }
- if ( ! is_dir($cache_path))
- {
- log_message('error', 'Unable to find cache path: '.$cache_path);
- return FALSE;
- }
- if (empty($uri))
- {
- $uri = $CI->uri->uri_string();
- }
- $cache_path .= md5($CI->config->item('base_url').$CI->config->item('index_page').$uri);
- if ( ! @unlink($cache_path))
- {
- log_message('error', 'Unable to delete cache file for '.$uri);
- return FALSE;
- }
- return TRUE;
- }
- // --------------------------------------------------------------------
- /**
- * Set Cache Header
- *
- * Set the HTTP headers to match the server-side file cache settings
- * in order to reduce bandwidth.
- *
- * @param int $last_modified Timestamp of when the page was last modified
- * @param int $expiration Timestamp of when should the requested page expire from cache
- * @return void
- */
- public function set_cache_header($last_modified, $expiration)
- {
- $max_age = $expiration - $_SERVER['REQUEST_TIME'];
- if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $last_modified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']))
- {
- $this->set_status_header(304);
- exit;
- }
- else
- {
- header('Pragma: public');
- header('Cache-Control: max-age='.$max_age.', public');
- header('Expires: '.gmdate('D, d M Y H:i:s', $expiration).' GMT');
- header('Last-modified: '.gmdate('D, d M Y H:i:s', $last_modified).' GMT');
- }
- }
- // --------------------------------------------------------------------
- /**
- * Minify
- *
- * Reduce excessive size of HTML/CSS/JavaScript content.
- *
- * @param string $output Output to minify
- * @param string $type Output content MIME type
- * @return string Minified output
- */
- public function minify($output, $type = 'text/html')
- {
- switch ($type)
- {
- case 'text/html':
- if (($size_before = strlen($output)) === 0)
- {
- return '';
- }
- // Find all the <pre>,<code>,<textarea>, and <javascript> tags
- // We'll want to return them to this unprocessed state later.
- preg_match_all('{<pre.+</pre>}msU', $output, $pres_clean);
- preg_match_all('{<code.+</code>}msU', $output, $codes_clean);
- preg_match_all('{<textarea.+</textarea>}msU', $output, $textareas_clean);
- preg_match_all('{<script.+</script>}msU', $output, $javascript_clean);
- // Minify the CSS in all the <style> tags.
- preg_match_all('{<style.+</style>}msU', $output, $style_clean);
- foreach ($style_clean[0] as $s)
- {
- $output = str_replace($s, $this->_minify_js_css($s, 'css', TRUE), $output);
- }
- // Minify the javascript in <script> tags.
- foreach ($javascript_clean[0] as $s)
- {
- $javascript_mini[] = $this->_minify_js_css($s, 'js', TRUE);
- }
- // Replace multiple spaces with a single space.
- $output = preg_replace('!\s{2,}!', ' ', $output);
- // Remove comments (non-MSIE conditionals)
- $output = preg_replace('{\s*<!--[^\[<>].*(?<!!)-->\s*}msU', '', $output);
- // Remove spaces around block-level elements.
- $output = preg_replace('/\s*(<\/?(html|head|title|meta|script|link|style|body|table|thead|tbody|tfoot|tr|th|td|h[1-6]|div|p|br)[^>]*>)\s*/is', '$1', $output);
- // Replace mangled <pre> etc. tags with unprocessed ones.
- if ( ! empty($pres_clean))
- {
- preg_match_all('{<pre.+</pre>}msU', $output, $pres_messed);
- $output = str_replace($pres_messed[0], $pres_clean[0], $output);
- }
- if ( ! empty($codes_clean))
- {
- preg_match_all('{<code.+</code>}msU', $output, $codes_messed);
- $output = str_replace($codes_messed[0], $codes_clean[0], $output);
- }
- if ( ! empty($textareas_clean))
- {
- preg_match_all('{<textarea.+</textarea>}msU', $output, $textareas_messed);
- $output = str_replace($textareas_messed[0], $textareas_clean[0], $output);
- }
- if (isset($javascript_mini))
- {
- preg_match_all('{<script.+</script>}msU', $output, $javascript_messed);
- $output = str_replace($javascript_messed[0], $javascript_mini, $output);
- }
- $size_removed = $size_before - strlen($output);
- $savings_percent = round(($size_removed / $size_before * 100));
- log_message('debug', 'Minifier shaved '.($size_removed / 1000).'KB ('.$savings_percent.'%) off final HTML output.');
- break;
- case 'text/css':
- return $this->_minify_js_css($output, 'css');
- case 'text/javascript':
- case 'application/javascript':
- case 'application/x-javascript':
- return $this->_minify_js_css($output, 'js');
- default: break;
- }
- return $output;
- }
- // --------------------------------------------------------------------
- /**
- * Minify JavaScript and CSS code
- *
- * Strips comments and excessive whitespace characters
- *
- * @param string $output
- * @param string $type 'js' or 'css'
- * @param bool $tags Whether $output contains the 'script' or 'style' tag
- * @return string
- */
- protected function _minify_js_css($output, $type, $tags = FALSE)
- {
- if ($tags === TRUE)
- {
- $tags = array('close' => strrchr($output, '<'));
- $open_length = strpos($output, '>') + 1;
- $tags['open'] = substr($output, 0, $open_length);
- $output = substr($output, $open_length, -strlen($tags['close']));
- // Strip spaces from the tags
- $tags = preg_replace('#\s{2,}#', ' ', $tags);
- }
- $output = trim($output);
- if ($type === 'js')
- {
- // Catch all string literals and comment blocks
- if (preg_match_all('#((?:((?<!\\\)\'|")|(/\*)|(//)).*(?(2)(?<!\\\)\2|(?(3)\*/|\n)))#msuUS', $output, $match, PREG_OFFSET_CAPTURE))
- {
- $js_literals = $js_code = array();
- for ($match = $match[0], $c = count($match), $i = $pos = $offset = 0; $i < $c; $i++)
- {
- $js_code[$pos++] = trim(substr($output, $offset, $match[$i][1] - $offset));
- $offset = $match[$i][1] + strlen($match[$i][0]);
- // Save only if we haven't matched a comment block
- if ($match[$i][0][0] !== '/')
- {
- $js_literals[$pos++] = array_shift($match[$i]);
- }
- }
- $js_code[$pos] = substr($output, $offset);
- // $match might be quite large, so free it up together with other vars that we no longer need
- unset($match, $offset, $pos);
- }
- else
- {
- $js_code = array($output);
- $js_literals = array();
- }
- $varname = 'js_code';
- }
- else
- {
- $varname = 'output';
- }
- // Standartize new lines
- $$varname = str_replace(array("\r\n", "\r"), "\n", $$varname);
- if ($type === 'js')
- {
- $patterns = array(
- '#\s*([!\#%&()*+,\-./:;<=>?@\[\]^`{|}~])\s*#' => '$1', // Remove spaces following and preceeding JS-wise non-special & non-word characters
- '#\s{2,}#' => ' ' // Reduce the remaining multiple whitespace characters to a single space
- );
- }
- else
- {
- $patterns = array(
- '#/\*.*(?=\*/)\*/#s' => '', // Remove /* block comments */
- '#\n?//[^\n]*#' => '', // Remove // line comments
- '#\s*([^\w.\#%])\s*#U' => '$1', // Remove spaces following and preceeding non-word characters, excluding dots, hashes and the percent sign
- '#\s{2,}#' => ' ' // Reduce the remaining multiple space characters to a single space
- );
- }
- $$varname = preg_replace(array_keys($patterns), array_values($patterns), $$varname);
- // Glue back JS quoted strings
- if ($type === 'js')
- {
- $js_code += $js_literals;
- ksort($js_code);
- $output = implode($js_code);
- unset($js_code, $js_literals, $varname, $patterns);
- }
- return is_array($tags)
- ? $tags['open'].$output.$tags['close']
- : $output;
- }
- }
- /* End of file Output.php */
- /* Location: ./system/core/Output.php */