Extension:HitCounters

MediaWiki 拡張機能マニュアル

HitCounters リリースの状態: 安定
実装	データベース , データ抽出, 自分のウィキ
説明	ページビュー機能の提供
作者	Mark A. Hershberger (MarkAHershbergerトーク)
最新バージョン	0.3.4
MediaWiki	1.31+
PHP	7.0+
データベースの変更	はい
Composer	mediawiki/hit-counters
テーブル	hit_counter
ライセンス	GNU 一般公衆利用許諾書 3.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
パラメーター $wgDisableCounters $wgEnableAddPageId $wgHitcounterUpdateFreq $wgEnableAddTextLength
使用するフック AbuseFilter-builder AbuseFilter-computeVariable AbuseFilter-deprecatedVariables AbuseFilter-generateTitleVars LoadExtensionSchemaUpdates MagicWordwgVariableIDs PageViewUpdates ParserFirstCallInit ParserGetVariableValueSwitch SkinAddFooterLinks SpecialStatsAddExtra
translatewiki.net で翻訳を利用できる場合は、HitCounters 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
Vagrant role	hitcounters
問題点	未解決のタスク · バグを報告

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 .

MediaWikiのコア実装との違い

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.

何をもって閲覧とするか

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.

インストール

コンポーザーを使って、MediaWikiのディレクトリで以下の2つのコマンドを実行することで、この拡張機能をインストールすることができます。

$ COMPOSER=composer.local.json composer require --no-update mediawiki/hit-counters
$ composer update

• Vagrant を使用している場合は、vagrant roles enable hitcounters --provisionでインストールしてください。

手動インストール

• ダウンロードして、ファイルをextensions/フォルダー内のHitCountersという名前のディレクトリ内に配置します。
• 以下のコードをLocalSettings.phpの末尾に追加します:

  wfLoadExtension( 'HitCounters' );
  

• 更新スクリプトを実行します。このスクリプトは、この拡張機能が必要とするデータベーステーブルを自動的に作成します。
• Configure as required.
•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

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 タスク 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!

Configuration

• $wgDisableCounters

  When set to true, it disables the notice in the pages footer saying "このページは 256 回アクセスされました。" 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.3.2 of this extension's fork is backward compatible to MediaWiki 1.25.x.
• Version 0.3.3 of this extension's fork is backward compatible to MediaWiki 1.25.x.

See also

• Extension:GoogleAnalyticsMetrics - Provides site-wide metrics for Google Analytics users