--- loncom/interface/lonsearchcat.pm 2002/07/29 21:53:57 1.146 +++ loncom/interface/lonsearchcat.pm 2002/08/01 14:11:57 1.150 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.146 2002/07/29 21:53:57 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.150 2002/08/01 14:11:57 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,14 +25,6 @@ # # 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,12/16 Scott Harrison -# YEAR=2002 -# 1/17 Scott Harrison -# 6/17 Matthew Hall -# ############################################################################### ############################################################################### @@ -140,7 +132,8 @@ my $diropendb = ""; # db file my %Views = ("Detailed Citation View" => \&detailed_citation_view, "Summary View" => \&summary_view, "Fielded Format" => \&fielded_format_view, - "XML/SGML" => \&xml_sgml_view ); + "XML/SGML" => \&xml_sgml_view, + "Compact View" => \&compact_view); my %persistent_db; my $hidden_fields; ###################################################################### @@ -191,7 +184,7 @@ sub handler { ## this once, so the pause indicator is deleted ## if (exists($ENV{'form.pause'})) { - sleep(5); + sleep(3); delete($ENV{'form.pause'}); } ## @@ -204,7 +197,8 @@ sub handler { # set the name of the persistent database # $ENV{'form.persistent_db_id'} can only have digits in it. if (! exists($ENV{'form.persistent_db_id'}) || - $ENV{'form.persistent_db_id'} =~ /\D/ ) { + ($ENV{'form.persistent_db_id'} =~ /\D/) || + ($ENV{'form.launch'} eq '1')) { $ENV{'form.persistent_db_id'} = time; } my $persistent_db_file = "/home/httpd/perl/tmp/". @@ -212,13 +206,30 @@ sub handler { '_'.&Apache::lonnet::escape($ENV{'user.name'}). '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db'; ## - &get_persistent_form_data($r,$persistent_db_file); + if (! &get_persistent_form_data($r,$persistent_db_file)) { + if ($ENV{'form.phase'} =~ /(run_search|results)/) { + &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ". + "from $persistent_db_file"); + $r->print(< +LON-CAPA Search Error + +We were unable to retrieve data describing your search. This is a serious +error and has been logged. Please alert your LON-CAPA administrator. + + +END + return OK; + } + } ## ## Clear out old values from groupsearch database ## untie %groupsearch_db if (tied(%groupsearch_db)); - if ($ENV{'form.launch'} eq '1') { - if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + if ($ENV{'form.launch'} eq '1' && + ($ENV{'form.catalogmode'} eq 'groupsearch') && + ($ENV{'form.phase'} eq 'results')) { + if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { &start_fresh_session(); untie %groupsearch_db; } else { @@ -228,18 +239,45 @@ sub handler { } } ## - ## Configure dynamic components of interface + ## Configure hidden fields ## $hidden_fields = ''; + $ENV{'form.persistent_db_id'}.'" />'."\n"; + if (exists($ENV{'form.catalogmode'})) { + $hidden_fields .= ''."\n"; + } + if (exists($ENV{'form.form'})) { + $hidden_fields .= ''."\n"; + } + if (exists($ENV{'form.element'})) { + $hidden_fields .= ''."\n"; + } + if (exists($ENV{'form.mode'})) { + $hidden_fields .= ''."\n"; + } + ## + ## Configure dynamic components of interface ## if ($ENV{'form.catalogmode'} eq 'interactive') { - $closebutton=""."\n"; + $closebutton=" -END + $closebutton=" @@ -252,9 +290,14 @@ END ## Sanity checks on form elements ## if (!defined($ENV{'form.viewselect'})) { - $ENV{'form.viewselect'} ="Detailed Citation View"; + if (($ENV{'form.catalogmode'} eq 'groupsearch') || + ($ENV{'form.catalogmode'} eq 'interactive')) { + $ENV{'form.viewselect'} ="Compact View"; + } else { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } } - $ENV{'form.phase'} = 'displaybasic' if (! exists($ENV{'form.phase'})); + $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'})); ## ## Switch on the phase ## @@ -269,23 +312,32 @@ END &get_persistent_data($persistent_db_file, ['query','customquery','customshow', 'libraries','pretty_string']); - &write_status($r,"query = $query"); - &write_status($r,"customquery = $customquery"); - &write_status($r,"customshow = $customshow"); - &write_status($r,"libraries = $libraries"); - &write_status($r,"pretty_string = $pretty_string"); &run_search($r,$query,$customquery,$customshow, $libraries,$pretty_string); } elsif(($ENV{'form.phase'} eq 'basic_search') || ($ENV{'form.phase'} eq 'adv_search')) { # Set up table if (! defined(&create_results_table())) { - # Unable to make table to store results in. - # Definately abort search. + $r->print(<Search Error + +Unable to create table in which to store search results. +The search has been aborted. + + +END + return OK; } + delete($ENV{'form.launch'}); if (! &make_form_data_persistent($r,$persistent_db_file)) { - # Unable to store persistent data. - # Probably should bail out. + $r->print(<Search Error + +Unable to properly store search information. The search has been aborted. + + +END + return OK; } # # We are running a search @@ -299,11 +351,6 @@ END = &parse_advanced_search($r,$closebutton); return OK if (! defined($query)); } - &write_status($r,"query = $query"); - &write_status($r,"customquery = $customquery"); - &write_status($r,"customshow = $customshow"); - &write_status($r,"libraries = $libraries"); - &write_status($r,"pretty_string = $pretty_string"); &make_persistent($r, { query => $query, customquery => $customquery, @@ -364,8 +411,6 @@ then press SEARCH below. ENDDOCUMENT $scrout.=' '.&simpletextfield('basicexp',$ENV{'form.basicexp'},40). ' '; -# $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'}); -# $scrout.='Search historic archives'; my $checkbox = &simplecheckbox('related',$ENV{'form.related'}); $scrout.=<Advanced Search @@ -608,9 +653,9 @@ to them. sub get_persistent_form_data { my $r = shift; my $filename = shift; - return undef if (! -e $filename); + return 0 if (! -e $filename); return undef if (! tie(%persistent_db,'GDBM_File',$filename, - &GDBM_READER,0640)); + &GDBM_READER(),0640)); # # These make sure we do not get array references printed out as 'values'. my %arrays_allowed = ('form.category'=>1,'form.domains'=>1); @@ -637,7 +682,6 @@ sub get_persistent_form_data { $ENV{$name} = $values[0] if ($values[0]); } } - &write_status($r,"Reconstructed $name = $ENV{$name}"); } untie (%persistent_db); return 1; @@ -668,7 +712,7 @@ sub get_persistent_data { my @Values; # Return array return undef if (! -e $filename); return undef if (! tie(%persistent_db,'GDBM_File',$filename, - &GDBM_READER,0640)); + &GDBM_READER(),0640)); foreach my $name (@Vars) { if (! exists($persistent_db{$name})) { push @Values, undef; @@ -709,7 +753,7 @@ sub make_persistent { my %save = %{shift()}; my $filename = shift; return undef if (! tie(%persistent_db,'GDBM_File', - $filename,&GDBM_WRCREAT,0640)); + $filename,&GDBM_WRCREAT(),0640)); foreach my $name (keys(%save)) { next if (! exists($save{$name})); next if (! defined($save{$name}) || $save{$name} eq ''); @@ -717,7 +761,6 @@ sub make_persistent { # We handle array references, but not recursively. my $store = join(',', map { &Apache::lonnet::escape($_); } @values ); $persistent_db{$name} = $store; - &write_status($r,"Stored $name = $store"); } untie(%persistent_db); return 1; @@ -745,7 +788,7 @@ sub make_form_data_persistent { my $filename = shift; my %save; foreach (keys(%ENV)) { - next if (! /^form/ || /submit/); + next if (!/^form/ || /submit/); $save{$_} = $ENV{$_}; } return &make_persistent($r,\%save,$filename); @@ -1527,9 +1570,7 @@ the following format: ## columns of type 'enum' cannot be used for FULLTEXT. ## my @DataOrder = qw/id title author subject url keywords version notes - abstract mime lang owner copyright creationdate lastrevisiondate hostname - idx_title idx_author idx_subject idx_abstract idx_mime idx_language - idx_owner idx_copyright/; + abstract mime lang owner copyright creationdate lastrevisiondate hostname/; my %Datatypes = ( id =>{ type => 'INT', @@ -1555,16 +1596,11 @@ my %Datatypes = creationdate =>{ type=>'DATETIME'}, lastrevisiondate =>{ type=>'DATETIME'}, #-------------------------------------------------- - idx_title =>{ type=>'FULLTEXT', target=>'title'}, - idx_author =>{ type=>'FULLTEXT', target=>'author'}, - idx_subject =>{ type=>'FULLTEXT', target=>'subject'}, - idx_abstract =>{ type=>'FULLTEXT', target=>'abstract'}, - idx_mime =>{ type=>'FULLTEXT', target=>'mime'}, - idx_language =>{ type=>'FULLTEXT', target=>'lang'}, - idx_owner =>{ type=>'FULLTEXT', target=>'owner'}, - idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'}, ); +my @Fullindicies = + qw/title author subject abstract mime language owner copyright/; + ###################################################################### ###################################################################### @@ -1587,6 +1623,7 @@ sub create_results_table { my $table = &Apache::lonmysql::create_table ( { columns => \%Datatypes, column_order => \@DataOrder, + fullindex => \@Fullindicies, } ); if (defined($table)) { $ENV{'form.table'} = $table; @@ -1594,24 +1631,58 @@ sub create_results_table { } return undef; # Error... } + ###################################################################### ###################################################################### =pod -=item &write_status() +=item Search Status update functions + +Each of the following functions changes the values of one of the +input fields used to display the search status to the user. The names +should be explanatory. + +Inputs: Apache request handler ($r), text to display. + +Returns: Nothing. + +=over 4 + +=item &update_count_status() + +=item &update_status() + +=item &update_seconds() + +=back =cut ###################################################################### ###################################################################### -sub write_status { - my ($r,$string) = @_; - $string =~ s/(\')/\$1/g; - $string =~ s/\n//sg; -# $r->print("\n"); -# $r->rflush(); - return; +sub update_count_status { + my ($r,$text) = @_; + $text =~ s/\'/\\\'/g; + $r->print + ("\n"); + $r->rflush(); +} + +sub update_status { + my ($r,$text) = @_; + $text =~ s/\'/\\\'/g; + $r->print + ("\n"); + $r->rflush(); +} + +sub update_seconds { + my ($r,$text) = @_; + $text =~ s/\'/\\\'/g; + $r->print + ("\n"); + $r->rflush(); } ###################################################################### @@ -1627,6 +1698,7 @@ sub write_status { ###################################################################### sub run_search { my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_; + my $connection = $r->connection; # # Timing variables # @@ -1636,7 +1708,7 @@ sub run_search { # Print run_search header # $r->print("Search Status"); - $r->print("Search: ".$pretty_string."
\n"); + $r->print("Search: ".$pretty_string."\n"); $r->rflush(); # # Determine the servers we need to contact. @@ -1649,14 +1721,23 @@ sub run_search { } my %Server_status; my $table =$ENV{'form.table'}; - 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:". + if (! defined($table) || $table eq '' || $table =~ /\D/ ) { + $r->print("Unable to determine table id to store search results in.". + "The search has been aborted."); + return; + } + my $table_status = &Apache::lonmysql::check_table($table); + if (! defined($table_status)) { + $r->print("Unable to determine status of table."); + &Apache::lonnet::logthis("Bogus table id of $table for ". + "$ENV{'user.name'} @ $ENV{'user.domain'}"); + &Apache::lonnet::logthis("lonmysql error = ". &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; + } + if (! $table_status) { + $r->print("The table id,$table, we tried to use is invalid.". + "The search has been aborted."); return; } ## @@ -1665,7 +1746,24 @@ sub run_search { my $hitcountsum; my $server; my $status; - while ((time - $starttime < $max_time) && + $r->print(< + + + + + + + + +
StatusTotal MatchesTime Remaining
+ +END + $r->rflush(); + my $time_remaining = $max_time - (time - $starttime) ; + my $last_time = $time_remaining; + &update_seconds($r,$time_remaining); + while (($time_remaining > 0) && ((@Servers_to_contact) || keys(%Server_status))) { # Send out a search request if it needs to be done. if (@Servers_to_contact) { @@ -1675,45 +1773,44 @@ sub run_search { $customshow,[$server]); ($server) = keys(%$reply); $Server_status{$server} = $reply->{$server}; - # $r->print("Contacted:$server:reply:$Server_status{$server}"); - if ($max_time - (time - $starttime) < 20) { - # If there are less than 20 seconds to go in the search, - # give the newly contacted servers 20 more seconds to - # respond.... - $max_time += 20; - } + &update_status($r,'contacting '.$server); } else { - sleep(1); # wait a sec. to give time for files to be written + # wait a sec. to give time for files to be written + # This sleep statement is here instead of outside the else + # block because we do not want to pause if we have servers + # left to contact. + sleep(1); } + &update_status($r,'waiting on '.(join(' ',keys(%Server_status)))); while (my ($server,$status) = each(%Server_status)) { + last if ($connection->aborted()); if ($status eq 'con_lost') { delete ($Server_status{$server}); - # $r->print("server $server is not responding."); 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 - # $r->print("$server:Receiving file"); + &update_status($r,'Receiving results from '.$server); next; } + last if ($connection->aborted()); if (-e "$datafile.end") { + &update_status($r,'Reading results from '.$server); 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? $r->print("Unable to open search results file for ". "server $server. Omitting from search"); - next; + delete($Server_status{$server}); + next; } # Read in the whole file. while (my $result = <$fh>) { + last if ($connection->aborted()); # handle custom fields? Someday we will! chomp($result); next unless $result; @@ -1728,27 +1825,42 @@ sub run_search { } # $r->print(&Apache::lonmysql::get_debug()); $hitcountsum ++; + $time_remaining = $max_time - (time - $starttime) ; + if ($last_time - $time_remaining > 0) { + &update_seconds($r,$time_remaining); + $last_time = $time_remaining; + } + if ($hitcountsum % 50 == 0) { + &update_count_status($r,$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}); - # $r->print("Received $new_count more results from ". - # $server."."); } + last if ($connection->aborted()); + &update_count_status($r,$hitcountsum); } + last if ($connection->aborted()); # Finished looping through the servers + $time_remaining = $max_time - (time - $starttime) ; + if ($last_time - $time_remaining > 0) { + $last_time = $time_remaining; + &update_seconds($r,$time_remaining); + } } + &update_status($r,'Search Complete'.$server); &Apache::lonmysql::disconnect_from_db(); # Let the user know # # We have run out of time or run out of servers to talk to and # results to get. - $r->print("

Search completed.

"); + $r->print("Search Completed.  "); if ($hitcountsum) { - $r->print($hitcountsum." successful matches to your query.
"); + $r->print($hitcountsum." matches were found."); } else { - $r->print("There were no successful matches to your query.
"); + $r->print("There were no successful matches to your query."); } $r->print(""); return; @@ -1810,8 +1922,9 @@ sub prev_next_buttons { ###################################################################### ###################################################################### sub display_results { - my ($r,$mode,$importbutton,$closebutton) = @_; - $r->print(&search_results_header()); + my ($r,$importbutton,$closebutton) = @_; + my $connection = $r->connection; + $r->print(&search_results_header($importbutton,$closebutton)); ## ## Set viewing function ## @@ -1826,12 +1939,12 @@ sub display_results { ## my $action = "/adm/searchcat?phase=results"; ## - ## + ## Deal with groupsearch ## if ($ENV{'form.catalogmode'} eq 'groupsearch') { if (! tie(%groupsearch_db,'GDBM_File',$diropendb, - &GDBM_WRCREAT,0640)) { - $r->print('Unable to tie hash to db file'); + &GDBM_WRCREAT(),0640)) { + $r->print('Unable to store import results.'); $r->rflush(); return; } @@ -1846,7 +1959,7 @@ sub display_results { } my $table_check = &Apache::lonmysql::check_table($table); if (! defined($table_check)) { - $r->print("A MySQL error has occurred."); + $r->print("A MySQL error has occurred."); &Apache::lonnet::logthis("lonmysql was unable to determine the status". " of table ".$table); return; @@ -1861,18 +1974,13 @@ sub display_results { ## my $total_results = &Apache::lonmysql::number_of_rows($table); if (! defined($total_results)) { - $r->print("A MySQL error has occurred."); + $r->print("A MySQL error has occurred."); &Apache::lonnet::logthis("lonmysql was unable to determine the number". " of rows in table ".$table); &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); &Apache::lonnet::logthis(&Apache::lonmysql::get_debug()); return; } - if ($total_results == 0) { - $r->print("There were no results matching your query.\n". - ""); - return; - } ## ## Determine how many results we need to get ## @@ -1890,15 +1998,22 @@ sub display_results { ## ## Output links (if necessary) for 'prev' and 'next' pages. ## - $r->print("
Results $min to $max out of $total_results
\n"); $r->print - ('
'. + ('
'. &prev_next_buttons($min,$ENV{'form.show'},$total_results, "table=".$ENV{'form.table'}. "&phase=results". "&persistent_db_id=".$ENV{'form.persistent_db_id'}) - ."

\n" + ."
\n" ); + if ($total_results == 0) { + $r->print("There are currently no results.\n". + ""); + return; + } else { + $r->print + ("
Results $min to $max out of $total_results
\n"); + } ## ## Get results from MySQL table ## @@ -1908,22 +2023,36 @@ sub display_results { ## Loop through the results and output them. ## foreach my $row (@Results) { + if ($connection->aborted()) { + untie %groupsearch_db if (tied(%groupsearch_db)); + &Apache::lonmysql::disconnect_from_db(); + return; + } my %Fields = %{&parse_row(@$row)}; my $output="

\n"; - $output.=&catalogmode_output($Fields{'title'},$Fields{'url'}); + my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'}); # Render the result into html - $output.= &$viewfunction(%Fields); - $output.="

\n
"; + $output.= &$viewfunction($prefix,%Fields); # Print them out as they come in. $r->print($output); $r->rflush(); } if (@Results < 1) { $r->print("There were no results matching your query"); + } else { + $r->print + ('
'. + &prev_next_buttons($min,$ENV{'form.show'},$total_results, + "table=".$ENV{'form.table'}. + "&phase=results". + "&persistent_db_id=". + $ENV{'form.persistent_db_id'}) + ."
\n" + ); } - $r->print(""); + $r->print(""); $r->rflush(); - untie %groupsearch_db; + untie %groupsearch_db if (tied(%groupsearch_db)); return; } @@ -1943,13 +2072,13 @@ $ENV{'form.catalogmode'}. Stores data i ###################################################################### ###################################################################### { -my $fnum; +my $fnum = 0; sub catalogmode_output { my $output = ''; my ($title,$url) = @_; if ($ENV{'form.catalogmode'} eq 'interactive') { - $title=~ s/\'/\\'/g; # ' Escape single quotes. + $title=~ s/\'/\\\'/g; if ($ENV{'form.catalogmode'} eq 'interactive') { $output.=< function select_data(title,url) { changeURL(url); - self.close(); + parent.close(); } function changeTitle(val) { } function changeURL(val) { - if (window.opener.document) { - window.opener.document.forms["$form"].elements["$element"].value=val; + if (parent.targetwin.document) { + parent.targetwin.document.forms["$form"].elements["$element"].value=val; } else { var url = 'forms[\"$form\"].elements[\"$element\"].value'; alert("Unable to transfer data to "+url); @@ -2220,26 +2348,25 @@ SCRIPT } $result.=< SCRIPT $result.=< +
+ +$importbutton END return $result; } @@ -2255,6 +2382,14 @@ Sending search request to LON-CAPA serve ENDSTATUS } +sub results_link { + my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. + "&persistent_db_id=".$ENV{'form.persistent_db_id'}; + my $results_link = $basic_link."&phase=results". + "&pause=10"."&start=0"."&show=20"; + return $results_link; +} + ###################################################################### ###################################################################### sub print_frames_interface { @@ -2262,11 +2397,13 @@ sub print_frames_interface { my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. "&persistent_db_id=".$ENV{'form.persistent_db_id'}; my $run_search_link = $basic_link."&phase=run_search"; - my $results_link = $basic_link."&phase=results". - "&pause=10"."&start=0"."&show=20"; + my $results_link = &results_link(); my $result = <<"ENDFRAMES"; + LON-CAPA Digital Library Search Results @@ -2302,10 +2439,10 @@ extra custom metadata to show. ###################################################################### ###################################################################### sub detailed_citation_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=<$values{'title'} +$prefix$values{'title'}

$values{'author'}, $values{'owner'}
@@ -2320,6 +2457,7 @@ $values{'extrashow'}

$values{'shortabstract'}

+
END return $result; } @@ -2335,19 +2473,42 @@ END ###################################################################### ###################################################################### sub summary_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=<$values{'author'}
$values{'title'}
$values{'owner'} -- $values{'lastrevisiondate'}
$values{'copyrighttag'}
$values{'extrashow'}

+
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &compact_view() + +=cut + +###################################################################### +###################################################################### +sub compact_view { + my ($prefix,%values) = @_; + my $result=< +$values{'title'} +$values{'author'}
END return $result; } + ###################################################################### ###################################################################### @@ -2360,8 +2521,9 @@ END ###################################################################### ###################################################################### sub fielded_format_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=<URL: $values{'url'}
@@ -2380,6 +2542,7 @@ sub fielded_format_view { Abstract: $values{'shortabstract'}
$values{'extrashow'}

+
END return $result; } @@ -2398,8 +2561,9 @@ END ###################################################################### ###################################################################### sub xml_sgml_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=< <LonCapaResource> <url>$values{'url'}</url> @@ -2428,6 +2592,7 @@ sub xml_sgml_view { </LonCapaResource> $values{'extrashow'} +
END return $result; }