package Alex::Concordance;

# Concordance.pm - KWIC search engine and bigram tool for Alex content

# Eric Lease Morgan <eric_morgan@infomotions.com>
# June      18, 2009 - first investigations
# July       1, 2009 - add bigrams and dynamic content from Alex
# July       3, 2009 - added words by letter and specialized searches
# July      22, 2009 - tweaked option elements in forms; changed id to fkey
# August    27, 2010 - added ngram functionality and tweaked the form; yeah for Lingua::EN::Bigram!
# August    30, 2010 - added map of where queries are located in the text
# September 12, 2010 - tweaked for use with Lingua::EN::Ngram
# September 18, 2010 - added Twitter and Delicious links; moved ' in the beginning and ending of words
# Januaray  23, 2011 - linked to network diagrams

# define/configure
use constant PROXY           => 56234;
use constant INSTANCE        => 'alex3';
use constant ROOT            => '/var/www/html/main';
use constant INFOMO          => 'http://infomotions.com';
use constant URL             => 73038;
use constant MAXCOLLOCATIONS => 100;
use constant RADIUS          => 40;

# require
use Apache2::Const -compile => qw( OK );
use CGI;
use Lingua::Concordance;
use Lingua::EN::Ngram;
use Lingua::StopWords qw( getStopWords );
use MyLibrary::Core;
use strict;

