<?php

// BackIron Referrals
//
// Referral tracker/display program with php and MySql
// v0.12 March 6, 2003
// by John S. Irons 
//
// jsirons@argmax.com
// http://www.argmax.com/mt_blog/archive/000327.php
//
// (c) copyright 2003 Arlington, VA
// Free to use or modify provided credit is given. No guarantee is implied or granted.
//
// This php script will display referrers to your website. Just include the
// script on any page(s) you want to track
//
// The script currently only supports MySQL, but other modifications may be easy.
//
// Usage:
//	include('backiron.php');
//
// Options:
//	$output_type 	= [ "none" | "short" | "all" ] -- Default: Short
//	$output_number 	= number -- Default: 25
//	$output_min 	= number -- Default: 2
//
// Examples:
//   1) To display the 15 referrers with a minimum of 5 refers.
//
//	$output_type = "short";
//	$output_min = 5;
//	$output_number = 15;
//	include('backiron.php');
//
//   2) To Track referrals only
//
//	$output_type = "none";
//	include('backiron.php');
//
// ChangeLog
//
// v0.1  first version - 3/6/03
// v0.11 Bug fix, ability to turn off "Unknown" from display - 3/7/03
// v0.12 Added total hits, reworded text - 3/7/03
// v0.13 [..] more link - 3/7/03
// v0.14 Set to display correct number if unknown and local are off. 3/9
// v0.15 Added exclude list. 3/9
// v0.16 Set to aggregate google refers from multiple countries 3/10
//
/* Table Structure:

CREATE TABLE bi_refer_table (
  refer_name text NOT NULL,
  refer_title text NOT NULL,
  count int(11) NOT NULL default '1',
  time int(11) NOT NULL default '0',
  keycount int(11) NOT NULL auto_increment,
  refer_full text NOT NULL,
  PRIMARY KEY  (keycount)
) TYPE=MyISAM;

*/    




// -------------- Configure the script here ------------ //



$db_host='localhost';		// set to local MySQL settings
$db_username='username';	// set to local MySQL settings
$db_password='password';	// set to local MySQL settings
$db_name='DBname';		// set to local MySQL settings

$local_site= "yoursite.com";	//set to local site
$backiron_loc = "/backiron.php";  //current file location of backiron

$include_local = false;		//set to true to include local referrals in count
$include_unknown = true;	//set to true to include unknown referrals in count
$include_total = true;	 	//set to true to include total hits

$exclude_sites=array('radio.xmlstoragesystem.com', 'blo.gs', 'technorati.com', 'popdex.com');  //sites to exclude from tracking (do not include www)

$table_name='bi_refer_table';	// set to preferred table name

$title_max = 25; 		// maximum number of characters to store for title of refers
$expire_time = 24;		// maximum number of hours to keep information

$debug=false;			// set to true to get some feedback

// ----------------- Default Display options -----------------//

$output_type_default="short"; 	// for printing, either none, short or all, change by setting $output_type
$output_number_default=25;	// for short only, change by setting $output_number
$output_min_default=2;		// for short only, change by setting $output_min


// ----------------------------------------------------------- //


function openDatabase($db_name, $db_host, $db_username, $db_password) {
	// proc to open database

	global $debug;

	if (!($link = @mysql_connect($db_host, $db_username, $db_password))) {
		if ($debug) echo "Could not connect";
		die;
	}

	if (!(@mysql_select_db($db_name))) {
	     	if ($debug) echo "Could not select datase: $db_name";
	     	die;
	}
	return true;
}


function closeDatabase($result, $link) {
	//proc to close database

	mysql_free_result($result);
	mysql_close($link);
}

function do_query($query) {

	if (!($result = @mysql_query($query))) {
	     	if ($debug) echo "Bad query: $query";
	     	die;
	}
	return $result;
}


function lookup_title($refer) {
	//proc to lookup title

	global $title_max;

	$file = @fopen ('http://' . $refer, "r");

	if (!$file) {
	    echo " - Unable to open remote file.\n";
	} else {
		while ($line = fgets($file, 3048)) {
			if (eregi ('(.*)<title>(.*)</title>(.*)', $line, $out)) {
				$title = $out[2];
			        break;
			} //if
		} //while
	} //else

	// trim title to max character length without breaking words
	if (isset($title)) {
		$aspace=" ";
		if(strlen($title) > $title_max ) {
			$title = substr(trim($title),0,$title_max);
			$title = substr($title,0,strlen($title)-1-strpos(strrev($title),$aspace));
			$title = $title . '...';
		}
		// clean $title to exclude single quotes
		$title=htmlspecialchars($title, ENT_QUOTES);
		$title=eregi_replace("\'", "", $title);
		return $title;
	} else {
		return "No Title";
	}
}

