img_auth.php File Reference

Image authorisation script. More...

Go to the source code of this file.

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. More...
	wfImageAuthMain ()

Variables
	$factory = wfGetLBFactory()
	$wgActionPaths = array( "$wgUploadPath/" )
	$wgArticlePath = false
const	MW_NO_OUTPUT_COMPRESSION 1

Detailed Description

Image authorisation script.

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

• 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.

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
	)

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 173 of file img_auth.php.

wfImageAuthMain()

wfImageAuthMain

(

)

Definition at line 58 of file img_auth.php.

Variable Documentation

$factory

$factory = wfGetLBFactory()

Definition at line 54 of file img_auth.php.

Referenced by MediaWiki\restInPeace(), MWExceptionHandler\rollbackMasterChangesAndLog(), ConfigFactoryTest\testMakeConfig(), ConfigFactoryTest\testMakeConfigWithInvalidCallback(), ConfigFactoryTest\testMakeConfigWithNoBuilders(), and ConfigFactoryTest\testRegister().

$wgActionPaths

$wgActionPaths = array( "$wgUploadPath/" )

Definition at line 49 of file img_auth.php.

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

$wgArticlePath

$wgArticlePath = false

Definition at line 48 of file img_auth.php.

Referenced by HTMLForm\getAction(), ResourceLoaderStartUpModule\getConfig(), SpecialVersion\getEntryPointInfo(), HTMLForm\getHiddenFields(), Title\getLocalURL(), WebRequest\getPathInfo(), SkinTemplate\prepareQuickTemplate(), BenchmarkPurge\randomUrl(), and wfThumbHandle404().

MW_NO_OUTPUT_COMPRESSION

const MW_NO_OUTPUT_COMPRESSION 1

Definition at line 42 of file img_auth.php.