# main
sub handler {

	# initalize
	my $r    = shift;
	my $cgi  = CGI->new;
	my $id   = $cgi->param( 'id' );
	my $html = '';
	MyLibrary::Config->instance( INSTANCE );
	
	# display default page
	if ( ! $id ) {
	
		# set-up output
		$html = &template;
		$html =~ s/##CONTENT##/&default/e;
	
	}
	
	# branch according to cmd
	else {
	
		# get the id's metadata; needs error checking
		my ( $title, $author, $filename, $url ) = &get_metadata( $id );
		
		# get the cmd
		my $cmd = $cgi->param( 'cmd' );
		
		# no command
		if ( ! $cmd ) {
		
			# display the home page
			$html =  &template;
			$html =~ s/##CONTENT##/&home( $url )/e;
			$html =~ s/##TITLE##/$title/e;
			$html =~ s/##AUTHOR##/$author/e;
			$html =~ s/##FORM##/&form( $cgi )/e;
			$html =~ s/##ID##/$id/ge;
			$html =~ s/##SHOWMAP##//e;
			$html =~ s/##DIAGRAM##//e;
			$html =~ s/##MAP##//e;
			$html =~ s/##QUERY##//e;
			$html =~ s/##SUBFORM##//e;
			$html =~ s/##LINES##//e;
			
		}
		
		# display words starting with letter
		elsif ( $cmd eq 'letters' ) {
		
			my $i = $cgi->param( 'l' );
			
			# set up
			my $collocations = Lingua::EN::Ngram->new( file => $filename );

			my $words = $collocations->ngram( 1 );
			my $lines = '';
			foreach my $word ( sort keys %$words ) {

				my $l = substr $word, 0, 1;
				next if ( $i gt $l );
				last if ( $i lt $l );
				my $link = $cgi->a({ href => "./?cmd=search&id=$id&query=" . $word }, $word );
				$lines .= $link . ' (' . $$words{ $word } . '); &nbsp;';
	
			}

			$lines = $cgi->p( $lines );

			# set-up output
			$html =  &template;
			$html =~ s/##CONTENT##/&home( $url )/e;
			$html =~ s/##TITLE##/$title/e;
			$html =~ s/##AUTHOR##/$author/e;
			$html =~ s/##FORM##/&form( $cgi )/e;
			$html =~ s/##ID##/$id/ge;
			$html =~ s/##QUERY##//e;
			$html =~ s/##SHOWMAP##//e;
			$html =~ s/##DIAGRAM##//e;
			$html =~ s/##MAP##//e;
			$html =~ s/##SUBFORM##//e;
			$html =~ s/##LINES##/$lines/e;
				
		}
		
		# display single words
		elsif ( $cmd eq 'words' ) {
		
			# get the number of words
			my $n = $cgi->param( 'n' );
			
			# set up
			my $collocations = Lingua::EN::Ngram->new( file => $filename );
				
			# do the work
			my $words      = $collocations->ngram( 1 );
			my $index      = 0;
			my $lines      = '';
			my $stopwords  = &getStopWords( 'en' );
			foreach ( sort { $$words{ $b } <=> $$words{ $a } } keys %$words ) {
			
				# skip stopwords and punctuation
				next if ( $$stopwords{ $_ } );
				next if ( $_ =~ /[,.?!:;()\-]/ or $_ =~ /^'/ or $_ =~ /'$/ );
		
				# limit the output
				$index++;
				last if ( $index > $n );
				
				# gather the words
				my $link = $cgi->a({ href => "./?cmd=search&id=$id&query=" . $_ }, $_ );
				$lines .= $link . ' (' . $$words{ $_ } . '); &nbsp;';
			
			}
			$lines = $cgi->p( $lines );
			
			# set-up output
			$html =  &template;
			$html =~ s/##CONTENT##/&home( $url )/e;
			$html =~ s/##TITLE##/$title/e;
			$html =~ s/##AUTHOR##/$author/e;
			$html =~ s/##FORM##/&form( $cgi )/e;
			$html =~ s/##ID##/$id/ge;
			$html =~ s/##QUERY##//e;
			$html =~ s/##SHOWMAP##//e;
			$html =~ s/##DIAGRAM##//e;
			$html =~ s/##MAP##//e;
			$html =~ s/##SUBFORM##//e;
			$html =~ s/##LINES##/$lines/e;
		
		}
		
		# display collocations
		elsif ( $cmd eq 'collocations' ) {
		
			# get the input: length of collocations
			my $n = $cgi->param( 'n' );
						
			# initalize
			my $collocations = Lingua::EN::Ngram->new( file => $filename );
			
			# count; branch according to how many
			my $bigrams = '';
			my $count   = '';
			my $tscore  = '';
			if ( $n == 2 ) { 
			
				$bigrams = $collocations->ngram( 2 );
				$count   = $collocations->tscore;
				
			}
			else { $count = $collocations->ngram( $n )}
			
			# process each count
			my $index     = 0;
			my $lines     = '';
			my $stopwords = &getStopWords( 'en' );
			foreach my $phrase ( sort { $$count{ $b } <=> $$count{ $a } } keys %$count ) {
			
				# get the tokens of the phrase
				my @tokens = split / /, $phrase;
			
				# process each token; filter based on it's value
				my $found = 0;
				foreach ( @tokens ) {
				
					# skip stop words for bigrams
					if ( $n == 2 ) {
					
						if ( $$stopwords{ $_ }) {
						
							$found = 1;
							last;
						
						}
					
					}
					
					# skip punctuation
					if ( $_ =~ /[,.?!:;()\-]/ or $_ =~ /^'/ or $_ =~ /'$/  ) {
					
						$found = 1;
						last;
						
					}
						
					# skip punctuation
					if ( $_ =~ /^'/ ) {
					
						$found = 1;
						last;
						
					}
						
				}
				
				# loop if found an unwanted token
				next if ( $found );
		
				# limit the output
				$index++;
				last if ( $index > MAXCOLLOCATIONS );
				last if ( $$count{ $phrase } == 1 );
				
				# gather the words
				my $link = $cgi->a({ href => "./?cmd=search&id=$id&query=" . $phrase }, $phrase );
				if ( $n == 2 ) { $lines .= $link . ' (' . $$bigrams{ $phrase } . '); &nbsp;' }
				else { $lines .= $link . ' (' . $$count{ $phrase } . '); &nbsp;' }
			
			}
			$lines = $cgi->p( $lines );
			
			# set-up output
			$html =  &template;
			$html =~ s/##CONTENT##/&home( $url )/e;
			$html =~ s/##TITLE##/$title/e;
			$html =~ s/##AUTHOR##/$author/e;
			$html =~ s/##FORM##/&form( $cgi )/e;
			$html =~ s/##QUERY##//e;
			$html =~ s/##SHOWMAP##//e;
			$html =~ s/##DIAGRAM##//e;
			$html =~ s/##MAP##//e;
			$html =~ s/##SUBFORM##//e;
			$html =~ s/##ID##/$id/ge;
			$html =~ s/##LINES##/$lines/e;
		
		}
	
		# implement concordance
		elsif ( $cmd eq 'search' ) {
		
			# get the query
			my $query = $cgi->param( 'query' );
			
			# check for escaped urls because twitter hacks them; a reverse hack
			if ( $query =~ /%5C/ or $query =~ /%28/ or $query =~ /%7C/ ) {
			
				# unescape
				$query =~ s/%5C/\\/g;
				$query =~ s/%28/(/g;
				$query =~ s/%29/)/g;
				$query =~ s/%7C/\|/g;
			
				# redirect
				my $url = INFOMO . "/sandbox/concordance/?cmd=search&id=$id&query=$query";
				print $cgi->header( -status => '303 See Other', -Location => $url );
				
				# done
				return Apache2::Const::OK;
				
			}
			
			# build & configure concordance
			my $concordance = Lingua::Concordance->new;
			$concordance->text( &slurp( $filename ));
			$concordance->radius( RADIUS );
			$concordance->query( $query );
			my $radius = $cgi->param( 'radius' ) ? $cgi->param( 'radius' ) : $concordance->radius;
			$concordance->radius( $radius );
			my $sort = $cgi->param( 'sort' ) ? $cgi->param( 'sort' ) : $concordance->radius;
			$concordance->sort( $sort );
	
			# do the work
			my $lines = '';
			my $index = 0;
			foreach my $line ( $concordance->lines ) {
			
				# build padding
				$index++;
				
				if ( $radius < 200 ) {
				
					my $spaces = '';
					if ( length( $index ) == 1 ) { $spaces = '   ' }
					if ( length( $index ) == 2 ) { $spaces = '  ' }
					if ( length( $index ) == 3 ) { $spaces = ' ' }
					
					# format line
					$lines .= "$index.$spaces$line" . $cgi->br;
				
				}
				
				else { $lines .= $cgi->p( $index . '. ' . $line ) }
			
			}
			
			# format results, some more
			my $pattern = '\w+' . $query . '\w+|' . $query . '\w+|' . $query . '|\w+' . $query ;
			$lines =~ s|($pattern)|<b style='color:red'>$1</b>|gi;
			if ( $radius < 200 ) { $lines = $cgi->pre({ style => 'text-align: center' }, $lines )}
	
			# calculate and configure map
			$concordance->scale( 10 );
			my $map = $concordance->map;
			my @keys = sort { $$map{ $b } <=> $$map{ $a }} keys %$map;
			my $greatest_value = $$map{ $keys[ 0 ]};
			@keys = sort { $a <=> $b } keys %$map;
			my $values = '';
			foreach ( @keys ) { $values .= $$map{ $_ } . ',' }
			$values = substr( $values, 0, -1 );
			my $showmap = qq[<a href="javascript:show_map('Number of times &quot;$query&quot; occurs in the text and where')">Show map</a>];
			my $diagram = "<a href='/sandbox/diagrams/?id=##ID##&q=##QUERY##&r=$radius'>Visualize results</a>";
			
			# set-up output
			$html =  &template;
			$html =~ s/##CONTENT##/&home( $url )/e;
			$html =~ s/##TITLE##/$title/e;
			$html =~ s/##AUTHOR##/$author/e;
			$html =~ s/##FORM##/&form( $cgi )/e;
			$html =~ s/##SHOWMAP##/$showmap/e;
			$html =~ s/##DIAGRAM##/$diagram/e;
			$html =~ s/##ID##/$id/ge;
			$html =~ s/##QUERY##/$query/eg;
			$html =~ s/##MAP##/&map( $greatest_value, $values )/e;
			$html =~ s/##SUBFORM##/&subform( $radius, $sort )/e;
			$html =~ s/##LINES##/$lines/e;
		
		}
	
	}

	# done
	$r->content_type( 'text/html' );
	$r->print( $html );
	return Apache2::Const::OK;

}


