--- loncom/interface/lonsearchcat.pm 2002/06/20 19:43:50 1.125
+++ loncom/interface/lonsearchcat.pm 2002/06/26 16:04:13 1.130
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.125 2002/06/20 19:43:50 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.130 2002/06/26 16:04:13 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -67,14 +67,14 @@ search (on a server basis) is displayed
###############################################################################
###############################################################################
+###############################################################################
## ##
## 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 ##
+## 2. Variables used throughout the module ##
+## 3. handler subroutine called via Apache and mod_perl ##
+## 4. Other subroutines ##
## ##
###############################################################################
@@ -101,18 +101,6 @@ use Apache::loncommon();
=over 4
-=item %hostdomains
-
-matches host name to host domain
-
-=item %hostips
-
-matches host name to host ip
-
-=item %hitcount
-
-stores number of hits per host
-
=item $closebutton
button that closes the search window
@@ -137,46 +125,13 @@ used in &handler() and is also used in &
######################################################################
######################################################################
-# -- information holders
-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 $yourself; # allows for quickly limiting to oneself
my %hash; # database hash
-
-# ------------------------------------------ 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
-
-#------------------------------------------------------------- global variables
-my $diropendb = "";
-my $domain = "";
-
-# ----------------------------------------------------------------------- BEGIN
-
-=pod
-
-=item BEGIN block
-
-Load %hostdomains and %hostips with data from lonnet.pm. Only library
-servers are considered.
-
-=cut
-
-BEGIN {
- foreach (keys (%Apache::lonnet::libserv)) {
- $hostdomains{$_}=$Apache::lonnet::hostdom{$_};
- $hostips{$_}=$Apache::lonnet::hostip{$_};
- }
-}
+my $diropendb = ""; # db file
######################################################################
######################################################################
@@ -268,10 +223,10 @@ END
##
if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
# Perform basic search and give results
- return &basicsearch($r,\%ENV,$hidden);
+ return &basicsearch($r,$hidden);
} elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
# Perform advanced search and give results
- return &advancedsearch($r,\%ENV,$hidden);
+ return &advancedsearch($r,$hidden);
} elsif ($ENV{'form.reqinterface'} eq 'advanced') {
# Output the advanced interface
$r->print(&advanced_search_form($closebutton,$hidden));
@@ -318,7 +273,8 @@ sub basic_search_form{
$hidden
Basic Search
-Enter terms or phrases separated by AND, OR, or NOT then press SEARCH below.
+Enter terms or quoted phrases separated by AND, OR, or NOT
+then press SEARCH below.
@@ -334,15 +290,14 @@ ENDDOCUMENT
$closebutton
-
-
@@ -367,6 +322,14 @@ Returns a scalar which holds html for th
sub advanced_search_form{
my ($closebutton,$hidden) = @_;
+ my $advanced_buttons = <<"END";
+
+
+
+$closebutton
+
+
+END
my $scrout=<<"ENDHEADER";
@@ -381,34 +344,56 @@ sub advanced_search_form{
-
Search Catalog
+
Advanced Catalog Search
+
+Enter terms or quoted phrases separated by search operators
+such as AND, OR, or NOT.
@@ -515,7 +484,8 @@ ENDDOCUMENT
=item &make_persistent()
Returns a scalar which holds the current ENV{'form.*'} values in
-a 'hidden' html input tag.
+a 'hidden' html input tag. This allows search interface information
+to be somewhat persistent.
=cut
@@ -573,8 +543,52 @@ is where the $name and $value are used)
=item &dateboxes()
+Returns html selection form elements for the specification of
+the day, month, and year.
+
=item &selectbox()
+Returns a scalar containing an html form.
+
+Inputs:
+
+=over 4
+
+=item $title
+
+Printed above the select box, in uppercase.
+
+=item $name
+
+The name element of the tag.
+
+=item $default
+
+The default value of the form. Can be $anyvalue or in @idlist.
+
+=item $anyvalue
+
+The ';
}
else {$selout.='>'.&{$functionref}($_).'';}
}
- return $selout.'';
+ return $selout.'';
}
######################################################################
@@ -674,15 +686,16 @@ sub selectbox {
=pod
-=item &advancedsearch()
+=item &advancedsearch()
+
+Parse advanced search results.
=cut
######################################################################
######################################################################
sub advancedsearch {
- my ($r,$envhash,$hidden)=@_;
- my %ENV=%{$envhash};
+ my ($r,$hidden)=@_;
my $fillflag=0;
# Clean up fields for safety
for my $field ('title','author','subject','keywords','url','version',
@@ -719,7 +732,7 @@ sub advancedsearch {
my @queries;
# Evaluate logical expression AND/OR/NOT phrase fields.
foreach my $field ('title','author','subject','notes','abstract','url',
- 'keywords','version','owner') {
+ 'keywords','version','owner','mime') {
if ($ENV{'form.'.$field}) {
push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
}
@@ -728,9 +741,9 @@ sub advancedsearch {
if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
push @queries,"(language like \"$ENV{'form.language'}\")";
}
- if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
- push @queries,"(mime like \"$ENV{'form.mime'}\")";
- }
+# if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
+# push @queries,"(mime like \"$ENV{'form.mime'}\")";
+# }
if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
}
@@ -784,13 +797,14 @@ sub advancedsearch {
$reply=&Apache::lonnet::metadata_query($query,
$customquery,$customshow);
}
- &output_results('Advanced',$r,$envhash,$customquery,$reply,$hidden);
- }
- elsif ($customquery) {
+ &output_results('Advanced',$r,$customquery,$reply,$hidden);
+ return OK;
+ } elsif ($customquery) {
my $reply; # reply hash reference
$reply=&Apache::lonnet::metadata_query('',
$customquery,$customshow);
- &output_results('Advanced',$r,$envhash,$customquery,$reply,$hidden);
+ &output_results('Advanced',$r,$customquery,$reply,$hidden);
+ return OK;
}
# should not get to this point
return 'Error. Should not have gone to this point.';
@@ -803,13 +817,14 @@ sub advancedsearch {
=item &basicsearch()
+Parse basic search form.
+
=cut
######################################################################
######################################################################
sub basicsearch {
- my ($r,$envhash,$hidden)=@_;
- my %ENV=%{$envhash};
+ my ($r,$hidden)=@_;
# Clean up fields for safety
for my $field ('basicexp') {
$ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
@@ -837,11 +852,12 @@ sub basicsearch {
$query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
# Get reply (either a hash reference to filehandles or bad connection)
+# &Apache::lonnet::logthis("metadata query started:".time);
my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);
-
+# &Apache::lonnet::logthis("metadata query finished:".time);
# Output search results
- &output_results('Basic',$r,$envhash,$query,$reply,$hidden);
+ &output_results('Basic',$r,$query,$reply,$hidden);
return OK;
}
@@ -854,6 +870,9 @@ sub basicsearch {
=item &build_SQL_query()
+Builds a SQL query string from a logical expression with AND/OR keywords
+using Text::Query and &recursive_SQL_query_builder()
+
=cut
######################################################################
@@ -876,14 +895,15 @@ sub build_SQL_query {
=item &build_custommetadata_query()
+Constructs a custom metadata query using a rather heinous regular
+expression.
+
=cut
######################################################################
######################################################################
sub build_custommetadata_query {
my ($field_name,$logic_statement)=@_;
- &Apache::lonnet::logthis("Entered build_custommetadata_query:".
- $field_name.':'.$logic_statement);
my $q=new Text::Query('abc',
-parse => 'Text::Query::ParseAdvanced',
-build => 'Text::Query::BuildAdvancedString');
@@ -898,7 +918,6 @@ sub build_custommetadata_query {
\*$2\[\^\\<\]?# *wordtwo[^\<]
\*\\<\\\/$1\\>?# *\<\/wordone\>
/g;
- &Apache::lonnet::logthis("match expression: ".$matchexp);
return $matchexp;
}
@@ -909,6 +928,8 @@ sub build_custommetadata_query {
=item &recursive_SQL_query_build()
+Recursively constructs an SQL query. Takes as input $dkey and $pattern.
+
=cut
######################################################################
@@ -953,6 +974,9 @@ sub recursive_SQL_query_build {
=item &build_date_queries()
+Builds a SQL logic query to check time/date entries.
+Also reports errors (check for /^Incorrect/).
+
=cut
######################################################################
@@ -1023,30 +1047,31 @@ contacted, etc.)
######################################################################
######################################################################
sub output_results {
+# &Apache::lonnet::logthis("output_results:".time);
my $fnum; # search result counter
- my ($mode,$r,$envhash,$query,$replyref,$hidden)=@_;
- my %ENV=%{$envhash};
+ my ($mode,$r,$query,$replyref,$hidden)=@_;
my %rhash=%{$replyref};
my $compiledresult='';
my $timeremain=300; # (seconds)
my $elapsetime=0;
my $resultflag=0;
my $tflag=1;
+ my $viewselect=$ENV{'form.viewselect'};
#
# make query information persistent to allow for subsequent revision
my $persistent=&make_persistent();
- # spit out the generic header
- $r->print(&search_results_header());
+ # spit out the results header
+ $r->print(&search_results_header($mode));
$r->rflush();
# begin showing the cataloged results
- $r->print(<
-
-
-