File Coverage

blib/lib/SETI/WebStats.pm

Criterion	Covered	Total	%
statement	7	9	77.7
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	10	12	83.3

# $Id: WebStats.pm,v 1.9 2003/10/10 01:57:57 vek Exp $

package SETI::WebStats;

use Carp qw(croak);
use LWP::UserAgent;
use XML::Simple;
use strict;
use vars qw($VERSION);

$VERSION = '1.03';

use constant USERURL =>
	"http://setiathome.ssl.berkeley.edu/fcgi-bin/fcgi?cmd=user_xml&email=%s";

use constant GROUPURL =>
	"http://setiathome.ssl.berkeley.edu/fcgi-bin/fcgi?cmd=team_lookup_xml&name=%s";

sub new {
	my ($class, $emailAddr) = @_;
	my $self = {};
	$self->{version} = $VERSION;
	bless $self, $class;
	# still allowing emailAddr in constructor for
	# backwards compatability...
	if ($emailAddr) {
		return $self->fetchUserStats($emailAddr);
	}
	return $self;
}

###############################################################################
# Public methods
###############################################################################

sub fetchUserStats {
	my ($self, $emailAddr) = @_;
	if (! $emailAddr) {
		croak("You must specify an email address");
		return 0;
	}
	my $url = sprintf(USERURL, $emailAddr);
	$self->_mode('user');
	return $self->_fetch($url);
}

sub fetchGroupStats {
	my ($self, $groupName) = @_;
	if (! $groupName) {
		croak("You must specify a group name");
		return 0;
	}
	my $url = sprintf(GROUPURL, $groupName);
	$self->_mode('group');
	return $self->_fetch($url);
}

# userinfo methods

sub userInfo {
	my $self = shift;
	return $self->{data}->{userinfo};
}

sub userTime {
	my $self = shift;
	return $self->{data}->{userinfo}->{usertime};
}

sub aveCpu {
	my $self = shift;
	return $self->{data}->{userinfo}->{avecpu};
}

sub numResults {
	my $self = shift;
	return $self->{data}->{userinfo}->{numresults};
}

sub regDate {
	my $self = shift;
	return $self->{data}->{userinfo}->{regdate};
}

sub profileURL {
	my $self = shift;
	if ($self->{data}->{userinfo}->{userprofile}) {
		return $self->{data}->{userinfo}->{userprofile}->{a}->{href};
	} else {
		return "No URL";
	}
}

sub resultsPerDay {
	my $self = shift;
	return $self->{data}->{userinfo}->{resultsperday};
}

sub lastResultTime {
	my $self = shift;
	return $self->{data}->{userinfo}->{lastresulttime} || 0;
}

sub cpuTime {
	my $self = shift;
	return $self->{data}->{userinfo}->{cputime};
}

sub name {
	my $self = shift;
	if (ref $self->{data}->{userinfo}->{name}) {
		return $self->{data}->{userinfo}->{name}->{a}->{content};
	} else {
		return $self->{data}->{userinfo}->{name};
	}
}

sub homePage {
	my $self = shift;
	if (ref $self->{data}->{userinfo}->{name}) {
		if ($self->{data}->{userinfo}->{name}->{a}->{href}) {
			return $self->{data}->{userinfo}->{name}->{a}->{href};
		} else {
			return "No Home Page";
		}
	} else {
		return "No Home Page";
	}
}

# rankinfo methods

sub rankInfo {
	my $self = shift;
	return $self->{data}->{rankinfo};
}

sub haveSameRank {
	my $self = shift;
	return $self->{data}->{rankinfo}->{num_samerank};
}

sub totalUsers {
	my $self = shift;
	return $self->{data}->{rankinfo}->{ranktotalusers};
}

sub rankPercent {
	my $self = shift;
	return (100 - $self->{data}->{rankinfo}->{top_rankpct});
}

sub rank {
	my $self = shift;
	return $self->{data}->{rankinfo}->{rank};
}

# groupinfo methods from individual user query...

sub groupInfo {
	my $self = shift;
	return $self->{data}->{groupinfo}->{group} ?
		$self->{data}->{groupinfo}->{group}->{a} :
		undef;
}

sub groupName {
	my $self = shift;
	return $self->{data}->{groupinfo}->{group} ?
		$self->{data}->{groupinfo}->{group}->{a}->{content} :
		undef;
}

sub groupUrl {
	my $self = shift;
	return $self->{data}->{groupinfo}->{group} ?
		$self->{data}->{groupinfo}->{group}->{a}->{href} :
		undef;
}

# group methods (from group query)

sub groupURL {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{url} || undef) :
		undef;
}

sub numGroupResults {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{numresults} || undef) :
		undef;
}

sub numGroupMembers {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{nummembers} || undef) :
		undef;
}

sub totalGroupCPU {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{totalcpu} || undef) :
		undef;
}

sub nameOfGroup {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{name} || undef) :
		undef;
}

sub groupFounderName {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{founder}->{name} || undef) :
		undef;
}

sub groupFounderURL {
	my $self = shift;
	return $self->{groupdata} ?
		($self->{groupdata}->{founder}->{url} || undef) :
		undef;
}

###############################################################################
# Private methods
###############################################################################

sub _fetch {
	my ($self, $URL) = @_;
	my $ua   = LWP::UserAgent->new;
	$ua->agent("SETI::WebStats/$VERSION " . $ua->agent);
	my $req  = HTTP::Request->new('GET', $URL);
	my $resp = $ua->request($req);
	return 0 if (! $resp->is_success);
	if ($resp->content =~ /No user|No such group/) {
		croak($resp->content);
		return 0;
	}
	local ($^W) = 0; # silence XML::SAX::Expat
	if ($self->_mode eq 'user') {
		$self->{data} = XMLin($resp->content);
	} else {
		$self->{groupdata} = XMLin($resp->content);
	}
	local ($^W) = 1;
	return 1;
}

sub _mode {
	my ($self, $mode) = @_;
	if (defined $mode) {
		$self->{mode} = $mode;
		return $self;
	} else {
		return $self->{mode} || undef;
	}
}

1;
__END__