# template
sub template {
	
	return <<EOT;
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><title>Concordances</title>
<link rel="stylesheet" type="text/css" href="http://infomotions.com/etc/css/jquery-ui.css" />
<script type="text/javascript" src="http://infomotions.com/etc/js/jquery-core.js"></script>
<script type="text/javascript" src="http://infomotions.com/etc/js/jquery-addons.js"></script>
<meta name="ROBOTS" content="NOINDEX,NOFOLLOW"/>
	<script type="text/javascript">
		
		// show the size dialog
		function show_map(t) {
			\$("#map").dialog(
				{
					disabled: false,
					height: 350,
					modal: true,
					resizable: false,
					title: t,
					width: 475
				}
			);
		};
	</script>
<script type="text/javascript">

  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-78927-1']);
  _gaq.push(['_trackPageview']);

  (function() {
    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  })();

</script>
</head>
<body style='margin: 5%; font-size: large'>
##CONTENT##
<hr style='margin-top: 2em' />
<p style="font-size: medium">Author: Eric Lease Morgan &lt;<a href="mailto:eric_morgan\@infomotions.com">eric_morgan\@infomotions.com</a>&gt;<br />
Date created: June 18, 2009<br />
Date updated: September 12, 2010<br />
URL: <a href="http://infomotions.com/sandbox/concordance/">http://infomotions.com/sandbox/concordance/</a><br />
</p>
</body>
</html>
EOT

}


