<?php
/* NJS 2006-04-28
In earlier versions of this script, which eprints to count was
determined by comparing the request date of the eprint against the
"lastproc" date of this script (i.e., minimum time unit one day).
This was fine if you only ran the script once per day, but if you ran
it more than that, it counted multiple times requests whose
$request_date == $lastproc. For example, if you ran this script five
times per day, all the downloads that occurred during that day would
be counted EVERY TIME this script ran, thus overinflating your stats
by a factor of up to five :(
The solution is to use the full time stamp for comparison rather than
just the date. This timestamp MUST include time zone information so
that things don't get screwed up by daylight saving time. As long as
this is done consistently, there's no need to do things like convert
to GMT, for example.
The very first thing we need to do is grab the current time stamp
with time zone, which will later be stored in the database as the
"lastproc" time. This needs to happen first so that we don't "lose"
any requests that occur while the script is running.
*/
$start_time = date('Y-m-d H:i:s O');
// NJS 2005-12-09 Switched to GeoIP from GeoIP:IPfree.
include("geoip.inc");
$gi = geoip_open("##GEOIP_DATABASE##",GEOIP_STANDARD);
/*
Apache log for ePrints uses this format:
LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
If the log format differs the regular expression matching would need to be adjusted.
Parse:
ip
date YYYY MM DD
archive ID
*/
// Web server log files
$log_dir = '##APACHE_LOG_LOCATION##';
$log_file = array(
'otago_eprints' => '##APACHE_LOG_NAME_1##',
'cardrona' => '##APACHE_LOG_NAME_2##',
);
// eprintstats db
$sqlserver = 'localhost';
$sqluser = 'eprintstatspriv';
$sqlpass = 'AuldGrizzel';
$sqldatabase = 'eprintstats';
/* NJS 2006-05-26
SQL details of your ePrints installation(s). This has now been
generalised to work with multiple archives. For each archive that you
have, add an entry to this array in the following format:
'archive_name' => array(
'sqlserver' => 'db_host',
'username' => 'archive_name',
'password' => 'password',
),
*/
$eprintsdbs = array(
'otago_eprints' => array(
'sqlserver' => 'localhost',
'username' => 'otago_eprints',
'password' => 'DrSyntaxRidesAgain',
),
'cardrona' => array(
'sqlserver' => 'localhost',
'username' => 'cardrona',
'password' => 'chautquau',
),
);
/* NJS 2005-12-16
IP address ranges for your local Intranet(s). You can have multiple
ranges of IP addresses, each with a different "country name", so that
they will appear as separate entries in the by country stats pages.
You should use a different country code for each range (ISO 3166-1
specifies the range XA through XZ as "user-assignable", so you can use
codes from there as necessary), and create flag icons as appropriate.
Each address range key is the name that will appear in the statistics
database (the "country name"), followed by a comma, followed by the
appropriate ISO 3166-1 country code as noted above. Each entry in the
range is either a single IP address, or an array specifying a lower and
upper bound for a contiguous IP address range (see example below).
All IP addresses must be converted to long values using the ip2long()
function before being stored.
Note that address ranges may overlap. The script will use the first
range that matches a given IP, so list the ranges in the correct order
of precedence for your needs.
Example:
$local_IPs = array(
'Repository Admin,XA' => array(
ip2long('192.168.1.5'),
ip2long('192.168.1.22'),
array(
lower => ip2long('192.168.1.30'),
upper => ip2long('192.168.1.35'),
),
),
'Our Intranet,XI' => array(
array(
lower => ip2long('192.168.1.0'),
upper => ip2long('192.168.255.255'),
),
),
);
'Repository Admin' covers the IP addresses 192.168.1.5, 192.168.1.22 and
the range 192.168.1.30 to 192.168.1.35, inclusive. 'Our Intranet' covers
the range 192.168.1.0 to 192.168.255.255, inclusive. A machine will only
match the 'Our Intranet' range if it first fails to match the
'Repository Admin' range.
*/
$local_IPs = array(
'Repository Admin,XA' => array(
ip2long('139.80.75.110'), // Nigel @ Uni
ip2long('60.234.209.74'), // Nigel @ home
ip2long('139.80.92.138'), // Monica & Jeremy
ip2long('139.80.92.151'), // @ Uni
ip2long('203.89.162.155'), // Monica @ home
ip2long('139.80.81.50'), // eprints.otago.ac.nz
ip2long('172.20.1.50'), // eprints.otago.ac.nz pre-switch
ip2long('172.20.1.1'), // eprints.otago.ac.nz pre-switch
),
'Otago Intranet,XI' => array(
array(
'lower' => ip2long('139.80.0.0'),
'upper' => ip2long('139.80.127.255'),
),
),
);
###########################################
##
## No configuration required below here.
##
###########################################
$connect = mysql_pconnect ($sqlserver,$sqluser,$sqlpass);
$db = mysql_select_db($sqldatabase,$connect) or die("Could not connect");
// First get the date of last update
// NJS 2006-04-28 Changed this from order by timeinsert to order by id.
// The is always guaranteed to increase temporally, but is otherwise
// time-independent and thus not affected by things like daylight savings.
$query = "SELECT lastproc FROM lastproc ORDER BY id DESC LIMIT 1";
$result = mysql_query($query,$connect);
$num_rows = mysql_num_rows($result);
if ($num_rows > 0) {
$row = mysql_fetch_assoc($result);
$lastproc = $row["lastproc"];
$datetestA = strtotime($lastproc);
}
else {
$datetestA = 0;
}
// NJS 2006-06-14: Generalised connection list for multiple archives.
$eprints_connections = array();
foreach ($eprintsdbs as $archive_name => $details)
{
$eprints_connections[$archive_name] =
mysql_connect($details['sqlserver'],$details['username'],$details['password']);
}
$counter = 0;
foreach($log_file as $archive_name=>$archive_log) {
$logf = $log_dir . $archive_log;
$handle = fopen($logf, "r");
while (!feof($handle)) {
$buffer = fgets($handle, 4096);
// NJS 2005-11-25 Added regexp for EPrints short URLs.
if ((preg_match("/^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) - - \[(.*?)\] \"GET \/archive\/0{1,8}(\d{1,4}).*? HTTP\/1..\" 200 .*/i",$buffer,$matches)) ||
(preg_match("/^(\S{1,}\.\S{1,}\.\S{1,}\.\S{1,}) - - \[(.*?)\] \"GET \/archive\/0{1,8}(\d{1,4}).*? HTTP\/1..\" 200 .*/i",$buffer,$matches)) ||
(preg_match("/^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) - - \[(.*?)\] \"GET \/(\d{1,4}).*? HTTP\/1..\" 200 .*/i",$buffer,$matches)))
{
$counter++;
$country_code = '';
$country_name = '';
$insertid = '';
$eprint_name = '';
$view_type = '';
$uniquebits = '';
$ip = $matches[1];
/* NJS 2005-12-16
Determine country code and name.
Check whether the IP number falls into any of the local
intranet ranges. If so, then use that.
*/
$ip_long = ip2long($ip);
$found_country = FALSE;
foreach ($local_IPs as $id => $addresses)
{
foreach ($addresses as $ip_range)
{
if (is_array($ip_range)) // check against lower/upper bounds
{
$found_country = (($ip_long >= $ip_range['lower'])
&& ($ip_long <= $ip_range['upper']));
break;
}
else if (is_long($ip_range)) // data type sanity check
{
$found_country = ($ip_long == $ip_range);
break;
}
else // something is seriously broken, ignore this entry
{
print "Unsupported data type " . gettype($ip_range) .
" (value " . $ip_range .
") in \$local_IPs (expected long).\n";
continue;
}
}
if ($found_country)
{
list($country_name, $country_code) = explode(',', $id);
break;
}
}
// Otherwise, fall back to GeoIP.
if (!$found_country)
{
$country_code = geoip_country_code_by_addr($gi, $ip);
$country_name = geoip_country_name_by_addr($gi, $ip);
}
// end NJS 2005-12-16
$date = $matches[2];
$eprint_id = $matches[3];
$uniquebits = $buffer;
/* NJS 2006-04-28
Switched to timestamp rather than date-based comparison.
First, clean up the Apache request date into something
that strtotime understands. Note that the Apache log
dates include time zone info by default.
*/
$date = preg_replace("/:/"," ",$date,1); // Change first ":" to " ".
$date = preg_replace("/\//", " ", $date); // Change all "/" to " ".
$datetestB = strtotime($date);
// Convert to properly formatted date string.
$request_date = date('Y-m-d H:i:s O', $datetestB);
if ($datetestB < $datetestA)
continue;
// NJS 2005-11-25 Added regexp for EPrints short URLs.
if(preg_match("/GET \/archive\/0{1,8}\d{1,4}\/\d\d\//i",$buffer) || preg_match("/GET \/\d{1,4}\/\d\d\//i",$buffer)) {
$view_type = "download";
} else {
$view_type = "abstract";
}
if(isset($eprintname[$archive_name . $eprint_id])) {
$eprint_name = $eprintname[$archive_name . $eprint_id];
} else {
$eprint_name = getePrintName($eprints_connections[$archive_name],$archive_name,$eprint_id);
$eprintname[$archive_name . $eprint_id] = $eprint_name;
}
if($eprint_name=='') {
// Do nothing.
} else {
$eprint_name = mysql_escape_string($eprint_name);
/* NJS 2006-04-25
Requests containing apostrophes (') are dumped by
MySQL unless we escape them. Looking in the GeoIP
files I also see country names with apostrophes, so
escape that as well. Everything else should be fine.
*/
$uniquebits = mysql_escape_string($uniquebits);
$country_name = mysql_escape_string($country_name);
// end NJS 2006-04-25
$query = "
INSERT INTO view (uniquebits,archive_name,ip,request_date,archiveid,country_code,country_name,view_type,eprint_name)
VALUES('".$uniquebits."','".$archive_name."','".$ip."','".$request_date."',".$eprint_id.",'".$country_code."','".$country_name."','".$view_type."','".$eprint_name."')";
$result = mysql_query($query,$connect);
$insertid = mysql_insert_id($connect);
}
} else {
// print "NO match" . "\n";
}
}
fclose($handle);
}
/*
Keep track of where we are. Should avoid duplication of results
if the script is run more than once on the same log file
*/
// NJS 2006-04-28 Switched value inserted to $start_time instead of $request_date.
$query = "INSERT into lastproc (lastproc) values('".$start_time."')";
$result = mysql_query($query,$connect);
#print "Records counted: $counter\n";
#print "Last count: $request_date\n";
foreach ($eprints_connections as $connection)
{
mysql_close($connection);
}
mysql_close($connect);
// Look up the title corresponding to the specified eprint id.
function getePrintName($connection,$archive,$eprintid) {
// NJS 2006-06-14: DB connection now passed as an argument.
$db = mysql_select_db($archive,$connection);
$query3 = "
SELECT title
FROM archive
WHERE eprintid = $eprintid
";
$result3 = mysql_query($query3,$connection);
$title = '';
$suffix = '';
// NJS 2006-04-25 Added check for empty result, probably a deleted item.
// Look in the deletion table for details.
if (mysql_num_rows($result3) == 0) {
$query3 = "
SELECT title
FROM deletion
WHERE eprintid = $eprintid
";
$result3 = mysql_query($query3,$connection);
// If it's not in deletion, then we have no clue what it is.
if (mysql_num_rows($result3) == 0) {
$title = "Unknown item [$eprintid]";
}
else {
$suffix = ' [deleted]';
}
}
if ($title == '') {
$row = mysql_fetch_assoc($result3);
$row["title"] = trim($row["title"]);
$row["title"] = preg_replace("/\s+/"," ",$row["title"]);
$title = $row["title"];
}
return $title . $suffix;
}
?>
