<?php
/**
- * Functions related to the output of file content
+ * Functions related to the output of file content.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
+
+/**
+ * Functions related to the output of file content
+ */
class StreamFile {
+ const READY_STREAM = 1;
+ const NOT_MODIFIED = 2;
+
/**
- * Stream a file to the browser, adding all the headings and fun stuff
+ * Stream a file to the browser, adding all the headings and fun stuff.
+ * Headers sent include: Content-type, Content-Length, Last-Modified,
+ * and Content-Disposition.
+ *
* @param $fname string Full name and path of the file to stream
* @param $headers array Any additional headers to send
* @param $sendErrors bool Send error messages if errors occur (like 404)
* @return bool Success
*/
public static function stream( $fname, $headers = array(), $sendErrors = true ) {
- global $wgLanguageCode;
+ wfProfileIn( __METHOD__ );
wfSuppressWarnings();
$stat = stat( $fname );
wfRestoreWarnings();
- if ( !$stat ) {
+
+ $res = self::prepareForStream( $fname, $stat, $headers, $sendErrors );
+ if ( $res == self::NOT_MODIFIED ) {
+ $ok = true; // use client cache
+ } elseif ( $res == self::READY_STREAM ) {
+ wfProfileIn( __METHOD__ . '-send' );
+ $ok = readfile( $fname );
+ wfProfileOut( __METHOD__ . '-send' );
+ } else {
+ $ok = false; // failed
+ }
+
+ wfProfileOut( __METHOD__ );
+ return $ok;
+ }
+
+ /**
+ * Call this function used in preparation before streaming a file.
+ * This function does the following:
+ * (a) sends Last-Modified, Content-type, and Content-Disposition headers
+ * (b) cancels any PHP output buffering and automatic gzipping of output
+ * (c) sends Content-Length header based on HTTP_IF_MODIFIED_SINCE check
+ *
+ * @param $path string Storage path or file system path
+ * @param $info Array|bool File stat info with 'mtime' and 'size' fields
+ * @param $headers Array Additional headers to send
+ * @param $sendErrors bool Send error messages if errors occur (like 404)
+ * @return int|bool READY_STREAM, NOT_MODIFIED, or false on failure
+ */
+ public static function prepareForStream(
+ $path, $info, $headers = array(), $sendErrors = true
+ ) {
+ global $wgLanguageCode;
+
+ if ( !is_array( $info ) ) {
if ( $sendErrors ) {
header( 'HTTP/1.0 404 Not Found' );
header( 'Cache-Control: no-cache' );
header( 'Content-Type: text/html; charset=utf-8' );
- $encFile = htmlspecialchars( $fname );
+ $encFile = htmlspecialchars( $path );
$encScript = htmlspecialchars( $_SERVER['SCRIPT_NAME'] );
echo "<html><body>
<h1>File not found</h1>
return false;
}
- header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s', $stat['mtime'] ) . ' GMT' );
+ // Sent Last-Modified HTTP header for client-side caching
+ header( 'Last-Modified: ' . wfTimestamp( TS_RFC2822, $info['mtime'] ) );
// Cancel output buffering and gzipping if set
wfResetOutputBuffers();
- $type = self::getType( $fname );
+ $type = self::contentTypeFromPath( $path );
if ( $type && $type != 'unknown/unknown' ) {
header( "Content-type: $type" );
} else {
+ // Send a content type which is not known to Internet Explorer, to
+ // avoid triggering IE's content type detection. Sending a standard
+ // unknown content type here essentially gives IE license to apply
+ // whatever content type it likes.
header( 'Content-type: application/x-wiki' );
}
}
header( "Content-Disposition: inline;filename*=utf-8'$wgLanguageCode'" .
- urlencode( basename( $fname ) ) );
+ urlencode( basename( $path ) ) );
// Send additional headers
foreach ( $headers as $header ) {
// Don't send if client has up to date cache
if ( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
$modsince = preg_replace( '/;.*$/', '', $_SERVER['HTTP_IF_MODIFIED_SINCE'] );
- $sinceTime = strtotime( $modsince );
- if ( $stat['mtime'] <= $sinceTime ) {
+ if ( wfTimestamp( TS_UNIX, $info['mtime'] ) <= strtotime( $modsince ) ) {
ini_set( 'zlib.output_compression', 0 );
header( "HTTP/1.0 304 Not Modified" );
- return true; // ok
+ return self::NOT_MODIFIED; // ok
}
}
- header( 'Content-Length: ' . $stat['size'] );
+ header( 'Content-Length: ' . $info['size'] );
- return readfile( $fname );
+ return self::READY_STREAM; // ok
}
/**
- * Determine the filetype we're dealing with
- * @param $filename string
- * @param $safe bool
+ * Determine the file type of a file based on the path
+ *
+ * @param $filename string Storage path or file system path
+ * @param $safe bool Whether to do retroactive upload blacklist checks
* @return null|string
*/
- private static function getType( $filename, $safe = true ) {
+ public static function contentTypeFromPath( $filename, $safe = true ) {
global $wgTrivialMimeDetection;
$ext = strrchr( $filename, '.' );
dépôts / lhc / web / wiklou.git / blobdiff