IRStats Technical Documentation

This document is intended as guidance to the last stage of development of EPstats.

Directory Structure

/opt/epstats

Contains data files for GeoIP. If I had had root access, I would have put them in the correct place. They are linked to from the correct place. These need regular updating, something which hasn't been implemented.

/opt/epstats/bin

Contains the scripts needed to update the table.

• daily_update.sh - Runs all the scripts in the right order.
• extract_metadata_from_archive.pl - Extracts eprint, author and group metadata from the repository by iterating over every eprint.
• update_table.pl - Filters and processes new entries in the accesslog to update the epstats_true_acesses_table. Uses 'SearchParser.pm' and 'repeatscache'.
• convert_ip_to_host.pl - Attempts to convert ip addresses of the new entries in epstats_true_acesses_table to hostnames. Uses 'host_updated' to keep track of where it got to last time.

Note that most of these scripts probably need to be tidied up. They were written in a hurry and were never polished.

/opt/epstats/cache

Contains cache files. Feel free to delete these whenever you like.

/opt/epstats/cgi

Contains two scripts, 'get_view' and 'stats'.

• get_view returns the output of a EPstats::View (see below), which is currently a chunk of html or csv, but could be almost anything.
• stats is a handy cgi form that passes arguements to get_view

/opt/epstats/img

Conceptually, where any images would be kept (e.g. national flags). At the moment, only the img/graphs directory is used. This is where generated graphs are stored.

/opt/epstats/perl_lib

Contains all the epstats classes.

EPStats Classes

Note that the leading EPStats:: has been left out for brevity.

Params

This object holds the parameters that are used to generate the statistics.

Configuration Constants

• $cgi_script - the name of the cgi script (currently unused)
• $id_params - When generating an ID, which parameters are important.
• $defaults - Any default parameters you wish to set.

Functions

• new(CGI_object) - returns new object
• mask(params_hash) - used when you want to temporarily overwrite parameter(s). Overwrites values with contents of params_hash. Overwritten values get pushed onto a stack.
• unmask - Sets parameters back to how they were before the last mask.
• generate_cgi - returns a string containing the name of the cgi script, and all parameters, to enable the creation of links. (currently unused)
• get(param_name) - returns the value of a single parameter.
• create_id - Uses MD5 to create a unique ID from the id_params (see Constants above). This is called whenever get('id') is called.

DatabaseInterface

Date

Cache

Periods

UserInterface::Controls

Page (depricated)

View View.pm Visualisation Visualisation.pm