Extension:WSStats

MediaWiki extensions manual

WSStats Release status: stable
Implementation	Parser extension
Description	Collect page statistics
Author(s)	Charlot Cobben (Sen-Saitalk)
Latest version	1.0.6
MediaWiki
Database changes	Yes
Composer	wikibase-solutions/w-s-stats
Parameters $wgWSSStats
Tags wikibasesolutions, page statistics
Hooks used ParserFirstCallInit BeforePageDisplay LoadExtensionSchemaUpdates AdminLinks
Licence	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL commit history Note: No localisation updates are provided by translatewiki.net . [README]

Make sure you update to at least version 1.0.4 due to a security risk

WSStats extension counts pageviews by user

• Version 1.0.6 : Fixed path to sql tables
• Version 1.0.5 : Rewrote database queries to use MW database abstraction layer. extension manifest 2 and all user input is validated.
• Version 1.0.4 : Security fix! Unhandled user input. Update to 1.0.4 as soon as possible.
• Version 1.0.3 : Top X list changed as it no longer shows deleted pages
• Version 1.0.2 : Catched request for title on a non-existing page
• Version 1.0.1 : Code clean-up and i18n messages added
• Version 1.0.0 : Added support for setting limit and export as WSArrays
• Version 0.8.2 : Added support for filtering only unique visitors
• Version 0.8.1 : adminlinks added
• Version 0.8.0 : Clean Up
• Version 0.1.9 : Fetch Title changes
• Version 0.1.8 : Removed dbprefix class variable
• Version 0.1.7 : Show top visited pages with date range. Show as csv option
• Version 0.1.6 : Filter results on user or anonymous
• Version 0.1.5 : Added more configuration options
• Version 0.1.3 : Fixed error in MySQL
• Version 0.1.2 : Skip usergroup results
• Version 0.1.1 : Initial release

Installation

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

  wfLoadExtension( 'WSStats' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

By default Anonymous users and sysops are skipped from stats recording. To change this add following to LocalSettings.php..

Start with:

$wgWSStats=array();

Allow statistics for anonymous users..

//Record anonymous users
$wgWSStats['skip_anonymous']=false;

Skip users in the following groups..

//Skip if user is in following groups
$wgWSStats['skip_user_groups'][]='sysop';
$wgWSStats['skip_user_groups'][]='admin';

Count all hits..

$wgWSStats = array();
$wgWSStats['count_all_usergroups'] = true;

If you have set $wgWSStats['count_all']=true; then $wgWSStats['skip_user_groups'] is ignored.

Skip page with certain text in their referer url. Default action=edit and veaction=edit are ignored. This configuration option is case sensitive.

$wgWSStats['ignore_in_url'][] = 'Template:Test';
$wgWSStats['ignore_in_url'][] = 'action=edit';

Using the parser functions

To retrieve statistics you can use the following parser function :

Ask number of hits for page id : 9868

This returns a number

{{#wsstats:id=9868}}

Ask number of hits for page id : 714 since start date 2018-09-01

This returns a number

{{#wsstats:id=714
|start date=2018-09-01}}

Ask number of hits for page id : 714 since start date 2018-02-01 and end date 2018-09-08

This returns a number

{{#wsstats:id=714
|start date=2018-02-01|end date=2018-09-08}}

Filter results on registered users or anonymous users

This returns a number

{{#wsstats:id=714
|start date=2018-02-01
|end date=2018-02-08
|type=only anonymous}}

This returns a number

{{#wsstats:id=714
|start date=2018-02-01
|end date=2018-02-08
|type=only user}}

Get the top ten pages sorted by hits

This returns a table

{{#wsstats:stats}}

Get the top ten pages sorted by hits in a date range

This returns a table from 2018-02-01 00:00:00 up to 2018-02-08 00:00:00 ( so not including 2018-02-08 )

{{#wsstats:stats
|start date=2018-02-01
|end date=2018-02-08}}

Get the top ten pages sorted by hits and show as csv

This returns a string with the results comma seperated (e.g. 1230;51,1;17,921)

{{#wsstats:stats
|format:csv}}

Get the top ten pages sorted by hits and insert in a WSArrays variable

This returns an empty string and sets the WSArray key. Nothing happens when the WSArrays extension is not installed

{{#wsstats:stats
|format:wsarrays}}
|name=<wsarray key name>}}

Get the result from WSArrays:
{{#caprint:<wsarray key name>}} 

For all queries you can add a unique identifier to only return unique views

This returns a table

{{#wsstats:stats
|start date=2018-02-01
|end date=2018-02-08
|unique}}

This returns a table

{{#wsstats:stats
|unique}}

For all top ten stats queries you can add limit to get less or more than ten results

This returns a table

{{#wsstats:stats
|unique
|limit=20}}

Date format to use

Date formats

Date	Translates to
2018-02-01	First of February 2018
2018-02-01 11	First of February 2018 at 11am
2018-02-01 11:15	First of February 2018 at a quarter past eleven in the morning
2018-02-01 14:15:30	First of February 2018 at a quarter past two in the afternoon and 30 seconds

If no statistics the result will be 0