Editing IRStats Technical Documentation (section)

= Directory Structure =

== /opt/irstats/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 irstats_true_acesses_table.  Uses 'SearchParser.pm' and 'repeatscache'.
* convert_ip_to_host.pl - Attempts to convert ip addresses of the new entries in irstats_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/irstats/cache ==
Contains cache files.  These should probably be deleted whenever the database is updated.

== /opt/irstats/cgi ==

Contains two scripts, 'get_view and 'stats'.

*get_view returns the output of a IRStats::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/irstats/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/irstats/cfg ==

Where the configuration file and the text files containing repository data are held.

=== The Configuration File ===

irstats.cfg contains a number of configuration strings.  Here are some of the more important ones, with the default in brackets:

*configuration_path (/opt/irstats/cfg/) - The path of the configuration directory.
*view_path (/opt/irstats/perl_lib/IRStats/View/) - The directory containing the Views.
*cache_path (/opt/irstats/cache/) - The directory in which to store cache files.
*graph_path (/opt/irstats/img/graphs/) - The directory in which to store graph images.
*graph_relative_url_path (/img/graphs/) - The url of the directory in which the graph file is from the point of view of the web browser.
*update_lock_filename (/opt/irstats/bin/.lock) - The name of the file that is created to prevent the update process running twice concurrently
*The names of the files used to store set information
**set_member_full_citations_file (/opt/irstats/cfg/irstats_set_member_full_citations.txt)
**set_member_short_citations_file (/opt/irstats/cfg/irstats_set_member_short_citations.txt)
**set_membership_file (/opt/irstats/cfg/irstats_set_membership.txt)
**set_member_codes_file (/opt/irstats/cfg/irstats_set_member_codes.txt)
**set_member_urls_file (/opt/irstats/cfg/irstats_set_member_urls.txt)
*Referrer Scope Labels (note, if you change these, you should also change them in the database)
**referrer_scope_1 (Internal)
**referrer_scope_2 (ECS)
**referrer_scope_3 (Search)
**referrer_scope_4 (External)
**referrer_scope_no_referrer (None)
*awstats_search_engines (/usr/local/awstats/wwwroot/cgi-bin/lib/search_engines.pm) - The path to the awstats search engine module
*repeats_filter_file (/opt/irstats/bin/repeatscache) - The file to maintain state between updates
*repeats_filter_timeout (86400) - repeat timeout in seconds (the amount of time there needs to be between two hits for them both to be recorded, initially set to 60*60*24)

*repository_url = http://eprints.ecs.soton.ac.uk - the path to the repository

*database configuration
**database_driver (mysql)
**database_server (localhost)
**database_name
**database_user
**database_password

*database_id_columns ([ requester_organisation, requester_host, referrer_scope, search_engine, search_terms, referring_entity_id ]) - The columns in the database that have a UID rather than data.  These need seperate tables in which to store the data.

*Various table names and parts of names
**database_eprints_access_log_table (accesslog) ##Perhaps remove after update rewrite.
**database_main_stats_table (irstats_true_accesses_table)
**database_column_table_prefix (irstats_column_)
**database_set_table_prefix (irstats_set_)
**database_set_table_code_suffix (_code)
**database_set_table_citation_suffix (_citation)

*id_parameters ([ start_date, end_date, eprints, view ]) - the parameters that are used to uniquely identify a view
*host_lookup_temp_dir (/opt/irstats/bin/convert_hosts_temp_files/) - The directory in which to store temp files for host lookups


== /opt/irstats/perl_lib ==

Contains all the irstats classes.