Where-Is Plugin

This plugin handles a WHEREIS variable. All interaction is done via this variable. The functionality is determined by an action parameter.

WHEREIS{ action="recordlocation" } - record the location

%WHEREIS{ action="recordlocation" }% records the location of the logged in user. No additional parameters are supported. No action is done if the user is not authenticated.

This variable needs to be called to record user location. It can be done by enabling the whereis skin template, which contains the variable. Example setting in TWikiPreferences:

• Set SKIN = whereis, topmenu, pattern

Alternatively, add the variable anywhere to a skin template within the body tags.

Please note that the whereis skin template and the tagme skin template clash and can't be used together. If you want to use tagging and this plugin you need to manually merge the content of template/view.tagme.tmpl into template/view.whereis.tmpl, and set the SKIN to whereis, topmenu, pattern.

WHEREIS{ action="setlocation" } - set location name

%WHEREIS{ action="setlocation" }% sets the name of a location associated with the IP address of the logged in user. Additional parameters:

WHEREIS{ action="showlocation" } - show user location

%WHEREIS{ action="showlocation" }% shows the location and time of a user. Additional parameters:

WHEREIS{ action="editlocations" } - show and edit known locations

%WHEREIS{ action="editlocations" }% shows a table with known locations and users last seen at each location. Hover over a row to update a location. Use the last row to add a location. Additional parameter:

WHEREIS{ action="showrecent" } - show recent location

%WHEREIS{ action="showrecent" }% shows recent locations and times of users. Additional parameters:

Plugin data

The IP address data and user access data is stored in the plugin's working area at twiki/working/work_areas/WhereIsPlugin.

IP address data is stored in files named addr-<ip>.txt, e.g. one file per recorded IP address. This data is used to map from IP address to location name.

User access data is stored in files named addr-<wikiname>.txt, e.g. one file per user. This data is used to record the most recent access time and IP address of a user.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
  • See the installation supplement on TWiki.org for more information.

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

    File:	Description:
    data/TWiki/WhereIsPlugin.txt	Plugin topic
    data/TWiki/WhereIs.txt	Report topic
    pub/TWiki/WhereIsPlugin/*.gif and *.png	Image files
    templates/view.whereis.tmpl	Skin template
    templates/whereisdialog.tmpl	New location dialog box template
    templates/whereiseditlocations.tmpl	Edit location table template
    lib/TWiki/Plugins/WhereIsPlugin.pm	Plugin Perl module
    lib/TWiki/Plugins/WhereIsPlugin/Core.pm	Plugin Perl module
    lib/TWiki/Plugins/WhereIsPlugin/Config.spec	Configure spec file

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration:
  • Run the configure script and enable the plugin in the Plugins section.
  • Configure additional plugin settings in the Extensions section if desired.

• Enable location tracking:
  • Add the whereis skin template to the SKIN path. Example setting in TWikiPreferences:
    • Set SKIN = whereis, topmenu, pattern
  • There are alternatives, see site admin docs above

• Show location in user profiles:
  • Edit UserProfileHeader and add the user location next to the user's name:
    ---+!! %FORMFIELD{ "FirstName" topic="%INCLUDINGTOPIC%" }% %FORMFIELD{ "LastName" topic="%INCLUDINGTOPIC%" }% <span style="font-size: 60%"> %FORMFIELD{ "StatusUpdate" topic="%INCLUDINGTOPIC%" }% &mdash; [[%SYSTEMWEB%.WhereIs][<img src="%PUBURLPATH%/%SYSTEMWEB%/WhereIsPlugin/whereis.gif" alt="" title="Where is?" width="16" height="16" border="0" />]] %WHEREIS{ user="WhereIsPlugin" }%</span>

• Test if the configuration is successful:
  • Visit your user profile topic - it should show your location.
  • Visit WhereIs - it should show locations of recent users.

• Optional: Install the TWiki:Plugins.GeoLookupPlugin to map automatically from IP address to location