function process_refer($refer, $refer_full) {
	//Compare link to database

	global $debug;
	global $db_host;
	global $db_username;
	global $db_password;
	global $db_name;
	global $table_name;
	global $exclude_sites;

	$refer_lookup = $refer;
	$timeStamp = time();

	//strip www from refer
	$refer = eregi_replace('www\.','',$refer);

	if (in_array($refer, $exclude_sites)) {
		return;
	}

	if (eregi('google', $refer)) {
		//fix to aggregate all googles (countries) to one
		$refer="google.com";
	}

	$query = "SELECT refer_title, refer_name, count FROM $table_name WHERE refer_name='$refer' ";
	$result = do_query($query);

	// if in database
	if ($row = mysql_fetch_array($result)) {

		$title = $row['refer_title'];

		$query = "INSERT INTO $table_name SET count=1, refer_name='$refer', refer_full='$refer_full', refer_title='$title', time=$timeStamp ";
		$result = do_query($query);
	}	
	else {
		// insert link, title

		$title = lookup_title($refer_lookup);

		$query = "INSERT INTO $table_name SET count=1, refer_name='$refer', refer_full='$refer_full', refer_title='$title', time=$timeStamp ";
		$result = do_query($query);
	}
}

function cleanUp($expire_time) {
	// delete old entries

	global $table_name;
	
	$timeCutoff = time() - (3600*$expire_time);
	
	$query = "DELETE FROM $table_name WHERE time<$timeCutoff ";
	$result = do_query($query);
}

function print_refers($output_type, $n, $min) {
	// none - track only
	// short - list of $n, and count >= $min
	// all - all

	global $table_name;
	global $expire_time;	// in hours
	global $include_local;
	global $include_unknown;
	global $local_site;
	global $include_total;
	global 	$backiron_loc;


	echo "Sites that sent visitors over the past $expire_time hours. ";

	if ($include_total) {
		$query = "SELECT count(*) FROM $table_name";
		$result = do_query($query);
		$row = mysql_fetch_array($result);
		echo "Total: " . $row['count(*)']. " pageviews. ";
	}

	if ($output_type=='short') {
		echo "Top $n referrals, with minimum of [$min].";
		if (!$include_local) $n=$n+1;
		if (!$include_unknown) $n=$n+1;
		$query = "SELECT refer_name, refer_full, refer_title, count(*) FROM $table_name GROUP BY refer_name ORDER BY 4 DESC LIMIT $n";
	} elseif ($output_type=='all') {
		$query = "SELECT refer_name, refer_full, refer_title, count(*) FROM $table_name GROUP BY refer_name ORDER BY 4 DESC";
	} else {
		return;
	}
	$result = do_query($query);

	echo "<br><br>";
	while($row = mysql_fetch_array($result)) {
		if (!((!$include_local) AND eregi($local_site, $row['refer_full'] ))) {
			if (($output_type=='short') AND ($row['count(*)']<$min)) {
				break;
			}
			if ($row['refer_title']=='No Title') {
				$row['refer_title']=''.$row['refer_name'];
				if ($row['refer_title']=='') {
					$row['refer_title']='Unknown';
				}
			}
			if ($row['refer_full']) {
				echo ' [' . $row['count(*)'] . '] <a href=' . $row['refer_full']. '>' . $row['refer_title'] . '</a><br>';
			} else {
				if ( ($include_unknown) OR ($row['refer_title']!='Unknown') ) {
					echo ' [' . $row['count(*)'] . '] ' . $row['refer_title'] . '<br>';
				}
			}
		}
	}

	echo "[..] <a href=". $backiron_loc . "?output_type=all>more...</a>";
	echo "</p><p>Powered by <a href=http://www.argmax.com/mt_blog/archive/000327.php>backIron</a>";
}

// -----------------------------  MAIN   ----------------------------------//

$refer_full = $_SERVER['HTTP_REFERER'];
$page = $_SERVER['PHP_SELF'];
if ($_SERVER['QUERY_STRING']) {
	$query = $_SERVER['QUERY_STRING'];
}

// Strip full url to get base only
$url_comp = parse_url($refer_full);
$refer = '' . $url_comp[host] ;

openDatabase ($db_name, $db_host, $db_username, $db_password);

// Insert or increment
process_refer($refer, $refer_full);

// Remove old refers
cleanUp($expire_time);

if (!isset($output_type)) {
	$output_type=$output_type_default;
}
if (!isset($output_number)) {
	$output_number=25;
}
if (!isset($output_min)) {
	$output_min=2;
}

print_refers($output_type, $output_number, $output_min);

?>