- Added EPrints version configuration item. - Added support for different database structures in v2/v3 of EPrints.

nigel.stanger / Digital_Repository

Browse code - Added EPrints version configuration item. - Added support for different database structures in v2/v3 of EPrints. master
1 parent 6528a9d commit b9980097e303f0f31026921a21bd5bc5365b0f4a nstanger authored on 24 Jul 2007

Patch

Showing 3 changed files

                Ignore Space
               Show notes
              View
            
          
          4 ■■■■■
          Repositories/statistics/config/inc.vars.es_src.php
 			"prog_title_public" => "ePrints Statistics",
			"short_prog_title" => "es",
			"public_prog" => "index.php",
			"public_prog_request_uri" => "/index.php",
			// NJS 2007-07-24: Added EPrints version setting, as the
			// repository database structure changed between version
			// 2.x and 3.x. Use the major version number only.
			"eprints_version" => 3,
			// NJS 2006-06-15: Made location URL a list and added list of
			// full repository names.
			"eprints_location" => array(
				"default" => "http://##EPRINTS_HOST####EPRINTS_PORT##",

            <?php

	/*
		Configuration for ePrintstats project.
		The serialized vars in user.serialized.es.cfg are read after this
		so may override any values. This is done to allow settings to be 
		changed via the web admin interface. 

		Note that many of the variables are actually not used as eprintstats uses
		code from another project.
	*/

	// These are available globally by default.
	// Not all are relevant as code was copied from another project.
	define("ERROR_EXIT", 1); 
	define("ERROR_CONTINUE", 0); 
	define("GET_POST_PROCESS_INVALID", TRUE);
	define("UNSET_REQUEST", 1);
	define("UNSET_KEY", 2);
	define("UNSET_CONTINUE", 3);
	define("UNSET_ACTION", 4);
	define("UNSET_REPLACE", 5);
	define("NOT_EMPTY", 1);
	
	// These are loaded to $GLOBALS and are available throughout the program without using "global"
	$GLOBALS["config_vars"] = array(
		"debug" => array(
			"vTITLE" => "Debug output",
			"vDESCRIPTION" => "TRUE or FALSE selected for public or private",
			/* the initial page needs to be able to identify if public (no auth) or private (auth) */
			"public" => 1
		),
		"connections" => array(
			"vTITLE" => "SQL server settings",
			"vDESCRIPTION" => "Specify the server name, database name, and user accounts to use.",
			"sqlserver" => "localhost",
			"sqldatabase" => "eprintstats",
			"sqluser_public" => "eprintstatspub",
			"sqlpass_public" => "AuldGrizzel",
			// NJS 2006-06-14: Generalised the connection list to support
			// multiple EPrints archives. Also added the natural-language
			// archive name for easy reference.
			"eprints_archives" => array(
				"otago_eprints" => array(
					"sqlserver_eprints" => "localhost",
					"sqluser_eprints" => "otago_eprints",
					"sqlpass_eprints" => "DrSyntaxRidesAgain",
				),
				"cardrona" => array(
					"sqlserver_eprints" => "localhost",
					"sqluser_eprints" => "cardrona",
					"sqlpass_eprints" => "chautquau",
				),
			),
		),
		"filelocation" => array(
			"vTITLE" => "File locations",
			"vDESCRIPTION" => "Install directory and location of required files.",
			"base_install_dir" => array(
				"unix" => "##EPRINTSSTATS##",
				"windows" => "C:/ePrintsStats",
			),
			"base_log_dir" => "logs",
			"base_includes_dir" => "includes",
			"base_session_dir" => "session",
			"base_config_dir" => "config",
		),
		"input_filter" => array(
			"vTITLE" => "Input filtering.",
			"vDESCRIPTION" => "Input checking for GET POST",
			/* List of allowed key/value pairs and COOKIES Values either explicit or a function */
			/* Escaping of strings destined for sql are dealt with by the sql object. */
			/* Excludes the action array which is explicitly named below. */
			/* How to deal with sets of parameters. Define arrays of them? */
			"keys" => array(
				"public" => array(
					"action" => array(
						"maxlength" => "20",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					"year" => array(
						"maxlength" => "50",
						"type" => "freetext",
						"action" => UNSET_REPLACE,
						"pattern" => "/[%;#--<>\(\)]/i",
						"replacement" => "",
						"content" => NOT_EMPTY,
					),
					"month" => array(
						"maxlength" => "50",
						"type" => "freetext",
						"action" => UNSET_REPLACE,
						"pattern" => "/[%;#--<>\(\)]/i",
						"replacement" => "",
						"content" => NOT_EMPTY,
					),
					"range" => array(
						"maxlength" => "20",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					"code" => array(
						"maxlength" => "3",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					/* maxlength here refers to largest integer */
					"id" => array(
						"maxlength" => "1005",
						"type" => "integer",
						"action" => UNSET_REQUEST,
					),
				),
			),
		),
		"general" => array(
			"vTITLE" => "General progam details",
			"vDESCRIPTION" => "Admin name and contact, prog title",
			"admin_name" => "ePrints Administrator",
			"admin_email" => "##EPRINTS_ADMIN_EMAIL##",
			"support_name" => "ePrints Administrator",
			"support_email" => "##EPRINTS_ADMIN_EMAIL##",
			"prog_title" => "ePrints Statistics",
			"prog_title_public" => "ePrints Statistics",
			"short_prog_title" => "es",
			"public_prog" => "index.php",
			"public_prog_request_uri" => "/index.php",
			// NJS 2007-07-24: Added EPrints version setting, as the
			// repository database structure changed between version
			// 2.x and 3.x. Use the major version number only.
			"eprints_version" => 3,
			// NJS 2006-06-15: Made location URL a list and added list of
			// full repository names.
			"eprints_location" => array(
				"default" => "http://##EPRINTS_HOST####EPRINTS_PORT##",
				"otago_eprints" => "http://##EPRINTS_HOST####EPRINTS_PORT##",
				"cardrona" => "http://cardrona.eprints.otago.ac.nz",
			),
			"repository_name" => array(
				"default" => "EPrints Repositories @ Otago",
				"otago_eprints" => "Otago Eprints Repository",
				"cardrona" => "Cardrona Community Repository",
			),
			// NJS 2006-06-16: Added reverse lookup list of server names.
			"virtual_host_to_archive" => array(
				"##EPRINTS_HOST##" => "otago_eprints",
				"cardrona.eprints.otago.ac.nz" => "cardrona",
			),
			/* replaced admin_prog */
			"prog_address" => array(
				"public" => "index.php",
			),
		),
		/* NJS 2005-12-16
			Local network setup. Must correspond to the $local_IPs
			variable in eprints-usage.php.
		*/
		"local_networks" => array(
			"XA" => "Repository Admin",
			"XI" => "Otago Intranet",
		),
		/* NJS 2007-01-31
		   List of known search engines. Must correspond to the
		   $bot_patterns variable in eprints-usage.php.
		*/
		"search_engines" => array(
			"X@GG" => "Google",
			"X@YH" => "Yahoo!",
			"X@MS" => "Windows Live Search",
			"X@AC" => "Ask.com",
			"X@OS" => "Other search engine",
		),
		"messages" => array(
			"vTITLE" => "Messages",
			"vDESCRIPTION" => "Error messages.",
			"message_noservice" => "This service is currently unavailable.",
			"message_missing_include" => "Missing include file.",
		),
		"actions" => array(
			"vTITLE" => "Form actions",
			"vDESCRIPTION" => "Which files are included for get/post actions. i.e the pub_default action will include the files listed in the array",
			"includes" => array(
				'public' => array(
					// NJS 2006-06-14
					'default' => array(
						'pub_default' => array ('inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.es.php'),
						'no_service_public' => array ('inc.html.header.es.php','inc.html.no_service_public.es.php','inc.html.footer.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.es.php'),
					),
					'otago_eprints' => array(
						'pub_default' => array ('inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.otago_eprints.es.php'),
						'no_service_public' => array ('inc.html.header.otago_eprints.es.php','inc.html.no_service_public.es.php','inc.html.footer.otago_eprints.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.otago_eprints.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.otago_eprints.es.php'),
					),
					'cardrona' => array(
						'pub_default' => array ('inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.cardrona.es.php'),
						'no_service_public' => array ('inc.html.header.cardrona.es.php','inc.html.no_service_public.es.php','inc.html.footer.cardrona.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.cardrona.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.cardrona.es.php'),
					),
				),
			),
		),
	);


            <?php

	/*
		Configuration for ePrintstats project.
		The serialized vars in user.serialized.es.cfg are read after this
		so may override any values. This is done to allow settings to be 
		changed via the web admin interface. 

		Note that many of the variables are actually not used as eprintstats uses
		code from another project.
	*/

	// These are available globally by default.
	// Not all are relevant as code was copied from another project.
	define("ERROR_EXIT", 1); 
	define("ERROR_CONTINUE", 0); 
	define("GET_POST_PROCESS_INVALID", TRUE);
	define("UNSET_REQUEST", 1);
	define("UNSET_KEY", 2);
	define("UNSET_CONTINUE", 3);
	define("UNSET_ACTION", 4);
	define("UNSET_REPLACE", 5);
	define("NOT_EMPTY", 1);
	
	// These are loaded to $GLOBALS and are available throughout the program without using "global"
	$GLOBALS["config_vars"] = array(
		"debug" => array(
			"vTITLE" => "Debug output",
			"vDESCRIPTION" => "TRUE or FALSE selected for public or private",
			/* the initial page needs to be able to identify if public (no auth) or private (auth) */
			"public" => 1
		),
		"connections" => array(
			"vTITLE" => "SQL server settings",
			"vDESCRIPTION" => "Specify the server name, database name, and user accounts to use.",
			"sqlserver" => "localhost",
			"sqldatabase" => "eprintstats",
			"sqluser_public" => "eprintstatspub",
			"sqlpass_public" => "AuldGrizzel",
			// NJS 2006-06-14: Generalised the connection list to support
			// multiple EPrints archives. Also added the natural-language
			// archive name for easy reference.
			"eprints_archives" => array(
				"otago_eprints" => array(
					"sqlserver_eprints" => "localhost",
					"sqluser_eprints" => "otago_eprints",
					"sqlpass_eprints" => "DrSyntaxRidesAgain",
				),
				"cardrona" => array(
					"sqlserver_eprints" => "localhost",
					"sqluser_eprints" => "cardrona",
					"sqlpass_eprints" => "chautquau",
				),
			),
		),
		"filelocation" => array(
			"vTITLE" => "File locations",
			"vDESCRIPTION" => "Install directory and location of required files.",
			"base_install_dir" => array(
				"unix" => "##EPRINTSSTATS##",
				"windows" => "C:/ePrintsStats",
			),
			"base_log_dir" => "logs",
			"base_includes_dir" => "includes",
			"base_session_dir" => "session",
			"base_config_dir" => "config",
		),
		"input_filter" => array(
			"vTITLE" => "Input filtering.",
			"vDESCRIPTION" => "Input checking for GET POST",
			/* List of allowed key/value pairs and COOKIES Values either explicit or a function */
			/* Escaping of strings destined for sql are dealt with by the sql object. */
			/* Excludes the action array which is explicitly named below. */
			/* How to deal with sets of parameters. Define arrays of them? */
			"keys" => array(
				"public" => array(
					"action" => array(
						"maxlength" => "20",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					"year" => array(
						"maxlength" => "50",
						"type" => "freetext",
						"action" => UNSET_REPLACE,
						"pattern" => "/[%;#--<>\(\)]/i",
						"replacement" => "",
						"content" => NOT_EMPTY,
					),
					"month" => array(
						"maxlength" => "50",
						"type" => "freetext",
						"action" => UNSET_REPLACE,
						"pattern" => "/[%;#--<>\(\)]/i",
						"replacement" => "",
						"content" => NOT_EMPTY,
					),
					"range" => array(
						"maxlength" => "20",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					"code" => array(
						"maxlength" => "3",
						"type" => "string",
						"action" => UNSET_REQUEST,
						"pattern" => "/[^\w]/i",
						"values" => array('one','two'),
					),
					/* maxlength here refers to largest integer */
					"id" => array(
						"maxlength" => "1005",
						"type" => "integer",
						"action" => UNSET_REQUEST,
					),
				),
			),
		),
		"general" => array(
			"vTITLE" => "General progam details",
			"vDESCRIPTION" => "Admin name and contact, prog title",
			"admin_name" => "ePrints Administrator",
			"admin_email" => "##EPRINTS_ADMIN_EMAIL##",
			"support_name" => "ePrints Administrator",
			"support_email" => "##EPRINTS_ADMIN_EMAIL##",
			"prog_title" => "ePrints Statistics",
			"prog_title_public" => "ePrints Statistics",
			"short_prog_title" => "es",
			"public_prog" => "index.php",
			"public_prog_request_uri" => "/index.php",
			// NJS 2006-06-15: Made location URL a list and added list of
			// full repository names.
			"eprints_location" => array(
				"default" => "http://##EPRINTS_HOST####EPRINTS_PORT##",
				"otago_eprints" => "http://##EPRINTS_HOST####EPRINTS_PORT##",
				"cardrona" => "http://cardrona.eprints.otago.ac.nz",
			),
			"repository_name" => array(
				"default" => "EPrints Repositories @ Otago",
				"otago_eprints" => "Otago Eprints Repository",
				"cardrona" => "Cardrona Community Repository",
			),
			// NJS 2006-06-16: Added reverse lookup list of server names.
			"virtual_host_to_archive" => array(
				"##EPRINTS_HOST##" => "otago_eprints",
				"cardrona.eprints.otago.ac.nz" => "cardrona",
			),
			/* replaced admin_prog */
			"prog_address" => array(
				"public" => "index.php",
			),
		),
		/* NJS 2005-12-16
			Local network setup. Must correspond to the $local_IPs
			variable in eprints-usage.php.
		*/
		"local_networks" => array(
			"XA" => "Repository Admin",
			"XI" => "Otago Intranet",
		),
		/* NJS 2007-01-31
		   List of known search engines. Must correspond to the
		   $bot_patterns variable in eprints-usage.php.
		*/
		"search_engines" => array(
			"X@GG" => "Google",
			"X@YH" => "Yahoo!",
			"X@MS" => "Windows Live Search",
			"X@AC" => "Ask.com",
			"X@OS" => "Other search engine",
		),
		"messages" => array(
			"vTITLE" => "Messages",
			"vDESCRIPTION" => "Error messages.",
			"message_noservice" => "This service is currently unavailable.",
			"message_missing_include" => "Missing include file.",
		),
		"actions" => array(
			"vTITLE" => "Form actions",
			"vDESCRIPTION" => "Which files are included for get/post actions. i.e the pub_default action will include the files listed in the array",
			"includes" => array(
				'public' => array(
					// NJS 2006-06-14
					'default' => array(
						'pub_default' => array ('inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.es.php'),
						'no_service_public' => array ('inc.html.header.es.php','inc.html.no_service_public.es.php','inc.html.footer.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.es.php'),
					),
					'otago_eprints' => array(
						'pub_default' => array ('inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.otago_eprints.es.php'),
						'no_service_public' => array ('inc.html.header.otago_eprints.es.php','inc.html.no_service_public.es.php','inc.html.footer.otago_eprints.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.otago_eprints.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.otago_eprints.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.otago_eprints.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.otago_eprints.es.php'),
					),
					'cardrona' => array(
						'pub_default' => array ('inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.pub_default.es.php','inc.html.footer.cardrona.es.php'),
						'no_service_public' => array ('inc.html.header.cardrona.es.php','inc.html.no_service_public.es.php','inc.html.footer.cardrona.es.php'),
						'cumulative_usage' => array ('inc.fns.cumulative_usage.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage.es.php','inc.html.footer.cardrona.es.php'),
						'cumulative_usage_country' => array ('inc.fns.cumulative_usage_country.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.cumulative_usage_country.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_date' => array ('inc.fns.show_detail_date.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_date.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_country' => array ('inc.fns.show_detail_country.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_country.es.php','inc.html.footer.cardrona.es.php'),
						'show_detail_eprint' => array ('inc.fns.show_detail_eprint.es.php','inc.html.header.cardrona.es.php','inc.fns.navbar.es.php','inc.html.navbar_global.es.php','inc.html.show_detail_eprint.es.php','inc.html.footer.cardrona.es.php'),
					),
				),
			),
		),
	);
 			"prog_title_public" => "ePrints Statistics",
 			"short_prog_title" => "es",
 			"public_prog" => "index.php",
 			"public_prog_request_uri" => "/index.php",
+			// NJS 2007-07-24: Added EPrints version setting, as the
+			// repository database structure changed between version
+			// 2.x and 3.x. Use the major version number only.
+			"eprints_version" => 3,
 			// NJS 2006-06-15: Made location URL a list and added list of
 			// full repository names.
 			"eprints_location" => array(
 				"default" => "http://##EPRINTS_HOST####EPRINTS_PORT##",

                Ignore Space
               Show notes
              View
            
          
          38 ■■■■■
          Repositories/statistics/includes/inc.class.mysql.es.php
 				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlpass_eprints"]
			);
			$db_eprints = mysql_select_db( $archive, $conn_eprints );
			if (!$db_eprints) return $eprint_title;
			$query_eprints = "
				SELECT title
				FROM archive
				WHERE eprintid = $eprint_id
			";
			// NJS 2007-07-24: Added check for EPrints version, as the
			// database structure changed between versions 2 and 3.
			if ($GLOBALS["config_vars"]["general"]["eprints_version"] > 2)
			{
				$query_eprints = "
					SELECT title
					FROM eprint
					WHERE eprintid = $eprint_id
					  AND eprint_status = 'archive'
				";
			}
			else
			{
				$query_eprints = "
					SELECT title
					FROM archive
					WHERE eprintid = $eprint_id
				";
			}
			$result_eprints = mysql_query($query_eprints,$conn_eprints);
			$row_eprints = mysql_fetch_assoc($result_eprints);
			$eprint_title = trim($row_eprints["title"]);
			$eprint_title = preg_replace("/\s+/"," ",$eprint_title);

            <?php
/**
 * Project:     ePrintstats
 * File:        inc.class.mysql.es.php
 * Description: All SQL interactions via this object.
 *              This includes connections, adding, updating, inserting.
 */

class sqlconn {
	var $_mysql_error = array();
	var $_database;
	var $_host_info;
	var $_debug = FALSE;
	var $_debugAll = array();

	function doConnectServer($sqlserver,$sqluser,$sqlpass)
	{
		$connect = mysql_pconnect ($sqlserver,$sqluser,$sqlpass)
		or sqlconn::_setError(mysql_errno(),mysql_error());
		$db_list = mysql_list_dbs($connect); 
		while ($row = mysql_fetch_object($db_list)) { 
 			$this->_db_list[] = $row->Database; 
		} 
		$this->_host_info = sprintf ("MySQL host info: %s\n", mysql_get_host_info()); 	
		return $connect;
	}
	function doConnectDb($sqldatabase)
	{
		$db = mysql_select_db($sqldatabase)
		or sqlconn::_setError(mysql_errno(),mysql_error());
		sqlconn::_setError(mysql_errno(),mysql_error());
		$this->_database = $sqldatabase;
		return $db;
	}
	function closeConnection()
	{
		mysql_close();
	}

	function getHostInfo()
	{
		return $this->_host_info;
	}
	
	function setDebug($debuglevel)
	{
		$this->_debug = $debuglevel;
	}
	
	function getDebug()
	{
		$_outstring = '';
		foreach ($this->_debugAll as $k=>$v) {
			$_outstring .= $v;	
		}
		return $_outstring;
	}
	
	function getError()
	{
		return $this->_mysql_error;	
	}
	
	/*
	* @return void
	* @param $input unknown
	* @desc HTML output debug info
	* @usage sqlconn::_debug($this->_db_schema);	
	*/
	function _debug($output,$line,$file,$function,$class)
	{
		ob_start();
		print "<div class=\"debug\">\n";
		print "<pre>\n";
		if (!empty($line))     { print "LINE: $line\n"; };
		if (!empty($file))     { print "FILE: $file\n"; };
		if (!empty($function)) { print "FUNCTION: $function\n"; };
		if (!empty($class))    { print "CLASS: $class\n"; };
		//if (!empty($method))   { print "METHOD: $method\n"; }; // Only > PHP5
		print_r($output);
		print "</ pre></div>";
		$ret_str = ob_get_contents();
		ob_end_clean();	
		$this->_debugAll[] = $ret_str;
	}
	
	function _setError($mysql_errno,$mysql_error)
	{
		/*
		* May be of limited use where a method makes multiple calls
		* and one error message is replaced by another.
		*/
		$this->_mysql_error["code"] = $mysql_errno;
		$this->_mysql_error["text"] = $mysql_error;
	}

	/********************************************
	*
	*
	*	Program specific
	*
	**********************************************/

/* ------------------------------------------------------------------------------
 This function is a rewritten version of getCumulativeUsage, to optionally 
 	select the view_type.
 (c) Copyright 2004 Arthur Sale, University of Tasmania
 Parameters:
 	id # of eprint
	strings 'abstract', 'download' or anything else acts as view=abstract+download	
 Returns:
	Result array from query or failure
------------------------------------------------------------------------------ */
function getCumulativeUsageType($archive,$id,$type) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// Formulate the id part of the select.
		$this->addArchiveIDCondition( $id, $where_parts );
		
		// Formulate the view part of the select.
		$this->addViewTypeCondition( $type, $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
// Create a result array
		$records = array();
//Build up the query
// NJS 2006-01-18: Added count of country_code.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       MONTH(request_date) AS monthnum,
			       DATE_FORMAT(request_date, '%b') AS month,
			       YEAR(request_date) AS year
			FROM view
			$limit
			GROUP BY year, monthnum
			ORDER BY year DESC, monthnum DESC
		";
// Make the query
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	}

/* ------------------------------------------------------------------------------ 
 This function is a rewritten version of getCumulativeUsageCountry, to optionally 
 	select the view_type.
 (c) Copyright 2004 Arthur Sale, University of Tasmania
 Parameters:
 	id # of eprint
	strings 'abstract', 'download' or anything else acts as view=abstract+download	
 Returns:
	Result array from query or failure
------------------------------------------------------------------------------ */
	function getCumulativeUsageCountryType($archive,$type) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// Formulate the view part of the select.
		$this->addViewTypeCondition( $type, $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );

// Create a result array
		$records = array();
//Build up the query
// NJS 2006-05-02: Fixed typo in ORDER BY and added ascending order of country
// name for countries with the same number of accesses.
		$query = "
			SELECT COUNT(*) AS count, country_name, country_code
			FROM view
			$limit
			GROUP BY country_name
			ORDER BY count DESC, country_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
		
	}
/* ------------------------------------------------------------------------------ */

	function getArchiveCountDate($archive,$year,$month,$range,$type='download')
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$year = (int) $year;
		$month = (int) $month;
		$records = array();
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// create a date based limit
		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $range, $where_parts );

		// Constrain the view to downloads - Arthur Sale addition -----------
		$this->addViewTypeCondition( 'download', $where_parts );
		// End of addition --------------------------------------------------
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		// NJS 2006-01-18: Added count of country_code.
		// NJS 2006-05-02: Added descending order of number of countries and
		// ascending order of title for eprints with the same number of
		// downloads.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       archiveid,
			       archive_name,
			       eprint_name
			FROM view
			$limit
			GROUP BY archiveid, archive_name
			ORDER BY count DESC, countries DESC, eprint_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	
	}

/*
	NJS 2005-12-15
	
	getArchiveCountCountry()
	arguments:
		$archive	archive name
		$ccode		country code
		$type		eprint view type (e.g., download)
	returns: array
	
	Similar to getArchiveCountDate but does it by country code instead
	of by date.
*/
	function getArchiveCountCountry($archive,$ccode,$type='download')
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$records = array();
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Create a country based limit. Also constrain to downloads only
		// in the appropriate archive.
		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addStringCondition( 'country_code', '=', $ccode, $where_parts );
		$this->addViewTypeCondition( 'download', $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
		// NJS 2003-05-02: Added ascending order of title for eprints with
		// the same number of downloads.
		$query = "
			SELECT COUNT(*) AS count,
			       archiveid,
			       archive_name,
			       eprint_name,
			       country_name
			FROM view
			$limit
			GROUP BY archiveid, archive_name
			ORDER BY count DESC, eprint_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	}

/* New */
	function getCountryEprintType($archive,$year,$month,$rnge,$type,$id) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$year = (int) $year;
		$month = (int) $month;
		$records = array();

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );
		
		// Generate type enquiry
		$this->addViewTypeCondition( $type, $where_parts );

		// generate date enquiry
		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $rnge, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
		// NJS 2006-05-02: Added ascending order of country
		// name for countries with the same number of accesses.
		$query = "
			SELECT COUNT(*) AS count, country_name, country_code
			FROM view
			$limit
			GROUP BY country_name
			ORDER BY count DESC, country_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
		
	}
	
	function getTitle($archive,$id)
	{
		// Get the title of an eprint given its id
		// NJS 2006-06-14: Added archive name as argument.

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		$query = "
			SELECT eprint_name
			FROM view
			$limit
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return;
		} else {
			$row = mysql_fetch_assoc($result);
			return $row["eprint_name"];
		}
	}
	
	function getAbstractDownload($archive,$year,$month,$range,$type='download',$id)
	{
		// NJS 2006-06-14: Added archive name as argument.

		$year = (int) $year;
		$month = (int) $month;
		$records = array();

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );

		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $range, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		// NJS 2006-01-18: Added count of country_code.
		// NJS 2006-05-02: Added ascending order of country code.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       view_type
			FROM view
			$limit
			GROUP BY view_type
			ORDER BY count DESC, country_code ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	
	}

	function getLastProc()
	{
		// Get the time that the stats were last processed.
		// Note that the archive name is irrelevant for this,
		// as the stats are updated for ALL archives at the
		// same time.
		//
		// NJS 2007-02-27: Changed from timeinsert to lastproc.
		// Missed this when fixing earlier bugs! Fortunately it
		// only affects display, not internal processing.
		$query = "
			SELECT lastproc
			FROM lastproc
			ORDER BY id DESC
			LIMIT 1
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return;
		} else {
			$row = mysql_fetch_assoc($result);
			return $row["lastproc"];
		}
	}


	/*
		NJS 2006-02-09 (moved here from inc.fns.show_detail_eprint.es.php)
		
		Grab the title of an eprint from the repository. Only needed if
		the title isn't already in the stats database, which should only
		occur when an eprint hasn't been downloaded yet.
		
		Do nothing if the archive name is empty or "default".
		
		We could be more clever about this and raise some kind of error
		if the eprint ID doesn't exist in the archive, but I don't see
		that it would add that much to the overall user experience :)
	*/
	function getEPrintTitle($archive,$eprint_id)
	{
		// NJS 2006-06-14: Added archive name as argument to support
		// multi-archive statistics.
		
		$eprint_title = '';
		if ( ( $archive != '' ) and ( $archive != 'default' ) )
		{
			$conn_eprints = mysql_connect(
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlserver_eprints"],
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqluser_eprints"],
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlpass_eprints"]
			);
			$db_eprints = mysql_select_db( $archive, $conn_eprints );
			if (!$db_eprints) return $eprint_title;
			// NJS 2007-07-24: Added check for EPrints version, as the
			// database structure changed between versions 2 and 3.
			if ($GLOBALS["config_vars"]["general"]["eprints_version"] > 2)
			{
				$query_eprints = "
					SELECT title
					FROM eprint
					WHERE eprintid = $eprint_id
					  AND eprint_status = 'archive'
				";
			}
			else
			{
				$query_eprints = "
					SELECT title
					FROM archive
					WHERE eprintid = $eprint_id
				";
			}
			$result_eprints = mysql_query($query_eprints,$conn_eprints);
			$row_eprints = mysql_fetch_assoc($result_eprints);
			$eprint_title = trim($row_eprints["title"]);
			$eprint_title = preg_replace("/\s+/"," ",$eprint_title);
			mysql_close($conn_eprints);
		}
		return $eprint_title;
	}
	
	/*
		NJS 2006-06-14
		
		buildWhereClause()
		arguments:
			$where_parts	array of WHERE clause conditions
			$op				boolean operator to separate conditions with
							(e.g., 'AND')
		returns: string
		
		Given an array of condition strings, build a WHERE clause,
		combining the conditions using the specified operator. (If you
		need to build something more complex, you'll have to do it
		manually.)
	*/
	function buildWhereClause( $where_parts, $op )
	{
		$limit = '';
		$num_parts = count( $where_parts );
		if ( $num_parts > 0 )
		{
			$limit = 'WHERE ';
			// Append all but the last one, with the specified operator.
			for ( $i = 0; $i < ( $num_parts - 1 ); $i++ )
			{
				$limit .= $where_parts[$i] . " $op ";
			}
			// Append the last one with no operator.
			$limit .= $where_parts[$num_parts - 1];
		}
		return $limit;
	}
	
	/*
		NJS 2006-06-14
		
		addArchiveNameCondition()
		arguments:
			$archive		the name of an archive
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the archive name to the list of WHERE
		conditions. Do nothing if the archive name is empty. We also
		ignore the value "default" in order to be backwards-compatible
		with earlier versions of the stats package. Note that in either
		of the latter two cases this means that ALL stats for ALL
		archives will be queried!
	*/
	function addArchiveNameCondition ( $archive, &$where_parts )
	{
		if ( ( $archive != '' ) and ( $archive != 'default' ) )
			$this->addStringCondition( 'archive_name', '=', $archive, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addArchiveIDCondition()
		arguments:
			$id				the id of an eprint
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the eprint ID to the list of WHERE
		conditions. Do nothing if the eprint ID is zero or less.
	*/
	function addArchiveIDCondition ( $id, &$where_parts )
	{
		$id = (int) $id;
		// BUG FIX: ID should be > 0, not > 1!
		if ( $id > 0 ) $this->addNumericCondition( 'archiveid', '=', $id, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addViewTypeCondition()
		arguments:
			$type			the type of archive view (download or abstract)
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the eprint view type to the list of WHERE
		conditions. Do nothing if the view type is not "download" or
		"abstract".
	*/
	function addViewTypeCondition ( $type, &$where_parts )
	{
		if ( ( $type == 'download' ) or ( $type == 'abstract' ) )
			$this->addStringCondition( 'view_type', '=', $type, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addYearCondition()
		arguments:
			$year			the year to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the year to the list of WHERE conditions. Do
		nothing if the year is outside the range 1990--2100. (Note:
		lower bound changed from 2002 as it seems more appropriate.)

		NJS 2006-01-18: Fixed upper year bound (was 2005).
	*/
	function addYearCondition ( $year, &$where_parts )
	{
		if ( ( $year >= 1990 ) and ( $year < 2100 ) )
			$this->addStringCondition( 'YEAR(request_date)', '=', $year, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addMonthCondition()
		arguments:
			$month			the month to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the month to the list of WHERE conditions.
		Do nothing if the month is outside the range 1--12.
	*/
	function addMonthCondition ( $month, &$where_parts )
	{
		if ( ( $month > 0 ) and ( $month <= 12 ) )
			$this->addStringCondition( 'MONTH(request_date)', '=', $month, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addFourWeeksCondition()
		arguments:
			$range			the range to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the last four weeks to the list of WHERE
		conditions. Do nothing if the range is not "4w".
	*/
	function addFourWeeksCondition ( $range, &$where_parts )
	{
		if ( $range == '4w' )
			$this->addExprCondition( 'request_date', '>=', 'DATE_SUB(CURDATE(),INTERVAL 1 MONTH)', $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addStringCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$value			the value to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a generic condition for a string column to the list of WHERE
		conditions. Any validation of the value should be done prior to
		calling this function.
	*/
	function addStringCondition ( $column, $op, $value, &$where_parts )
	{
		$where_parts[] = "$column $op '$value'";
	}

	/*
		NJS 2006-06-14
		
		addNumericCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$value			the value to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a generic condition for a numeric column to the list of WHERE
		conditions. Any validation of the value should be done prior to
		calling this function.
	*/
	function addNumericCondition ( $column, $op, $value, &$where_parts )
	{
		$where_parts[] = "$column $op $value";
	}

	/*
		NJS 2006-06-16
		
		addExprCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$expr			the expression to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add to the list of WHERE conditions a generic condition for a
		column to be tested against some arbitrary expression. Any
		validation of the value should be done prior to calling this
		function.
	*/
	function addExprCondition ( $column, $op, $expr, &$where_parts )
	{
		$where_parts[] = "$column $op $expr";
	}


}

?>


            <?php
/**
 * Project:     ePrintstats
 * File:        inc.class.mysql.es.php
 * Description: All SQL interactions via this object.
 *              This includes connections, adding, updating, inserting.
 */

class sqlconn {
	var $_mysql_error = array();
	var $_database;
	var $_host_info;
	var $_debug = FALSE;
	var $_debugAll = array();

	function doConnectServer($sqlserver,$sqluser,$sqlpass)
	{
		$connect = mysql_pconnect ($sqlserver,$sqluser,$sqlpass)
		or sqlconn::_setError(mysql_errno(),mysql_error());
		$db_list = mysql_list_dbs($connect); 
		while ($row = mysql_fetch_object($db_list)) { 
 			$this->_db_list[] = $row->Database; 
		} 
		$this->_host_info = sprintf ("MySQL host info: %s\n", mysql_get_host_info()); 	
		return $connect;
	}
	function doConnectDb($sqldatabase)
	{
		$db = mysql_select_db($sqldatabase)
		or sqlconn::_setError(mysql_errno(),mysql_error());
		sqlconn::_setError(mysql_errno(),mysql_error());
		$this->_database = $sqldatabase;
		return $db;
	}
	function closeConnection()
	{
		mysql_close();
	}

	function getHostInfo()
	{
		return $this->_host_info;
	}
	
	function setDebug($debuglevel)
	{
		$this->_debug = $debuglevel;
	}
	
	function getDebug()
	{
		$_outstring = '';
		foreach ($this->_debugAll as $k=>$v) {
			$_outstring .= $v;	
		}
		return $_outstring;
	}
	
	function getError()
	{
		return $this->_mysql_error;	
	}
	
	/*
	* @return void
	* @param $input unknown
	* @desc HTML output debug info
	* @usage sqlconn::_debug($this->_db_schema);	
	*/
	function _debug($output,$line,$file,$function,$class)
	{
		ob_start();
		print "<div class=\"debug\">\n";
		print "<pre>\n";
		if (!empty($line))     { print "LINE: $line\n"; };
		if (!empty($file))     { print "FILE: $file\n"; };
		if (!empty($function)) { print "FUNCTION: $function\n"; };
		if (!empty($class))    { print "CLASS: $class\n"; };
		//if (!empty($method))   { print "METHOD: $method\n"; }; // Only > PHP5
		print_r($output);
		print "</ pre></div>";
		$ret_str = ob_get_contents();
		ob_end_clean();	
		$this->_debugAll[] = $ret_str;
	}
	
	function _setError($mysql_errno,$mysql_error)
	{
		/*
		* May be of limited use where a method makes multiple calls
		* and one error message is replaced by another.
		*/
		$this->_mysql_error["code"] = $mysql_errno;
		$this->_mysql_error["text"] = $mysql_error;
	}

	/********************************************
	*
	*
	*	Program specific
	*
	**********************************************/

/* ------------------------------------------------------------------------------
 This function is a rewritten version of getCumulativeUsage, to optionally 
 	select the view_type.
 (c) Copyright 2004 Arthur Sale, University of Tasmania
 Parameters:
 	id # of eprint
	strings 'abstract', 'download' or anything else acts as view=abstract+download	
 Returns:
	Result array from query or failure
------------------------------------------------------------------------------ */
function getCumulativeUsageType($archive,$id,$type) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// Formulate the id part of the select.
		$this->addArchiveIDCondition( $id, $where_parts );
		
		// Formulate the view part of the select.
		$this->addViewTypeCondition( $type, $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
// Create a result array
		$records = array();
//Build up the query
// NJS 2006-01-18: Added count of country_code.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       MONTH(request_date) AS monthnum,
			       DATE_FORMAT(request_date, '%b') AS month,
			       YEAR(request_date) AS year
			FROM view
			$limit
			GROUP BY year, monthnum
			ORDER BY year DESC, monthnum DESC
		";
// Make the query
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	}

/* ------------------------------------------------------------------------------ 
 This function is a rewritten version of getCumulativeUsageCountry, to optionally 
 	select the view_type.
 (c) Copyright 2004 Arthur Sale, University of Tasmania
 Parameters:
 	id # of eprint
	strings 'abstract', 'download' or anything else acts as view=abstract+download	
 Returns:
	Result array from query or failure
------------------------------------------------------------------------------ */
	function getCumulativeUsageCountryType($archive,$type) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// Formulate the view part of the select.
		$this->addViewTypeCondition( $type, $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );

// Create a result array
		$records = array();
//Build up the query
// NJS 2006-05-02: Fixed typo in ORDER BY and added ascending order of country
// name for countries with the same number of accesses.
		$query = "
			SELECT COUNT(*) AS count, country_name, country_code
			FROM view
			$limit
			GROUP BY country_name
			ORDER BY count DESC, country_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
		
	}
/* ------------------------------------------------------------------------------ */

	function getArchiveCountDate($archive,$year,$month,$range,$type='download')
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$year = (int) $year;
		$month = (int) $month;
		$records = array();
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Formulate the archive name part of the select.
		$this->addArchiveNameCondition( $archive, $where_parts );
		
		// create a date based limit
		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $range, $where_parts );

		// Constrain the view to downloads - Arthur Sale addition -----------
		$this->addViewTypeCondition( 'download', $where_parts );
		// End of addition --------------------------------------------------
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		// NJS 2006-01-18: Added count of country_code.
		// NJS 2006-05-02: Added descending order of number of countries and
		// ascending order of title for eprints with the same number of
		// downloads.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       archiveid,
			       archive_name,
			       eprint_name
			FROM view
			$limit
			GROUP BY archiveid, archive_name
			ORDER BY count DESC, countries DESC, eprint_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	
	}

/*
	NJS 2005-12-15
	
	getArchiveCountCountry()
	arguments:
		$archive	archive name
		$ccode		country code
		$type		eprint view type (e.g., download)
	returns: array
	
	Similar to getArchiveCountDate but does it by country code instead
	of by date.
*/
	function getArchiveCountCountry($archive,$ccode,$type='download')
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$records = array();
		
		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';
		
		// Create a country based limit. Also constrain to downloads only
		// in the appropriate archive.
		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addStringCondition( 'country_code', '=', $ccode, $where_parts );
		$this->addViewTypeCondition( 'download', $where_parts );
		
		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
		// NJS 2003-05-02: Added ascending order of title for eprints with
		// the same number of downloads.
		$query = "
			SELECT COUNT(*) AS count,
			       archiveid,
			       archive_name,
			       eprint_name,
			       country_name
			FROM view
			$limit
			GROUP BY archiveid, archive_name
			ORDER BY count DESC, eprint_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	}

/* New */
	function getCountryEprintType($archive,$year,$month,$rnge,$type,$id) 
	{
		// NJS 2006-06-14: Added archive name as argument.
		
		$year = (int) $year;
		$month = (int) $month;
		$records = array();

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );
		
		// Generate type enquiry
		$this->addViewTypeCondition( $type, $where_parts );

		// generate date enquiry
		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $rnge, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );
		
		// NJS 2006-05-02: Added ascending order of country
		// name for countries with the same number of accesses.
		$query = "
			SELECT COUNT(*) AS count, country_name, country_code
			FROM view
			$limit
			GROUP BY country_name
			ORDER BY count DESC, country_name ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
		
	}
	
	function getTitle($archive,$id)
	{
		// Get the title of an eprint given its id
		// NJS 2006-06-14: Added archive name as argument.

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		$query = "
			SELECT eprint_name
			FROM view
			$limit
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return;
		} else {
			$row = mysql_fetch_assoc($result);
			return $row["eprint_name"];
		}
	}
	
	function getAbstractDownload($archive,$year,$month,$range,$type='download',$id)
	{
		// NJS 2006-06-14: Added archive name as argument.

		$year = (int) $year;
		$month = (int) $month;
		$records = array();

		// Build up the components of the WHERE clause (refactored).
		$where_parts = array();
		$limit = '';

		$this->addArchiveNameCondition( $archive, $where_parts );
		$this->addArchiveIDCondition( $id, $where_parts );

		$this->addYearCondition( $year, $where_parts );
		$this->addMonthCondition( $month, $where_parts );
		// Note that year(+month) is mutually exclusive of "4w" (last four
		// weeks), but we don't check for this. (The original code didn't
		// check either.)
		$this->addFourWeeksCondition( $range, $where_parts );

		$limit = $this->buildWhereClause( $where_parts, 'AND' );

		// NJS 2006-01-18: Added count of country_code.
		// NJS 2006-05-02: Added ascending order of country code.
		$query = "
			SELECT COUNT(*) AS count,
			       COUNT(DISTINCT country_code) AS countries,
			       view_type
			FROM view
			$limit
			GROUP BY view_type
			ORDER BY count DESC, country_code ASC
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return mysql_error();
		} else {
			while ($row = mysql_fetch_assoc($result)) {
				$records[] = $row;
			}
			return $records;
		}
	
	}

	function getLastProc()
	{
		// Get the time that the stats were last processed.
		// Note that the archive name is irrelevant for this,
		// as the stats are updated for ALL archives at the
		// same time.
		//
		// NJS 2007-02-27: Changed from timeinsert to lastproc.
		// Missed this when fixing earlier bugs! Fortunately it
		// only affects display, not internal processing.
		$query = "
			SELECT lastproc
			FROM lastproc
			ORDER BY id DESC
			LIMIT 1
		";
		$result = mysql_query($query);
		if (!$result) {
			sqlconn::_setError(mysql_errno(),mysql_error());
			return;
		} else {
			$row = mysql_fetch_assoc($result);
			return $row["lastproc"];
		}
	}


	/*
		NJS 2006-02-09 (moved here from inc.fns.show_detail_eprint.es.php)
		
		Grab the title of an eprint from the repository. Only needed if
		the title isn't already in the stats database, which should only
		occur when an eprint hasn't been downloaded yet.
		
		Do nothing if the archive name is empty or "default".
		
		We could be more clever about this and raise some kind of error
		if the eprint ID doesn't exist in the archive, but I don't see
		that it would add that much to the overall user experience :)
	*/
	function getEPrintTitle($archive,$eprint_id)
	{
		// NJS 2006-06-14: Added archive name as argument to support
		// multi-archive statistics.
		
		$eprint_title = '';
		if ( ( $archive != '' ) and ( $archive != 'default' ) )
		{
			$conn_eprints = mysql_connect(
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlserver_eprints"],
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqluser_eprints"],
				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlpass_eprints"]
			);
			$db_eprints = mysql_select_db( $archive, $conn_eprints );
			if (!$db_eprints) return $eprint_title;
			$query_eprints = "
				SELECT title
				FROM archive
				WHERE eprintid = $eprint_id
			";
			$result_eprints = mysql_query($query_eprints,$conn_eprints);
			$row_eprints = mysql_fetch_assoc($result_eprints);
			$eprint_title = trim($row_eprints["title"]);
			$eprint_title = preg_replace("/\s+/"," ",$eprint_title);
			mysql_close($conn_eprints);
		}
		return $eprint_title;
	}
	
	/*
		NJS 2006-06-14
		
		buildWhereClause()
		arguments:
			$where_parts	array of WHERE clause conditions
			$op				boolean operator to separate conditions with
							(e.g., 'AND')
		returns: string
		
		Given an array of condition strings, build a WHERE clause,
		combining the conditions using the specified operator. (If you
		need to build something more complex, you'll have to do it
		manually.)
	*/
	function buildWhereClause( $where_parts, $op )
	{
		$limit = '';
		$num_parts = count( $where_parts );
		if ( $num_parts > 0 )
		{
			$limit = 'WHERE ';
			// Append all but the last one, with the specified operator.
			for ( $i = 0; $i < ( $num_parts - 1 ); $i++ )
			{
				$limit .= $where_parts[$i] . " $op ";
			}
			// Append the last one with no operator.
			$limit .= $where_parts[$num_parts - 1];
		}
		return $limit;
	}
	
	/*
		NJS 2006-06-14
		
		addArchiveNameCondition()
		arguments:
			$archive		the name of an archive
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the archive name to the list of WHERE
		conditions. Do nothing if the archive name is empty. We also
		ignore the value "default" in order to be backwards-compatible
		with earlier versions of the stats package. Note that in either
		of the latter two cases this means that ALL stats for ALL
		archives will be queried!
	*/
	function addArchiveNameCondition ( $archive, &$where_parts )
	{
		if ( ( $archive != '' ) and ( $archive != 'default' ) )
			$this->addStringCondition( 'archive_name', '=', $archive, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addArchiveIDCondition()
		arguments:
			$id				the id of an eprint
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the eprint ID to the list of WHERE
		conditions. Do nothing if the eprint ID is zero or less.
	*/
	function addArchiveIDCondition ( $id, &$where_parts )
	{
		$id = (int) $id;
		// BUG FIX: ID should be > 0, not > 1!
		if ( $id > 0 ) $this->addNumericCondition( 'archiveid', '=', $id, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addViewTypeCondition()
		arguments:
			$type			the type of archive view (download or abstract)
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the eprint view type to the list of WHERE
		conditions. Do nothing if the view type is not "download" or
		"abstract".
	*/
	function addViewTypeCondition ( $type, &$where_parts )
	{
		if ( ( $type == 'download' ) or ( $type == 'abstract' ) )
			$this->addStringCondition( 'view_type', '=', $type, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addYearCondition()
		arguments:
			$year			the year to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the year to the list of WHERE conditions. Do
		nothing if the year is outside the range 1990--2100. (Note:
		lower bound changed from 2002 as it seems more appropriate.)

		NJS 2006-01-18: Fixed upper year bound (was 2005).
	*/
	function addYearCondition ( $year, &$where_parts )
	{
		if ( ( $year >= 1990 ) and ( $year < 2100 ) )
			$this->addStringCondition( 'YEAR(request_date)', '=', $year, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addMonthCondition()
		arguments:
			$month			the month to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the month to the list of WHERE conditions.
		Do nothing if the month is outside the range 1--12.
	*/
	function addMonthCondition ( $month, &$where_parts )
	{
		if ( ( $month > 0 ) and ( $month <= 12 ) )
			$this->addStringCondition( 'MONTH(request_date)', '=', $month, $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addFourWeeksCondition()
		arguments:
			$range			the range to filter on
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a condition for the last four weeks to the list of WHERE
		conditions. Do nothing if the range is not "4w".
	*/
	function addFourWeeksCondition ( $range, &$where_parts )
	{
		if ( $range == '4w' )
			$this->addExprCondition( 'request_date', '>=', 'DATE_SUB(CURDATE(),INTERVAL 1 MONTH)', $where_parts );
	}

	/*
		NJS 2006-06-14
		
		addStringCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$value			the value to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a generic condition for a string column to the list of WHERE
		conditions. Any validation of the value should be done prior to
		calling this function.
	*/
	function addStringCondition ( $column, $op, $value, &$where_parts )
	{
		$where_parts[] = "$column $op '$value'";
	}

	/*
		NJS 2006-06-14
		
		addNumericCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$value			the value to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add a generic condition for a numeric column to the list of WHERE
		conditions. Any validation of the value should be done prior to
		calling this function.
	*/
	function addNumericCondition ( $column, $op, $value, &$where_parts )
	{
		$where_parts[] = "$column $op $value";
	}

	/*
		NJS 2006-06-16
		
		addExprCondition()
		arguments:
			$column			the name of the SQL column
			$op				the comparison operator
			$expr			the expression to be tested
			$where_parts	reference to an array to which to add the new
							condition string
		returns: void
		
		Add to the list of WHERE conditions a generic condition for a
		column to be tested against some arbitrary expression. Any
		validation of the value should be done prior to calling this
		function.
	*/
	function addExprCondition ( $column, $op, $expr, &$where_parts )
	{
		$where_parts[] = "$column $op $expr";
	}


}

?>
 				$GLOBALS["config_vars"]["connections"]["eprints_archives"][$archive]["sqlpass_eprints"]
 			);
 			$db_eprints = mysql_select_db( $archive, $conn_eprints );
 			if (!$db_eprints) return $eprint_title;
+			$query_eprints = "
+				SELECT title
+				FROM archive
+				WHERE eprintid = $eprint_id
+			";
+			// NJS 2007-07-24: Added check for EPrints version, as the
+			// database structure changed between versions 2 and 3.
+			if ($GLOBALS["config_vars"]["general"]["eprints_version"] > 2)
+			{
+				$query_eprints = "
+					SELECT title
+					FROM eprint
+					WHERE eprintid = $eprint_id
+					  AND eprint_status = 'archive'
+				";
+			}
+			else
+			{
+				$query_eprints = "
+					SELECT title
+					FROM archive
+					WHERE eprintid = $eprint_id
+				";
+			}
 			$result_eprints = mysql_query($query_eprints,$conn_eprints);
 			$row_eprints = mysql_fetch_assoc($result_eprints);
 			$eprint_title = trim($row_eprints["title"]);
 			$eprint_title = preg_replace("/\s+/"," ",$eprint_title);

Ignore Space Show notes View Repositories/statistics/scripts/eprints-usage_src.php
<?php /* NJS 2007-07-24 The database structure changed between versions 2.x and 3.x of EPrints, so we now need to check the major version number and alter the queries appropriately. Use only the MAJOR version number (i.e., 2 or 3, don't include the release number). / $eprints_version = 3; / 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 2007-01-30 A further twist! The original script ignored log lines that had a date falling before $lastproc, i.e., if log line date < $lastproc then it's already been dealt with. This is all fine. However, it didn't bother checking for log lines that were written after the script started running (i.e. log line date >= $start_time). Why is this a problem? We're reading the live Apache log file, so it's quite likely that new lines will be written to it after the script has started (i.e., after $start_time). Suppose $start_time is '2006-06-15 14:03:15 +1200', $lastproc is '2006-06-15 12:03:15 +1200' (i.e., the script is run every two hours) and the log file contains lines with the following dates: '2006-06-15 10:03:15 +1200' [1] <-- written before $lastproc '2006-06-15 12:03:14 +1200' [2] <-- written before $lastproc '2006-06-15 13:03:15 +1200' [3] <-- written before $start_time '2006-06-15 14:03:14 +1200' [4] <-- written before $start_time '2006-06-15 14:03:15 +1200' [5] <-- written at $start_time '2006-06-15 14:03:16 +1200' [6] <-- written after $start_time During this run, dates [1] and [2] are both < $lastproc and thus ignored. The remaining four dates ([4]--[6]) are >= $lastproc and thus processed. Two hours later, the script runs again, this time with $start_time set to '2006-06-15 16:03:15 +1200' and $lastproc to '2006-06-15 14:03:15 +1200'. Dates [1] through [4] are all < $lastproc and thus ignored. However, dates [5] and [6] are both >= $lastproc and are processed a second time, resulting in a duplicate entry in the database. The solution is to ignore any log line entries that occur at or after (>=) $start_time. In the example above, this would mean that in the first run, dates [1], [2], [5] and [6] would be ignored and dates [3] and [4] processed. In the second run, dates [1]--[4] would be ignored and dates [5] and [6] processed. / $test_starttime = strtotime($start_time); // 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'), ), ), ); / NJS 2007-01-26 Patterns to match various search engine bots. Ideally, we'd use a similar mechanism to the $local_IPs variable above, but this isn't feasible because we'd need to know the IP ranges for the likes of Google, for example. This clearly isn't possible in practice. Fortunately, most search bots insert a readily identifiable string into the user-agent part of the HTTP response, which gets recorded in the Apache log file. We can look for these and re-code log entries as appropriate. The format of this list is similar to that of the $local_IPs variable. The key is the "country name" (in this case the name of the search engine) plus a non-standard four-character country code starting with "X@", separated by a comma. Each key value has an associated list of corresponding regular expressions that can occur in the user-agent part of the Apache log entry. If any one of these REs matches the user-agent part of the log entry, then we should re-code the country appropriately. A four-character code is used because that what the database allows, and it avoids having to reserve several of the "X" country codes for search engines. / $bot_patterns = array( // Yahoo! (http://www.yahoo.com/) 'Yahoo!,X@YH' => array( '/yahoo! slurp/i', '/yahooseeker/i', ), // Windows Live Search (http://search.msn.com/) 'Windows Live Search,X@MS' => array( '/msnbot/i', ), // Google (http://www.google.com/) 'Google,X@GG' => array( '/googlebot/i', ), // Ask.com (http://www.ask.com/) 'Ask.com,X@AC' => array( '/ask jeeves\/teoma/i', ), // Everything else I could find in our log files :) 'Other search engine,X@OS' => array( // TAMU Internet Research Lab (http://irl.cs.tamu.edu/) '/http:\/\/irl\.cs\.tamu\.edu\/crawler/i', // Alexa web search (http://www.alexa.com/) '/ia_archiver/i', // TrueKnowledge for Web (http://www.authoritativeweb.com/) '/converacrawler/i', // Majestic 12 distributed search engine (http://www.majestic12.co.uk/) '/mj12bot/i', // Picsearch (http://www.picsearch.com/) '/psbot/i', // Exalead (http://www.exalead.com/search) '/exabot/i', // Cazoodle (note cazoodle.com doesn't exist) '/cazoodlebot crawler/i', '/mqbot@cazoodle\.com/i', // Gigablast (http://www.gigablast.com/) '/gigabot/i', // Houxou (http://www.houxou.com/) '/houxoucrawler/i', '/crawler at houxou dot com/i', // IBM Almaden Research Center Computer Science group (http://www.almaden.ibm.com/cs/) '/http:\/\/www\.almaden\.ibm\.com\/cs\/crawler/i', // Goo? (http://help.goo.ne.jp/) '/ichiro/i', // Daum Communications Corp (Korea) '/edacious & intelligent web robot/i', '/daum communications corp/i', '/daum web robot/i', '/msie is not me/i', '/daumoa/i', // Girafa (http://www.girafa.com/) '/girafabot/i', // The Generations Network (http://www.myfamilyinc.com/) '/myfamilybot/i', // Naver? (http://www.naver.com/) '/naverbot/i', // WiseNut (http://www.wisenutbot.com/) '/zyborg/i', '/wn-[0-9]+\.zyborg@looksmart\.net/i', // Accelobot (http://www.accelobot.com/) // This one seems particularly busy! '/heritrix/i', // Seeqpod (http://www.seeqpod.com/) '/seeqpod-vertical-crawler/i', // University of Illinois at Urbana-Champaign, Computer Science (http://www.cs.uiuc.edu/) '/mqbot crawler/i', '/mqbot@cs\.uiuc\.edu/i', // Microsoft Research (http://research.microsoft.com/) '/msrbot/i', // Nusearch '/nusearch spider/i', // SourceForge (http://www.sf.net/) '/nutch-agent@lists\.sourceforge\.net/i', // Lucene (http://lucene.apache.org/) '/nutch-agent@lucene\.apache\.org/i', '/raphael@unterreuth.de/i', // Computer Science, University of Washington (http://cs.washington.edu/) '/nutch running at uw/i', '/sycrawl@cs\.washington\.edu/i', // Chikayama & Taura Laboratory, University of Tokyo (http://www.logos.ic.i.u-tokyo.ac.jp/) '/shim-crawler/i', '/crawl@logos\.ic\.i\.u-tokyo\.ac\.jp/i', // Sproose (http://www.sproose.com/) '/sproose bot/i', '/crawler@sproose\.com/i', // Turnitin (http://www.turnitin.com/) '/turnitinbot/i', // WISH Project (http://wish.slis.tsukuba.ac.jp/) '/wish-project/i', // WWWster '/wwwster/i', '/gue@cis\.uni-muenchen\.de/i', // Forex Trading Network Organization (http://www.netforex.org/) '/forex trading network organization/i', '/info@netforex\.org/i', // FunnelBack (http://www.funnelback.com/) '/funnelback/i', // Baidu (http://www.baidu.com/) '/baiduspider/i', // Brandimensions (http://www.brandimensions.com/) '/bdfetch/i', // Blaiz Enterprises (http://www.blaiz.net/) '/blaiz-bee/i', // Boitho/SearchDaimon (http://www.boitho.com/ or http://www.searchdaimon.com/) '/boitho\.com-dc/i', // Celestial (OAI aggregator, see http://oai-perl.sourceforge.net/ for a little info) '/celestial/i', // Cipinet (http://www.cipinet.com/) '/cipinetbot/i', // iVia (http://ivia.ucr.edu/) '/crawlertest crawlertest/i', // Encyclopedia of Keywords (http://keywen.com/) '/easydl/i', // Everest-Vulcan Inc. (http://everest.vulcan.com/) '/everest-vulcan inc/i', // FactBites (http://www.factbites.com/) '/factbot/i', // Scirus (http://www.scirus.com/) '/scirus scirus-crawler@fast\.no/i', // UOL (http://www.uol.com.br/) '/uolcrawler/i', '/soscrawler@uol\.com\.br/i', // Always Updated (http://www.updated.com/) '/updated crawler/i', '/crawler@updated\.com/i', // FAST Enterprise Search (http://www.fast.no/) '/fast metaweb crawler/i', '/crawler@fast\.no/i', '/helpdesk at fastsearch dot com/i', // Deutsche Wortschatz Portal (http://wortschatz.uni-leipzig.de/) '/findlinks/i', // Gais (http://gais.cs.ccu.edu.tw/) '/gaisbot/i', '/robot[0-9]{2}@gais.cs.ccu.edu.tw/i', // http://ilse.net/ '/ingrid/i', // Krugle (http://corp.krugle.com/) '/krugle\/krugle/i', '/krugle web crawler/i', '/webcrawler@krugle\.com/i', // WebWobot (http://www.webwobot.com/) '/scollspider/i', // Omni-Explorer (http://www.omni-explorer.com/) '/omniexplorer_bot/i', '/worldindexer/i', // PageBull (http://www.pagebull.com/) '/pagebull http:\/\/www\.pagebull\.com\//i', // dir.com (http://dir.com/) '/pompos/i', // Sensis (http://sensis.com.au/) '/sensis web crawler/i', '/search_comments\\\\at\\\\sensis\\\\dot\\\\com\\\\dot\\\\au/i', // Shopwiki (http://www.shopwiki.com/) '/shopwiki/i', // Guruji (http://www.terrawiz.com/) '/terrawizbot/i', // Language Observatory Project (http://www.language-observatory.org/) '/ubicrawler/i', // MSIE offline bookmarks crawler '/msiecrawler/i', // Unidentified '/bot/i', '/crawler/i', '/spider/i', '/larbin/i', // also larbinSpider '/httrack/i', '/voyager/i', '/acadiauniversitywebcensusclient/i', '/feedchecker/i', '/knowitall\(knowitall@cs\.washington\.edu\)/i', '/mediapartners-google/i', '/psycheclone/i', '/topicblogs/i', '/nutch/i', ), ); ########################################### ## ## 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 ID 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"]; // NJS 2007-01-30 Refactored $databaseA to more meaningful $test_lastproc. $test_lastproc = strtotime($lastproc); } else { $test_lastproc = 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 2007-01-26 Added user-agent match to all regexps to enable bot detection. NJS 2007-01-31 Refactored regexps from four down to one, after realising that (a) long EPrints URLs are a superset of the short ones, and (b) a regexp that matches domain names works just as well for IP addresses (the GeoIP lookup doesn't care which it gets). Also fixed the pattern so it can handle an arbitrary number of subdomains. Note that the latter would be the main argument for keeping a separate IP address pattern, as IP addresses always comprise exactly four parts. However, it's not really up to the script to verify IP addresses; Apache should be recording them correctly in the first place! The typical kinds of strings we are matching look something like this: fetch abstract (short, long): 168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /1/ HTTP/1.1" 200 12345 "referer" "user-agent" 168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /archive/00000001/ HTTP/1.1" 200 12345 "referer" "user-agent" download item (short, long): 168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /1/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent" 168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /archive/00000001/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent" Plus any of the above with a domain name substituted for the IP address (e.g., foo.bar.com instead of 168.192.1.1). / if (preg_match("/^(\S+(?:\.\S+)+) - - \[(.?)\] \"GET \/(?:archive\/0{1,8})?(\d{1,4}).? HTTP\/1..\" 200 .?(\"[^\"]+\")?$/i",$buffer,$matches)) { $counter++; $country_code = ''; $country_name = ''; $insertid = ''; $eprint_name = ''; $view_type = ''; $uniquebits = ''; /* NJS 2007-01-29 Moved date checking to the start of the loop, as there's no point in doing any of the regexp checks if we've already processed this log entry and will discard it anyway. / $date = $matches[2]; / 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 " ". // NJS 2007-01-30 Refactored $databaseB to more meaningful // $test_logdate. $test_logdate = strtotime($date); // NJS 2007-01-30 Added test for log dates >= $start_time. if ( ( $test_logdate < $test_lastproc ) \|\| ( $test_logdate >= $test_starttime ) ) continue; // Convert to properly formatted date string. $request_date = date('Y-m-d H:i:s O', $test_logdate); / 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 = $matches[1]; $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 / NJS 2007-01-26 Check whether this is a bot reference. / $user_agent = $matches[4]; $found_country = FALSE; foreach ($bot_patterns as $id => $patterns) { foreach ($patterns as $pat) { if (preg_match($pat, $user_agent)) { $found_country = TRUE; break; } } if ($found_country) { list($country_name, $country_code) = explode(',', $id); break; } } // end NJS 2007-01-26 // Now sort out the remaining bits and we're done. $eprint_id = $matches[3]; $uniquebits = $buffer; // NJS 2005-11-25 Added regexp for EPrints short URLs. // NJS 2007-01-31 Refactored into one regexp for both styles. if (preg_match("/GET \/(?:archive\/0{1,8})?\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); if ( $eprints_version > 2 ) { $query3 = " SELECT title FROM eprint WHERE eprintid = $eprintid AND eprint_status = 'archive' "; } else { $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 deleted items for details. if (mysql_num_rows($result3) == 0) { if ( $eprints_version > 2 ) { $query3 = " SELECT title FROM eprint WHERE eprintid = $eprintid AND eprint_status = 'deletion' "; } else { $query3 = " SELECT title FROM archive 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; } ?> <?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 2007-01-30 A further twist! The original script ignored log lines that had a date falling before $lastproc, i.e., if log line date < $lastproc then it's already been dealt with. This is all fine. However, it didn't bother checking for log lines that were written after the script started running (i.e. log line date >= $start_time). Why is this a problem? We're reading the live Apache log file, so it's quite likely that new lines will be written to it after the script has started (i.e., after $start_time). Suppose $start_time is '2006-06-15 14:03:15 +1200', $lastproc is '2006-06-15 12:03:15 +1200' (i.e., the script is run every two hours) and the log file contains lines with the following dates: '2006-06-15 10:03:15 +1200' [1] <-- written before $lastproc '2006-06-15 12:03:14 +1200' [2] <-- written before $lastproc '2006-06-15 13:03:15 +1200' [3] <-- written before $start_time '2006-06-15 14:03:14 +1200' [4] <-- written before $start_time '2006-06-15 14:03:15 +1200' [5] <-- written at $start_time '2006-06-15 14:03:16 +1200' [6] <-- written after $start_time During this run, dates [1] and [2] are both < $lastproc and thus ignored. The remaining four dates ([4]--[6]) are >= $lastproc and thus processed. Two hours later, the script runs again, this time with $start_time set to '2006-06-15 16:03:15 +1200' and $lastproc to '2006-06-15 14:03:15 +1200'. Dates [1] through [4] are all < $lastproc and thus ignored. However, dates [5] and [6] are both >= $lastproc and are processed a second time, resulting in a duplicate entry in the database. The solution is to ignore any log line entries that occur at or after (>=) $start_time. In the example above, this would mean that in the first run, dates [1], [2], [5] and [6] would be ignored and dates [3] and [4] processed. In the second run, dates [1]--[4] would be ignored and dates [5] and [6] processed. / $test_starttime = strtotime($start_time); // 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'), ), ), ); / NJS 2007-01-26 Patterns to match various search engine bots. Ideally, we'd use a similar mechanism to the $local_IPs variable above, but this isn't feasible because we'd need to know the IP ranges for the likes of Google, for example. This clearly isn't possible in practice. Fortunately, most search bots insert a readily identifiable string into the user-agent part of the HTTP response, which gets recorded in the Apache log file. We can look for these and re-code log entries as appropriate. The format of this list is similar to that of the $local_IPs variable. The key is the "country name" (in this case the name of the search engine) plus a non-standard four-character country code starting with "X@", separated by a comma. Each key value has an associated list of corresponding regular expressions that can occur in the user-agent part of the Apache log entry. If any one of these REs matches the user-agent part of the log entry, then we should re-code the country appropriately. A four-character code is used because that what the database allows, and it avoids having to reserve several of the "X" country codes for search engines. / $bot_patterns = array( // Yahoo! (http://www.yahoo.com/) 'Yahoo!,X@YH' => array( '/yahoo! slurp/i', '/yahooseeker/i', ), // Windows Live Search (http://search.msn.com/) 'Windows Live Search,X@MS' => array( '/msnbot/i', ), // Google (http://www.google.com/) 'Google,X@GG' => array( '/googlebot/i', ), // Ask.com (http://www.ask.com/) 'Ask.com,X@AC' => array( '/ask jeeves\/teoma/i', ), // Everything else I could find in our log files :) 'Other search engine,X@OS' => array( // TAMU Internet Research Lab (http://irl.cs.tamu.edu/) '/http:\/\/irl\.cs\.tamu\.edu\/crawler/i', // Alexa web search (http://www.alexa.com/) '/ia_archiver/i', // TrueKnowledge for Web (http://www.authoritativeweb.com/) '/converacrawler/i', // Majestic 12 distributed search engine (http://www.majestic12.co.uk/) '/mj12bot/i', // Picsearch (http://www.picsearch.com/) '/psbot/i', // Exalead (http://www.exalead.com/search) '/exabot/i', // Cazoodle (note cazoodle.com doesn't exist) '/cazoodlebot crawler/i', '/mqbot@cazoodle\.com/i', // Gigablast (http://www.gigablast.com/) '/gigabot/i', // Houxou (http://www.houxou.com/) '/houxoucrawler/i', '/crawler at houxou dot com/i', // IBM Almaden Research Center Computer Science group (http://www.almaden.ibm.com/cs/) '/http:\/\/www\.almaden\.ibm\.com\/cs\/crawler/i', // Goo? (http://help.goo.ne.jp/) '/ichiro/i', // Daum Communications Corp (Korea) '/edacious & intelligent web robot/i', '/daum communications corp/i', '/daum web robot/i', '/msie is not me/i', '/daumoa/i', // Girafa (http://www.girafa.com/) '/girafabot/i', // The Generations Network (http://www.myfamilyinc.com/) '/myfamilybot/i', // Naver? (http://www.naver.com/) '/naverbot/i', // WiseNut (http://www.wisenutbot.com/) '/zyborg/i', '/wn-[0-9]+\.zyborg@looksmart\.net/i', // Accelobot (http://www.accelobot.com/) // This one seems particularly busy! '/heritrix/i', // Seeqpod (http://www.seeqpod.com/) '/seeqpod-vertical-crawler/i', // University of Illinois at Urbana-Champaign, Computer Science (http://www.cs.uiuc.edu/) '/mqbot crawler/i', '/mqbot@cs\.uiuc\.edu/i', // Microsoft Research (http://research.microsoft.com/) '/msrbot/i', // Nusearch '/nusearch spider/i', // SourceForge (http://www.sf.net/) '/nutch-agent@lists\.sourceforge\.net/i', // Lucene (http://lucene.apache.org/) '/nutch-agent@lucene\.apache\.org/i', '/raphael@unterreuth.de/i', // Computer Science, University of Washington (http://cs.washington.edu/) '/nutch running at uw/i', '/sycrawl@cs\.washington\.edu/i', // Chikayama & Taura Laboratory, University of Tokyo (http://www.logos.ic.i.u-tokyo.ac.jp/) '/shim-crawler/i', '/crawl@logos\.ic\.i\.u-tokyo\.ac\.jp/i', // Sproose (http://www.sproose.com/) '/sproose bot/i', '/crawler@sproose\.com/i', // Turnitin (http://www.turnitin.com/) '/turnitinbot/i', // WISH Project (http://wish.slis.tsukuba.ac.jp/) '/wish-project/i', // WWWster '/wwwster/i', '/gue@cis\.uni-muenchen\.de/i', // Forex Trading Network Organization (http://www.netforex.org/) '/forex trading network organization/i', '/info@netforex\.org/i', // FunnelBack (http://www.funnelback.com/) '/funnelback/i', // Baidu (http://www.baidu.com/) '/baiduspider/i', // Brandimensions (http://www.brandimensions.com/) '/bdfetch/i', // Blaiz Enterprises (http://www.blaiz.net/) '/blaiz-bee/i', // Boitho/SearchDaimon (http://www.boitho.com/ or http://www.searchdaimon.com/) '/boitho\.com-dc/i', // Celestial (OAI aggregator, see http://oai-perl.sourceforge.net/ for a little info) '/celestial/i', // Cipinet (http://www.cipinet.com/) '/cipinetbot/i', // iVia (http://ivia.ucr.edu/) '/crawlertest crawlertest/i', // Encyclopedia of Keywords (http://keywen.com/) '/easydl/i', // Everest-Vulcan Inc. (http://everest.vulcan.com/) '/everest-vulcan inc/i', // FactBites (http://www.factbites.com/) '/factbot/i', // Scirus (http://www.scirus.com/) '/scirus scirus-crawler@fast\.no/i', // UOL (http://www.uol.com.br/) '/uolcrawler/i', '/soscrawler@uol\.com\.br/i', // Always Updated (http://www.updated.com/) '/updated crawler/i', '/crawler@updated\.com/i', // FAST Enterprise Search (http://www.fast.no/) '/fast metaweb crawler/i', '/crawler@fast\.no/i', '/helpdesk at fastsearch dot com/i', // Deutsche Wortschatz Portal (http://wortschatz.uni-leipzig.de/) '/findlinks/i', // Gais (http://gais.cs.ccu.edu.tw/) '/gaisbot/i', '/robot[0-9]{2}@gais.cs.ccu.edu.tw/i', // http://ilse.net/ '/ingrid/i', // Krugle (http://corp.krugle.com/) '/krugle\/krugle/i', '/krugle web crawler/i', '/webcrawler@krugle\.com/i', // WebWobot (http://www.webwobot.com/) '/scollspider/i', // Omni-Explorer (http://www.omni-explorer.com/) '/omniexplorer_bot/i', '/worldindexer/i', // PageBull (http://www.pagebull.com/) '/pagebull http:\/\/www\.pagebull\.com\//i', // dir.com (http://dir.com/) '/pompos/i', // Sensis (http://sensis.com.au/) '/sensis web crawler/i', '/search_comments\\\\at\\\\sensis\\\\dot\\\\com\\\\dot\\\\au/i', // Shopwiki (http://www.shopwiki.com/) '/shopwiki/i', // Guruji (http://www.terrawiz.com/) '/terrawizbot/i', // Language Observatory Project (http://www.language-observatory.org/) '/ubicrawler/i', // MSIE offline bookmarks crawler '/msiecrawler/i', // Unidentified '/bot/i', '/crawler/i', '/spider/i', '/larbin/i', // also larbinSpider '/httrack/i', '/voyager/i', '/acadiauniversitywebcensusclient/i', '/feedchecker/i', '/knowitall\(knowitall@cs\.washington\.edu\)/i', '/mediapartners-google/i', '/psycheclone/i', '/topicblogs/i', '/nutch/i', ), ); ########################################### ## ## 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 ID 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"]; // NJS 2007-01-30 Refactored $databaseA to more meaningful $test_lastproc. $test_lastproc = strtotime($lastproc); } else { $test_lastproc = 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 2007-01-26 Added user-agent match to all regexps to enable bot detection. NJS 2007-01-31 Refactored regexps from four down to one, after realising that (a) long EPrints URLs are a superset of the short ones, and (b) a regexp that matches domain names works just as well for IP addresses (the GeoIP lookup doesn't care which it gets). Also fixed the pattern so it can handle an arbitrary number of subdomains. Note that the latter would be the main argument for keeping a separate IP address pattern, as IP addresses always comprise exactly four parts. However, it's not really up to the script to verify IP addresses; Apache should be recording them correctly in the first place! The typical kinds of strings we are matching look something like this: fetch abstract (short, long): 168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /1/ HTTP/1.1" 200 12345 "referer" "user-agent" 168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /archive/00000001/ HTTP/1.1" 200 12345 "referer" "user-agent" download item (short, long): 168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /1/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent" 168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /archive/00000001/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent" Plus any of the above with a domain name substituted for the IP address (e.g., foo.bar.com instead of 168.192.1.1). / if (preg_match("/^(\S+(?:\.\S+)+) - - \[(.?)\] \"GET \/(?:archive\/0{1,8})?(\d{1,4}).? HTTP\/1..\" 200 .?(\"[^\"]+\")?$/i",$buffer,$matches)) { $counter++; $country_code = ''; $country_name = ''; $insertid = ''; $eprint_name = ''; $view_type = ''; $uniquebits = ''; /* NJS 2007-01-29 Moved date checking to the start of the loop, as there's no point in doing any of the regexp checks if we've already processed this log entry and will discard it anyway. / $date = $matches[2]; / 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 " ". // NJS 2007-01-30 Refactored $databaseB to more meaningful // $test_logdate. $test_logdate = strtotime($date); // NJS 2007-01-30 Added test for log dates >= $start_time. if ( ( $test_logdate < $test_lastproc ) \|\| ( $test_logdate >= $test_starttime ) ) continue; // Convert to properly formatted date string. $request_date = date('Y-m-d H:i:s O', $test_logdate); / 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 = $matches[1]; $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 / NJS 2007-01-26 Check whether this is a bot reference. / $user_agent = $matches[4]; $found_country = FALSE; foreach ($bot_patterns as $id => $patterns) { foreach ($patterns as $pat) { if (preg_match($pat, $user_agent)) { $found_country = TRUE; break; } } if ($found_country) { list($country_name, $country_code) = explode(',', $id); break; } } // end NJS 2007-01-26 // Now sort out the remaining bits and we're done. $eprint_id = $matches[3]; $uniquebits = $buffer; // NJS 2005-11-25 Added regexp for EPrints short URLs. // NJS 2007-01-31 Refactored into one regexp for both styles. if (preg_match("/GET \/(?:archive\/0{1,8})?\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; } ?>

Ignore Space Show notes View

Repositories/statistics/scripts/eprints-usage_src.php

<?php

/* NJS 2007-07-24
   The database structure changed between versions 2.x and 3.x of
   EPrints, so we now need to check the major version number and alter
   the queries appropriately. Use only the MAJOR version number (i.e.,
   2 or 3, don't include the release number).
*/
$eprints_version = 3;

/* 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 2007-01-30
   A further twist! The original script ignored log lines that had a
   date falling before $lastproc, i.e., if log line date < $lastproc
   then it's already been dealt with. This is all fine. However, it
   didn't bother checking for log lines that were written after the
   script started running (i.e. log line date >= $start_time).
   
   Why is this a problem? We're reading the live Apache log file, so
   it's quite likely that new lines will be written to it after the
   script has started (i.e., after $start_time). Suppose $start_time is
   '2006-06-15 14:03:15 +1200', $lastproc is '2006-06-15 12:03:15 +1200'
   (i.e., the script is run every two hours) and the log file contains
   lines with the following dates:
   
     '2006-06-15 10:03:15 +1200' [1] <-- written before $lastproc
     '2006-06-15 12:03:14 +1200' [2] <-- written before $lastproc
     '2006-06-15 13:03:15 +1200' [3] <-- written before $start_time
     '2006-06-15 14:03:14 +1200' [4] <-- written before $start_time
     '2006-06-15 14:03:15 +1200' [5] <-- written at $start_time
     '2006-06-15 14:03:16 +1200' [6] <-- written after $start_time

During this run, dates [1] and [2] are both < $lastproc and thus
   ignored. The remaining four dates ([4]--[6]) are >= $lastproc and
   thus processed.

Two hours later, the script runs again, this time with $start_time
   set to '2006-06-15 16:03:15 +1200' and $lastproc to '2006-06-15
   14:03:15 +1200'. Dates [1] through [4] are all < $lastproc and
   thus ignored. However, dates [5] and [6] are both >= $lastproc
   and are processed a second time, resulting in a duplicate entry
   in the database.
   
   The solution is to ignore any log line entries that occur at or after
   (>=) $start_time. In the example above, this would mean that in the
   first run, dates [1], [2], [5] and [6] would be ignored and dates [3]
   and [4] processed. In the second run, dates [1]--[4] would be ignored
   and dates [5] and [6] processed.
*/
$test_starttime = strtotime($start_time);

// 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'),
		),
	),
);

/* NJS 2007-01-26
Patterns to match various search engine bots. Ideally, we'd use a similar
mechanism to the $local_IPs variable above, but this isn't feasible because
we'd need to know the IP ranges for the likes of Google, for example. This
clearly isn't possible in practice.

Fortunately, most search bots insert a readily identifiable string into
the user-agent part of the HTTP response, which gets recorded in the Apache
log file. We can look for these and re-code log entries as appropriate.

The format of this list is similar to that of the $local_IPs variable.
The key is the "country name" (in this case the name of the search
engine) plus a non-standard four-character country code starting with
"X@", separated by a comma. Each key value has an associated list of
corresponding regular expressions that can occur in the user-agent part
of the Apache log entry. If any one of these REs matches the user-agent
part of the log entry, then we should re-code the country appropriately.

A four-character code is used because that what the database allows, and
it avoids having to reserve several of the "X" country codes for search
engines.
*/
$bot_patterns = array(
	// Yahoo! (http://www.yahoo.com/)
	'Yahoo!,X@YH' => array(
		'/yahoo! slurp/i',
		'/yahooseeker/i',
	),
	// Windows Live Search (http://search.msn.com/)
	'Windows Live Search,X@MS' => array(
		'/msnbot/i',
	),
	// Google (http://www.google.com/)
	'Google,X@GG' => array(
		'/googlebot/i',
	),
	// Ask.com (http://www.ask.com/)
	'Ask.com,X@AC' => array(
		'/ask jeeves\/teoma/i',
	),
	// Everything else I could find in our log files :)
	'Other search engine,X@OS' => array(
		// TAMU Internet Research Lab (http://irl.cs.tamu.edu/)
		'/http:\/\/irl\.cs\.tamu\.edu\/crawler/i',
		// Alexa web search (http://www.alexa.com/)
		'/ia_archiver/i',
		// TrueKnowledge for Web (http://www.authoritativeweb.com/)
		'/converacrawler/i',
		// Majestic 12 distributed search engine (http://www.majestic12.co.uk/)
		'/mj12bot/i',
		// Picsearch (http://www.picsearch.com/)
		'/psbot/i',
		// Exalead (http://www.exalead.com/search)
		'/exabot/i',
		// Cazoodle (note cazoodle.com doesn't exist)
		'/cazoodlebot crawler/i',
		'/mqbot@cazoodle\.com/i',
		// Gigablast (http://www.gigablast.com/)
		'/gigabot/i',
		// Houxou (http://www.houxou.com/)
		'/houxoucrawler/i',
		'/crawler at houxou dot com/i',
		// IBM Almaden Research Center Computer Science group (http://www.almaden.ibm.com/cs/)
		'/http:\/\/www\.almaden\.ibm\.com\/cs\/crawler/i',
		// Goo? (http://help.goo.ne.jp/)
		'/ichiro/i',
		// Daum Communications Corp (Korea)
		'/edacious & intelligent web robot/i',
		'/daum communications corp/i',
		'/daum web robot/i',
		'/msie is not me/i',
		'/daumoa/i',
		// Girafa (http://www.girafa.com/)
		'/girafabot/i',
		// The Generations Network (http://www.myfamilyinc.com/)
		'/myfamilybot/i',
		// Naver? (http://www.naver.com/)
		'/naverbot/i',
		// WiseNut (http://www.wisenutbot.com/)
		'/zyborg/i',
		'/wn-[0-9]+\.zyborg@looksmart\.net/i',
		// Accelobot (http://www.accelobot.com/)
		// This one seems particularly busy!
		'/heritrix/i',
		// Seeqpod (http://www.seeqpod.com/)
		'/seeqpod-vertical-crawler/i',
		// University of Illinois at Urbana-Champaign, Computer Science (http://www.cs.uiuc.edu/)
		'/mqbot crawler/i',
		'/mqbot@cs\.uiuc\.edu/i',
		// Microsoft Research (http://research.microsoft.com/)
		'/msrbot/i',
		// Nusearch
		'/nusearch spider/i',
		// SourceForge (http://www.sf.net/)
		'/nutch-agent@lists\.sourceforge\.net/i',
		// Lucene (http://lucene.apache.org/)
		'/nutch-agent@lucene\.apache\.org/i',
		'/raphael@unterreuth.de/i',
		// Computer Science, University of Washington (http://cs.washington.edu/)
		'/nutch running at uw/i',
		'/sycrawl@cs\.washington\.edu/i',
		// Chikayama & Taura Laboratory, University of Tokyo (http://www.logos.ic.i.u-tokyo.ac.jp/)
		'/shim-crawler/i',
		'/crawl@logos\.ic\.i\.u-tokyo\.ac\.jp/i',
		// Sproose (http://www.sproose.com/)
		'/sproose bot/i',
		'/crawler@sproose\.com/i',
		// Turnitin (http://www.turnitin.com/)
		'/turnitinbot/i',
		// WISH Project (http://wish.slis.tsukuba.ac.jp/)
		'/wish-project/i',
		// WWWster
		'/wwwster/i',
		'/gue@cis\.uni-muenchen\.de/i',
		// Forex Trading Network Organization (http://www.netforex.org/)
		'/forex trading network organization/i',
		'/info@netforex\.org/i',
		// FunnelBack (http://www.funnelback.com/)
		'/funnelback/i',
		// Baidu (http://www.baidu.com/)
		'/baiduspider/i',
		// Brandimensions (http://www.brandimensions.com/)
		'/bdfetch/i',
		// Blaiz Enterprises (http://www.blaiz.net/)
		'/blaiz-bee/i',
		// Boitho/SearchDaimon (http://www.boitho.com/ or http://www.searchdaimon.com/)
		'/boitho\.com-dc/i',
		// Celestial (OAI aggregator, see http://oai-perl.sourceforge.net/ for a little info)
		'/celestial/i',
		// Cipinet (http://www.cipinet.com/)
		'/cipinetbot/i',
		// iVia (http://ivia.ucr.edu/)
		'/crawlertest crawlertest/i',
		// Encyclopedia of Keywords (http://keywen.com/)
		'/easydl/i',
		// Everest-Vulcan Inc. (http://everest.vulcan.com/)
		'/everest-vulcan inc/i',
		// FactBites (http://www.factbites.com/)
		'/factbot/i',
		// Scirus (http://www.scirus.com/)
		'/scirus scirus-crawler@fast\.no/i',
		// UOL (http://www.uol.com.br/)
		'/uolcrawler/i',
		'/soscrawler@uol\.com\.br/i',
		// Always Updated (http://www.updated.com/)
		'/updated crawler/i',
		'/crawler@updated\.com/i',
		// FAST Enterprise Search (http://www.fast.no/)
		'/fast metaweb crawler/i',
		'/crawler@fast\.no/i',
		'/helpdesk at fastsearch dot com/i',
		// Deutsche Wortschatz Portal (http://wortschatz.uni-leipzig.de/)
		'/findlinks/i',
		// Gais (http://gais.cs.ccu.edu.tw/)
		'/gaisbot/i',
		'/robot[0-9]{2}@gais.cs.ccu.edu.tw/i',
		// http://ilse.net/
		'/ingrid/i',
		// Krugle (http://corp.krugle.com/)
		'/krugle\/krugle/i',
		'/krugle web crawler/i',
		'/webcrawler@krugle\.com/i',
		// WebWobot (http://www.webwobot.com/)
		'/scollspider/i',
		// Omni-Explorer (http://www.omni-explorer.com/)
		'/omniexplorer_bot/i',
		'/worldindexer/i',
		// PageBull (http://www.pagebull.com/)
		'/pagebull http:\/\/www\.pagebull\.com\//i',
		// dir.com (http://dir.com/)
		'/pompos/i',
		// Sensis (http://sensis.com.au/)
		'/sensis web crawler/i',
		'/search_comments\\\\at\\\\sensis\\\\dot\\\\com\\\\dot\\\\au/i',
		// Shopwiki (http://www.shopwiki.com/)
		'/shopwiki/i',
		// Guruji (http://www.terrawiz.com/)
		'/terrawizbot/i',
		// Language Observatory Project (http://www.language-observatory.org/)
		'/ubicrawler/i',
		// MSIE offline bookmarks crawler
		'/msiecrawler/i',
		// Unidentified
		'/bot/i',
		'/crawler/i',
		'/spider/i',
		'/larbin/i', // also larbinSpider
		'/httrack/i',
		'/voyager/i',
		'/acadiauniversitywebcensusclient/i',
		'/feedchecker/i',
		'/knowitall$knowitall@cs\.washington\.edu$/i',
		'/mediapartners-google/i',
		'/psycheclone/i',
		'/topicblogs/i',
		'/nutch/i',
	),
);

###########################################
##
## 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 ID 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"];
	// NJS 2007-01-30 Refactored $databaseA to more meaningful $test_lastproc.
	$test_lastproc = strtotime($lastproc);
}
else {
	$test_lastproc = 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 2007-01-26
		   Added user-agent match to all regexps to enable bot detection.
		   
		   NJS 2007-01-31
		   Refactored regexps from four down to one, after realising
		   that (a) long EPrints URLs are a superset of the short ones,
		   and (b) a regexp that matches domain names works just as well
		   for IP addresses (the GeoIP lookup doesn't care which it
		   gets). Also fixed the pattern so it can handle an arbitrary
		   number of subdomains. Note that the latter would be the main
		   argument for keeping a separate IP address pattern, as IP
		   addresses always comprise exactly four parts. However, it's
		   not really up to the script to verify IP addresses; Apache
		   should be recording them correctly in the first place!
		   
		   The typical kinds of strings we are matching look something
		   like this:
		   
		   fetch abstract (short, long):
		   168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /1/ HTTP/1.1" 200 12345 "referer" "user-agent"
		   168.192.1.1 - - [31/Jan/2007:09:15:36 +1300] "GET /archive/00000001/ HTTP/1.1" 200 12345 "referer" "user-agent"
		   
		   download item (short, long):
		   168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /1/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent"
		   168.192.1.1 - - [31/Jan/2007:09:15:37 +1300] "GET /archive/00000001/01/foo.pdf HTTP/1.1" 200 12345 "referer" "user-agent"
		   
		   Plus any of the above with a domain name substituted for the IP
		   address (e.g., foo.bar.com instead of 168.192.1.1).
		*/
		if	(preg_match("/^(\S+(?:\.\S+)+) - - \[(.*?)\] \"GET \/(?:archive\/0{1,8})?(\d{1,4}).*? HTTP\/1..\" 200 .*?(\"[^\"]+\")?$/i",$buffer,$matches))
		{
			$counter++;
			$country_code = '';
			$country_name = '';
			$insertid = '';
			$eprint_name = '';
			$view_type = '';
			$uniquebits = '';
			
			/* NJS 2007-01-29
			   Moved date checking to the start of the loop, as there's
			   no point in doing any of the regexp checks if we've already
			   processed this log entry and will discard it anyway.
			*/
			$date = $matches[2];
			/* 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 " ".
			// NJS 2007-01-30 Refactored $databaseB to more meaningful
			// $test_logdate.
			$test_logdate = strtotime($date);

// NJS 2007-01-30 Added test for log dates >= $start_time.
			if ( ( $test_logdate < $test_lastproc ) ||
			     ( $test_logdate >= $test_starttime ) )
				continue;
			
			// Convert to properly formatted date string.
			$request_date =  date('Y-m-d H:i:s O', $test_logdate);
			
			/* 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 = $matches[1];
			$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
			
			/* NJS 2007-01-26
			   Check whether this is a bot reference.
			*/
			$user_agent = $matches[4];
			$found_country = FALSE;
			foreach ($bot_patterns as $id => $patterns)
			{
				foreach ($patterns as $pat)
				{
					if (preg_match($pat, $user_agent))
					{
						$found_country = TRUE;
						break;
					}
				}
				
				if ($found_country)
				{
					list($country_name, $country_code) = explode(',', $id);
					break;
				}
			}
			// end NJS 2007-01-26
			
			// Now sort out the remaining bits and we're done.
			$eprint_id = $matches[3];
			$uniquebits = $buffer;
			
			// NJS 2005-11-25 Added regexp for EPrints short URLs.
			// NJS 2007-01-31 Refactored into one regexp for both styles.
			if (preg_match("/GET \/(?:archive\/0{1,8})?\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);
	if ( $eprints_version > 2 )
	{
		$query3 = "
			SELECT title
			FROM eprint
			WHERE eprintid = $eprintid
			  AND eprint_status = 'archive'
		";
	}
	else
	{
		$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 deleted items for details.
	if (mysql_num_rows($result3) == 0) {
		if ( $eprints_version > 2 )
		{
			$query3 = "
				SELECT title
				FROM eprint
				WHERE eprintid = $eprintid
				  AND eprint_status = 'deletion'
			";
		}
		else
		{
			$query3 = "
				SELECT title
				FROM archive
				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;
}

<?php

During this run, dates [1] and [2] are both < $lastproc and thus
   ignored. The remaining four dates ([4]--[6]) are >= $lastproc and
   thus processed.

// 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';

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:

###########################################
##
## No configuration required below here.
##
###########################################

$connect = mysql_pconnect ($sqlserver,$sqluser,$sqlpass);
$db = mysql_select_db($sqldatabase,$connect) or die("Could not 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;
}

Show line notes below