# default
sub default {

	return <<EOT;
<h1><a href="http://infomotions.com/" title="Infomotions, Inc."><img src="http://infomotions.com/logo.gif" alt="Infomotions, Inc." width="42" height="44" border="0" align="left" hspace="15" /></a>Concordances</h1><p>This is a set of concordances against content in the Alex Catalogue of Electronic Texts. You can use the concordances to analyze and evaluate texts quickly. Here are few texts that can be used as examples:</p>
<ul>
<li><a href="./?id=twain-adventures-27">Adventures of Tom Sawyer / Mark Twain</a></li>
<li><a href="./?id=london-call-203">Call of the Wild / Jack London</a></li>
<li><a href="./?id=kant-critique-141">Critic of Pure Reason / Immanual Kant</a></li>
<li><a href="./?id=emerson-representative-238">Representative Men / Ralph Waldo Emerson</a></li>
<li><a href="./?id=shakespeare-romeo-48">Romeo And Juliet / William Shakespeare</a></li>
<li><a href="./?id=plato-symposium-356">Symposium / Plato</a></li>
<li><a href="./?id=nietzsche-thus-223">Thus Spake Zarathustra / Friedrich Nietzsche</a></li>
<li><a href="./?id=stevenson-treasure-166">Treasure Island / Robert Louis Stevenson</a></li>
<li><a href="./?id=thoreau-walden-186">Walden / Henry David Thoreau</a></li>
</ul>

<p>
For more texts, <a href="/alex/">search the Catalogue</a>.</p>
EOT

}



# home
sub home {

	my $url = shift;
	return <<EOT;
<h1><a href="http://infomotions.com/" title="Infomotions, Inc."><img src="http://infomotions.com/logo.gif" alt="Infomotions, Inc." width="42" height="44" border="0" align="left" hspace="15" /></a>Concordance for ##TITLE## / ##AUTHOR##</h1>
<p style='text-align: center'><em>Use the features on this page to analyze and evaluate the text.</em></p>
<a href="$url">View full text</a>
##FORM##
##MAP##
##LINES##
EOT

}


# map
sub map {

	my $g = shift;
	my $v = shift;
	my $q = shift;
	
	return <<EOT;
<!-- greatest: $g -->
<!--   values: $v -->
<!-- map dialog box -->
<div id="map" style='text-align: center; display: none'>
	<img src="http://chart.apis.google.com/chart?chxr=0,10,100|1,0,$g&chxt=x,y&chbh=a&chs=425x205&cht=bvs&chds=0,$g&chd=t:$v" width="425" height="205" alt="map" />
</div>
EOT

}


