TWiki> TWiki Web>UserInfoPlugin (12 Apr 2019, TWikiAdminUser)

UserInfoPlugin

Render information about users on a TWiki site

This plugin analyzes the log files of your twiki-engine and extracts useful information to be displayed on your site.

NOTE: Please respect the privacy of your users and don't display too much information.

Syntax Rules

Tag Description Default
%VISITORS{format="..." max="..." sep="..." header="..." footer="..."}% list of users currently logged in format="\t* $wikiusername" sep="$n" max="unlimited"
%NRVISITORS% number of users currently online  
%LASTVISITORS{format="..." max="..." sep="..." days="..." header="..." footer="..."}% list of users that recently visited the site format="\t* $date: $wikiusername" sep="$n" max="unlimited" days="1"
%NRLASTVISITORS{days="..."}% list of users that recently visited the site days="1"
%NRUSERS% number of registered users  
%NRGUESTS% number of guest users currently online  
%NEWUSERS{format="..." max="..." sep="..." header="..." footer="..."}% list of users that recently registerd format="\t* date: $wikiusername" sep="$n" max="10"

The format parameter might contain the following variables:

Variable Description Valid in
$counter enumeration %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$wikiname wikiname of the visitor %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$username username of the visitor %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$wikiusername wikiusername of the visitor %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$date date of last visit/registration %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$time time of last visit %VISITORS%, %LASTVISITORS%
$host host of visitor %VISITORS%, %LASTVISITORS%
$topic topic that a visitor viewed last %VISITORS%, %LASTVISITORS%
$n newline %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$quot double-quote sign %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$percnt percentage sign %VISITORS%, %LASTVISITORS%, %NEWUSERS%
$dollar dollar sign %VISITORS%, %LASTVISITORS%, %NEWUSERS%

Plugin Settings

  • Set SHORTDESCRIPTION = Render information about users on a TWiki site

  • add a list of host addresses to ignore users coming from them
    • Set IGNORE_HOSTS =
  • add a list of users to ignore

Plugin Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip UserInfoPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/UserInfoPlugin.txt Plugin topic
    lib/TWiki/Plugins/UserInfoPlugin.pm Plugin Perl module
    lib/TWiki/Plugins/UserInfoPlugin/Core.pm Plugin Perl module
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Test

If the plugin is installed correctly then you should get valid output for the tags below:

0 of 12 registered user(s), 679 guest(s) currently online:

0 visitor(s) today (22 Nov 2024):

Recently registered users:

Plugin Info

Plugin Author: TWiki:Main.MichaelDaum
Copyright: © 2005-2006 Michael Daum,
© 2005-2010 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 19259 (2010-07-25)
Change History:  
2010-07-25: TWikibug:Item6530 - doc fixes
09 June 2006: fixed duplicate users in LASTVISITORS; use IGNORE_USERS in LASTVISITORS
27 May 2006: fixed error computing the number of last visitors (TWiki:Main.DavidBright); exclude the TWikiAdminGroup "user" from the statistics; check back if the user found in the logs already approved his account; fixed use of non-numerical value in comparison
17 Feb 2006: optimized tag parsing; using Time::Local instead of Date::Parse; added header and footer format strings; fixed error restricting seen visitors by days
16 Feb 2006: OO-ified the plugin to compile on demand; added IGNORE_USER plugin parameter
14 Feb 2006: fixed detection of the session directory
02 Feb 2006: fixed numerical comparison of dates (TWiki:Main/AntonAylward)
05 Aug 2005: removed dependency on the SessionPlugin
27 Apr 2005: fixed getting guests + some minor glitches
12 Apr 2005: initial release
  fixed sep handling, fixed $host parsing
TWiki Dependency: $TWiki::Plugins::VERSION 1.024
CPAN Dependencies: Time::Local
Other Dependencies: none
Perl Version: 5.8
TWiki:Plugins/Benchmark: TWiki:TWiki/GoodStyle nn%, TWiki:TWiki/FormattedSearch nn%, UserInfoPlugin nn%
Plugin Home: TWiki:Plugins/UserInfoPlugin
Feedback: TWiki:Plugins/UserInfoPluginDev
Appraisal: TWiki:Plugins/UserInfoPluginAppraisal
Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 12 Apr 2019 - TWikiAdminUser
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.UserInfoPlugin.