Go to the documentation of this file.
32 if ( self::$instance ===
null ) {
33 self::$instance =
new self;
35 return self::$instance;
46 if ( !defined(
'MW_PHPUNIT_TEST' ) ) {
48 'Can not invoke ' . __METHOD__ .
'() ' .
49 'out of tests (MW_PHPUNIT_TEST not set).'
53 self::$instance =
null;
60 global $wgTitleBlacklistSources, $wgTitleBlacklistCaching;
64 $cachedBlacklist =
$cache->get(
wfMemcKey(
"title_blacklist_entries" ) );
65 if ( is_array( $cachedBlacklist ) &&
count( $cachedBlacklist ) > 0 && ( $cachedBlacklist[0]->getFormatVersion() == self::VERSION ) ) {
66 $this->mBlacklist = $cachedBlacklist;
70 $sources = $wgTitleBlacklistSources;
71 $sources[
'local'] =
array(
'type' =>
'message' );
72 $this->mBlacklist =
array();
73 foreach( $sources
as $sourceName =>
$source ) {
76 $cache->set(
wfMemcKey(
"title_blacklist_entries" ), $this->mBlacklist, $wgTitleBlacklistCaching[
'expiry'] );
78 .
' with ' .
count( $this->mBlacklist ) .
' entries.' );
85 global $wgTitleBlacklistCaching;
88 $cachedWhitelist =
$cache->get(
wfMemcKey(
"title_whitelist_entries" ) );
89 if ( is_array( $cachedWhitelist ) &&
count( $cachedWhitelist ) > 0 && ( $cachedWhitelist[0]->getFormatVersion() != self::VERSION ) ) {
90 $this->mWhitelist = $cachedWhitelist;
94 ->inContentLanguage()->
text(),
'whitelist' );
95 $cache->set(
wfMemcKey(
"title_whitelist_entries" ), $this->mWhitelist, $wgTitleBlacklistCaching[
'expiry'] );
109 if (
$source[
'type'] ==
'message' ) {
110 return wfMessage(
'titleblacklist' )->inContentLanguage()->text();
113 if ( is_null(
$title ) ) {
118 if ( !$msg->isDisabled() ) {
125 if (
$page->exists() ) {
130 return self::getHttp(
$source[
'src'] );
132 if ( file_exists(
$source[
'src'] ) ) {
133 return file_get_contents(
$source[
'src'] );
149 $lines = preg_split(
"/\r?\n/", $list );
178 if ( isset(
$params[
'autoconfirmed'] ) &&
$user->isAllowed(
'autoconfirmed' ) ) {
181 if ( $override && self::userCanOverride(
$user, $action ) ) {
206 $autoconfirmedItem =
false;
207 foreach ( $blacklist
as $item ) {
208 if ( $item->matches(
$title->getFullText(), $action ) ) {
213 if ( !isset(
$params[
'autoconfirmed'] ) ) {
216 if ( !$autoconfirmedItem ) {
217 $autoconfirmedItem = $item;
221 return $autoconfirmedItem;
237 foreach ( $whitelist
as $item ) {
238 if ( $item->matches(
$title->getFullText(), $action ) ) {
251 if ( is_null( $this->mBlacklist ) ) {
263 if ( is_null( $this->mWhitelist ) ) {
277 $key =
"title_blacklist_source:" . md5( $url );
278 $warnkey =
wfMemcKey(
"titleblacklistwarning", md5( $url ) );
281 if ( !is_string(
$result ) || ( !$warn && !mt_rand( 0, $wgTitleBlacklistCaching[
'warningchance'] ) ) ) {
283 $messageMemc->set( $warnkey, 1, $wgTitleBlacklistCaching[
'warningexpiry'] );
304 $badEntries =
array();
305 foreach ( $blacklist
as $e ) {
307 $regex =
$e->getRegex();
308 if ( preg_match(
"/{$regex}/u",
'' ) ===
false ) {
309 $badEntries[] =
$e->getRaw();
324 return $user->isAllowed(
'tboverride' ) ||
325 ( $action ==
'new-account' &&
$user->isAllowed(
'tboverride-account' ) );
350 $this->mRegex = $regex;
360 global $wgTitleBlacklistUsernameSources;
362 if( $wgTitleBlacklistUsernameSources ===
'*' ) {
366 if( !$wgTitleBlacklistUsernameSources ) {
370 if( !is_array( $wgTitleBlacklistUsernameSources ) ) {
372 '$wgTitleBlacklistUsernameSources must be "*", false or an array' );
375 return in_array( $this->mSource, $wgTitleBlacklistUsernameSources,
true );
395 if ( isset( $this->mParams[
'antispoof'] )
396 && is_callable(
'AntiSpoof::checkUnicodeString' )
398 if ( $action ===
'edit' ) {
401 list( $ok, $norm ) =
$cache->getWithSetCallback(
402 $cache->makeKey(
'titleblacklist',
'normalized-unicode', md5(
$title ) ),
405 return AntiSpoof::checkUnicodeString(
$title );
409 list( $ok, $norm ) = AntiSpoof::checkUnicodeString(
$title );
412 if ( $ok ===
"OK" ) {
413 list( $ver,
$title ) = explode(
':', $norm, 2 );
415 wfDebugLog(
'TitleBlacklist',
'AntiSpoof could not normalize "' .
$title .
'".' );
421 "/^(?:{$this->mRegex})$/us" . ( isset( $this->mParams[
'casesensitive'] ) ?
'' :
'i' ),
427 if ( isset( $this->mParams[
'moveonly'] ) && $action !=
'move' ) {
430 if ( isset( $this->mParams[
'newaccountonly'] ) && $action !=
'new-account' ) {
433 if ( !isset( $this->mParams[
'noedit'] ) && $action ==
'edit' ) {
436 if ( isset( $this->mParams[
'reupload'] ) && $action ==
'upload' ) {
456 $line = preg_replace(
"/^\\s*([^#]*)\\s*((.*)?)$/",
"\\1",
$line );
459 preg_match(
'/^(.*?)(\s*<([^<>]*)>)?$/',
$line, $pockets );
460 @
list( $full, $regex, $null, $opts_str ) = $pockets;
461 $regex = trim( $regex );
462 $regex = str_replace(
'_',
' ', $regex );
463 $opts_str = trim( $opts_str );
465 $opts = preg_split(
'/\s*\|\s*/', $opts_str );
466 foreach ( $opts
as $opt ) {
467 $opt2 = strtolower(
$opt );
468 if ( $opt2 ==
'autoconfirmed' ) {
471 if ( $opt2 ==
'moveonly' ) {
474 if ( $opt2 ==
'newaccountonly' ) {
477 if ( $opt2 ==
'noedit' ) {
480 if ( $opt2 ==
'casesensitive' ) {
483 if ( $opt2 ==
'reupload' ) {
486 if ( preg_match(
'/errmsg\s*=\s*(.+)/i',
$opt,
$matches ) ) {
489 if ( $opt2 ==
'antispoof' ) {
494 preg_match_all(
'/{{\s*([a-z]+)\s*:\s*(.+?)\s*}}/', $regex, $magicwords, PREG_SET_ORDER );
495 foreach ( $magicwords
as $mword ) {
497 switch( strtolower( $mword[1] ) ) {
500 if ( is_string( $cpf_result ) ) {
501 $regex = str_replace( $mword[0], $cpf_result, $regex );
505 $cpf_result =
wfMessage( $mword[2] )->inContentLanguage()->text();
506 if ( is_string( $cpf_result ) ) {
507 $regex = str_replace( $mword[0], $cpf_result, $regex );
544 return isset( $this->mParams[
'errmsg'] ) ? $this->mParams[
'errmsg'] :
null;
571 return $message ? $message :
"titleblacklist-forbidden-{$operation}";
setFormatVersion( $v)
Set the format version.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
validate( $blacklist)
Validate a new blacklist.
static singleton()
Get an instance of this class.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest to get request data $messageMemc
static destroySingleton()
Destroy/reset the current singleton instance.
getErrorMessage( $operation)
Return the error message name for the blacklist entry.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
$mRegex
Regular expression to match.
filtersNewAccounts()
Returns whether this entry is capable of filtering new accounts.
wfMemcKey()
Make a cache key for the local wiki.
namespace and then decline to actually register it file or subcat img or subcat $title
$mFormatVersion
Entry format version.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
$mSource
Source of this entry.
getWhitelist()
Get the current whitelist.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
matches( $title, $action)
Check whether a user can perform the specified action on the specified Title.
Represents a title blacklist entry.
getBlacklist()
Get the current blacklist.
when a variable name is used in a it is silently declared as a new masking the global
static ns( $parser, $part1='')
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static get( $url, $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
static getHttp( $url)
Get the text of a blacklist source via HTTP.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static newFromString( $line, $source)
Create a new TitleBlacklistEntry from a line of text.
userCannot( $title, $user, $action='edit', $override=true)
Check whether the blacklist restricts given user performing a specific action on the given Title.
$mParams
Parameters for this entry.
__construct( $regex, $params, $raw, $source)
Construct a new TitleBlacklistEntry.
static parseBlacklist( $list, $sourceName)
Parse blacklist from a string.
static getBlacklistText( $source)
Get the text of a blacklist from a specified source.
loadWhitelist()
Load local whitelist.
static userCanOverride( $user, $action)
Inidcates whether user can override blacklist on certain action.
invalidate()
Invalidate the blacklist cache.
Represents a title within MediaWiki.
isWhitelisted( $title, $action='edit')
Check whether it has been explicitly whitelisted that the current User may perform a specific action ...
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
load()
Load all configured blacklist sources.
static getMainWANInstance()
Get the main WAN cache object.
static TitleBlacklist $instance
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
Implements a title blacklist for MediaWiki.
isBlacklisted( $title, $action='edit')
Check whether the blacklist restricts performing a specific action on the given Title.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
the array() calling protocol came about after MediaWiki 1.4rc1.