# form
sub form {

	my $cgi    = shift;
	my $script = $cgi->url;

	return <<EOT;
<form name='f4' action='$script' method='get' >
<input type='hidden' name='cmd' value='letters' />
<input type='hidden' name='id' value='##ID##' />
Words begining with: <select name="l" onChange='javascript:document.f4.submit()' title='Letter beginning of word'>
	<option value="a">a</option>
	<option value="b">b</option>
	<option value="d">c</option>
	<option value="d">d</option>
	<option value="e">e</option>
	<option value="f">f</option>
	<option value="g">g</option>
	<option value="h">h</option>
	<option value="i">i</option>
	<option value="j">j</option>
	<option value="k">k</option>
	<option value="l">l</option>
	<option value="m">m</option>
	<option value="n">n</option>
	<option value="o">o</option>
	<option value="p">p</option>
	<option value="q">q</option>
	<option value="r">r</option>
	<option value="s">s</option>
	<option value="t">t</option>
	<option value="u">u</option>
	<option value="v">v</option>
	<option value="w">w</option>
	<option value="x">x</option>
	<option value="y">y</option>
	<option value="z">z</option>
</select>
<input type='submit' value='Go' style='font-size: x-large' />
</form>
<form name='f1' action='$script' method='get' >
<input type='hidden' name='cmd' value='words' />
<input type='hidden' name='id' value='##ID##' />
Number of words: <select name="n" onChange='javascript:document.f1.submit()' title='Number of words to return'>
	<option value="10">10</option>
	<option value="25">25</option>
	<option value="50" selected='selected'>50</option>
	<option value="100">100</option>
	<option value="250">250</option>
</select>
<input type='submit' value='Go' style='font-size: x-large' />
</form>
<form name='f3' action='$script' method='get' >
<input type='hidden' name='cmd' value='collocations' />
<input type='hidden' name='id' value='##ID##' />
Most frequent collocations: <select name="n" onChange='javascript:document.f3.submit()' title='Number of phrases to return'>
	<option label="2" value="2" selected='selected'>2</option>
	<option label="3" value="3">3</option>
	<option label="4" value="4">4</option>
	<option label="5" value="5">5</option>
	<option label="6" value="6">6</option>
	<option label="7" value="7">7</option>
	<option label="8" value="8">8</option>
	<option label="9" value="9">9</option>
	<option label="10" value="10">10</option>
</select>
<input type='submit' value='Go' style='font-size: x-large' />
</form>
<form name='f5' action='$script' method='get' >
<input type='hidden' name='cmd' value='search' />
<input type='hidden' name='id' value='##ID##' />
Search: <input type='text' name='query' value='##QUERY##' />
<input type='submit' value='Go' style='font-size: x-large' /> ##SHOWMAP## ##DIAGRAM##
##SUBFORM##
</form>
<p>Specialized searches: <a href="./?id=##ID##&cmd=search&query=%5Cb%28white%7Cblack%7Cgray%7Cred%7Cyellow%7Cblue%7Corange%7Cgreen%7Cpurple%7Cbrown%29%5Cb">colors</a>; <a href="./?id=##ID##&cmd=search&query=ly%5Cb">adverbs</a>; <a href="./?id=##ID##&cmd=search&query=ing%5Cb">gerunds</a>; "<a href='./?id=##ID##&cmd=search&query=%5Cb%28aeschylus%7Capollonius%7Caquinas%7Carchimedes%7Caristophanes%7Caristotle%7Caugustine%7Caurelius%7Cbacon%7Cberkeley%7Cboswell%7Ccervantes%7Cchaucer%7Ccopernicus%7Cdante%7Cdarwin%7Cdescartes%7Cdostoevsky%7Cengles%7Cepictetus%7Ceuclid%7Ceuripides%7Cfaraday%7Cfielding%7Cfourier%7Cfreud%7Cgalen%7Cgalilei%7Cgibbon%7Cgilbert%7Cgoethe%7Charvey%7Chegel%7Cherodotus%7Chippocrates%7Chobbes%7Chomer%7Chume%7Chuygens%7Cjames%7Ckant%7Ckepler%7Clavoisier%7Clocke%7Clucretius%7Cmachiavelli%7Cmarx%7Cmelville%7Cmill%7Cmilton%7Cmontaigne%7Cmontesquieu%7Cnewton%7Cnicomachus%7Cpascal%7Cplato%7Cplotinus%7Cplutarch%7Cptolemy%7Crabelais%7Crousseau%7Cshakespeare%7Csmith%7Csophocles%7Cspinoza%7Csterne%7Cswift%7Ctacitus%7Cthucydides%7Ctolstoy%7Cvirgil%29%5Cb'>big names</a>"; "<a href='./?cmd=search&id=##ID##&query=%5Cb(angel%7Canimal%7Caristocracy%7Cart%7Castronomy%7Cbeauty%7Cbeing%7Ccause%7Cchance%7Cchange%7Ccitizen%7Cconstitution%7Ccontingency%7Cconvention%7Ccosmology%7Ccourage%7Ccustom%7Cdeath%7Cdefinition%7Cdemocracy%7Cdesire%7Cdespotism%7Cdialectic%7Cduty%7Ceducation%7Celement%7Cemotion%7Cequality%7Ceternity%7Cevil%7Cevolution%7Cexperience%7Cfamily%7Cfate%7Cform%7Cgod%7Cgood%7Cgovernment%7Chabit%7Chappiness%7Chistory%7Chonor%7Chypothesis%7Cidea%7Cimagination%7Cimmortality%7Cinduction%7Cinfinity%7Cjudgment%7Cjustice%7Cknowledge%7Clabor%7Clanguage%7Claw%7Cliberty%7Clife%7Clogic%7Clove%7Cman%7Cmany%7Cmathematics%7Cmatter%7Cmechanics%7Cmedicine%7Cmemory%7Cmetaphysics%7Cmind%7Cmonarchy%7Cnature%7Cnecessity%7Coligarchy%7Cone%7Copinion%7Copposition%7Cother%7Cpain%7Cparticular%7Cpeace%7Cphilosophy%7Cphysics%7Cpleasure%7Cpoetry%7Cprinciple%7Cprogress%7Cprophecy%7Cprudence%7Cpunishment%7Cquality%7Cquantity%7Creasoning%7Crelation%7Creligion%7Crevolution%7Crhetoric%7Csame%7Cscience%7Csense%7Csign%7Csin%7Cslavery%7Csoul%7Cspace%7Cstate%7Csymbol%7Ctemperance%7Ctheology%7Ctime%7Ctruth%7Ctyranny%7Cuniversal%7Cvice%7Cvirtue%7Cwar%7Cwealth%7Cwill%7Cwisdom%7Cworld)%5Cb'>great ideas</a>"</p>
EOT

}


