Extension:RottenLinks

MediaWiki extensions manual

RottenLinks Release status: stable
Description	Provides the Special page Special:RottenLinks.
Author(s)	John Lewis, Paladox, Universal Omega
Maintainer(s)	Miraheze system administrators
Latest version	continuous updates
MediaWiki	1.39+
PHP	7.2+
Database changes	Yes
Composer	miraheze/rotten-links
Parameters $wgRottenLinksBadCodes $wgRottenLinksCurlTimeout $wgRottenLinksExcludeProtocols $wgRottenLinksExcludeWebsites $wgRottenLinksExternalLinkTarget
Hooks used LoadExtensionSchemaUpdates
License	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL commit history README CHANGELOG

The RottenLinks extension provides the special page "Special:RottenLinks", which shows a table of all external links on your wiki pages, and tells you their status.

For reporting an issue or a bug, please use Miraheze Phabricator. See here for the workboard.

Installation

• Download and place the file(s) in a directory called RottenLinks in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'RottenLinks' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
• Configure as required.
• Run the following script to populate the special page "Special:RottenLinks":

  php extensions/RottenLinks/maintenance/updateExternalLinks.php
  

Since the REL1_42 branch, the filename has been UpdateExternalLinks.php, with a capital "U".

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

If you would like to use RottenLinks with MediaWiki 1.39, you have to use the REL1_39 branch. For MediaWiki 1.43, use the REL1_42 branch.

Configuration

$wgRottenLinksBadCodes

Holds a list of HTTP codes that are considered bad. Defaults to [ "0", "400", "401", "403", "404", "405", "502", "503", "504" ].

$wgRottenLinksCurlTimeout

Sets the timeout for cURL in seconds. Defaults to 30.

$wgRottenLinksHTTPProxy

Sets a proxy to use for requests. Defaults to "" (use no proxy). Example: $wgRottenLinksHTTPProxy = "http://username:password@proxy.example.com:8080";

$wgRottenLinksExcludeProtocols

Holds a list of protocols that should not be checked for validity. Defaults to [ "tel", "mailto" ].

$wgRottenLinksExternalLinkTarget

Sets the external link target (_self for the current tab or _blank for new tab). Defaults to _self.

$wgRottenLinksExcludeWebsites

List of websites to blacklist checking of response codes for. Defaults to false. Omit the protocol, e.g. use $wgRottenLinksExcludeWebsites = [ "www.example.com" ];

Usage

Run the updateExternalLinks.php script provided with the extension every time you would like to create or update the list of rotten links shown on the special page "Special:RottenLinks".