The web entry point for serving non-public images to logged-in users. More...

Functions
	wfForbidden ( $msg1, $msg2,... $args)
	Issue a standard HTTP 403 Forbidden header ($msg1-a message index, not a message) and an error message ($msg2, also a message index), (both required) then end the script subsequent arguments to $msg2 will be passed as parameters only for replacing in $msg2.

	wfImageAuthMain ()

Variables
	$mediawiki = new MediaWiki()

const	MW_ENTRY_POINT 'img_auth'

const	MW_NO_OUTPUT_COMPRESSION 1

Detailed Description

The web entry point for serving non-public images to logged-in users.

To use this, see https://www.mediawiki.org/wiki/Manual:Image_authorization

Set $wgUploadDirectory to a non-public directory (not web accessible)
Set $wgUploadPath to point to this file

Optional Parameters

Set $wgImgAuthDetails = true if you want the reason the access was denied messages to be displayed instead of just the 403 error (doesn't work on IE anyway), otherwise it will only appear in error logs

For security reasons, you usually don't want your user to know why access was denied, just that it was. If you want to change this, you can set $wgImgAuthDetails to 'true' in localsettings.php and it will give the user the reason why access was denied.

Your server needs to support REQUEST_URI or PATH_INFO; CGI-based configurations sometimes don't.

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

Definition in file img_auth.php.

Function Documentation

◆ wfForbidden()

wfForbidden	(	$msg1,
		$msg2,
		$args )

Issue a standard HTTP 403 Forbidden header ($msg1-a message index, not a message) and an error message ($msg2, also a message index), (both required) then end the script subsequent arguments to $msg2 will be passed as parameters only for replacing in $msg2.

Parameters

string	$msg1
string	$msg2
	mixed	...$args To pass as params to wfMessage() with $msg2. Either variadic, or a single array argument.

Definition at line 212 of file img_auth.php.

References $templateParser, $wgImgAuthDetails, wfDebugLog(), and wfMessage().

Referenced by wfImageAuthMain().

◆ wfImageAuthMain()

wfImageAuthMain ( )

Definition at line 57 of file img_auth.php.

References $path, $wgImgAuthPath, $wgImgAuthUrlPathMap, $wgScriptPath, NS_FILE, wfBaseName(), wfDebugLog(), and wfForbidden().

Variable Documentation

◆ $mediawiki

$mediawiki = new MediaWiki()

Definition at line 54 of file img_auth.php.

◆ MW_ENTRY_POINT

const MW_ENTRY_POINT 'img_auth'

Definition at line 49 of file img_auth.php.

◆ MW_NO_OUTPUT_COMPRESSION

const MW_NO_OUTPUT_COMPRESSION 1

Definition at line 48 of file img_auth.php.

Functions

Variables