1 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
\r
5 * An open source application development framework for PHP 4.3.2 or newer
\r
7 * @package CodeIgniter
\r
8 * @author ExpressionEngine Dev Team
\r
9 * @copyright Copyright (c) 2008, EllisLab, Inc.
\r
10 * @license http://codeigniter.com/user_guide/license.html
\r
11 * @link http://codeigniter.com
\r
12 * @since Version 1.0
\r
16 // ------------------------------------------------------------------------
\r
21 * Responsible for sending final output to browser
\r
23 * @package CodeIgniter
\r
24 * @subpackage Libraries
\r
26 * @author ExpressionEngine Dev Team
\r
27 * @link http://codeigniter.com/user_guide/libraries/output.html
\r
32 var $cache_expiration = 0;
\r
33 var $headers = array();
\r
34 var $enable_profiler = FALSE;
\r
37 function CI_Output()
\r
39 log_message('debug', "Output Class Initialized");
\r
42 // --------------------------------------------------------------------
\r
47 * Returns the current output string
\r
52 function get_output()
\r
54 return $this->final_output;
\r
57 // --------------------------------------------------------------------
\r
62 * Sets the output string
\r
68 function set_output($output)
\r
70 $this->final_output = $output;
\r
73 // --------------------------------------------------------------------
\r
78 * Appends data onto the output string
\r
84 function append_output($output)
\r
86 if ($this->final_output == '')
\r
88 $this->final_output = $output;
\r
92 $this->final_output .= $output;
\r
96 // --------------------------------------------------------------------
\r
101 * Lets you set a server header which will be outputted with the final display.
\r
103 * Note: If a file is cached, headers will not be sent. We need to figure out
\r
104 * how to permit header data to be saved with the cache data...
\r
110 function set_header($header, $replace = TRUE)
\r
112 $this->headers[] = array($header, $replace);
\r
115 // --------------------------------------------------------------------
\r
118 * Set HTTP Status Header
\r
121 * @param int the status code
\r
125 function set_status_header($code = '200', $text = '')
\r
129 '201' => 'Created',
\r
130 '202' => 'Accepted',
\r
131 '203' => 'Non-Authoritative Information',
\r
132 '204' => 'No Content',
\r
133 '205' => 'Reset Content',
\r
134 '206' => 'Partial Content',
\r
136 '300' => 'Multiple Choices',
\r
137 '301' => 'Moved Permanently',
\r
139 '304' => 'Not Modified',
\r
140 '305' => 'Use Proxy',
\r
141 '307' => 'Temporary Redirect',
\r
143 '400' => 'Bad Request',
\r
144 '401' => 'Unauthorized',
\r
145 '403' => 'Forbidden',
\r
146 '404' => 'Not Found',
\r
147 '405' => 'Method Not Allowed',
\r
148 '406' => 'Not Acceptable',
\r
149 '407' => 'Proxy Authentication Required',
\r
150 '408' => 'Request Timeout',
\r
151 '409' => 'Conflict',
\r
153 '411' => 'Length Required',
\r
154 '412' => 'Precondition Failed',
\r
155 '413' => 'Request Entity Too Large',
\r
156 '414' => 'Request-URI Too Long',
\r
157 '415' => 'Unsupported Media Type',
\r
158 '416' => 'Requested Range Not Satisfiable',
\r
159 '417' => 'Expectation Failed',
\r
161 '500' => 'Internal Server Error',
\r
162 '501' => 'Not Implemented',
\r
163 '502' => 'Bad Gateway',
\r
164 '503' => 'Service Unavailable',
\r
165 '504' => 'Gateway Timeout',
\r
166 '505' => 'HTTP Version Not Supported'
\r
169 if ($code == '' OR ! is_numeric($code))
\r
171 show_error('Status codes must be numeric');
\r
174 if (isset($stati[$code]) AND $text == '')
\r
176 $text = $stati[$code];
\r
181 show_error('No status text available. Please check your status code number or supply your own message text.');
\r
184 $server_protocol = (isset($_SERVER['SERVER_PROTOCOL'])) ? $_SERVER['SERVER_PROTOCOL'] : FALSE;
\r
186 if (substr(php_sapi_name(), 0, 3) == 'cgi')
\r
188 header("Status: {$code} {$text}", TRUE);
\r
190 elseif ($server_protocol == 'HTTP/1.1' OR $server_protocol == 'HTTP/1.0')
\r
192 header($server_protocol." {$code} {$text}", TRUE, $code);
\r
196 header("HTTP/1.1 {$code} {$text}", TRUE, $code);
\r
200 // --------------------------------------------------------------------
\r
203 * Enable/disable Profiler
\r
209 function enable_profiler($val = TRUE)
\r
211 $this->enable_profiler = (is_bool($val)) ? $val : TRUE;
\r
214 // --------------------------------------------------------------------
\r
223 function cache($time)
\r
225 $this->cache_expiration = ( ! is_numeric($time)) ? 0 : $time;
\r
228 // --------------------------------------------------------------------
\r
233 * All "view" data is automatically put into this variable by the controller class:
\r
235 * $this->final_output
\r
237 * This function sends the finalized output data to the browser along
\r
238 * with any server headers and profile data. It also stops the
\r
239 * benchmark timer so the page rendering speed and memory usage can be shown.
\r
244 function _display($output = '')
\r
246 // Note: We use globals because we can't use $CI =& get_instance()
\r
247 // since this function is sometimes called by the caching mechanism,
\r
248 // which happens before the CI super object is available.
\r
251 // --------------------------------------------------------------------
\r
253 // Set the output data
\r
256 $output =& $this->final_output;
\r
259 // --------------------------------------------------------------------
\r
261 // Do we need to write a cache file?
\r
262 if ($this->cache_expiration > 0)
\r
264 $this->_write_cache($output);
\r
267 // --------------------------------------------------------------------
\r
269 // Parse out the elapsed time and memory usage,
\r
270 // then swap the pseudo-variables with the data
\r
272 $elapsed = $BM->elapsed_time('total_execution_time_start', 'total_execution_time_end');
\r
273 $output = str_replace('{elapsed_time}', $elapsed, $output);
\r
275 $memory = ( ! function_exists('memory_get_usage')) ? '0' : round(memory_get_usage()/1024/1024, 2).'MB';
\r
276 $output = str_replace('{memory_usage}', $memory, $output);
\r
278 // --------------------------------------------------------------------
\r
280 // Is compression requested?
\r
281 if ($CFG->item('compress_output') === TRUE)
\r
283 if (extension_loaded('zlib'))
\r
285 if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) AND strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE)
\r
287 ob_start('ob_gzhandler');
\r
292 // --------------------------------------------------------------------
\r
294 // Are there any server headers to send?
\r
295 if (count($this->headers) > 0)
\r
297 foreach ($this->headers as $header)
\r
299 @header($header[0], $header[1]);
\r
303 // --------------------------------------------------------------------
\r
305 // Does the get_instance() function exist?
\r
306 // If not we know we are dealing with a cache file so we'll
\r
307 // simply echo out the data and exit.
\r
308 if ( ! function_exists('get_instance'))
\r
311 log_message('debug', "Final output sent to browser");
\r
312 log_message('debug', "Total execution time: ".$elapsed);
\r
316 // --------------------------------------------------------------------
\r
318 // Grab the super object. We'll need it in a moment...
\r
319 $CI =& get_instance();
\r
321 // Do we need to generate profile data?
\r
322 // If so, load the Profile class and run it.
\r
323 if ($this->enable_profiler == TRUE)
\r
325 $CI->load->library('profiler');
\r
327 // If the output data contains closing </body> and </html> tags
\r
328 // we will remove them and add them back after we insert the profile data
\r
329 if (preg_match("|</body>.*?</html>|is", $output))
\r
331 $output = preg_replace("|</body>.*?</html>|is", '', $output);
\r
332 $output .= $CI->profiler->run();
\r
333 $output .= '</body></html>';
\r
337 $output .= $CI->profiler->run();
\r
341 // --------------------------------------------------------------------
\r
343 // Does the controller contain a function named _output()?
\r
344 // If so send the output there. Otherwise, echo it.
\r
345 if (method_exists($CI, '_output'))
\r
347 $CI->_output($output);
\r
351 echo $output; // Send it to the browser!
\r
354 log_message('debug', "Final output sent to browser");
\r
355 log_message('debug', "Total execution time: ".$elapsed);
\r
358 // --------------------------------------------------------------------
\r
361 * Write a Cache File
\r
366 function _write_cache($output)
\r
368 $CI =& get_instance();
\r
369 $path = $CI->config->item('cache_path');
\r
371 $cache_path = ($path == '') ? BASEPATH.'cache/' : $path;
\r
373 if ( ! is_dir($cache_path) OR ! is_really_writable($cache_path))
\r
378 $uri = $CI->config->item('base_url').
\r
379 $CI->config->item('index_page').
\r
380 $CI->uri->uri_string();
\r
382 $cache_path .= md5($uri);
\r
384 if ( ! $fp = @fopen($cache_path, FOPEN_WRITE_CREATE_DESTRUCTIVE))
\r
386 log_message('error', "Unable to write cache file: ".$cache_path);
\r
390 $expire = time() + ($this->cache_expiration * 60);
\r
392 if (flock($fp, LOCK_EX))
\r
394 fwrite($fp, $expire.'TS--->'.$output);
\r
395 flock($fp, LOCK_UN);
\r
399 log_message('error', "Unable to secure a file lock for file at: ".$cache_path);
\r
403 @chmod($cache_path, DIR_WRITE_MODE);
\r
405 log_message('debug', "Cache file written: ".$cache_path);
\r
408 // --------------------------------------------------------------------
\r
411 * Update/serve a cached file
\r
416 function _display_cache(&$CFG, &$URI)
\r
418 $cache_path = ($CFG->item('cache_path') == '') ? BASEPATH.'cache/' : $CFG->item('cache_path');
\r
420 if ( ! is_dir($cache_path) OR ! is_really_writable($cache_path))
\r
425 // Build the file path. The file name is an MD5 hash of the full URI
\r
426 $uri = $CFG->item('base_url').
\r
427 $CFG->item('index_page').
\r
430 $filepath = $cache_path.md5($uri);
\r
432 if ( ! @file_exists($filepath))
\r
437 if ( ! $fp = @fopen($filepath, FOPEN_READ))
\r
442 flock($fp, LOCK_SH);
\r
445 if (filesize($filepath) > 0)
\r
447 $cache = fread($fp, filesize($filepath));
\r
450 flock($fp, LOCK_UN);
\r
453 // Strip out the embedded timestamp
\r
454 if ( ! preg_match("/(\d+TS--->)/", $cache, $match))
\r
459 // Has the file expired? If so we'll delete it.
\r
460 if (time() >= trim(str_replace('TS--->', '', $match['1'])))
\r
462 @unlink($filepath);
\r
463 log_message('debug', "Cache file has expired. File deleted");
\r
467 // Display the cache
\r
468 $this->_display(str_replace($match['0'], '', $cache));
\r
469 log_message('debug', "Cache file is current. Sending it to browser.");
\r
475 // END Output Class
\r
477 /* End of file Output.php */
\r
478 /* Location: ./system/libraries/Output.php */