MediaWiki  1.30.0
TitleBlacklist Class Reference

Implements a title blacklist for MediaWiki. More...

Collaboration diagram for TitleBlacklist:

Public Member Functions

 getBlacklist ()
 Get the current blacklist. More...
 
 getWhitelist ()
 Get the current whitelist. More...
 
 invalidate ()
 Invalidate the blacklist cache. More...
 
 isBlacklisted ( $title, $action='edit')
 Check whether the blacklist restricts performing a specific action on the given Title. More...
 
 isWhitelisted ( $title, $action='edit')
 Check whether it has been explicitly whitelisted that the current User may perform a specific action on the given Title. More...
 
 load ()
 Load all configured blacklist sources. More...
 
 loadWhitelist ()
 Load local whitelist. More...
 
 userCannot ( $title, $user, $action='edit', $override=true)
 Check whether the blacklist restricts given user performing a specific action on the given Title. More...
 
 validate ( $blacklist)
 Validate a new blacklist. More...
 

Static Public Member Functions

static destroySingleton ()
 Destroy/reset the current singleton instance. More...
 
static parseBlacklist ( $list, $sourceName)
 Parse blacklist from a string. More...
 
static singleton ()
 Get an instance of this class. More...
 
static userCanOverride ( $user, $action)
 Inidcates whether user can override blacklist on certain action. More...
 

Public Attributes

const VERSION = 3
 

Static Protected Attributes

static TitleBlacklist $instance = null
 

Static Private Member Functions

static getBlacklistText ( $source)
 Get the text of a blacklist from a specified source. More...
 
static getHttp ( $url)
 Get the text of a blacklist source via HTTP. More...
 

Private Attributes

array $mBlacklist = null
 
array $mWhitelist = null
 

Detailed Description

Implements a title blacklist for MediaWiki.

Definition at line 17 of file TitleBlacklist.list.php.

Member Function Documentation

◆ destroySingleton()

static TitleBlacklist::destroySingleton ( )
static

Destroy/reset the current singleton instance.

This is solely for testing and will fail unless MW_PHPUNIT_TEST is defined.

Definition at line 47 of file TitleBlacklist.list.php.

Referenced by ApiQueryTitleBlacklistTest::setUp(), and ApiQueryTitleBlacklistTest::tearDown().

◆ getBlacklist()

TitleBlacklist::getBlacklist ( )

Get the current blacklist.

Returns
TitleBlacklistEntry[]

Definition at line 262 of file TitleBlacklist.list.php.

References $mBlacklist, and load().

Referenced by isBlacklisted().

◆ getBlacklistText()

static TitleBlacklist::getBlacklistText (   $source)
staticprivate

Get the text of a blacklist from a specified source.

Parameters
string$sourceA blacklist source from $wgTitleBlacklistSources
Returns
string The content of the blacklist source as a string

Definition at line 115 of file TitleBlacklist.list.php.

References $source, $title, captcha-old::count, WikiPage::factory(), ContentHandler::getContentText(), Title::newFromText(), NS_MEDIAWIKI, and wfMessage().

Referenced by load().

◆ getHttp()

static TitleBlacklist::getHttp (   $url)
staticprivate

Get the text of a blacklist source via HTTP.

Parameters
string$urlURL of the blacklist source
Returns
string The content of the blacklist source as a string

Definition at line 287 of file TitleBlacklist.list.php.

References $messageMemc, Http::get(), global, and wfMemcKey().

◆ getWhitelist()

TitleBlacklist::getWhitelist ( )

Get the current whitelist.

Returns
Array of TitleBlacklistEntry items

Definition at line 274 of file TitleBlacklist.list.php.

References $mWhitelist, and loadWhitelist().

Referenced by isWhitelisted().

◆ invalidate()

TitleBlacklist::invalidate ( )

Invalidate the blacklist cache.

Definition at line 306 of file TitleBlacklist.list.php.

References $cache, ObjectCache::getMainWANInstance(), and wfMemcKey().

◆ isBlacklisted()

TitleBlacklist::isBlacklisted (   $title,
  $action = 'edit' 
)

Check whether the blacklist restricts performing a specific action on the given Title.

