Extension:TitleBlacklist

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎한국어 • ‎polski • ‎português • ‎português do Brasil
This extension is bundled with MediaWiki 1.21 and above. Thus you do not have to download it again.
MediaWiki extensions manual
Crystal Clear action run.png
TitleBlacklist

Release status: stable

Implementation User rights, API
Description Blocks the creation of pages matching a regular expression blacklist
Author(s) Victor Vasiliev (VasilievVVtalk)
Latest version 1.5.0 (2014-03-29)
MediaWiki 1.20+
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgTitleBlacklistSources
Added rights
  • tboverride
  • tboverride-account
Hooks used
getUserPermissionsErrorsExpensive

AbortMove
AbortNewAccount
AbortAutoAccount
EditFilter
ArticleSaveComplete
UserCreateForm

Translate the TitleBlacklist extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

The TitleBlacklist extension allows wiki administrators to block the creation, movement and upload of pages, the title of which matches one or more regular expressions, as well as blocking creation of accounts with matching usernames.

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called TitleBlacklist in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/TitleBlacklist.git
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/TitleBlacklist/TitleBlacklist.php";
  • Configure blacklist sources (see below)
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Note Note: By default it only affects non-sysop users. To make it default for all use $wgGroupPermissions['sysop']['tboverride'] = false;.

Multiple blacklist sources[edit | edit source]

Title blacklist can be gathered from multiple sources except local message. For configuring blacklist sources use code like this:

$wgTitleBlacklistSources = array(
    array(
         'type' => TBLSRC_LOCALPAGE,
         'src'  => 'MediaWiki:Titleblacklist',
    ),
    array(
         'type' => TBLSRC_URL,
         'src'  => 'https://meta.wikimedia.org/w/index.php?title=Title_blacklist&action=raw',
    ),
    array(
         'type' => TBLSRC_FILE,
         'src'  => '/home/wikipedia/blacklists/titles',
    ),
);
  • Use TBLSRC_LOCALPAGE for using local page as title blacklist
  • Use TBLSRC_URL for using external URL as title blacklist
  • Use TBLSRC_FILE for using file as title blacklist

Editing the blacklist[edit | edit source]

The title blacklist is found on the MediaWiki:Titleblacklist page.

This page consists of regular expressions, each on a separate line, for example:

Foo <autoconfirmed|noedit|errmsg=blacklisted-testpage> 
[Bb]ar #No one should create article about it

Each entry may also contain optional attributes, enclosed in <> and separated with |

  • autoconfirmed - only autoconfirmed users are able to create/upload/move such pages
  • casesensitive - don't ignore case when checking title for being blacklisted
  • noedit - users are also unable to edit this article
  • moveonly - forbid moves but allow ordinary creation (rev:35163)
  • newaccountonly - forbid creation of matching usernames, but allow page creation (rev:38977)
  • reupload - allow reuploads of existing blacklisted files (rev:33656)
  • errmsg - the name of the message that should be displayed instead of standard

What is referred to here as regular expressions are not proper regular expressions, but rather subpatterns that are inserted into a hard-coded regular expression. i.e. the subpattern Foo from above would create a regular expression like /^Foo$/usi.

Underscores ("_") in regular expressions will be converted to spaces by the extension, because titles are matched against its text form ("Page title" instead of "Page_title").

Whitelist[edit | edit source]

There is also a whitelist at MediaWiki:Titlewhitelist. The blacklist is applied first, then the whitelist. So user input that matches an entry on the blacklist is blocked, except if it matches an entry on the whitelist. You don't have to configure anything in LocalSettings.php in order to use the whitelist. Some of the optional attributes listed above, for the blacklist, also work for the whitelist, e.g. casesensitive.

Customising warning messages[edit | edit source]

When an attempt to create a page is blocked due to a blacklisted title, a warning message is shown to the user. This can be customised via system messages

Custom messages can be defined by using the errmsg attribute.

Using TitleBlacklist to control user account creation[edit | edit source]

Conceptual overview[edit | edit source]

The username for new accounts will be regarded by Titleblacklist differently to the way it regards new articles. Titleblacklist will prepend "User:" (or its localized equivalent) to the string that a user enters at Username on the create account page. So when Titleblacklist is performing matches with your Regex's, as found on MediaWiki:Titleblacklist or MediaWiki:Titlewhitelist, it will match against "User:" + <userinput>.

For example, imagine you want to block "jill" as a new user. Imagine you had a blacklist regex "jill.* <newaccountonly>" and a user enters "jill" as the username on the create account page. This will pass as the comparison Titleblacklist will make will be between "jill.*" (the regex) and "User:jill" (the constructed input string). These don't match and so "jill" is allowed (and you probably didn't intend this). To effect the intended block use a regex like ".*jill.* <newaccountonly>" or "User:jill.* <newaccountonly>" on MediaWiki:Titleblacklist.

If you want to block all users except for all those that do match a regex then block all users in MediaWiki:Titleblacklist and write the permissible regex in the MediaWiki:Titlewhitelist.

A working example[edit | edit source]

If you would like to force all usernames, during account creation, to consist of exactly two names, space separated, with each name capitalized then do the following:

1. Install TitleBlacklist.

2. Add the following to your LocalSettings.php

require_once( "{$IP}/extensions/TitleBlacklist/TitleBlacklist.php" );
// Apply to all, not just anonymous users.
$wgGroupPermissions['sysop']['tboverride'] = false; 
$wgTitleBlacklistSources = array(
  array(
    'type' => TBLSRC_LOCALPAGE,
    'src'  => 'MediaWiki:Titleblacklist'
  )
);

3. In https://www.example.com/mywiki/MediaWiki:Titleblacklist add

# Block all user accounts, and only permit those that match the MediaWiki:Titlewhitelistregex 
.* <newaccountonly>

4. In https://www.example.com/mywiki/MediaWiki:Titlewhitelist add

# Only allow two names, separated by a space, with each name capitalized. E.g "Fred Mew" OK, "Fred mew" fails, "Fredmew" fails.
# Depends on .* <newaccountonly> in blacklist
User:[A-Z][a-z]+\s[A-Z][a-z]+ <casesensitive>

5. In https://www.example.com/mywiki/MediaWiki:Titleblacklist-forbidden-new-account edit

The user name "$2" has been blocked from creation. It matches the following blacklist entry: <code>$1</code>.

Please use a real name for the user name. User names need to be comprised of two names separated by a space. Each name must be capitalised.

E.g.:
* "Mary Smith". OK.
* "MarySmith". Invalid.
* "Mary smith". Invalid.
* "marysmith". Invalid.

User name creation (and article creation) blocking rules are controlled by MediaWiki:Titleblacklist and MediaWiki:Titlewhitelist. This message can be customised at MediaWiki:Titleblacklist-forbidden-new-account

Resources on regular expressions[edit | edit source]


See also[edit | edit source]