--- loncom/interface/lonsearchcat.pm 2002/06/20 14:31:31 1.124
+++ loncom/interface/lonsearchcat.pm 2002/06/27 14:46:00 1.132
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.124 2002/06/20 14:31:31 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.132 2002/06/27 14:46:00 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 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,35 +344,81 @@ sub advanced_search_form{
-
Search Catalog
+
Advanced Catalog Search
+
+Enter terms or phrases separated by search operators
+such as AND, OR, or NOT.
@@ -515,7 +508,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
@@ -524,7 +518,6 @@ a 'hidden' html input tag.
sub make_persistent {
my $persistent='';
-
foreach (keys %ENV) {
if (/^form\./ && !/submit/) {
my $name=$_;
@@ -532,7 +525,7 @@ sub make_persistent {
$ENV{$key}=~s/\'//g; # do not mess with html field syntax
$name=~s/^form\.//;
$persistent.=<
+
END
}
}
@@ -574,8 +567,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 ';
}
######################################################################
@@ -675,15 +710,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',
@@ -694,7 +730,7 @@ sub advancedsearch {
'lastrevisiondatestart_year','lastrevisiondateend_month',
'lastrevisiondateend_day','lastrevisiondateend_year',
'notes','abstract','mime','language','owner',
- 'custommetadata','customshow') {
+ 'custommetadata','customshow','category') {
$ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
}
foreach ('mode','form','element') {
@@ -703,6 +739,12 @@ sub advancedsearch {
$ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
$ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
}
+ # Preprocess the category form element.
+ if ($ENV{'form.category'} ne 'any') {
+ my @extensions = &Apache::loncommon::filecategorytypes
+ ($ENV{'form.category'});
+ $ENV{'form.mime'} = join ' OR ',@extensions;
+ }
# Check to see if enough information was filled in
for my $field ('title','author','subject','keywords','url','version',
'notes','abstract','mime','language','owner',
@@ -720,18 +762,15 @@ 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});
- }
+ }
}
# Evaluate option lists
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.copyright'} and $ENV{'form.copyright'} ne 'any') {
push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
}
@@ -771,6 +810,33 @@ sub advancedsearch {
my @fields=split(/\s+/,$customshow);
$customshow=join(" ",@fields);
}
+ ##
+ ## Deal with restrictions to given domains
+ ##
+ my $libraries_to_query = undef;
+ # $ENV{'form.domains'} can be either a scalar or an array reference.
+ # We need an array.
+ my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}
+ : ($ENV{'form.domains'}) );
+ my %domain_hash = ();
+ foreach (@allowed_domains) {
+ $domain_hash{$_}++;
+ }
+ foreach (keys(%Apache::lonnet::libserv)) {
+ if ($_ eq 'any') {
+ $libraries_to_query = undef;
+ last;
+ }
+ if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
+ push @$libraries_to_query,$_;
+ }
+ }
+ if (defined($libraries_to_query)) {
+ &Apache::lonnet::logthis("libraries: @$libraries_to_query");
+ } else {
+ &Apache::lonnet::logthis("libraries: undef");
+ }
+ #
# Send query statements over the network to be processed by either the SQL
# database or a recursive scheme of 'grep'-like actions (for custom
# metadata).
@@ -779,19 +845,23 @@ sub advancedsearch {
$query="select * from metadata where $query";
my $reply; # reply hash reference
unless ($customquery or $customshow) {
- $reply=&Apache::lonnet::metadata_query($query);
+ $reply=&Apache::lonnet::metadata_query($query,undef,undef,
+ $libraries_to_query);
}
else {
$reply=&Apache::lonnet::metadata_query($query,
- $customquery,$customshow);
+ $customquery,$customshow,
+ $libraries_to_query);
}
- &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);
+ $customquery,$customshow,
+ $libraries_to_query);
+ &output_results('Advanced',$r,$customquery,$reply,$hidden);
+ return OK;
}
# should not get to this point
return 'Error. Should not have gone to this point.';
@@ -804,13 +874,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;
@@ -838,11 +909,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;
}
@@ -855,6 +927,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
######################################################################
@@ -877,14 +952,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');
@@ -899,7 +975,6 @@ sub build_custommetadata_query {
\*$2\[\^\\<\]?# *wordtwo[^\<]
\*\\<\\\/$1\\>?# *\<\/wordone\>
/g;
- &Apache::lonnet::logthis("match expression: ".$matchexp);
return $matchexp;
}
@@ -910,6 +985,8 @@ sub build_custommetadata_query {
=item &recursive_SQL_query_build()
+Recursively constructs an SQL query. Takes as input $dkey and $pattern.
+
=cut
######################################################################
@@ -954,6 +1031,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
######################################################################
@@ -1024,31 +1104,391 @@ 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;
+ 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 results header
+ $r->print(&search_results_header($mode));
+ $r->rflush();
+ # begin showing the cataloged results
+ my $action = "/adm/searchcat";
+ if ($mode eq 'Basic') {
+ $action .= "?reqinterface=basic";
+ } elsif ($mode eq 'Advanced') {
+ $action .= "?reqinterface=advanced";
+ }
+ $r->print(<
+$hidden
+
+
+$importbutton
+$closebutton
+$persistent
+
+CATALOGCONTROLS
+ #
+ # make the pop-up window for status
+ #
+ $r->print(&make_popwin(%rhash));
+ $r->rflush();
+ ##
+ ## Prepare for the main loop below
+ ##
+ my $servercount=0;
+ my $hitcountsum=0;
+ my $servernum=(keys %rhash);
+ my $serversleft=$servernum;
+ ##
+ ## Run until we run out of time or we run out of servers
+ ##
+ while($serversleft && $timeremain) {
+ ##
+ ## %rhash has servers deleted from it as results come in
+ ## (within the foreach loop below).
+ ##
+ foreach my $rkey (sort keys %rhash) {
+# &Apache::lonnet::logthis("Server $rkey:".time);
+ $servercount++;
+ $compiledresult='';
+ my $reply=$rhash{$rkey};
+ my @results;
+ if ($reply eq 'con_lost') {
+ &popwin_imgupdate($r,$rkey,"srvbad.gif");
+ $serversleft--;
+ delete $rhash{$rkey};
+ } else {
+ # must do since 'use strict' checks for tainting
+ $reply=~/^([\.\w]+)$/;
+ my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
+ $reply=~/(.*?)\_/;
+ for (my $counter=0;$counter<2;$counter++) {
+ if (-e $replyfile && ! -e "$replyfile.end") {
+ &popwin_imgupdate($r,$rkey,"srvhalf.gif");
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
+ '"still transferring..."'.';');
+ }
+ # Are we finished transferring data?
+ if (-e "$replyfile.end") {
+ $serversleft--;
+ delete $rhash{$rkey};
+ if (-s $replyfile) {
+ &popwin_imgupdate($r,$rkey,"srvgood.gif");
+ my $fh;
+ unless ($fh=Apache::File->new($replyfile)){
+ # Is it really appropriate to die on this error?
+ $r->print('ERROR: file '.
+ $replyfile.' cannot be opened');
+ return OK;
+ }
+ @results=<$fh> if $fh;
+ my $hits =@results;
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
+ $hits.';');
+ $hitcountsum+=$hits;
+ &popwin_js($r,'popwin.document.forms.popremain.'.
+ 'numhits.value='.$hitcountsum.';');
+ } else {
+ &popwin_imgupdate($r,$rkey,"srvempty.gif");
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');
+ }
+ last;
+ } # end of if ( -e "$replyfile.end")
+ last unless $timeremain;
+ sleep 1; # wait for daemons to write files?
+ $timeremain--;
+ $elapsetime++;
+ &popwin_js($r,"popwin.document.popremain.".
+ "elapsetime.value=$elapsetime;");
+ }
+ &popwin_js($r,'popwin.document.whirly.'.
+ 'src="/adm/lonIcons/lonanimend.gif";');
+ } # end of if ($reply eq 'con_lost') else statement
+ my %Fields = undef; # Holds the data to be sent to the various
+ # *_view routines.
+ my ($extrashow,$customfields,$customhash) = &handle_custom_fields(\@results);
+ my @customfields = @$customfields;
+ my %customhash = %$customhash;
+ untie %hash if (keys %hash);
+ #
+ if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ $r->print('Unable to tie hash to db '.
+ 'file');
+ } else {
+ if ($ENV{'form.launch'} eq '1') {
+ &start_fresh_session();
+ }
+ foreach my $result (@results) {
+ next if $result=~/^custom\=/;
+ chomp $result;
+ next unless $result;
+ %Fields = &parse_raw_result($result,$rkey);
+ $Fields{'extrashow'}=$extrashow;
+ if ($extrashow) {
+ foreach my $field (@customfields) {
+ my $value='';
+ $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);
+ $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;
+ }
+ }
+ $compiledresult.="\n
-