--- loncom/interface/lonsearchcat.pm 2002/07/09 17:27:11 1.140 +++ loncom/interface/lonsearchcat.pm 2002/07/26 16:37:58 1.144 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.140 2002/07/09 17:27:11 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.144 2002/07/26 16:37:58 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -87,8 +87,10 @@ use Apache::lonnet(); use Apache::File(); use CGI qw(:standard); use Text::Query; +use DBI; use GDBM_File; use Apache::loncommon(); +use Apache::lonmysql(); # ---------------------------------------- variables used throughout the module @@ -109,9 +111,9 @@ button that closes the search window button to take the select results and go to group sorting -=item %hash +=item %groupsearch_db -The ubiquitous database hash +Database hash used to save values for the groupsearch RAT interface. =item $diropendb @@ -125,6 +127,10 @@ that produces it. Adding a new view typ adding a line to the definition of this hash and making sure the function takes the proper parameters. +=item $results_db + +The name of the database results from searches are put in. + =back =cut @@ -137,9 +143,10 @@ my $closebutton; # button that closes t my $importbutton; # button to take the selected results and go to group sorting # -- miscellaneous variables -my %hash; # database hash +my %groupsearch_db; # database hash my $diropendb = ""; # db file +my $results_db = ""; # View Description Function Pointer my %Views = ("Detailed Citation View" => \&detailed_citation_view, "Summary View" => \&summary_view, @@ -173,26 +180,29 @@ string that holds portions of the screen ###################################################################### sub handler { my $r = shift; - untie %hash; + untie %groupsearch_db; $r->content_type('text/html'); $r->send_http_header; return OK if $r->header_only; - + ## + ## Initialize global variables + ## my $domain = $r->dir_config('lonDefDomain'); $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain). "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db"; - + $results_db = "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain). + '_'.&Apache::lonnet::escape($ENV{'user.name'})."_searchresults.db"; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['catalogmode','launch','acts','mode','form','element', 'reqinterface']); ## - ## Clear out old values from database + ## Clear out old values from groupsearch database ## if ($ENV{'form.launch'} eq '1') { - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { &start_fresh_session(); - untie %hash; + untie %groupsearch_db; } else { $r->print('Unable to tie hash to db '. 'file'); @@ -239,20 +249,23 @@ END # We are running a search my ($query,$customquery,$customshow,$libraries) = (undef,undef,undef,undef); + my $pretty_string; if ($searchtype eq 'Basic') { - $query = &parse_basic_search($r); + ($query,$pretty_string) = &parse_basic_search($r); } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - ($query,$customquery,$customshow,$libraries) + ($query,$customquery,$customshow,$libraries,$pretty_string) = &parse_advanced_search($r); return OK if (! defined($query)); } - # 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). + # Output some information to the user. + $r->print(&search_results_header($searchtype,$pretty_string)); + $r->print("Sending search request to LON-CAPA servers.
\n"); + $r->rflush(); + &run_search($r,$query,$customquery,$customshow,$libraries); + &display_results($r,$searchtype,$hidden,$importbutton, + $closebutton); + $r->rflush(); - my $reply=&Apache::lonnet::metadata_query($query,$customquery, - $customshow,$libraries); - &output_results($searchtype,$r,$reply,$hidden); } else { # # We need to get information to search on @@ -318,8 +331,11 @@ ENDDOCUMENT ' '; # $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'}); # $scrout.='Search historic archives'; + my $checkbox = &simplecheckbox('related',$ENV{'form.related'}); $scrout.=<Advanced Search +Advanced Search +$checkbox use related words +

   @@ -394,19 +410,24 @@ ENDHEADER $ENV{'form.viewselect'}, undef,undef,undef, sort(keys(%Views))); - $scrout.="\n"; - $scrout.=&searchphrasefield('title', 'title' ,$ENV{'form.title'}); + $scrout.="Related
Words\n"; + $scrout.=&searchphrasefield_with_related('title', 'title' , + $ENV{'form.title'}); $scrout.=&searchphrasefield('author', 'author' ,$ENV{'form.author'}); - $scrout.=&searchphrasefield('subject', 'subject' ,$ENV{'form.subject'}); - $scrout.=&searchphrasefield('keywords','keywords',$ENV{'form.keywords'}); + $scrout.=&searchphrasefield_with_related('subject', 'subject' , + $ENV{'form.subject'}); + $scrout.=&searchphrasefield_with_related('keywords','keywords', + $ENV{'form.keywords'}); $scrout.=&searchphrasefield('URL', 'url' ,$ENV{'form.url'}); - $scrout.=&searchphrasefield('notes', 'notes' ,$ENV{'form.notes'}); - $scrout.=&searchphrasefield('abstract','abstract',$ENV{'form.abstract'}); + $scrout.=&searchphrasefield_with_related('notes', 'notes' , + $ENV{'form.notes'}); + $scrout.=&searchphrasefield_with_related('abstract','abstract', + $ENV{'form.abstract'}); # Hack - an empty table row. - $scrout.="  \n"; + $scrout.="   \n"; $scrout.=&searchphrasefield('file
extension','mime', $ENV{'form.mime'}); - $scrout.="  \n"; + $scrout.="   \n"; $scrout.=&searchphrasefield('publisher
owner','owner', $ENV{'form.owner'}); $scrout.="\n"; @@ -549,13 +570,13 @@ to be somewhat persistent. sub make_persistent { my %save = %{shift()}; my $persistent=''; - foreach (keys %save) { - if (/^form\./ && !/submit/) { - my $name=$_; + foreach my $name (keys %save) { + if ($name =~ /^form\./ && $name !~ /submit/) { my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); $name=~s/^form\.//; foreach (@values) { s/\"/\'/g; # do not mess with html field syntax + next if (! $_ ); $persistent.=< END @@ -565,8 +586,8 @@ END return $persistent; } - ###################################################################### +# HTML form building functions # ###################################################################### =pod @@ -575,6 +596,13 @@ END =over 4 +=cut + +############################################### +############################################### + +=pod + =item &simpletextfield() Inputs: $name,$value,$size @@ -582,6 +610,23 @@ Inputs: $name,$value,$size Returns a text input field with the given name, value, and size. If size is not specified, a value of 20 is used. +=cut + +############################################### +############################################### + +sub simpletextfield { + my ($name,$value,$size)=@_; + $size = 20 if (! defined($size)); + return ''; +} + +############################################### +############################################### + +=pod + =item &simplecheckbox() Inputs: $name,$value @@ -589,92 +634,106 @@ Inputs: $name,$value Returns a simple check box with the given $name. If $value eq 'on' the box is checked. -=item &searchphrasefield() +=cut -Inputs: $title,$name,$value +############################################### +############################################### -Returns html for a title line and an input field for entering search terms. -the instructions "Enter terms or phrases separated by search operators such -as AND, OR, or NOT." are given following the title. The entry field (which -is where the $name and $value are used) is an 80 column simpletextfield. +sub simplecheckbox { + my ($name,$value)=@_; + my $checked=''; + $checked="checked" if $value eq 'on'; + return ''; +} -=item &dateboxes() +############################################### +############################################### -Returns html selection form elements for the specification of -the day, month, and year. +=pod -=item &selectbox() +=item &fieldtitle() -Returns a scalar containing an html tag. +=pod -=item $default +=item &searchphrasefield() -The default value of the form. Can be $anyvalue, or in @idlist. +Inputs: $title,$name,$value -=item $anyvalue +Returns html for a title line and an input field for entering search terms. +The entry field (which is where the $name and $value are used) is a 50 column +simpletextfield. The html returned is for a row in a three column table. -The 

