/***************************************************************************
 *
 *   RobotStats
 *
 * Author:   Olivier Duffez, WebRankInfo ( http://www.webrankinfo.com )
 * Version:  1.0
 * Date:     2003-10-11
 * Homepage: http://www.robotstats.com    
 *
 ***************************************************************************/

// ---------------------------------------------------------------------------
// RobotStats
// ---------------------------------------------------------------------------

RobotStats is a free application analysing the web robots visits on your site.
For each page of your site, a small PHP code allows RobotStats to detect if
the visitor is one of the 180 robots supported by the application. In this
case, the visit is recorded in a MySQL data base.
Then, you can see complete statistics:
- list of all the robots that came in a given period
- for each robot:
  * number of pages viewed
  * list of the pages viewed, with the date and time
  * graphic chart of the visits for several months
RobotStats gives you precise information about the activity of the web robots
on your site. It allows you to know if your site has any chance to be
indexed in the search engines.
RobotStats is free, but you're asked to add a link on your site to the
official RobotStats site. You can choose to put a text link or a small picture:
see http://www.robotstats.com/en/link.php


// ---------------------------------------------------------------------------
// Description of RobotStats application
// ---------------------------------------------------------------------------

The main screen of RobotStats is made of 5 parts:
- the calendar
- the list of robots
- the Summary section
- the Pages section
- the Graph section

This file also provides information about RobotStats administration.


// ---------------------------------------------------------------------------
// Calendar
// ---------------------------------------------------------------------------

The current day is colored in orange. All the cells with a date anterior to
the current date are clickable.
You can also click on a week's number or on the month's name to modify the
period defined for the sections Summary and Pages.
The calendar isn't active for the section Graph.


// ---------------------------------------------------------------------------
// List of robots
// ---------------------------------------------------------------------------

The robots set up for RobotStats are listed in 2 distinct groups:
- enabled robots (taken into account for the detection)
- disabled robots
The selected robot is marked with a green arrow. All the statistics of the
other sections are given for this robot. If you want to change the selected
robot, just click on another robot name.
A click on [info] displays a detailed description of the robot.


// ---------------------------------------------------------------------------
// Summary
// ---------------------------------------------------------------------------

The summary indicates, for the selected robot and the period defined in the
calendar, the following data:
- visits:       nb of times where the robot came and has been detected
- pages :       nb of different pages ('pages' is always less or equal to
                'visits')
- visits/day: mean nb of visits per day (for the defined period)
Then a list of all the robots detected during the defined period is given (in
order to avoid to select each robot one at a time). The number of visits of
each robot is displayed right to its name.
Then a graph is displayed: it is a pie plot giving the number of visits
in percentage for each robot (this indicates the most active robots on your
site). The graph may take some time for being displayed (you can disable it by
modifying the $RS_DISPLAY_PIE_PLOT variable in 'admin/config.php' file).
Finally, all the selected robot IP addresses are displayed in 2 columns,
along with their occurrence.


// ---------------------------------------------------------------------------
// Pages
// ---------------------------------------------------------------------------

This section displays in full details all the pages visited by the selected
robot during the period defined through the calendar (by default this period
is the current day).
You can sort the table by URL, by HTTP return code, by date, by number of
visits, by IP address or by DNS. You just have to click on a column name.
If you click twice on the same column the table will be sorted in reverse
order.
If a page has been visited more than one time during the selected period, the
date displayed is the last visit date.


// ---------------------------------------------------------------------------
// Graph
// ---------------------------------------------------------------------------

This section displays in a bar diagram the statistics of the selected robot'
visits. The calendar is no longer active because you select the period of
analyse inside this section. You can display the graph for a period of 1, 2, 3,
6 or 12 months. More precisely, the period of analyse covers the 30, 60, 90,
180 or 360 last days.


// ---------------------------------------------------------------------------
// RobotStats Administration
// ---------------------------------------------------------------------------

RobotStats administration is quite simple. Most of the options are set up
during the installation in the file 'admin/config.php'.
3 sections are available:
1- reset (deletion of records)
2- version check
3- robots management

1- You can reset all the records in the database table storing the visits or
   only for one month at a time. Be careful: no confirmation is asked.

2- This option allows you to check if there is a version of RobotStats newer
   than the version you have installed.

3- The robots management allows you to precisely define the robots to detect
   and analyse. During the installation, RobotStats is configured with a set
   of the most common robots. You can add, modify or delete a robot.
   Hint: don't delete a robot, use instead the 'active' field to disable
   it temporarily. You'll be able to enable it again if you want.
   Here is the description of the fields of the form:
   name          : name you wish to give to the robot (free text)
   active?       : 'yes' if you want to take this robot into account (during
                   the detection), otherwise 'no'.
   user agent    : official name of the agent. You can put only a sub part of
                   this name if it is sufficient for detection.
   IP address #1 : IP address of the robot (or the begining of the address)
   IP address #2 : other IP address
   Detection mode: by IP address or by user agent
   Description   : free text in french then in english
   URL           : URL of the page describing the robot.

