Extension:GlobalUsage

From MediaWiki.org
Jump to: navigation, search


MediaWiki extensions manual
Crystal Clear action run.png
GlobalUsage

Release status: stable

Implementation Special pageAPI
Description Allows to view the global usage of images in a wiki farm with shared image repository
Author(s) Bryan Tong Minh (Bryantalk)
MediaWiki 1.16+
Database changes Yes
License MIT
Download
README
Hooks used
LinksUpdateComplete

ArticleDeleteComplete
TitleMoveComplete
FileUndeleteComplete
UploadComplete
ImagePageAfterImageLinks

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

Check usage and version matrix; code metrics
Bugs: list open list all report

The GlobalUsage extension allows to view the global usage of images in a wiki farm with shared image repository. It adds Special:GlobalUsage as well as a list of pages that include the image on image description pages.

Installation[edit | edit source]

  1. Download the extension and unpack it in the extensions directory
  2. Source GlobalUsage.sql: php maintenance/sql.php extensions/GlobalUsage/GlobalUsage.sql
    Note: do this from the wiki installation where you want the GlobalUsage data to be located. Typically this is your shared image repository. Running update.php on that wiki will also create the table.
  3. Edit LocalSettings.php and add to the bottom of the file:
    require_once("$IP/extensions/GlobalUsage/GlobalUsage.php");
    
  4. In LocalSettings, set $wgGlobalUsageDatabase to the identifier of the wiki where the GlobalUsage data is located (usually the database name). It should be something understandable to wfGetDB. Example: $wgGlobalUsageDatabase = 'commonswiki';
    At present, this can NOT be a database name of a wiki, but must be a name given in a load balancer configuration: Manual:$wgLBFactoryConf, a complex and largely undocumented configuration structure used by the WMF and Wikia. For a normal mediawiki setup using multiple databases configuring and maintaining this data structures implies significant difficulties.
  5. Run refreshGlobalimagelinks.php on all wikis in your farm. This will take a long time. php extensions/GlobalUsage/refreshGlobalimagelinks.php
  6. Visit Special:GlobalUsage and enjoy.

API[edit | edit source]

Extension:GlobalUsage includes an API extension that allows bots and other programs to query the global usage of a file. For example, this query on Wikimedia Commons returns global uses of File:Example.jpg:


By default this returns only 10 results. The next 10 results can be retrieved using the gucontinue parameter included in the result above:


The number of results returned is set with the gulimit parameter. The guprop parameter sets which properties to retrieve. The gufilterlocal parameter, when set to 1, will exclude uses on the same wiki as the file (e.g. on Commons). The following query retrieves all properties and up to 100 results, excluding local uses: