Extension:GlobalBlocking

MediaWiki extensions manualManual:Extensions

GlobalBlocking Release status:Extension status beta
ImplementationTemplate:Extension#type	Special page, User identity, API
DescriptionTemplate:Extension#description	Allows IP addresses to be blocked on multiple wikis.
Author(s)Template:Extension#username	Andrew Garrett (Werdnatalk)
MediaWikiTemplate:Extension#mediawiki	1.13-alpha and later
Database changesTemplate:Extension#needs-updatephp	Yes
LicenseTemplate:Extension#license	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history code review
ParametersTemplate:Extension#parameters $wgGlobalBlockingDatabase
Added rightsTemplate:Extension#rights globalblock, globalblock-exempt, "globalblock-whitelist"
Hooks usedTemplate:Extension#hook getUserPermissionsErrorsExpensiveManual:Hooks/getUserPermissionsErrorsExpensive
Translate the GlobalBlocking extension if it is available at translatewiki.net
Check usage and version matrix.
Vagrant roleMediaWiki-Vagrant#Using roles	globalblocking

The GlobalBlocking extension allows a user with the appropriate permissions to block an IP address or IP address range (but not accounts) on all wikis in a group sharing the same globalblocking database. It is intended to be used for combating severe cross-wiki vandalism and spam. Before revision 6899, IPv6 addresses were accepted by the block form, but the blocks were not effective and did not show up in the list of global blocks, unless the default schema of the global blocking database was changed (see below).

Installation instructions

• Download and place the file(s) in a directory called GlobalBlocking in your extensions/ folder.

• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'GlobalBlocking' );
  

• You will also need to create a dedicated database for this extension to work. At a minimum (all wikis running on the same host), you need to create a local database called 'globalblocking' (or specify a different name in $wgGlobalBlockingDatabase), and grant all database users that your wikis run as full permissions on that database (at a minimum, SELECT, UPDATE, INSERT, DELETE).
• After creating the database, you should import the SQL from globalblocking.sql, into the global blocking database.
• You also need to run update.php on each of your local databases, or otherwise import the SQL schema in localdb_patches/setup-global_block_whitelist.sql to them.
• Y Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'GlobalBlocking' );, you need to use:

require_once "$IP/extensions/GlobalBlocking/GlobalBlocking.php";

If you are using a revision before aa93ee537: manually change each 32 in globalblocking.sql to 35 or larger for IPv6 support. If you already have existing IPv6 global blocks, reblock those addresses for the change to take effect. Upgrading the extension past revision aa93ee537 will do this for you.

Configuration

$wgApplyGlobalBlocks

Whether to respect global blocks on this wiki. This is used so that global blocks can be set one one wiki, but not actually applied there (i.e. so people can contest them on that wiki.)

$wgGlobalBlockingBlockXFF

The flag $wgGlobalBlockingBlockXFF, set to true by default, causes blocks to apply to all of the IP addresses in the X-Forwarded-For (XFF) header. Set this flag to false to disable this feature. For more details, see bug 23343.

API

Two API modules are provided, one to (un)block users, and another to view existing global blocks. They are documented at Extension:GlobalBlocking/API

Usage

The following requires appropriate permissions, assigned by default to stewards, which by default can be added or removed by bureaucrats. To make a global block:

1. Go to Special:GlobalBlock
2. Enter the IPv4 address or range (up to /16) that you wish to block (or any IPv6 address or range up to /4 if you made the schema changes prescribed in the installation instructions section of this page or you have the latest revision), and decide if you want to only block anonymous users. To only block anonymous users, check the checkbox.
3. Submit the form. The IP address or range is now globally blocked on your wikis that opt in to the global blocking. Account creation is blocked (even if you selected "anonymous users only": bug 40190), and the blocked IP or range cannot edit any associated user talk pages on any wiki affected and opted in to the global block. If Extension:AbuseFilter is installed, globally blocked IP addresses are prohibited from viewing the abuse log if the particular wiki is opted in to the block.

To remove a global block:

1. Go to Special:GlobalBlockList and click "Remove a global block"
2. Enter the IP address or range to unblock and the reason, and submit the form. The IP address or range will no longer be globally blocked.

See also

• Combating spam and combating vandalism.