DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:accscounter

Access Counter and Popularity Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin Export the number of those who visited a specified page in your wiki today, yesterday, or in whole period. You can also show the list of the popularity according to the log data taken by the plugin. This plugin is ported from those of PukiWiki (with some customizing).

Last updated on
2018-10-30
Provides
Syntax
Repository
Source

Similar to top

Tagged with counter, statistics, users

:!: このページを日本語でご覧頂けます。(This page is also available in Japanese.)
:!: I’m not a native English speaker, so this page may contain some mistakes in English sentences.

Summary

This plugin shows the number of people who visited specified pages.
You can also show the list of popular pages of today, yesterday, and whole period.

I ported Counter plugin and Popular plugin of PukiWiki1).

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Examples/Usage

:!: Please add ~~NOCACHE~~ macro to the page you'll use this plugin, because the data will be changed in real time and the page shouldn't be cached.

Access Counter

The most simple example is:

{{counter}} person(s) visited this page until now.

Then exported like 15 person(s) visited this page until now. (if there are 15 visitors that have been visited the page).

Also, you can enter like this:

This page has been accessed for:
Today: {{counter|today}} / Yesterday: {{counter|yesterday}}
Until now: {{counter|total}}

The other example is this:

{{counter|total| person visited this page till now.| people visited this page till now.}}

Then exported like 1 person visited this page till now. (if there is 1 user), and 12 people visited this page till now. (if there are 12 users).

:!: The pages where the access counter plugin is active will be listed. If you want the popular plugin check all pages, you will put the counter plugin in sidebars or templates.

The most simple example is:

{{POPULAR}}

Then you'll see the list of the most accessed 10 pages till now, like this:

You can change the parameters:

{{POPULAR 45 today}}
{{POPULAR 20 yesterday blacklist1|blacklist2}}

See the plugin working

See the plugin in action here (sorry but this page is available only in Japanese).

Syntax

{{counter|argument|message A|message B}}
  • argument: today, yesterday, or total(default)
  • message A: texts following the number (when the number is 0 or 1)
  • message B: texts following the number (when the number is 2 or more)
{{POPULAR number argument blacklist}}
  • number: the number of items that will be shown
  • argument: today, yesterday, or allperiod(default)
  • blacklist: pages that will not be shown in the list (divide by |)

Configuration and Settings

You can change the following setting by using the Configuration Manager.

OptionDescriptionValue TypeDefault Value
timezoneTimezone used to judge changing of the day (if empty, the timezone set to the server will be used. You can specify one of IDs in List of Supported Timezones" at PHP Manualstring2)
excludeMgAndSpDon't count managers and superusers? (see config “manager” and “superuserpull-down choice from 0 (Count both), sp (Don't count superusers), or mg (Don't count managers (including superusers))0
exclusionListIPs and remote hosts that will be excluded
The plugin don't count users with these IPs and remote hosts. This list will be useful if your website has many accesses by robot(s) from specified IP(s) and remote host(s).
The plugin gets remote hosts by IPs reverse lookup (gethostbyaddr).
Enter one IP or remote host per line.
Wildcards available:
? = one character (an alphanumeric character, a dot ”.“, or a hyphen ”-“)
* = one or more characters (alphanumeric characters, dots ”.“, or hyphens ”-“)
! = one character (a numeral)
~ = one or more characters (numerals)

e.g.: “123.456.???.123” → 123.456.789.123, etc. (123.456.78.123 won't be excluded)
e.g.: “*.example.com” → 123.456.789.123.example.com, 1-2-3-4.rooter.example.com, etc.
textarea3)
usrExclusionUsers or user groups that will be excluded
The plugin don't count these users and users in these groups.
Enter users and user groups separated by comma.
string4)
cntrExclusionCountries that will be exluded
The plugin don't count users from these countries. This list will be useful if your website has many accesses by robot(s) from specified country(ies).
The plugin gets country codes by a DNS service of “cc.wariate.jp” (Details in Japanese).
Enter two-character country codes(ISO 3166-1 alpha-2) separated by comma.
string5)
reverseLookupFailedExclude from the counter when the reverse lookup (IPs to remote hosts) failed (IPs of robots tend to reject the reverse lookup)boolean0
reverseLookupExceptionIPs which the plugin doesn't apply to the option “reverseLookupFailed”
Enter one IP per line.
Wildcards available:
? = one character
* = one or more characters

e.g.: “123.456.???.123” → 123.456.789.123, etc. (123.456.78.123 won't be excluded)
e.g.: “123.*.789.123” → 123.456.789.123, 123.9.789.123, etc.
textarea6)
reverseLookupCntrExceptionCountries which the plugin doesn't apply to the option “reverseLookupFailed”
The plugin gets country codes by a DNS service of “cc.wariate.jp” (Details in Japanese).
Enter two-character country codes(ISO 3166-1 alpha-2) separated by comma.
string7)
saveLogSave the log of IPs, the date and the time when visitors access this wiki?
The log will be recorded for every page. This option will be useful when you decide which IPs, remote hosts, and countries to exclude from the counter.
The log files will be saved in /(path of your DokuWiki)/lib/plugins/accscounter/log/iplogs/. Pick up and delete the log files if necessary.
pull-down choice from 0 (Don't save), ppage (Save (Don't make files for every date)), or pdate (Save (Make files for every date))0

Localization

Error messages and the description of configuration can be shown in:

  • English
  • Japanese

Development

Change Log

  • 2018-07-02
    • Initial release
  • 2018-07-17
    • Fixed the bug (The plugin sometimes used to do their works with tomorrow's date)
  • 2018-08-08
    • Fixed the bug (An elementary mistake. The plugin used to write files without making a directory)
  • 2018-08-29
    • Added a htaccess file
  • 2018-10-30
    • Big update! Added options of black lists and the log saving system.

Known Bugs and Issues

(Currently none)

ToDo and Wishlist

I'll do my best if you think this leaves something to be desired

Contact Me

If you find some problems in this plugin, you can make issue topics on the GitHub page, or if you wanna contact me for other things, you can contact me by:

Discussion

1)
according to the license of the original plugin
2) , 3) , 4) , 5) , 6) , 7)
empty
plugin/accscounter.txt · Last modified: 2018-10-30 15:41 by hokkaidoperson