RecentVisitorPlugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/RecentVisitorPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/RecentVisitorPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

• Introduction
• Syntax Rules
  • Recent visit of an individual
  • Report of recent visitors
• Examples
• Plugin Installation & Configuration
• Plugin Info

This plugin is
sponsored by:

Introduction

This plugin shows statistics of recent visitors to a TWiki site. The time of last visit and the IP address used can be shown of individual users. The recent report shows latest visitors in chronological order.

Syntax Rules

Recent visit of an individual

%RECENTVISITOR{ action="user" ... }%

Report of recent visitors

%RECENTVISITOR{ action="recent" ... }%

See also VarRECENTVISITOR documentation for TWikiVariables.

Examples

Example: Show most recent visit of TWikiAdminUser

%RECENTVISITOR{
 action="user"
 name="TWikiAdminUser"
 format="Last seen $ago ago ($date 
$time)"
}%

Example: Show recent visitors, default bullet list report

%RECENTVISITOR{
 action="recent"
 limit="5"
}%

Example: Show recent visitors, table report

%RECENTVISITOR{
 action="recent"
 format="| $wikiusername | $date |"
 limit="5"
}%

Example: Show recent visitors with geolocation

This example uses the TWiki:Plugins.GeoLookupPlugin to resolve IP addresses to geolocations.

| *Name* | *Last seen* | *Where* |
%RECENTVISITOR{
 action="recent"
 limit="5"
 format="| $wikiusername | $ago ago
 | $percntGEOLOOKUP{$ip}$percnt |"
}%

Plugin Installation & Configuration

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip RecentVisitorPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/RecentVisitorPlugin.txt	Plugin topic
    lib/TWiki/Plugins/RecentVisitorPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.
  • Install the dependencies (if any).

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Configure additional plugin settings in the Extensions section if needed:
    $TWiki::cfg{Plugins}{RecentVisitorPlugin}{Debug} = 0;      # debug flag, 0 or 1
$TWiki::cfg{Plugins}{RecentVisitorPlugin}{ShowIP} = 0;     # show IP address, 0 or 1
$TWiki::cfg{Plugins}{RecentVisitorPlugin}{OnlyAdmins} = 0; # show reports to administrators only, 0 or 1
  • Test if the installation was successful: See example above.

Plugin Info

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Show statistics of recent visitors to the TWiki site

Plugin Author:	TWiki:Main.PeterThoeny, Twiki, Inc.
Copyright:	© 2011 TWiki:Main.PeterThoeny © 2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-06-06
Change History:	<-- versions below in reverse order -->
2011-06-06:	TWikibug:Item6725: Plugins: Change global package variables from "use vars" to "our" -- TWiki:Main.PeterThoeny
2011-05-14:	TWikibug:Item6701: Small fix in Config.spec -- TWiki:Main.PeterThoeny
2011-05-01:	TWikibug:Item6701: Fix small warning issue if plugin is run by a shell script
2011-02-03:	TWikibug:Item6646: Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins.Benchmark:	GoodStyle nn%, FormattedSearch nn%, RecentVisitorPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RecentVisitorPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RecentVisitorPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RecentVisitorPluginAppraisal

Related Topics: VarRECENTVISITOR, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences