#!/home/rebelsky/perl/bin/perl
#This script gets the data from an annotation file and displays it.
#(POD documentation at end)
##################
# Package Begins #
##################
#package declaration
package Top;
use Exporter ();
@ISA = (Exporter);
@EXPORT = qw(top_execute);
#import modules
use AFile;
use HTTP::Request;
use HTTP::Daemon;
###########################################################################
# top_execute #
###########################################################################
# This subroutine takes in the user information from ravel and sends a
# response to the client containing a web page with the desired annotation
# displayed in it.
# ARGUMENTS: The user's name in string form, the user information in
# string form, the client connection in order to send a response, and the
# original client request.
# RETURNS: Returns 1 to show that it ran correctly.
###########################################################################
sub top_execute
{
#read arguments
my $name=shift; # ID of the user for this request
my $user_info=shift; # A string with info. on the user
my $client=shift; # Client connection
my $client_request=shift; # Request from the client
#other variables
my $query; #the original query string
my $file; #the annotation file address
my $url; #the url of the annotated page
my $lasttime; #lasttime user viewed this page
# parse the string of user information
$query = $client_request->url;
$query =~ /\?(.*)/i;
$query = $1;
#split the query into parts
$query =~ /(.*)\&(.*)\&(.*)/i;
$file = $1;
$url = $2;
$lasttime = $3;
#process the annotation file using AFile->readFile
&readFile(*fields,$file);
#display the annotation
&showAnnotation(*fields,$url,$name,$lasttime,$client);
#return the true value to show that it ran correctly
return 1;
}#sub top_execute
###########################################################################
# showAnnotation #
###########################################################################
# This subroutine simply displays an annotation on a web page.
# ARGUMENTS: A typeglob that is a reference to a hash containing the info
# for the annotation obtained by reading the annotation file with
# AFile->readFile, the url of the page that was annotated in string form,
# the user's name in string form, the last time that the user viewed this
# web page in string form as returned by History->history, and the client
# connection in order to send a response.
# RETURNS: Returns 1 to say that it ran correctly.
###########################################################################
sub showAnnotation
{
#read in arguments
local(*data) = shift; #hash in which annotation info is stored
my $url = shift; #the url for the annotated page
my $name = shift; #the user viewing the annotation
my $lasttime = shift; #lasttime user viewed this page
my $client = shift; #the client object
#other variables
my $date; #the date of the annotation
my $mon; #the month in $date
my $day; #the day in $date
my $year; #the year in $date
my $protection; #the protection setting in string form
my $num; #number of commas replaced in group list
my $delete; #optional HTML delete button
my $response; #the response to send the client
my $response_object; #the client response object
#split date into month, day, year
$date = $data{'date'};
$mon = substr($date,0,2);
$day = substr($date,2,2);
$year = substr($date,4,2);
#Turn the protection setting into a readable string.
$protection = $data{'protection'};
$protection =~ s/(.*),/$1,and /i;
$num = ($protection =~ s/,/, /ig);
#if exactly one comma existed in the protection line, we can remove
#that comma.
if ($num == 1)
{
$protection =~ s/,//i;
} #if ($num == 1)
#if the author of the annotation is the same as the current user, they
#can delete the annotation thus, the delete button should show up.
if (($data{'author'} eq $name) || ($name eq "sysadmin"))
{
$delete = " \n";
} #if ($data{'author'} eq $name)
#display annotation
$response = <<"EOF";