# update subform; retain selected values
sub subform {

	my $radius = shift;
	my $sort   = shift;
	
	my $subform = <<EOF;
<br />
<!-- radius -->
Radius:
<select name="radius" onChange='javascript:document.f5.submit()' title='Length of surrounding text'>
	<option value="40">40</option>
	<option value="50">50</option>
	<option value="60">60</option>
	<option value="200">200</option>
	<option value="500">500</option>
	<option value="1000">1000</option>
</select>

<!-- sort -->
Sort: <input name="sort" type="radio" value="none" onClick='javascript:document.f5.submit()' title='Order found in the text' /> None
<input name="sort" type="radio" value="left" onClick='javascript:document.f5.submit()' title='Finds phrases to the left' /> Left
<input name="sort" type="radio" value="right" onClick='javascript:document.f5.submit()' title='Finds phrases to the right' /> Right
<input name="sort" type="radio" value="match" onClick='javascript:document.f5.submit()' title='Finds word variations' /> Match
EOF

	# brute force dynamic updating; there's got to be a better way
	if ( $radius eq '40' ) { $subform =~ s/value="40" /value="40" selected="selected" / }
	elsif ( $radius eq '50' ) { $subform =~ s/value="50" /value="50" selected="selected" / }
	elsif ( $radius eq '60' ) { $subform =~ s/value="60" /value="60" selected="selected" / }
	elsif ( $radius eq '200' ) { $subform =~ s/value="200" /value="200" selected="selected" / }
	elsif ( $radius eq '500' ) { $subform =~ s/value="500" /value="500" selected="selected" / }
	elsif ( $radius eq '1000' ) { $subform =~ s/value="1000" /value="1000" selected="selected" / }
	else  { $subform =~ s/value="30" /value="30" selected="selected" / }
	
	if    ( $sort eq 'none' )  { $subform =~ s/value="none" /value="none" checked="checked" / }
	elsif ( $sort eq 'left' )  { $subform =~ s/value="left" /value="left" checked="checked" / }
	elsif ( $sort eq 'right' ) { $subform =~ s/value="right" /value="right" checked="checked" / }
	elsif ( $sort eq 'match' ) { $subform =~ s/value="match" /value="match" checked="checked" / }
	else  { $subform =~ s/value="none" /value="none" checked="checked" / }
	
	# done
	return $subform;
	
}


# open a file named by the input and return its contents
sub slurp {

	my $f = shift;
	open ( F, $f ) or die "Can't open $f: $!\n";
	my $r = do { local $/; <F> };
	close F;
	return $r;

}


# given an id, return author, title, and filename
sub get_metadata {
	
	my $root      = ROOT;
	my $host      = INFOMO;
	my $resource  = MyLibrary::Resource->new( fkey => shift );
	my @locations = $resource->resource_locations;
	my $filename  = '';
	my $url       = '';
	foreach my $location ( @locations ) {
	
		if ( $location->resource_location_type == PROXY ) { $filename = $location->location }
		if ( $location->resource_location_type == URL   ) { $url      = $location->location }
	
	}
	
	$filename =~ s|$host|$root|e;
	
	return ( $resource->name, $resource->creator, $filename, $url );
	
}


# return true or die
1;