Extension:HitCounters/de-formal

This page is a translated version of the page Extension:HitCounters and the translation is 11% complete.
MediaWiki extensions manual
HitCounters
Release status: stable
Implementation Database , Data extraction, MyWiki
Description Provide the page views functionality
Author(s) Mark A. Hershberger (MarkAHershbergerDiskussion)
Latest version 0.3.4
MediaWiki >= 1.36.0
PHP 7.3.19+
Database changes Yes
Composer mediawiki/hit-counters
Tables hit_counter
hit_counter_extension
License GNU General Public License 3.0 or later
Download
  • $wgDisableCounters
  • $wgEnableAddPageId
  • $wgHitcounterUpdateFreq
  • $wgEnableAddTextLength
Quarterly downloads 221 (Ranked 42nd)
Translate the HitCounters extension if it is available at translatewiki.net
Vagrant role hitcounters
Issues Open tasks · Report a bug

The HitCounters extension displays the view count in the page footer and the most viewed pages on a special page called PopularPages. The extension provides page views statistics that were removed in MediaWiki 1.25 .

Benefits

This extension provides feedback in the form of audience measurement to editors. Knowing the rough size of one's audience as an editor allows editors to identify and improve popular articles. HitCounters' special page PopularPages also allows editors to focus on improving those articles with the highest traffic, and helps readers discover a project's most curated content.

HitCounters extension enables determining the wikiFactor, a rough measure of a wiki website's popularity.

HitCounters extension is minimally intrusive with respect to data security and privacy concerns. The extension handles metrics on the server side so aggregated data stays within the site's security boundary. The extension does not inject JavaScript to be executed by the client, and does not ask a client to download additional un-audited code from a third party, like GoogleAnalyticsMetrics.

The extension does not track users who visit a page. As such, there's no need for special handling of Do Not Track browser requests or Global Privacy Control settings. The extension also does not use third party services, like GoogleAnalyticsMetrics.

The extension does not have dependencies which can cause conflicts. Other extensions, like GoogleAnalyticsMetrics, can cause problems during a Composer update. Also see Phabricator P6481 .

Differences from core MediaWiki implementation

Before MediaWiki 1.25, the page views counting functionality was in core MediaWiki. This extension is based on that same code, but was deliberately done in a more lightweight way in order to speed up processing time. Many lines of superfluous code were removed. Also, the old MediaWiki core code did numerous database queries on every page hit; these have all been removed as well. This change may possibly lead to some inaccuracies in the data.

The core differences that wiki administrators need to know are:

  • The hit counts are stored in cache.
  • The visible hit count at the bottom of each page is updated only once per day. (Pages with hit count less than 100 are updated once per minute.)
  • If you refresh your browser on a wiki page, that hit is ignored.

What counts as view

According to tests conducted by several MediaWiki operators, a view is counted if a page is accessed normally (action=view), as well as action=render and when accessing a page revision.

A view is not counted with the other actions, such as action=raw, action=edit, and action=info.

Installation

You can use composer to install this extension by running the following two commands in your MediaWiki directory:

$ COMPOSER=composer.local.json composer require --no-update mediawiki/hit-counters
$ composer update
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens HitCounters im Ordner extensions/ ablegen.
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    wfLoadExtension( 'HitCounters' );
    
  • Führen Sie das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
  • Configure as required.
  •   Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.


Vagrant-Installation:

  • Wird Vagrant benutzt, ist mit vagrant roles enable hitcounters --provision zu installieren

Migration from before MediaWiki 1.25

Attention: If you do not act according to the following instructions, an update to MediaWiki 1.26 or newer can permanently delete your hitcounter numbers! See task T120216.

Another way to not lose page HitCounts while upgrading to newer version is by running SQL files from this extension manually (Tested by upgrading MW version from 1.23.0 to 1.35.9). Before upgrading entire MediaWiki database it is neccesary to install this extension and after this open folder with SQL files for this extension (should be path -> extensions/HitCounters/sql)

After that is following this approach:

  1. open file rename_table.sql. Delete it's content and replace it with this line -> CREATE TABLE hit_counter_extension SELECT * FROM hitcounter; so instead of renaming table we are creating new one
  2. run these 3 sql files on your MediaWiki database in this order: "rename_table.sql", "page_counter.sql" and "initial_count.sql"
  3. meaning your CLI command should look something like this: mysql -p -u <db_user> -D my_wiki < <sql_file>.sql
  4. by running these 3 commands you will preserve Hit Counts on your pages

mysql -p -u <db_user> -D my_wiki < rename_table.sql (edited one)

mysql -p -u <db_user> -D my_wiki < page_counter.sql

mysql -p -u <db_user> -D my_wiki < initial_count.sql
Attention: If you do not act according to the following instructions, an update to MediaWiki 1.26 or newer can permanently delete your hitcounter numbers! See task T120216.

If you install this extension a new wiki, you do not have to care about migrating as described here. However if you run a MediaWiki with version earlier than 1.25.x and update to 1.26+, you have to prevent loss of your hitcounter numbers by migrating it carefully.

If you want to update MediaWiki to version 1.26, currently the following steps have to be done in order to prevent loss of hitcounter numbers:

  1. Use MediaWiki 1.25 and install this extension.
  2. Still in MediaWiki 1.25, run update.php. This step is mandatory! This should migrate the hitcounter data to the new locations:
    • Table hit_counter should exist and should contain all the hit numbers
    • Table hit_counter_extension should exist (and possibly contain information on the few, newest hits)
    • Note that I have not tested if this actually works!
      The SQL files, which are included with the HitCounters extension, demonstrate the SQL commands, which have to be run before(!) running update.php in MediaWiki 1.26, in order to preserve the existing data.
    • Note: HitCounters in Version 0.3 does not work with MediaWiki 1.25. You may try a fork of HitCounters since Version 0.3.2.
  3. After the above steps, update to MediaWiki 1.26 or newer. Running update.php in that version will still remove hitcounter data from the old locations, as far as it is still present there. However, since you have done the migration, the extension should continue working!

Konfiguration

  • $wgDisableCounters
    When set to true, it disables the notice in the pages footer saying "Diese Seite wurde bisher 256-mal abgerufen." as well as the special page PopularPages. This configuration parameter was removed with MediaWiki 1.35.0.
  • $wgHitcounterUpdateFreq
    Sets how often page counters should be updated. Default value is 1.

Fork

There is a fork of this extension with extended backward compatibility available:

  • Version 0.4.0 of this extension's fork is backward compatible to MediaWiki 1.25+.
  • Version 0.3.2 of this extension's fork is backward compatible to MediaWiki 1.25+.

See also