--- loncom/interface/lonsearchcat.pm 2001/03/27 13:25:41 1.82
+++ loncom/interface/lonsearchcat.pm 2001/08/26 21:19:35 1.98
@@ -1,14 +1,40 @@
-# The LearningOnline Network
+# 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
+# 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
+
+###############################################################################
+## ##
+## 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
#
-# Functions
#
+# === 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
+#
+#
+# === WEB INTERFACE COMPONENT FUNCTIONS
# simpletextfield(name,value) : returns HTML formatted string for simple text
# field
# simplecheckbox(name,value) : returns HTML formatted string for simple
@@ -20,25 +46,64 @@
# for a calendar date
# selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
# a selection box field
+#
+#
+# === SEARCH FUNCTIONS
# advancedsearch(server reference, environment reference) : perform a complex
# multi-field logical query
-# filled(field) : determines whether a given field has been filled
# basicsearch(server reference, environment reference) : perform a simple
# single-field logical query
-# output_blank_field_error(server reference) : outputs a message saying that
-# more fields need to be filled in
-# output_results(output mode,
-# server reference,
-# environment reference,
-# reply list reference) : outputs results from search
# 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.
+#
+#
+# === 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
+#
+#
+# === 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.
package Apache::lonsearchcat;
+# ------------------------------------------------- modules used by this module
use strict;
use Apache::Constants qw(:common);
use Apache::lonnet();
@@ -46,12 +111,30 @@ use Apache::File();
use CGI qw(:standard);
use Text::Query;
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
-my $closebutton;
+# ---------------------------------------- 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 %hostdomains; # matches host name to host domain
+my %hostips; # matches host name to host ip
+my %hitcount; # stores number of hits per host
+
+# -- dynamically rendered interface components
+my $closebutton; # button that closes the search window
+my $importbutton; # button to take the selected results and go to group sorting
+
+# -- miscellaneous variables
+my $scrout; # string that holds portions of the screen output
+my $fnum; # search result counter
+my $yourself; # allows for quickly limiting to oneself
+
+# ------------------------------------------ choices for different output views
+# Detailed Citation View ---> sub detailed_citation_view
+# Summary View ---> sub summary_view
+# Fielded Format ---> sub fielded_format_view
+# XML/SGML ---> sub xml_sgml_view
my $basicviewselect=<
LIMIT BY CREATION DATE RANGE:
-
LIMIT BY LAST REVISION DATE RANGE:
-
+
between:
CREATIONDATESTART
$scrout.=&dateboxes('creationdatestart',1,1,1976,
@@ -201,7 +305,7 @@ CREATIONDATEEND
between:
+
between:
LASTREVISIONDATESTART
$scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
$ENV{'form.lastrevisiondatestart_month'},
@@ -220,7 +324,6 @@ LASTREVISIONDATEEND
$scrout.=&searchphrasefield('Limit by publisher/owner','owner',
$ENV{'form.owner'});
-# $metadatafields{'owner'});
$ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
$scrout.=&selectbox('Limit by copyright/distribution','copyright',
@@ -232,9 +335,9 @@ LASTREVISIONDATEEND
LIMIT BY SPECIAL METADATA FIELDS:
For resource-specific metadata, enter in an expression in the form of
-key=value separated by operators such as AND or OR.
+key=value separated by operators such as AND or OR.
Example: grandmother=75 OR grandfather=85
-
+
CUSTOMMETADATA
$scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
$scrout.=' initial users of this system do not need to worry about this option';
@@ -245,7 +348,7 @@ $scrout.=' initial users of this syst
Enter in a space-separated list of special metadata fields to show
in a fielded listing for each record result.
-
+
CUSTOMSHOW
$scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
$scrout.=' initial users of this system do not need to worry about this option';
@@ -257,33 +360,33 @@ $scrout.=' initial users of this syst
Search Catalog
Search Results
');
+ $r->rflush();
+ my $servernum=(keys %rhash)+0;
+
+ # define server grid (shows status of multiple machines)
+ my $hcinit;
+ my $grid="'
'+";
+ $grid.="\n";
+ my $sn=1;
+ for my $sk (sort keys %rhash) {
+ # ''+
+ $grid.="'+\"'\"+')\">'+";
+ $grid.="\n";
+ $grid.="''+\n";
+ $grid.="'
'+\n" unless $sn%10;
+ $sn++;
+ }
+ $r->print(<
\n";
}
}
my $customdata='';
+ my %customhash;
foreach my $result (@results) {
if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
- $customdata.=$result;
+ my $tmp=$result;
+ $tmp=~s/^custom\=//;
+ my ($k,$v)=map {&Apache::lonnet::unescape($_);
+ } split(/\,/,$tmp);
+ $customhash{$k}=$v;
}
}
foreach my $result (@results) {
next if $result=~/^custom\=/;
chomp $result;
+ next unless $result;
my @fields=map
- {&Apache::lonnet::unescape($_)}
- (split(/\,/,$result));
+ {&Apache::lonnet::unescape($_)}
+ (split(/\,/,$result));
my ($title,$author,$subject,$url,$keywords,$version,
$notes,$abstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
my $shortabstract=$abstract;
$shortabstract=substr($abstract,0,200) if length($abstract)>200;
$fields[7]=$shortabstract;
- $compiledresult.=<
+
+END
+ $compiledresult.=<
END
my $httphost=$ENV{'HTTP_HOST'};
- my $viewselect;
- if ($mode eq 'Basic') {
+ my $viewselect;
+ if ($mode eq 'Basic') {
$viewselect=$ENV{'form.basicviewselect'};
}
- elsif ($mode eq 'Advanced') {
- $viewselect=$ENV{'form.advancedviewselect'};
- }
+ elsif ($mode eq 'Advanced') {
+ $viewselect=$ENV{'form.advancedviewselect'};
+ }
if ($viewselect eq 'Detailed Citation View') {
- $compiledresult.=&detailed_citation_view(@fields,
- $hostname,$httphost,
- $extrashow);
+ $compiledresult.=&detailed_citation_view(@fields,
+ $hostname,$httphost,
+ $extrashow2);
}
elsif ($viewselect eq 'Summary View') {
$compiledresult.=&summary_view(@fields,$hostname,$httphost,
- $extrashow);
+ $extrashow2);
}
elsif ($viewselect eq 'Fielded Format') {
$compiledresult.=&fielded_format_view(@fields,$hostname,
- $httphost,$extrashow);
+ $httphost,$extrashow2);
}
elsif ($viewselect eq 'XML/SGML') {
$compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,
- $extrashow);
+ $extrashow2);
}
-
+
}
- unless ($compiledresult) {
- $compiledresult="There were no results that matched your query";
+ if ($compiledresult) {
+ $resultflag=1;
}
- # make query information persistent to allow for subsequent revision
- my $persistent=&make_persistent();
-
- $r->print(<Search Catalog
-
-Search Query
-RESULTS
- if ($mode eq 'Basic') {
$r->print(<
-Subject: $subject
-Keyword(s): $keywords
-Notes: $notes
-MIME Type: $mimetag{$mime}
-Language: $language{$lang}
-Copyright/Distribution: $cprtag{$copyright}
+Subject: $subject
+Keyword(s): $keywords
+Notes: $notes
+MIME Type: $mimetag{$mime}
+Language: $language{$lang}
+Copyright/Distribution: $cprtag{$copyright}
@@ -979,54 +1383,52 @@ END
return $result;
}
-sub build_date_queries {
- my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
- $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
- my @queries;
- if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {
- unless ($cmonth1 and $cday1 and $cyear1 and
- $cmonth2 and $cday2 and $cyear2) {
- return "Incorrect entry for the creation date. You must specify ".
- "a starting month, day, and year and an ending month, ".
- "day, and year.";
- }
- my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);
- $cnumeric1+=0;
- my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);
- $cnumeric2+=0;
- if ($cnumeric1>$cnumeric2) {
- return "Incorrect entry for the creation date. The starting ".
- "date must occur before the ending date.";
- }
- my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".
- "$cyear2-$cmonth2-$cday2 23:59:59')";
- push @queries,$cquery;
- }
- if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {
- unless ($lmonth1 and $lday1 and $lyear1 and
- $lmonth2 and $lday2 and $lyear2) {
- return "Incorrect entry for the last revision date. You must ".
- "specify a starting month, day, and year and an ending ".
- "month, day, and year.";
- }
- my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);
- $lnumeric1+=0;
- my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);
- $lnumeric2+=0;
- if ($lnumeric1>$lnumeric2) {
- return "Incorrect entry for the last revision date. The ".
- "starting date must occur before the ending date.";
- }
- my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".
- "$lyear2-$lmonth2-$lday2 23:59:59')";
- push @queries,$lquery;
+# ---------------------------------------------------- see if a field is filled
+sub filled {
+ my ($field)=@_;
+ if ($field=~/\S/ && $field ne 'any') {
+ return 1;
}
- if (@queries) {
- return join(" AND ",@queries);
+ else {
+ return 0;
}
- return '';
}
+# ---------------- Message to output when there are not enough fields filled in
+sub output_blank_field_error {
+ my ($r)=@_;
+ # make query information persistent to allow for subsequent revision
+ my $persistent=&make_persistent();
+
+ $r->print(<
+Incorrect search query due to blank entry fields.
+You need to fill in the relevant
+fields on the search page in order for a query to be
+processed.
+
$message
@@ -1057,21 +1459,6 @@ $message
RESULTS
}
-sub make_persistent {
- my $persistent='';
-
- map {
- if (/^form\./ && !/submit/) {
- my $name=$_;
- my $key=$name;
- $ENV{$key}=~s/\'//g; # do not mess with html field syntax
- $name=~s/^form\.//;
- $persistent.=<Search Catalog
+
+Helpful Message
+Search Catalog
+
Helpful Message