img_auth.php File Reference

Image authorisation script. More...

Go to the source code of this file.

Enumerations
enum	MW_NO_OUTPUT_COMPRESSION
Functions
	wfForbidden ($msg1, $msg2)
	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
	$wgActionPaths = array( "$wgUploadPath/" )
	$wgArticlePath = false

---

Detailed Description

Image authorisation script.

To use this, see http://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
• Set $wgImgAuthPublicTest false if you don't want to just check and see if all are public must be set to false if using specific restrictions such as LockDown or NSFileRepo

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 PATH_INFO; CGI-based configurations usually don't.

Definition in file img_auth.php.

---

Enumeration Type Documentation

enum MW_NO_OUTPUT_COMPRESSION

Definition at line 29 of file img_auth.php.

---

Function Documentation

wfForbidden	(	$	msg1,
		$	msg2
	)

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:

$msg1
$msg2

Definition at line 131 of file img_auth.php.

wfImageAuthMain

(

)

Definition at line 45 of file img_auth.php.

---

Variable Documentation

$wgActionPaths = array( "$wgUploadPath/" )

Definition at line 40 of file img_auth.php.

Referenced by ResourceLoaderStartUpModule\getConfig(), Title\getLocalURL(), and WebRequest\getPathInfo().

$wgArticlePath = false

Definition at line 39 of file img_auth.php.

Referenced by ResourceLoaderStartUpModule\getConfig(), Title\getLocalURL(), WebRequest\getPathInfo(), Parser\getVariableValue(), SkinTemplate\outputPage(), BenchmarkPurge\randomUrl(), and ParserTest\setUp().