|
后一修订版
|
前一修订版
|
access_counter_and_popularity_plugin [2019/12/06 16:01]
jackboo 创建 |
access_counter_and_popularity_plugin [2019/12/07 21:07] (当前版本)
|
| __false__ | ====== Access Counter and Popularity Plugin ====== |
| | |
| | ---- plugin ---- |
| | description: 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). |
| | author : HokkaidoPerson |
| | email : dosankomali@yahoo.co.jp |
| | type : Syntax |
| | lastupdate : 2019-11-07 |
| | compatible : Greebo, 2018-04-22 |
| | similar : top |
| | tags : statistics, users, counter |
| | |
| | downloadurl: https://github.com/hokkaidoperson/DokuWiki-AccsCounter-Plugin/zipball/master |
| | bugtracker : https://github.com/hokkaidoperson/DokuWiki-AccsCounter-Plugin/issues |
| | sourcerepo : https://github.com/hokkaidoperson/DokuWiki-AccsCounter-Plugin |
| | ---- |
| | |
| | :!: [[ja:plugin:accscounter|このページを日本語でご覧頂けます。(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 [[https://pukiwiki.osdn.jp/?About%20PukiWiki|PukiWiki]]((according to the license of the original plugin)). |
| | |
| | ===== Installation ===== |
| | |
| | Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. |
| | |
| | ===== Examples/Usage ===== |
| | :!: Please add ''<nowiki>~~NOCACHE~~</nowiki>'' 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). |
| | |
| | ==== Popular Pages ==== |
| | :!: 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: |
| | * [[:start]](57) |
| | * [[wiki:syntax]](21) |
| | * [[plugins]](19) |
| | * ...... |
| | |
| | You can change the parameters: |
| | {{POPULAR 45 today}} |
| | {{POPULAR 20 yesterday blacklist1|blacklist2}} |
| | |
| | ==== See the plugin working ==== |
| | |
| | See the plugin in action [[https://jdwiki.hkdyukkuri.space/|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 ''|'') |
| | |
| | ===== Data Manager ===== |
| | |
| | You can choose "Data Manager" in the admin menu of your wiki, and easily view and control the log data! |
| | |
| | ===== Configuration and Settings ===== |
| | |
| | You can change the following setting by using the [[plugin:config|Configuration Manager]]. |
| | |
| | ^Option^Description^Value Type^Default Value^ |
| | |''timezone''|Timezone 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 [[http://php.net/manual/en/timezones.php|List of Supported Timezones" at PHP Manual]]|string|((empty))| |
| | |''excludeMgAndSp''|Don't count managers and superusers? (see config "[[config:manager]]" and "[[config:superuser]]|pull-down choice from ''0'' (Count both), ''sp'' (Don't count superusers), or ''mg'' (Don't count managers (including superusers))|''0''| |
| | |''exclusionList''|IPs 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.|textarea|((empty))| |
| | |''usrExclusion''|Users 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.|string|((empty))| |
| | |''cntrExclusion''|Countries 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" ([[http://cc.wariate.jp/|Details in Japanese]]).\\ Enter two-character country codes(ISO 3166-1 alpha-2) separated by comma.|string|((empty))| |
| | |''cntrInclusion''|Set specific countries to be counted\\ If you specify county(ies) here, the plugin will count users ONLY from these countries.\\ The plugin gets country codes by a DNS service of "cc.wariate.jp" ([[http://cc.wariate.jp/|Details in Japanese]]).\\ Enter two-character country codes(ISO 3166-1 alpha-2) separated by comma.|string|((empty))| |
| | |''reverseLookupFailed''|Exclude from the counter when the reverse lookup (IPs to remote hosts) failed (IPs of robots tend to reject the reverse lookup)|boolean|''0''| |
| | |''reverseLookupException''|IPs 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.|textarea|((empty))| |
| | |''reverseLookupCntrException''|Countries which the plugin doesn't apply to the option "reverseLookupFailed"\\ The plugin gets country codes by a DNS service of "cc.wariate.jp" ([[http://cc.wariate.jp/|Details in Japanese]]).\\ Enter two-character country codes(ISO 3166-1 alpha-2) separated by comma.|string|((empty))| |
| | |''sfsExFreq''|Check the frequency score of the visitor's IP address not to count spammers? ([[plugin:stopforumspam2|Stopforumspam2 plugin]] required)\\ If the given number is "0" then the plugin won't do that, otherwise it'll do. You can define the borderline special to this function. If "-1" then the plugin will use the conf "freqBorder" of Stopforumspam2 plugin, if more than 0 then the number will be the borderline.|numeric (-1 +)|''0''| |
| | |''sfsExConf''|Check the confidence score of the visitor's IP address not to count spammers? (Stopforumspam2 plugin required)\\ If the given number is "0" then the plugin won't do that, otherwise it'll do. You can define the borderline special to this function. If "-1" then the plugin will use the conf "confidenceBorder" of Stopforumspam2 plugin, if more than 0 (and 100 or less) then the number will be the borderline.|numeric (-1 - 100)|''0''| |
| | |''saveLog''|Save 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 ''accscounterlog'' directory in your cache directory (inside [[config:savedir|the data directory]] in default config). 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''| |
| | |
| | ===== 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. |
| | * **2019-02-10** |
| | * Changed saving destinations of this plugin's data to be compatible with some plugins like [[plugin:farmer|farmer plugin]]. You can move or delete data in old directories. See the notification you'll see after updating the plugin. |
| | * Added a function that uses [[plugin:stopforumspam2|stopforumspam2 plugin]]. |
| | * **2019-03-12** |
| | * Changed saving destinations of this plugin's data **AGAIN**, to be easy to uninstall. See the notification you'll see after updating the plugin. |
| | * Added the function of Data Manager. |
| | * **2019-10-21** |
| | * Added the conf ''cntrInclusion'' |
| | * **2019-11-07** |
| | * Bug fix |
| | |
| | === 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 [[https://github.com/hokkaidoperson/DokuWiki-AccsCounter-Plugin|GitHub page]], or if you wanna contact me for other things, you can contact me by: |
| | |
| | * <dosankomali@yahoo.co.jp> |
| | * [[https://twitter.com/YukkuriDosanko|My Twitter]] (Japanese account but English acceptable) |
| | |
| | ===== Discussion ===== |
| |