".$string."
\n"); + $r->rflush(); + return; +} + +###################################################################### +###################################################################### + +=pod + +=item &run_search + +=cut + +###################################################################### +###################################################################### +sub run_search { + my ($r,$query,$customquery,$customshow,$serverlist) = @_; + # + my @Servers_to_contact; + if (defined($serverlist)) { + @Servers_to_contact = @$serverlist; + } else { + @Servers_to_contact = sort(keys(%Apache::lonnet::libserv)); + } + my %Server_status; + # + # Timing variables + my $starttime = time; + my $max_time = 120; # seconds for the search to complete + # + # Create Table + ##################################### + my $table = &Apache::lonmysql::create_table + ( { columns => \%Datatypes, + column_order => \@DataOrder, + } ); + if (! defined($table)) { + # What do I do now? Print out an error page. + &Apache::lonnet::logthis("lonmysql attempted to create a table ". + "and this was the result:". + &Apache::lonmysql::get_error()); + $r->print("An internal error occured with the database.
". + "The error has been logged, but you should probably alert". + " your system administrator."); + return; + } + $ENV{'form.table'}=$table; + # + ##################################### + my $hitcountsum; + my $server; + my $status; + while ((time - $starttime < $max_time) && + ((@Servers_to_contact) || keys(%Server_status))) { + # Send out a search request if it needs to be done. + if (@Servers_to_contact) { + # Contact one server + my $server = shift(@Servers_to_contact); + my $reply=&Apache::lonnet::metadata_query($query,$customquery, + $customshow,[$server]); + # We should let the user know we have contacted another server + ($server) = keys(%$reply); + $Server_status{$server} = $reply->{$server}; + # &write_status($r,"Contacted:$server:reply:". + # $Server_status{$server}); + # Hmmm, should we add to $max_time if we contact a server? + } else { + sleep(1); # wait a sec. to give time for files to be written + } + while (my ($server,$status) = each(%Server_status)) { + if ($status eq 'con_lost') { + delete ($Server_status{$server}); + # &write_status($r,"Removing $server"); + next; + } + $status=~/^([\.\w]+)$/; + my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1; + if (-e $datafile && ! -e "$datafile.end") { + # Let the user know we are receiving data from the server + &write_status($r,"$server:Receiving file"); + next; + } + if (-e "$datafile.end") { + if (-z "$datafile") { + delete($Server_status{$server}); + next; + } + my $fh; + if (!($fh=Apache::File->new($datafile))) { + # Error opening file... + # Tell the user and exit...? + # Should I give up on opening it? + &write_status("Unable to open $datafile"); + next; + } + # Read in the whole file. + while (my $result = <$fh>) { + # handle custom fields? Someday we will! + chomp($result); + next unless $result; + # Parse the result. + my %Fields = &parse_raw_result($result,$server); + $Fields{'hostname'} = $server; + next if (! ©right_check(\%Fields)); + # Store the result in the mysql database + my $result = &Apache::lonmysql::store_row($table,\%Fields); + if (! defined($result)) { + &write_status($r,&Apache::lonmysql::get_error()); + } + # &write_status($r,&Apache::lonmysql::get_debug()); + $hitcountsum ++; + } # End of foreach (@results) + $fh->close(); + # $server is only deleted if the results file has been + # found and (successfully) opened. This may be a bad idea. + delete($Server_status{$server}); + } + } + # Finished looping through the servers + } + &Apache::lonmysql::disconnect_from_db(); + # We have run out of time or run out of servers to talk to and + # results to get. + if ($hitcountsum > 0) { + $r->print("

Total results = $hitcountsum

"); + } + return; +} + +###################################################################### +###################################################################### +=pod + +=item &display_buttons + +=cut + +###################################################################### +###################################################################### +sub display_buttons { + my ($low,$high,$otherparms) = @_; + my $maxshow = 20; + my $lowest = ($low - $maxshow < 0 ? 0 : $low-$maxshow); + my $highest = $high + $maxshow; + my ($previous,$current,$next); + if ($lowest < $low) { + $previous = qq{prev}; + } else { + $previous = "prev"; + } + $current = qq{reload}; + $next = qq{next}; + my $result = $previous." ".$current." ".$next; + return $result; +} +###################################################################### +###################################################################### + +=pod + +=item &display_results + +=cut + +###################################################################### +###################################################################### +sub display_results { + my ($r,$mode,$hidden,$importbutton,$closebutton) = @_; + ## + ## Set viewing function + ## + my $viewfunction = $Views{$ENV{'form.viewselect'}}; + if (!defined($viewfunction)) { + $r->print("Internal Error - Bad view selected.\n"); + $r->rflush(); + return; + } + ## + ## make query information persistent to allow for subsequent revision + ## + my $persistent=&make_persistent(\%ENV); + ## + ## Get the catalog controls setup + ## + 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 + if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + $r->print('Unable to tie hash to db file'); + $r->rflush(); + return; + } + # + my $fnum; + # For now, just query the whole lot and spit them out. + my $table = $ENV{'form.table'}; + my $connection_result = &Apache::lonmysql::connect_to_db(); + if (!defined($connection_result)) { + &write_status($r,&Apache::lonmysql::get_error()); + } + my @Results = &Apache::lonmysql::get_rows($table,'id>=0'); + #&write_status($r,&Apache::lonmysql::get_debug()); + #&write_status($r,&Apache::lonmysql::get_error()); + foreach my $row (@Results) { + my %Fields = %{&parse_row(@$row)}; + my $output="\n

