Extension:GlobalBlocking

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
GlobalBlocking

Release status: beta

Globalblock.png
Implementation Special page, User identity, API
Description Allows IP addresses to be blocked on multiple wikis.
Author(s) Andrew Garrett (Werdnatalk)
MediaWiki 1.13-alpha and later
License GPL
Download
Parameters

$wgGlobalBlockingDatabase

Added rights

globalblock, globalunblock

Hooks used
getUserPermissionsErrorsExpensive

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

Check usage and version matrix; code metrics

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[edit | edit source]

  • Download and extract the tarball in your extensions/ folder. It should generate a new folder called GlobalBlocking directly inside your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/GlobalBlocking/GlobalBlocking.php";
  • 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 import the SQL schema in localdb_patches/setup-global_block_whitelist.sql to each of your local wiki databases.
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
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 6899 will do this for you.

API[edit | edit source]

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[edit | edit source]

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 is no longer globally blocked.

Blocks for X-Forwarded-For Header:

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

See also[edit | edit source]