Parameters
Title$titleTitle to check
string$actionAction to check; 'edit' if unspecified
Returns
TitleBlacklistEntry|bool The corresponding TitleBlacklistEntry if blacklisted; otherwise FALSE

Definition at line 208 of file TitleBlacklist.list.php.

References $params, $title, as, getBlacklist(), isWhitelisted(), and Title::newFromText().

Referenced by userCannot().

◆ isWhitelisted()

TitleBlacklist::isWhitelisted (   $title,
  $action = 'edit' 
)

Check whether it has been explicitly whitelisted that the current User may perform a specific action on the given Title.

Parameters
Title$titleTitle to check
string$actionAction to check; 'edit' if unspecified
Returns
bool True if whitelisted; otherwise false

Definition at line 244 of file TitleBlacklist.list.php.

References $title, as, getWhitelist(), and Title::newFromText().

Referenced by isBlacklisted().

◆ load()

TitleBlacklist::load ( )

Load all configured blacklist sources.

Definition at line 61 of file TitleBlacklist.list.php.

References $cache, $source, as, captcha-old::count, getBlacklistText(), ObjectCache::getMainWANInstance(), global, parseBlacklist(), wfDebugLog(), and wfMemcKey().

Referenced by getBlacklist().

◆ loadWhitelist()

TitleBlacklist::loadWhitelist ( )

Load local whitelist.

Definition at line 92 of file TitleBlacklist.list.php.

References $cache, captcha-old::count, ObjectCache::getMainWANInstance(), global, parseBlacklist(), text, wfMemcKey(), and wfMessage().

Referenced by getWhitelist().

◆ parseBlacklist()

static TitleBlacklist::parseBlacklist (   $list,
  $sourceName 
)
static

Parse blacklist from a string.

Parameters
string$listText of a blacklist source
string$sourceName
Returns
array of TitleBlacklistEntry entries

Definition at line 160 of file TitleBlacklist.list.php.

References $line, $lines, as, and TitleBlacklistEntry::newFromString().

Referenced by load(), and loadWhitelist().

◆ singleton()

◆ userCannot()

TitleBlacklist::userCannot (   $title,
  $user,
  $action = 'edit',
  $override = true 
)

Check whether the blacklist restricts given user performing a specific action on the given Title.

Parameters
Title$titleTitle to check
User$userUser to check
string$actionAction to check; 'edit' if unspecified
bool$overrideIf set to true, overrides work
Returns
TitleBlacklistEntry|bool The corresponding TitleBlacklistEntry if blacklisted; otherwise false

Definition at line 184 of file TitleBlacklist.list.php.

References $params, $title, $user, and isBlacklisted().

◆ userCanOverride()

static TitleBlacklist::userCanOverride (   $user,
  $action 
)
static

Inidcates whether user can override blacklist on certain action.

Parameters
User$user
string$actionAction
Returns
bool

Definition at line 338 of file TitleBlacklist.list.php.

References $user.

Referenced by TitleBlacklistHooks::addOverrideCheckbox(), and TitleBlacklistPreAuthenticationProvider::getAuthenticationRequests().

◆ validate()

TitleBlacklist::validate (   $blacklist)

Validate a new blacklist.

Parameters
array$blacklist
Returns
Array of bad entries; empty array means blacklist is valid

Definition at line 317 of file TitleBlacklist.list.php.

References $e, as, wfRestoreWarnings(), and wfSuppressWarnings().

Member Data Documentation

◆ $instance

TitleBlacklist TitleBlacklist::$instance = null
staticprotected

Definition at line 25 of file TitleBlacklist.list.php.

◆ $mBlacklist

array TitleBlacklist::$mBlacklist = null
private

Definition at line 19 of file TitleBlacklist.list.php.

Referenced by getBlacklist().

◆ $mWhitelist

array TitleBlacklist::$mWhitelist = null
private

Definition at line 22 of file TitleBlacklist.list.php.

Referenced by getWhitelist().

◆ VERSION

const TitleBlacklist::VERSION = 3

Definition at line 27 of file TitleBlacklist.list.php.

Referenced by TitleBlacklistEntry::__construct().


The documentation for this class was generated from the following file: