--- loncom/interface/lonsearchcat.pm 2001/10/16 17:12:51 1.101
+++ loncom/interface/lonsearchcat.pm 2001/12/13 14:00:37 1.112
@@ -1,106 +1,48 @@
# The LearningOnline Network with CAPA
-#
# Search Catalog
#
-# YEAR=2001
-# 03/08/2001 Scott Harrison
-# Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001
-# Scott Harrison: 03/20/2001, 03/21/2001, 03/22/2001, 03/26/2001, 03/27/2001
-# Scott Harrison: 04/02/2001, 08/15/2001, 08/24/2001, 08/25/2001
-# 10/12,10/14,10/15 Scott Harrison
-
-###############################################################################
-## ##
-## ORGANIZATION OF THIS PERL MODULE ##
-## ##
-## 1. Description of functions ##
-## 2. Modules used by this module ##
-## 3. Choices for different output views (detailed, summary, xml, etc) ##
-## 4. BEGIN block (to be run once after compilation) ##
-## 5. Handling routine called via Apache and mod_perl ##
-## 6. Other subroutines ##
-## ##
-###############################################################################
-
-# ---------------------------------------------------- Description of functions
-#
+# $Id: lonsearchcat.pm,v 1.112 2001/12/13 14:00:37 harris41 Exp $
#
-# === WEB HANDLER FUNCTIONS
-# BEGIN() : run once after compilation to initialize values
-# handler(server reference) : interacts with the Apache server layer
-# (for /adm/searchcat URLs)
-# get_unprocessed_cgi() : reads in critical name/value pairs that may have not
-# been processed and passed into %ENV by the web server
-# make_persistent() : makes a set of hidden HTML fields to make
-# SQL search interface information to be persistent
+# Copyright Michigan State University Board of Trustees
#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
-# === WEB INTERFACE COMPONENT FUNCTIONS
-# simpletextfield(name,value) : returns HTML formatted string for simple text
-# field
-# simplecheckbox(name,value) : returns HTML formatted string for simple
-# checkbox
-# searchphrasefield(title,name,value) : returns HTML formatted string for
-# a search expression phrase field
-# dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
-# formatted string
-# for a calendar date
-# selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
-# a selection box field
+# LON-CAPA is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
#
+# LON-CAPA is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# === SEARCH FUNCTIONS
-# advancedsearch(server reference, environment reference) : perform a complex
-# multi-field logical query
-# basicsearch(server reference, environment reference) : perform a simple
-# single-field logical query
-# build_SQL_query(field name, logic) : builds a SQL query string from a
-# logical expression with AND/OR keywords
-# build_custommetadata_query(field_name, logic_statement) : builds a perl
-# regular expression from a logical expression with AND/OR
-# keywords
-# recursive_SQL_query_build(field name, reverse notation expression) :
-# builds a SQL query string from a reverse notation expression
-# logical expression with AND/OR keywords
-# build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,
-# lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :
-# Builds a SQL logic query to check time/date entries.
+# You should have received a copy of the GNU General Public License
+# along with LON-CAPA; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
+# /home/httpd/html/adm/gpl.txt
#
-# === OUTPUTTING RESULTS FUNCTION
-# output_results(output mode,
-# server reference,
-# environment reference,
-# reply list reference) : outputs results from search
-#
-#
-# === DIFFERENT WAYS TO VIEW METADATA RECORDS
-# detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
-# see metadata viewing notes below
-# summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
-# see metadata viewing notes below
-# fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
-# see metadata viewing notes below
-# xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
-# see metadata viewing notes below
-# ___________________________________________________________________________
-# | * Metadata viewing notes |
-# | Output is a HTML-ified string. |
-# | Input arguments are title, author, subject, url, keywords, version, notes,|
-# | short abstract, mime, language, creation date, last revision date, owner, |
-# | copyright, hostname, httphost, and extra custom metadata to show. |
-# ---------------------------------------------------------------------------
-#
-#
-# === TEST CONDITIONAL FUNCTIONS
-# filled(field) : determines whether a given field has been filled
+# http://www.lon-capa.org/
#
+# YEAR=2001
+# 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison
+# 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison
+# 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12 Scott Harrison
#
-# === ERROR FUNCTIONS
-# output_blank_field_error(server reference) : outputs a message saying that
-# more fields need to be filled in
-# output_date_error(server reference, error message) : outputs
-# an error message specific to bad date format.
+###
+
+###############################################################################
+## ##
+## ORGANIZATION OF THIS PERL MODULE ##
+## ##
+## 1. Modules used by this module ##
+## 2. Choices for different output views (detailed, summary, xml, etc) ##
+## 3. BEGIN block (to be run once after compilation) ##
+## 4. Handling routine called via Apache and mod_perl ##
+## 5. Other subroutines ##
+## ##
+###############################################################################
package Apache::lonsearchcat;
@@ -112,13 +54,14 @@ use Apache::File();
use CGI qw(:standard);
use Text::Query;
use GDBM_File;
+use Apache::loncommon();
# ---------------------------------------- variables used throughout the module
# -- information holders
-my %language; # holds contents of language.tab
-my %cprtag; # holds contents of copyright.tab
-my %mimetag; # holds contents of filetypes.tab
+# my %language; # holds contents of language.tab
+# my %cprtag; # holds contents of copyright.tab
+# my %mimetag; # holds contents of filetypes.tab
my %hostdomains; # matches host name to host domain
my %hostips; # matches host name to host ip
my %hitcount; # stores number of hits per host
@@ -156,44 +99,16 @@ END
# ----------------------------------------------------------------------- BEGIN
sub BEGIN {
-# --------------------------------- Compute various listings of metadata values
- $language{'any'}='Any language';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/language.tab');
- map {
- $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
- $language{$1}=$2;
- } <$fh>;
- }
- $cprtag{'any'}='Any copyright/distribution';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonIncludes'}.
- '/copyright.tab');
- map {
- $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
- $cprtag{$1}=$2;
- } <$fh>;
- }
- $mimetag{'any'}='Any type';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/filetypes.tab');
- map {
- $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;
- $mimetag{$1}=".$1 $3";
- } <$fh>;
- }
{
my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
'/hosts.tab');
- map {
+ while (<$fh>) {
$_=~/(\w+?)\:(\w+?)\:(\w+?)\:(.*)/; chomp;
if ($3 eq 'library') {
$hostdomains{$1}=$2;
$hostips{$1}=$4;
}
- } <$fh>;
+ }
}
}
@@ -203,7 +118,7 @@ my $domain = "";
# ----------------------------- Handling routine called via Apache and mod_perl
sub handler {
my $r = shift;
-
+ untie %hash;
&get_unprocessed_cgi();
$r->content_type('text/html');
@@ -212,7 +127,7 @@ sub handler {
$domain = $r->dir_config('lonDefDomain');
- $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
+ $diropendb= "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_searchcat.db";
if ($ENV{'form.launch'} eq '1') {
if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
@@ -289,15 +204,20 @@ END
$scrout.=&searchphrasefield('Limit by abstract','abstract',
$ENV{'form.abstract'});
- $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});
+ $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});
$scrout.=&selectbox('Limit by MIME type','mime',
- $ENV{'form.mime'},%mimetag);
+ $ENV{'form.mime'},
+ 'any','Any type',
+ \&{Apache::loncommon::filedescriptionex},
+ (&Apache::loncommon::fileextensions));
$ENV{'form.language'}='any' unless length($ENV{'form.language'});
$scrout.=&selectbox('Limit by language','language',
- $ENV{'form.language'},%language);
-
+ $ENV{'form.language'},'any','Any Language',
+ \&{Apache::loncommon::languagedescription},
+ (&Apache::loncommon::languageids),
+ );
# ------------------------------------------------ Compute date selection boxes
$scrout.=<<CREATIONDATESTART;
@@ -348,7 +268,11 @@ LASTREVISIONDATEEND
$ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
$scrout.=&selectbox('Limit by copyright/distribution','copyright',
- $ENV{'form.copyright'},%cprtag);
+ $ENV{'form.copyright'},
+ 'any','Any copyright/distribution',
+ \&{Apache::loncommon::copyrightdescription},
+ (&Apache::loncommon::copyrightids),
+ );
# ------------------------------------------- Compute customized metadata field
$scrout.=<<CUSTOMMETADATA;
@@ -434,21 +358,21 @@ ENDDOCUMENT
# ----------- grab unprocessed CGI variables that may have been appended to URL
sub get_unprocessed_cgi {
- map {
+ foreach (split(/&/,$ENV{'QUERY_STRING'})) {
my ($name, $value) = split(/=/,$_);
$value =~ tr/+/ /;
$value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
if ($name eq 'catalogmode' or $name eq 'launch' or $name eq 'acts') {
$ENV{'form.'.$name}=$value;
}
- } (split(/&/,$ENV{'QUERY_STRING'}));
+ }
}
# ------------------------------------------------------------- make persistent
sub make_persistent {
my $persistent='';
- map {
+ foreach (keys %ENV) {
if (/^form\./ && !/submit/) {
my $name=$_;
my $key=$name;
@@ -458,7 +382,7 @@ sub make_persistent {
<input type='hidden' name='$name' value='$ENV{$key}' />
END
}
- } (keys %ENV);
+ }
return $persistent;
}
@@ -634,18 +558,27 @@ END
}
sub selectbox {
- my ($title,$name,$value,%options)=@_;
+ my ($title,$name,$value,$anyvalue,$anytag,$functionref,@idlist)=@_;
my $uctitle=uc($title);
my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
"</b></font><br />".'<select name="'.$name.'">';
- map {
+ foreach ($anyvalue,@idlist) {
$selout.='<option value=\''.$_.'\'';
- if ($_ eq $value) { $selout.=' selected'; }
- $selout.='>'.$options{$_}.'</option>';
- } sort keys %options;
+ if ($_ eq $value and !/^any$/) {
+ $selout.=' selected>'.&{$functionref}($_).'</option>';
+ }
+ elsif ($_ eq $value and /^$anyvalue$/) {
+ $selout.=' selected>'.$anytag.'</option>';
+ }
+ else {$selout.='>'.&{$functionref}($_).'</option>';}
+ }
return $selout.'</select>';
}
+sub testf {
+ return @_[0];
+}
+
# ----------------------------------------------- Performing an advanced search
sub advancedsearch {
my ($r,$envhash)=@_;
@@ -917,7 +850,7 @@ sub output_results {
my %ENV=%{$envhash};
my %rhash=%{$replyref};
my $compiledresult='';
- my $timeremain=30;
+ my $timeremain=300;
my $elapsetime=0;
my $resultflag=0;
my $tflag=1;
@@ -982,6 +915,11 @@ SCRIPT
'scrollbars=1,width=400,height=300');
openhelpwin.focus();
}
+ function abortsearch(val) {
+ openhelpwin=open('/adm/help/searchcat.html','helpscreen',
+ 'scrollbars=1,width=400,height=300');
+ openhelpwin.focus();
+ }
</script>
SCRIPT
$r->rflush();
@@ -1090,7 +1028,7 @@ RESULTS
'<'+'br />'+
' <'+'input type="button" name="button"'+
' value="abort search and view current results" '+
- ' />'+
+ ' onClick="javascript:opener.abortsearch()" />'+
' <'+'input type="button" name="button"'+
' value="help" onClick="javascript:opener.openhelp()" />'+
'<'+'/tt>'+
@@ -1102,10 +1040,16 @@ ENDPOP
$r->rflush();
my $servercount=0;
- $sn=0;
my $hitcountsum=0;
- foreach my $rkey (sort keys %rhash) {
+ my $bloop=$servernum;
+ my %orkey;
+ BLOOP: while(1) {
+ my $sn=0;
+ last BLOOP unless $bloop;
+ last BLOOP unless $timeremain;
+ RLOOP: foreach my $rkey (sort keys %rhash) {
$sn++;
+ next RLOOP if $orkey{$rkey};
$servercount++;
$tflag=1;
$compiledresult='';
@@ -1121,6 +1065,8 @@ ENDPOP
'src="/adm/lonIcons/srvbad.gif";</script>'.
"\n");
$r->rflush();
+ $bloop--;
+ $orkey{$rkey}=1;
}
else {
$reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting
@@ -1142,8 +1088,9 @@ ENDPOP
$r->rflush();
$tflag=0;
}
- last WLOOP if $temp>5;
if (-e "$replyfile.end") {
+ $bloop--;
+ $orkey{$rkey}=1;
if (-s $replyfile) {
$r->print('<script type="text/javascript">'.
'popwin.document.img'.$sn.'.'.
@@ -1184,6 +1131,12 @@ ENDPOP
}
last WLOOP;
}
+ if ($temp>1) {
+ sleep 1;
+ $timeremain--;
+ $elapsetime++;
+ last WLOOP;
+ }
last WLOOP unless $timeremain;
sleep 1;
$timeremain--;
@@ -1242,9 +1195,25 @@ ENDPOP
my ($title,$author,$subject,$url,$keywords,$version,
$notes,$abstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
+
+ unless ($ENV{'user.adv'}) {
+ $keywords='<i>- not displayed -</i>';
+ $fields[4]=$keywords;
+ $notes='<i>- not displayed -</i>';
+ $fields[6]=$notes;
+ $abstract='<i>- not displayed -</i>';
+ $fields[7]=$abstract;
+ $subject='<i>- not displayed -</i>';
+ $fields[2]=$subject;
+ }
+
my $shortabstract=$abstract;
- $shortabstract=substr($abstract,0,200) if length($abstract)>200;
+ $shortabstract=substr($abstract,0,200).'...' if length($abstract)>200;
$fields[7]=$shortabstract;
+ my $shortkeywords=$keywords;
+ $shortkeywords=substr($keywords,0,200).'...' if length($keywords)>200;
+ $fields[4]=$shortkeywords;
+
my $extrashow2=$extrashow;
if ($extrashow) {
foreach my $field (@customfields) {
@@ -1268,7 +1237,6 @@ onClick="javascript:select_data('$title'
</font>
<br />
END
- $hash{"HELLOWORLD"}='123';
if ($ENV{'form.catalogmode'} eq 'groupsearch') {
$fnum+=0;
$hash{"pre_${fnum}_link"}=$url;
@@ -1328,6 +1296,7 @@ $compiledresult
RESULTS
my $percent=sprintf('%3.0f',($servercount/$servernum*100));
}
+ }
unless ($resultflag) {
$r->print("\nThere were no results that matched your query\n");
}
@@ -1353,9 +1322,21 @@ sub detailed_citation_view {
<b>Subject:</b> $subject<br />
<b>Keyword(s):</b> $keywords<br />
<b>Notes:</b> $notes<br />
-<b>MIME Type:</b> $mimetag{$mime}<br />
-<b>Language:</b> $language{$lang}<br />
-<b>Copyright/Distribution:</b> $cprtag{$copyright}<br />
+<b>MIME Type:</b>
+END
+ $result.=&Apache::loncommon::filedescription($mime);
+ $result.=<<END;
+<br />
+<b>Language:</b>
+END
+ $result.=&Apache::loncommon::languagedescription($lang);
+ $result.=<<END;
+<br />
+<b>Copyright/Distribution:</b>
+END
+ $result.=&Apache::loncommon::copyrightdescription($copyright);
+ $result.=<<END;
+<br />
</p>
$extrashow
<p>
@@ -1371,11 +1352,12 @@ sub summary_view {
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
$hostname,$httphost,$extrashow)=@_;
+ my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
my $result=<<END;
<a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />
$title<br />
$owner -- $lastrevisiondate<br />
-$cprtag{$copyright}<br />
+$cprtag<br />
$extrashow
</p>
END
@@ -1388,6 +1370,9 @@ sub fielded_format_view {
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
$hostname,$httphost,$extrashow)=@_;
+ my $mimetag=&Apache::loncommon::filedescription($mime);
+ my $language=&Apache::loncommon::languagedescription($lang);
+ my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
my $result=<<END;
<b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>
<br />
@@ -1396,12 +1381,12 @@ sub fielded_format_view {
<b>Subject:</b> $subject<br />
<b>Keyword(s):</b> $keywords<br />
<b>Notes:</b> $notes<br />
-<b>MIME Type:</b> $mimetag{$mime}<br />
-<b>Language:</b> $language{$lang}<br />
+<b>MIME Type:</b> $mimetag<br />
+<b>Language:</b> $language<br />
<b>Creation Date:</b> $creationdate<br />
<b>Last Revision Date:</b> $lastrevisiondate<br />
<b>Publisher/Owner:</b> $owner<br />
-<b>Copyright/Distribution:</b> $cprtag{$copyright}<br />
+<b>Copyright/Distribution:</b> $cprtag<br />
<b>Repository Location:</b> $hostname<br />
<b>Abstract:</b> $shortabstract<br />
$extrashow
@@ -1416,6 +1401,9 @@ sub xml_sgml_view {
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
$hostname,$httphost,$extrashow)=@_;
+ my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
+ my $mimetag=&Apache::loncommon::filedescription($mime);
+ my $language=&Apache::loncommon::languagedescription($lang);
my $result=<<END;
<pre>
<LonCapaResource>
@@ -1427,18 +1415,18 @@ sub xml_sgml_view {
<notes>$notes</notes>
<mimeInfo>
<mime>$mime</mime>
-<mimetag>$mimetag{$mime}</mimetag>
+<mimetag>$mimetag</mimetag>
</mimeInfo>
<languageInfo>
<language>$lang</language>
-<languagetag>$language{$lang}</languagetag>
+<languagetag>$language</languagetag>
</languageInfo>
<creationdate>$creationdate</creationdate>
<lastrevisiondate>$lastrevisiondate</lastrevisiondate>
<owner>$owner</owner>
<copyrightInfo>
<copyright>$copyright</copyright>
-<copyrighttag>$cprtag{$copyright}</copyrighttag>
+<copyrighttag>$cprtag</copyrighttag>
</copyrightInfo>
<repositoryLocation>$hostname</repositoryLocation>
<shortabstract>$shortabstract</shortabstract>
@@ -1525,19 +1513,261 @@ $message
RESULTS
}
-# --------- settings whenever the user causes the indexer window to be launched
+# --------- settings whenever the user causes the search window to be launched
sub start_fresh_session {
delete $hash{'mode_catalog'};
- map {
+ foreach (keys %hash) {
if ($_ =~ /^pre_/) {
delete $hash{$_};
}
if ($_ =~ /^store/) {
delete $hash{$_};
}
- } keys %hash;
+ }
}
1;
__END__
+
+=head1 NAME
+
+Apache::lonsearchcat - mod_perl module for handling a searchable catalog
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <Location /adm/searchcat>
+ PerlAccessHandler Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonsearchcat
+ ErrorDocument 403 /adm/login
+ ErrorDocument 500 /adm/errorhandler
+ </Location>
+
+=head1 INTRODUCTION
+
+This module enables searching for a distributed browseable catalog.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 BEGIN SUBROUTINE
+
+This routine is only run once after compilation.
+
+=over 4
+
+=item *
+
+Initializes %language hash table.
+
+=item *
+
+Initializes %cprtag hash table (for copyright.tab).
+
+=item *
+
+Initializes %mimetag hash table (for filetypes.tab).
+
+=item *
+
+Initializes %hostdomains and hostips hash table (for hosts.tab).
+
+=back
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+configure dynamic components of interface
+
+=item *
+
+determine current user
+
+=item *
+
+see if a search invocation should be done
+
+=item *
+
+else, begin building search interface to output
+
+=item *
+
+compute date selection boxes
+
+=item *
+
+compute customized metadata field
+
+=item *
+
+print screen
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+get_unprocessed_cgi() : reads in critical name/value pairs that may have not
+been processed and passed into %ENV by the web server
+
+=item *
+
+make_persistent() : makes a set of hidden HTML fields to make
+SQL search interface information to be persistent
+
+=back
+
+WEB INTERFACE COMPONENT FUNCTIONS
+
+=over 4
+
+=item *
+
+simpletextfield(name,value) : returns HTML formatted string for simple text
+field
+
+=item *
+
+simplecheckbox(name,value) : returns HTML formatted string for simple
+checkbox
+
+=item *
+
+searchphrasefield(title,name,value) : returns HTML formatted string for
+a search expression phrase field
+
+=item *
+
+dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
+formatted string for a calendar date
+
+=item *
+
+selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
+a selection box field
+
+=back
+
+SEARCH FUNCTIONS
+
+=over 4
+
+=item *
+
+advancedsearch(server reference, environment reference) : perform a complex
+multi-field logical query
+
+=item *
+
+basicsearch(server reference, environment reference) : perform a simple
+single-field logical query
+
+=item *
+
+build_SQL_query(field name, logic) : builds a SQL query string from a
+logical expression with AND/OR keywords
+
+=item *
+
+build_custommetadata_query(field_name, logic_statement) : builds a perl
+regular expression from a logical expression with AND/OR keywords
+
+=item *
+
+recursive_SQL_query_build(field name, reverse notation expression) :
+builds a SQL query string from a reverse notation expression
+logical expression with AND/OR keywords
+
+=item *
+
+build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,
+lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :
+Builds a SQL logic query to check time/date entries.
+
+=back
+
+OUTPUTTING RESULTS FUNCTION
+
+=over 4
+
+=item *
+
+output_results(output mode, server reference, environment reference,
+reply list reference) : outputs results from search
+
+=back
+
+DIFFERENT WAYS TO VIEW METADATA RECORDS
+
+=over 4
+
+=item *
+
+detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+see metadata viewing notes below
+
+=item *
+
+summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+see metadata viewing notes below
+
+=item *
+
+fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+see metadata viewing notes below
+
+=item *
+
+xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+see metadata viewing notes below
+
+=back
+
+ _____________________________________________________________________
+ | * Metadata viewing notes |
+ | Output is a HTML-ified string. |
+ | Input arguments are title, author, subject, url, keywords, version, |
+ | notes, short abstract, mime, language, creation date, |
+ | last revision date, owner, copyright, hostname, httphost, and |
+ | extra custom metadata to show. |
+ ---------------------------------------------------------------------
+
+TEST CONDITIONAL FUNCTIONS
+
+=over 4
+
+=item *
+
+filled(field) : determines whether a given field has been filled
+
+=back
+
+ERROR FUNCTIONS
+
+=over 4
+
+=item *
+
+output_blank_field_error(server reference) : outputs a message saying that
+more fields need to be filled in
+
+=item *
+
+output_date_error(server reference, error message) : outputs
+an error message specific to bad date format.
+
+=back
+
+=cut