\n"; + if ($ENV{'form.catalogmode'} eq 'interactive') { + my $titleesc=$Fields{'title'}; + $titleesc=~s/\'/\\'/; # ' + if ($ENV{'form.catalogmode'} eq 'interactive') { + $output.=< + +
+END + } + } + if ($ENV{'form.catalogmode'} eq 'groupsearch') { + $fnum+=0; + $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'}; + $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'}; + $output.=< + + +
+END +# +# + $fnum++; + } + # Render the result into html + $output.= &$viewfunction(%Fields); + if ($output) { + $output.="

"; + } + $r->print($output); + $r->rflush(); + } + if (@Results < 1) { + $r->print("There were no results matching your query"); + } + $r->print(""); + $r->rflush(); + untie %groupsearch_db; + return; +} + +###################################################################### +###################################################################### + +=pod + +=item &parse_row + +Parse a row returned from the database. + +=cut + +###################################################################### +###################################################################### +sub parse_row { + my @Row = @_; + my %Fields; + for (my $i=0;$i<=$#Row;$i++) { + $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]); + } + $Fields{'language'} = + &Apache::loncommon::languagedescription($Fields{'lang'}); + $Fields{'copyrighttag'} = + &Apache::loncommon::copyrightdescription($Fields{'copyright'}); + $Fields{'mimetag'} = + &Apache::loncommon::filedescription($Fields{'mime'}); + return \%Fields; +} +###################################################################### +###################################################################### + =pod =item &output_results() @@ -1147,7 +1746,6 @@ sub output_results { my $persistent=&make_persistent(\%ENV); # # Begin producing output - $r->print(&search_results_header($mode)); $r->rflush(); # # begin showing the cataloged results @@ -1250,9 +1848,9 @@ CATALOGCONTROLS &handle_custom_fields(\@results); my @customfields = @$customfields; my %customhash = %$customhash; - untie %hash if (keys %hash); + untie %groupsearch_db if (tied %groupsearch_db); # - if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { $r->print('Unable to tie hash to db '. 'file'); } else { @@ -1300,8 +1898,8 @@ END } if ($ENV{'form.catalogmode'} eq 'groupsearch') { $fnum+=0; - $hash{"pre_${fnum}_link"}=$Fields{'url'}; - $hash{"pre_${fnum}_title"}=$Fields{'title'}; + $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'}; + $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'}; $compiledresult.=<

$title

END + if ($pretty_query) { + $result .= "

Search query: $pretty_query

"; + } return $result; } @@ -1968,7 +2570,7 @@ RESULTS =item &start_fresh_session() -Cleans the global %hash by removing all fields which begin with +Cleans the global %groupsearch_db by removing all fields which begin with 'pre_' or 'store'. =cut @@ -1976,13 +2578,13 @@ Cleans the global %hash by removing all ###################################################################### ###################################################################### sub start_fresh_session { - delete $hash{'mode_catalog'}; - foreach (keys %hash) { + delete $groupsearch_db{'mode_catalog'}; + foreach (keys %groupsearch_db) { if ($_ =~ /^pre_/) { - delete $hash{$_}; + delete $groupsearch_db{$_}; } if ($_ =~ /^store/) { - delete $hash{$_}; + delete $groupsearch_db{$_}; } } }