MediaWiki  1.33.1
TitleBlacklist.php
Go to the documentation of this file.
1 <?php
19  private $mBlacklist = null;
20 
22  private $mWhitelist = null;
23 
25  protected static $instance = null;
26 
27  const VERSION = 3; // Blacklist format
28 
34  public static function singleton() {
35  if ( self::$instance === null ) {
36  self::$instance = new self;
37  }
38  return self::$instance;
39  }
40 
47  public static function destroySingleton() {
48  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
49  throw new MWException(
50  'Can not invoke ' . __METHOD__ . '() ' .
51  'out of tests (MW_PHPUNIT_TEST not set).'
52  );
53  }
54 
55  self::$instance = null;
56  }
57 
61  public function load() {
62  global $wgTitleBlacklistSources, $wgTitleBlacklistCaching;
63 
65  // Try to find something in the cache
66  $cachedBlacklist = $cache->get( $cache->makeKey( 'title_blacklist_entries' ) );
67  if ( is_array( $cachedBlacklist ) && count( $cachedBlacklist ) > 0
68  && ( $cachedBlacklist[0]->getFormatVersion() == self::VERSION )
69  ) {
70  $this->mBlacklist = $cachedBlacklist;
71  return;
72  }
73 
74  $sources = $wgTitleBlacklistSources;
75  $sources['local'] = [ 'type' => 'message' ];
76  $this->mBlacklist = [];
77  foreach ( $sources as $sourceName => $source ) {
78  $this->mBlacklist = array_merge(
79  $this->mBlacklist,
80  $this->parseBlacklist( $this->getBlacklistText( $source ), $sourceName )
81  );
82  }
83  $cache->set( $cache->makeKey( 'title_blacklist_entries' ),
84  $this->mBlacklist, $wgTitleBlacklistCaching['expiry'] );
85  wfDebugLog( 'TitleBlacklist-cache', 'Updated ' . $cache->makeKey( 'title_blacklist_entries' )
86  . ' with ' . count( $this->mBlacklist ) . ' entries.' );
87  }
88 
92  public function loadWhitelist() {
93  global $wgTitleBlacklistCaching;
94 
96  $cachedWhitelist = $cache->get( $cache->makeKey( 'title_whitelist_entries' ) );
97  if ( is_array( $cachedWhitelist ) && count( $cachedWhitelist ) > 0
98  && ( $cachedWhitelist[0]->getFormatVersion() != self::VERSION )
99  ) {
100  $this->mWhitelist = $cachedWhitelist;
101  return;
102  }
103  $this->mWhitelist = $this->parseBlacklist( wfMessage( 'titlewhitelist' )
104  ->inContentLanguage()->text(), 'whitelist' );
105  $cache->set( $cache->makeKey( 'title_whitelist_entries' ),
106  $this->mWhitelist, $wgTitleBlacklistCaching['expiry'] );
107  }
108 
115  private static function getBlacklistText( $source ) {
116  if ( !is_array( $source ) || count( $source ) <= 0 ) {
117  return ''; // Return empty string in error case
118  }
119 
120  if ( $source['type'] == 'message' ) {
121  return wfMessage( 'titleblacklist' )->inContentLanguage()->text();
122  } elseif ( $source['type'] == 'localpage' && count( $source ) >= 2 ) {
123  $title = Title::newFromText( $source['src'] );
124  if ( is_null( $title ) ) {
125  return '';
126  }
127  if ( $title->getNamespace() == NS_MEDIAWIKI ) {
128  $msg = wfMessage( $title->getText() )->inContentLanguage();
129  if ( !$msg->isDisabled() ) {
130  return $msg->text();
131  } else {
132  return '';
133  }
134  } else {
135  $page = WikiPage::factory( $title );
136  if ( $page->exists() ) {
137  return ContentHandler::getContentText( $page->getContent() );
138  }
139  }
140  } elseif ( $source['type'] == 'url' && count( $source ) >= 2 ) {
141  return self::getHttp( $source['src'] );
142  } elseif ( $source['type'] == 'file' && count( $source ) >= 2 ) {
143  if ( file_exists( $source['src'] ) ) {
144  return file_get_contents( $source['src'] );
145  } else {
146  return '';
147  }
148  }
149 
150  return '';
151  }
152 
160  public static function parseBlacklist( $list, $sourceName ) {
161  $lines = preg_split( "/\r?\n/", $list );
162  $result = [];
163  foreach ( $lines as $line ) {
165  if ( $line ) {
166  $result[] = $line;
167  }
168  }
169 
170  return $result;
171  }
172 
184  public function userCannot( $title, $user, $action = 'edit', $override = true ) {
185  $entry = $this->isBlacklisted( $title, $action );
186  if ( !$entry ) {
187  return false;
188  }
189  $params = $entry->getParams();
190  if ( isset( $params['autoconfirmed'] ) && $user->isAllowed( 'autoconfirmed' ) ) {
191  return false;
192  }
193  if ( $override && self::userCanOverride( $user, $action ) ) {
194  return false;
195  }
196  return $entry;
197  }
198 
208  public function isBlacklisted( $title, $action = 'edit' ) {
209  if ( !( $title instanceof Title ) ) {
211  if ( !( $title instanceof Title ) ) {
212  // The fact that the page name is invalid will stop whatever
213  // action is going through. No sense in doing more work here.
214  return false;
215  }
216  }
217  $blacklist = $this->getBlacklist();
218  $autoconfirmedItem = false;
219  foreach ( $blacklist as $item ) {
220  if ( $item->matches( $title->getFullText(), $action ) ) {
221  if ( $this->isWhitelisted( $title, $action ) ) {
222  return false;
223  }
224  $params = $item->getParams();
225  if ( !isset( $params['autoconfirmed'] ) ) {
226  return $item;
227  }
228  if ( !$autoconfirmedItem ) {
229  $autoconfirmedItem = $item;
230  }
231  }
232  }
233  return $autoconfirmedItem;
234  }
235 
244  public function isWhitelisted( $title, $action = 'edit' ) {
245  if ( !( $title instanceof Title ) ) {
247  }
248  $whitelist = $this->getWhitelist();
249  foreach ( $whitelist as $item ) {
250  if ( $item->matches( $title->getFullText(), $action ) ) {
251  return true;
252  }
253  }
254  return false;
255  }
256 
262  public function getBlacklist() {
263  if ( is_null( $this->mBlacklist ) ) {
264  $this->load();
265  }
266  return $this->mBlacklist;
267  }
268 
274  public function getWhitelist() {
275  if ( is_null( $this->mWhitelist ) ) {
276  $this->loadWhitelist();
277  }
278  return $this->mWhitelist;
279  }
280 
287  private static function getHttp( $url ) {
288  global $messageMemc, $wgTitleBlacklistCaching;
289 
290  $key = 'title_blacklist_source:' . md5( $url ); // Global shared
291  $warnkey = $messageMemc->makeKey( 'titleblacklistwarning', md5( $url ) );
292  $result = $messageMemc->get( $key );
293  $warn = $messageMemc->get( $warnkey );
294 
295  if ( !is_string( $result )
296  || ( !$warn && !mt_rand( 0, $wgTitleBlacklistCaching['warningchance'] ) )
297  ) {
298  $result = Http::get( $url );
299  $messageMemc->set( $warnkey, 1, $wgTitleBlacklistCaching['warningexpiry'] );
300  $messageMemc->set( $key, $result, $wgTitleBlacklistCaching['expiry'] );
301  }
302 
303  return $result;
304  }
305 
309  public function invalidate() {
311  $cache->delete( $cache->makeKey( 'title_blacklist_entries' ) );
312  }
313 
321  public function validate( $blacklist ) {
322  $badEntries = [];
323  foreach ( $blacklist as $e ) {
324  Wikimedia\suppressWarnings();
325  $regex = $e->getRegex();
326  if ( preg_match( "/{$regex}/u", '' ) === false ) {
327  $badEntries[] = $e->getRaw();
328  }
329  Wikimedia\restoreWarnings();
330  }
331  return $badEntries;
332  }
333 
342  public static function userCanOverride( $user, $action ) {
343  return $user->isAllowed( 'tboverride' ) ||
344  ( $action == 'new-account' && $user->isAllowed( 'tboverride-account' ) );
345  }
346 }
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
TitleBlacklist\validate
validate( $blacklist)
Validate a new blacklist.
Definition: TitleBlacklist.php:321
TitleBlacklist\singleton
static singleton()
Get an instance of this class.
Definition: TitleBlacklist.php:34
captcha-old.count
count
Definition: captcha-old.py:249
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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 since 1.28! 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
Definition: hooks.txt:1991
$params
$params
Definition: styleTest.css.php:44
TitleBlacklist\destroySingleton
static destroySingleton()
Destroy/reset the current singleton instance.
Definition: TitleBlacklist.php:47
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1043
php
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
Definition: injection.txt:35
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
TitleBlacklist\getWhitelist
getWhitelist()
Get the current whitelist.
Definition: TitleBlacklist.php:274
Http\get
static get( $url, array $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
Definition: Http.php:98
$lines
$lines
Definition: router.php:61
TitleBlacklist\getBlacklist
getBlacklist()
Get the current blacklist.
Definition: TitleBlacklist.php:262
TitleBlacklist\$mWhitelist
array $mWhitelist
Definition: TitleBlacklist.php:22
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$line
$line
Definition: cdb.php:59
TitleBlacklist\getHttp
static getHttp( $url)
Get the text of a blacklist source via HTTP.
Definition: TitleBlacklist.php:287
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2170
TitleBlacklistEntry\newFromString
static newFromString( $line, $source)
Create a new TitleBlacklistEntry from a line of text.
Definition: TitleBlacklistEntry.php:161
$messageMemc
$messageMemc
Definition: Setup.php:769
TitleBlacklist\$mBlacklist
array $mBlacklist
Definition: TitleBlacklist.php:19
TitleBlacklist\userCannot
userCannot( $title, $user, $action='edit', $override=true)
Check whether the blacklist restricts given user performing a specific action on the given Title.
Definition: TitleBlacklist.php:184
TitleBlacklist\VERSION
const VERSION
Definition: TitleBlacklist.php:27
TitleBlacklist\parseBlacklist
static parseBlacklist( $list, $sourceName)
Parse blacklist from a string.
Definition: TitleBlacklist.php:160
TitleBlacklist\getBlacklistText
static getBlacklistText( $source)
Get the text of a blacklist from a specified source.
Definition: TitleBlacklist.php:115
text
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
Definition: All_system_messages.txt:1267
TitleBlacklist\loadWhitelist
loadWhitelist()
Load local whitelist.
Definition: TitleBlacklist.php:92
TitleBlacklist\userCanOverride
static userCanOverride( $user, $action)
Inidcates whether user can override blacklist on certain action.
Definition: TitleBlacklist.php:342
TitleBlacklist\invalidate
invalidate()
Invalidate the blacklist cache.
Definition: TitleBlacklist.php:309
Title
Represents a title within MediaWiki.
Definition: Title.php:40
TitleBlacklist\isWhitelisted
isWhitelisted( $title, $action='edit')
Check whether it has been explicitly whitelisted that the current User may perform a specific action ...
Definition: TitleBlacklist.php:244
ContentHandler\getContentText
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
Definition: ContentHandler.php:83
TitleBlacklist\load
load()
Load all configured blacklist sources.
Definition: TitleBlacklist.php:61
$cache
$cache
Definition: mcc.php:33
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:369
TitleBlacklist\$instance
static TitleBlacklist $instance
Definition: TitleBlacklist.php:25
as
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
Definition: distributors.txt:9
$source
$source
Definition: mwdoc-filter.php:46
TitleBlacklist
Implements a title blacklist for MediaWiki.
Definition: TitleBlacklist.php:17
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:72
wfMessage
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 use $formDescriptor instead 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 "&lt
TitleBlacklist\isBlacklisted
isBlacklisted( $title, $action='edit')
Check whether the blacklist restricts performing a specific action on the given Title.
Definition: TitleBlacklist.php:208