Base class for different kinds of blacklists. More...

Inheritance diagram for BaseBlacklist:

[legend]

Public Member Functions
	__construct ( $settings=[])
	Constructor.

	clearCache ()
	Clear all primary blacklist cache keys.

	filter (array $links, Title $title, $preventLog=false)

	getBlacklists ()
	Fetch local and (possibly cached) remote blacklists.

	getLocalBlacklists ()
	Returns the local blacklist.

	getRegexEnd ( $batchSize)
	Returns the end of the regex for matches.

	getRegexStart ()
	Returns the start of the regex for matches.

	getWhitelists ()
	Returns the (local) whitelist.

	warmCachesForFilter (Title $title, array $entries)

Static Public Member Functions
static	addBlacklistType ( $type, $class)
	Adds a blacklist class to the registry.

static	getBlacklistTypes ()
	Return the array of blacklist types currently defined.

static	getEmailBlacklist ()

static	getInstance ( $type)
	Returns an instance of the given blacklist.

static	getSpamBlacklist ()

static	getTypeFromTitle (Title $title)
	Returns the type of blacklist from the given title.

static	isLocalSource (Title $title)
	Check if the given local page title is a spam regex source.

Public Attributes
int	$expiryTime = 900

array	$files = []
	Array of blacklist sources.

int	$warningChance = 100
	Chance of receiving a warning when the filter is hit.

int	$warningTime = 600

Protected Member Functions
	getBlacklistType ()
	Returns the code for the blacklist implementation.

Protected Attributes
bool array	$regexes = false
	Array containing regexes to test against.

Private Member Functions
	buildSharedBlacklists ()

	getArticleText ( $wiki, $pagename)
	Fetch an article from this or another local MediaWiki database.

	getHttpText ( $fileName)

	getSharedBlacklists ()
	Fetch (possibly cached) remote blacklists.

Static Private Attributes
static array	$blacklistTypes
	Array containing blacklists that extend BaseBlacklist.

static array	$instances = []
	Array of blacklist instances.

Detailed Description

Base class for different kinds of blacklists.

Definition at line 9 of file BaseBlacklist.php.

Constructor & Destructor Documentation

◆ __construct()

BaseBlacklist::__construct ( $settings = [] )

Constructor.

Parameters

array $settings

Definition at line 63 of file BaseBlacklist.php.

Member Function Documentation

◆ addBlacklistType()

static BaseBlacklist::addBlacklistType	(		$type,
			$class )

static

Adds a blacklist class to the registry.

Parameters

string	$type
string	$class

Definition at line 83 of file BaseBlacklist.php.

References $type.

◆ buildSharedBlacklists()

BaseBlacklist::buildSharedBlacklists ( )

private

Definition at line 322 of file BaseBlacklist.php.

References $matches, $regexes, getArticleText(), getBlacklistType(), getHttpText(), SpamRegexBatch\regexesFromText(), and wfDebugLog().

◆ clearCache()

BaseBlacklist::clearCache ( )

Clear all primary blacklist cache keys.

Definition at line 311 of file BaseBlacklist.php.

References $cache, getBlacklistType(), and wfDebugLog().

◆ filter()

BaseBlacklist::filter	(	array	$links,
		Title	$title,
			$preventLog = false )

abstract

Parameters

array	$links
Title	$title
bool	$preventLog

Returns: mixed

Reimplemented in EmailBlacklist.

◆ getArticleText()

BaseBlacklist::getArticleText	(		$wiki,
			$pagename )

private

Fetch an article from this or another local MediaWiki database.

Parameters

string	$wiki
string	$pagename

Returns: bool|string|null

Definition at line 389 of file BaseBlacklist.php.

References $content, $title, and wfDebugLog().

Referenced by buildSharedBlacklists().

◆ getBlacklists()

BaseBlacklist::getBlacklists ( )

Fetch local and (possibly cached) remote blacklists.

Will be cached locally across multiple invocations.

Returns: array set of regular expressions, potentially empty.

Definition at line 223 of file BaseBlacklist.php.

References $regexes, getLocalBlacklists(), and getSharedBlacklists().

Referenced by EmailBlacklist\checkUser(), and SpamBlacklist\filter().

◆ getBlacklistType()

BaseBlacklist::getBlacklistType ( )

abstractprotected

Returns the code for the blacklist implementation.

Returns: string

Reimplemented in EmailBlacklist, and SpamBlacklist.

Referenced by buildSharedBlacklists(), clearCache(), getHttpText(), getLocalBlacklists(), getSharedBlacklists(), and getWhitelists().

◆ getBlacklistTypes()

static BaseBlacklist::getBlacklistTypes ( )

static

Return the array of blacklist types currently defined.

Returns: array

Definition at line 92 of file BaseBlacklist.php.

References $blacklistTypes.

Referenced by SpamBlacklistHooks\pageSaveContent().

◆ getEmailBlacklist()

static BaseBlacklist::getEmailBlacklist ( )

static

Returns: EmailBlacklist

Definition at line 106 of file BaseBlacklist.php.

References getInstance().

Referenced by SpamBlacklistPreAuthenticationProvider\testForAccountCreation(), and SpamBlacklistHooks\userCanSendEmail().

◆ getHttpText()

BaseBlacklist::getHttpText ( $fileName )

private

Definition at line 352 of file BaseBlacklist.php.

References $messageMemc, $wgDBname, getBlacklistType(), and wfDebugLog().

Referenced by buildSharedBlacklists().

◆ getInstance()

static BaseBlacklist::getInstance ( $type )

static

Returns an instance of the given blacklist.

Deprecated: Use getSpamBlacklist() or getEmailBlacklist() instead

Parameters

string $type Code for the blacklist

Returns: BaseBlacklist

Exceptions

Exception

