Extension:Access Log

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
Access Log

Release status: beta

Implementation Special page
Description Logs user access to MediaWiki
Author(s) University of Macau (Aleksandar Bojinovic, Peter Kin-Fong Fong) (umdaccTalk)
Last version 1.0.2 (06/01/2012)
MediaWiki 1.15+
PHP 5.0
License Educational Community License 2.0
Download see Download section
Hooks used
BeforePageDisplay

ArticleSaveComplete
LoadExtensionSchemaUpdates

Check usage (experimental)

Contents

[edit] What can this extension do?

The Access Log extension adds a special page to MediaWiki. This special page, which is only accessible by certain privileged users, shows who read or edited a page, and when. It provides options to filter the list by user, action, and/or namespace, and limit the number of days to show. It also provides an option to purge old log entries.

[edit] Usage

The AccessLog extension is a MediaWiki Special Page. Only members of the 'sysop' group, and if set, members of the group defined in the $wgAccessControlPanelAllowedGroup variable, can access this special page. There are two ways to invoke this special page and view the access log:

  1. Directly navigate to the page 'Special:AccessLog'.
  2. Enter the 'Special Pages' page and click on the AccessLog special page.

The following shows the access log page, with the filter box:

Screenshot-AccessLog.png

[edit] Download

Download the Access Log extension archive file.

[edit] Installation

[edit] Requirements

The AccessLog extension has the following requirements (besides the MediaWiki and PHP versions specified in the extension box):

  • MySQL database servers are required; PostgreSQL and SQLite are not supported.
  • MediaWiki database administrator access (or other database role that has privileges for creating SQL functions).

[edit] Step by Step Instruction

Step 1: Download the archive file from the link above.

Step 2: Extract the downloaded archive to the extensions directory of your MediaWiki installation. For example (replace with the actual path to your MediaWiki installation):

unzip AccessLog-1.0.2.zip -d /path/to/mediawiki/extensions

Step 3: Add the following line to the bottom of LocalSettings.php (before the trailing ?>, if it is present):

require_once("$IP/extensions/UMEduWiki/AccessLog/AccessLog.php");

Step 4 (optional): Disable client side caching to make sure every page view request hits the server and thus gets logged. Set $wgCachePages to false in LocalSettings.php:

$wgCachePages = false;

Step 5: Update the MediaWiki database by executing the update.php maintenance script.

php /path/to/mediawiki/maintenance/update.php

Step 6: As an administrator (sysop) user, visit the page 'Special:AccessLog' in your MediaWiki installation. If everything went well you should see the AccessLog special page.

Step 7 (optional): By default, actions from anonymous users are ignored. To log actions from anonymous users, add the following line after the require_once statement of step 3:

$wgAccessLogAnons = true;

Step 8 (optional): If you are using the Access Control Panel extension, the members of $wgAccessControlPanelAllowedGroup can also access the access log page. If you are not using that extension, but want to grant access privilege to non-sysop users, create a new user group. Add the following lines to LocalSettings.php.

$wgAccessControlPanelAllowedGroup = 'ControlGroup';
 
$wgGroupPermissions[$wgAccessControlPanelAllowedGroup]['read']   = true;
$wgGroupPermissions[$wgAccessControlPanelAllowedGroup]['edit']   = true;

After that, add user(s) who are going to read the access log into 'ControlGroup' (or whatever name you chose for this group). For detailed steps, please visit Help:Assigning permissions.

[edit] See also

Personal tools
Namespaces

Variants
Actions
Navigation
Support
Download
Development
Communication
Print/export
Toolbox