1.27.1/php/StreamFile_8php_source.html

 <?php

 class StreamFile {

     const READY_STREAM = 1;

     const NOT_MODIFIED = 2;


     public static function stream( $fname, $headers = [], $sendErrors = true ) {


         if ( FileBackend::isStoragePath( $fname ) ) { // sanity

             throw new MWException( __FUNCTION__ . " given storage path '$fname'." );

         }


         MediaWiki\suppressWarnings();

         $stat = stat( $fname );

         MediaWiki\restoreWarnings();


         $res = self::prepareForStream( $fname, $stat, $headers, $sendErrors );

         if ( $res == self::NOT_MODIFIED ) {

             $ok = true; // use client cache

         } elseif ( $res == self::READY_STREAM ) {

             $ok = readfile( $fname );

         } else {

             $ok = false; // failed

         }


         return $ok;

     }


     public static function prepareForStream(

         $path, $info, $headers = [], $sendErrors = true

     ) {

         if ( !is_array( $info ) ) {

             if ( $sendErrors ) {

                 HttpStatus::header( 404 );

                 header( 'Cache-Control: no-cache' );

                 header( 'Content-Type: text/html; charset=utf-8' );

                 $encFile = htmlspecialchars( $path );

                 $encScript = htmlspecialchars( $_SERVER['SCRIPT_NAME'] );

                 echo "<html><body>

                     <h1>File not found</h1>

                     <p>Although this PHP script ($encScript) exists, the file requested for output

                     ($encFile) does not.</p>

                     </body></html>

                     ";

             }

             return false;

         }


         // 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::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' );

         }


         // Don't stream it out as text/html if there was a PHP error

         if ( headers_sent() ) {

             echo "Headers already sent, terminating.\n";

             return false;

         }


         // Send additional headers

         foreach ( $headers as $header ) {

             header( $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'] );

             if ( wfTimestamp( TS_UNIX, $info['mtime'] ) <= strtotime( $modsince ) ) {

                 ini_set( 'zlib.output_compression', 0 );

                 HttpStatus::header( 304 );

                 return self::NOT_MODIFIED; // ok

             }

         }


         header( 'Content-Length: ' . $info['size'] );


         return self::READY_STREAM; // ok

     }


     public static function contentTypeFromPath( $filename, $safe = true ) {

         global $wgTrivialMimeDetection;


         $ext = strrchr( $filename, '.' );

         $ext = $ext === false ? '' : strtolower( substr( $ext, 1 ) );


         # trivial detection by file extension,

         # used for thumbnails (thumb.php)

         if ( $wgTrivialMimeDetection ) {

             switch ( $ext ) {

                 case 'gif':

                     return 'image/gif';

                 case 'png':

                     return 'image/png';

                 case 'jpg':

                     return 'image/jpeg';

                 case 'jpeg':

                     return 'image/jpeg';

             }


             return 'unknown/unknown';

         }


         $magic = MimeMagic::singleton();

         // Use the extension only, rather than magic numbers, to avoid opening

         // up vulnerabilities due to uploads of files with allowed extensions

         // but disallowed types.

         $type = $magic->guessTypesForExtension( $ext );


         if ( $safe ) {

             global $wgFileBlacklist, $wgCheckFileExtensions, $wgStrictFileExtensions,

                 $wgFileExtensions, $wgVerifyMimeType, $wgMimeTypeBlacklist;

             list( , $extList ) = UploadBase::splitExtensions( $filename );

             if ( UploadBase::checkFileExtensionList( $extList, $wgFileBlacklist ) ) {

                 return 'unknown/unknown';

             }

             if ( $wgCheckFileExtensions && $wgStrictFileExtensions

                 && !UploadBase::checkFileExtensionList( $extList, $wgFileExtensions )

             ) {

                 return 'unknown/unknown';

             }

             if ( $wgVerifyMimeType && in_array( strtolower( $type ), $wgMimeTypeBlacklist ) ) {

                 return 'unknown/unknown';

             }

         }

         return $type;

     }

 }

$wgStrictFileExtensions
$wgStrictFileExtensions
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
Definition: DefaultSettings.php:902

TS_RFC2822
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.
Definition: GlobalFunctions.php:2009

UploadBase\checkFileExtensionList
static checkFileExtensionList($ext, $list)
Perform case-insensitive match against a list of file extensions.
Definition: UploadBase.php:1020

StreamFile
Functions related to the output of file content.
Definition: StreamFile.php:26

list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11

MimeMagic\singleton
static singleton()
Get an instance of this class.
Definition: MimeMagic.php:366

$ext
$ext
Definition: NoLocalSettings.php:25

HttpStatus\header
static header($code)
Output an HTTP status code header.
Definition: HttpStatus.php:96

StreamFile\READY_STREAM
const READY_STREAM
Definition: StreamFile.php:27

global
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93

$wgCheckFileExtensions
$wgCheckFileExtensions
This is a flag to determine whether or not to check file extensions on upload.
Definition: DefaultSettings.php:894

wfTimestamp
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2050

StreamFile\prepareForStream
static prepareForStream($path, $info, $headers=[], $sendErrors=true)
Call this function used in preparation before streaming a file.
Definition: StreamFile.php:76

wfResetOutputBuffers
wfResetOutputBuffers($resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1805

$res
$res
Definition: database.txt:21

FileBackend\isStoragePath
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
Definition: FileBackend.php:1374

UploadBase\splitExtensions
static splitExtensions($filename)
Split a file into a base name and all dot-delimited 'extensions' on the end.
Definition: UploadBase.php:993

as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9

$wgFileExtensions
$wgFileExtensions
This is the list of preferred extensions for uploading files.
Definition: DefaultSettings.php:848

php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35

StreamFile\contentTypeFromPath
static contentTypeFromPath($filename, $safe=true)
Determine the file type of a file based on the path.
Definition: StreamFile.php:146

$fname
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:35

$wgTrivialMimeDetection
$wgTrivialMimeDetection
Switch for trivial MIME detection.
Definition: DefaultSettings.php:1315

StreamFile\NOT_MODIFIED
const NOT_MODIFIED
Definition: StreamFile.php:28

TS_UNIX
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition: GlobalFunctions.php:1994

$path
$path
Definition: NoLocalSettings.php:26

$wgMimeTypeBlacklist
$wgMimeTypeBlacklist
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled...
Definition: DefaultSettings.php:869

StreamFile\stream
static stream($fname, $headers=[], $sendErrors=true)
Stream a file to the browser, adding all the headings and fun stuff.
Definition: StreamFile.php:41

$wgVerifyMimeType
$wgVerifyMimeType
Determines if the MIME type of uploaded files should be checked.
Definition: DefaultSettings.php:1282

$wgFileBlacklist
$wgFileBlacklist
Files with these extensions will never be allowed as uploads.
Definition: DefaultSettings.php:855

$type
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2338

MWException