Definition at line 118 of file BaseBlacklist.php.

References $type.

Referenced by ApiSpamBlacklist\execute(), getEmailBlacklist(), getSpamBlacklist(), SpamBlacklistHooks\pageSaveContent(), SpamBlacklistTest\setUp(), and SpamBlacklistHooks\validate().

◆ getLocalBlacklists()

BaseBlacklist::getLocalBlacklists ( )

Returns the local blacklist.

Returns: array Regular expressions

Definition at line 238 of file BaseBlacklist.php.

References $cache, $type, getBlacklistType(), and SpamRegexBatch\regexesFromMessage().

Referenced by getBlacklists().

◆ getRegexEnd()

BaseBlacklist::getRegexEnd ( $batchSize )

Returns the end of the regex for matches.

Parameters

int $batchSize

Returns: string

Reimplemented in SpamBlacklist.

Definition at line 424 of file BaseBlacklist.php.

Referenced by SpamRegexBatch\buildRegexes().

◆ getRegexStart()

BaseBlacklist::getRegexStart ( )

Returns the start of the regex for matches.

Returns: string

Reimplemented in SpamBlacklist.

Definition at line 414 of file BaseBlacklist.php.

Referenced by SpamRegexBatch\buildRegexes().

◆ getSharedBlacklists()

BaseBlacklist::getSharedBlacklists ( )

private

Fetch (possibly cached) remote blacklists.

Returns: array

Definition at line 275 of file BaseBlacklist.php.

References $cache, $regexes, getBlacklistType(), and wfDebugLog().

Referenced by getBlacklists().

◆ getSpamBlacklist()

static BaseBlacklist::getSpamBlacklist ( )

static

Returns: SpamBlacklist

Definition at line 99 of file BaseBlacklist.php.

References getInstance().

Referenced by Cleanup\execute(), SpamBlacklistHooks\filterMergedContent(), SpamBlacklistHooks\onParserOutputStashForEdit(), and SpamBlacklistHooks\onUploadVerifyUpload().

◆ getTypeFromTitle()

static BaseBlacklist::getTypeFromTitle ( Title $title )

static

Returns the type of blacklist from the given title.

Todo: building a regex for this is pretty overkill

Parameters

Title $title

Returns: bool|string

Definition at line 205 of file BaseBlacklist.php.

References $title.

Referenced by BaseBlacklistTest\testGetTypeFromTitle(), and SpamBlacklistHooks\validate().

◆ getWhitelists()

BaseBlacklist::getWhitelists ( )

Returns the (local) whitelist.

Returns: array Regular expressions

Definition at line 257 of file BaseBlacklist.php.

References $cache, $type, getBlacklistType(), and SpamRegexBatch\regexesFromMessage().

Referenced by EmailBlacklist\checkUser(), and SpamBlacklist\filter().

◆ isLocalSource()

static BaseBlacklist::isLocalSource ( Title $title )

static

Check if the given local page title is a spam regex source.

Parameters

Title $title

Returns: bool

Definition at line 151 of file BaseBlacklist.php.

References $files, $matches, $title, $type, $wgDBname, NS_MEDIAWIKI, PROTO_HTTP, and wfExpandUrl().

Referenced by SpamBlacklistHooks\pageSaveContent(), and SpamBlacklistHooks\validate().

◆ warmCachesForFilter()

BaseBlacklist::warmCachesForFilter	(	Title	$title,
		array	$entries )

Parameters

Title	$title
string[]	$entries

Reimplemented in SpamBlacklist.

Definition at line 432 of file BaseBlacklist.php.

Member Data Documentation

◆ $blacklistTypes

array BaseBlacklist::$blacklistTypes

staticprivate

Initial value:

= [
        'spam' => 'SpamBlacklist',
        'email' => 'EmailBlacklist',
    ]

Array containing blacklists that extend BaseBlacklist.

Definition at line 46 of file BaseBlacklist.php.

Referenced by getBlacklistTypes().

◆ $expiryTime

int BaseBlacklist::$expiryTime = 900

Definition at line 39 of file BaseBlacklist.php.

◆ $files

array BaseBlacklist::$files = []

Array of blacklist sources.

Definition at line 15 of file BaseBlacklist.php.

Referenced by isLocalSource().

◆ $instances

array BaseBlacklist::$instances = []

staticprivate

Array of blacklist instances.

Definition at line 56 of file BaseBlacklist.php.

◆ $regexes

bool array BaseBlacklist::$regexes = false

protected

Array containing regexes to test against.

Definition at line 22 of file BaseBlacklist.php.

Referenced by buildSharedBlacklists(), getBlacklists(), and getSharedBlacklists().

◆ $warningChance

int BaseBlacklist::$warningChance = 100

Chance of receiving a warning when the filter is hit.

Definition at line 29 of file BaseBlacklist.php.

◆ $warningTime

int BaseBlacklist::$warningTime = 600

Definition at line 34 of file BaseBlacklist.php.

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

extensions/SpamBlacklist/includes/BaseBlacklist.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBlacklistType()

◆ buildSharedBlacklists()

◆ clearCache()

◆ filter()

◆ getArticleText()

◆ getBlacklists()

◆ getBlacklistType()

◆ getBlacklistTypes()

◆ getEmailBlacklist()

◆ getHttpText()

◆ getInstance()

◆ getLocalBlacklists()

◆ getRegexEnd()

◆ getRegexStart()

◆ getSharedBlacklists()

◆ getSpamBlacklist()

◆ getTypeFromTitle()

◆ getWhitelists()

◆ isLocalSource()

◆ warmCachesForFilter()

Member Data Documentation

◆ $blacklistTypes

◆ $expiryTime

◆ $files

◆ $instances

◆ $regexes

◆ $warningChance

◆ $warningTime