--- loncom/interface/lonsearchcat.pm 2002/07/28 20:02:14 1.145 +++ loncom/interface/lonsearchcat.pm 2002/08/26 14:34:19 1.155 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.145 2002/07/28 20:02:14 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.155 2002/08/26 14:34:19 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 -# ############################################################################### ############################################################################### @@ -123,6 +115,11 @@ 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 $bodytag + +LON-CAPA standard body tag, gotten from &Apache::lonnet::bodytag. +No title, no table, just a tag. + =back =cut @@ -140,10 +137,12 @@ 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 ); -my $persistent_db_file; + "XML/SGML" => \&xml_sgml_view, + "Compact View" => \&compact_view); my %persistent_db; my $hidden_fields; +my $bodytag; + ###################################################################### ###################################################################### @@ -172,8 +171,6 @@ string that holds portions of the screen sub handler { my $r = shift; # - untie %groupsearch_db if (tied(%groupsearch_db)); - # my $closebutton; # button that closes the search window # This button is different for the RAT compared to # normal invocation. @@ -185,8 +182,18 @@ sub handler { ## Pick up form fields passed in the links. ## &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['catalogmode','launch','acts','mode','form','element', - 'reqinterface','persistent_db_id','table']); + ['catalogmode','launch','acts','mode','form','element','pause', + 'phase','persistent_db_id','table','start','show']); + ## + ## The following is a trick - we wait a few seconds if asked to so + ## the daemon running the search can get ahead of the daemon + ## printing the results. We only need (theoretically) to do + ## this once, so the pause indicator is deleted + ## + if (exists($ENV{'form.pause'})) { + sleep(3); + delete($ENV{'form.pause'}); + } ## ## Initialize global variables ## @@ -195,118 +202,185 @@ sub handler { "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db"; # # set the name of the persistent database - # $ENV{'form.persistent_db_id'} can only have digits in it. + # $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; } - $persistent_db_file = "/home/httpd/perl/tmp/". + $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); + my $persistent_db_file = "/home/httpd/perl/tmp/". &Apache::lonnet::escape($domain). '_'.&Apache::lonnet::escape($ENV{'user.name'}). '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db'; - # - # Read in the database. It should (hopefully) not be catastrophic to - # fail in this exercise. - if (-e $persistent_db_file) { - # Read in the previous values, if we can. - if (tie(%persistent_db,'GDBM_File',$persistent_db_file, - &GDBM_READER,0640)) { - &reconstruct_persistent_form_data($r); - untie (%persistent_db); - } + ## + if (! &get_persistent_form_data($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 +$bodytag +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 ## - if ($ENV{'form.launch'} eq '1') { - if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + untie %groupsearch_db if (tied(%groupsearch_db)); + 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 { - $r->print('Unable to tie hash to db '. - 'file'); + # This is a stupid error to give to the user. + # It really tells them nothing. + $r->print(''.$bodytag. + 'Unable to tie hash to db file'); return OK; } } ## - ## 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=" END + } else { + $closebutton = ''; + $importbutton = ''; } ## - ## Do a search, if needed. + ## Sanity checks on form elements ## - my $searchtype; - $searchtype = 'Basic' if ($ENV{'form.basicsubmit'} eq 'SEARCH'); - $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH'); - if ($searchtype) { - ## - ## make query information persistent to allow for subsequent revision - ## - tie(%persistent_db,'GDBM_File',$persistent_db_file,&GDBM_WRCREAT,0640); - &make_persistent(\%ENV); - untie(%persistent_db); + if (!defined($ENV{'form.viewselect'})) { + 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'} = 'disp_basic' if (! exists($ENV{'form.phase'})); + $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'})); + ## + ## Switch on the phase + ## + if ($ENV{'form.phase'} eq 'disp_basic') { + &print_basic_search_form($r,$closebutton); + } elsif ($ENV{'form.phase'} eq 'disp_adv') { + &print_advanced_search_form($r,$closebutton); + } elsif ($ENV{'form.phase'} eq 'results') { + &display_results($r,$importbutton,$closebutton); + } elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) { + my ($query,$customquery,$customshow,$libraries,$pretty_string) = + &get_persistent_data($persistent_db_file, + ['query','customquery','customshow', + 'libraries','pretty_string']); + if ($ENV{'form.phase'} eq 'sort') { + &print_sort_form($r,$pretty_string); + } elsif ($ENV{'form.phase'} eq 'run_search') { + &run_search($r,$query,$customquery,$customshow, + $libraries,$pretty_string); + } + } elsif(($ENV{'form.phase'} eq 'basic_search') || + ($ENV{'form.phase'} eq 'adv_search')) { + $ENV{'form.searchmode'} = 'basic'; + if ($ENV{'form.phase'} eq 'adv_search') { + $ENV{'form.searchmode'} = 'advanced'; + } + # Set up table + if (! defined(&create_results_table())) { + $r->print(<Search Error +$bodytag +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)) { + $r->print(<Search Error +$bodytag +Unable to properly store search information. The search has been aborted. + + +END + return OK; + } # # We are running a search my ($query,$customquery,$customshow,$libraries) = (undef,undef,undef,undef); my $pretty_string; - if ($searchtype eq 'Basic') { + if ($ENV{'form.phase'} eq 'basic_search') { ($query,$pretty_string) = &parse_basic_search($r,$closebutton); - } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { + } else { # Advanced search ($query,$customquery,$customshow,$libraries,$pretty_string) = &parse_advanced_search($r,$closebutton); return OK if (! defined($query)); } - # 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); + &make_persistent({ query => $query, + customquery => $customquery, + customshow => $customshow, + libraries => $libraries, + pretty_string => $pretty_string }, + $persistent_db_file); ## - ## Display the results + ## Print out the frames interface ## - &display_results($r,$searchtype,$importbutton,$closebutton); - $r->rflush(); - } else { - # - # Set the default view if it is not already set. - if (!defined($ENV{'form.viewselect'})) { - $ENV{'form.viewselect'} ="Detailed Citation View"; - } - # - # remove the requested interface from the environment. - my $interface; - if ($ENV{'form.reqinterface'}) { - $interface = lc($ENV{'form.reqinterface'}); - } else { - $interface = 'basic'; - } - ## - ## Determine course of action - ## - if ($interface eq 'display') { - # &display_results($closebutton)); - } elsif ($interface eq 'advanced') { - $r->print(&advanced_search_form($closebutton)); - } elsif ($interface eq 'basic') { - # Output normal search interface - $r->print(&basic_search_form($closebutton)); - } + &print_frames_interface($r); } - untie (%persistent_db); return OK; } @@ -315,7 +389,7 @@ END =pod -=item &basic_search_form() +=item &print_basic_search_form() Returns a scalar which holds html for the basic search form. @@ -324,8 +398,9 @@ Returns a scalar which holds html for th ###################################################################### ###################################################################### -sub basic_search_form{ - my ($closebutton) = @_; +sub print_basic_search_form{ + my ($r,$closebutton) = @_; + my $bodytag=&Apache::loncommon::bodytag('Catalog Search'); my $scrout=<<"ENDDOCUMENT"; @@ -338,12 +413,10 @@ sub basic_search_form{ } - - -

Search Catalog

+$bodytag
+ $hidden_fields -

Basic Search

Enter terms or phrases separated by AND, OR, or NOT then press SEARCH below. @@ -354,11 +427,9 @@ 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 +Advanced Search $checkbox use related words

@@ -370,14 +441,19 @@ END $ENV{'form.viewselect'}, undef,undef,undef, sort(keys(%Views))); + $scrout.=&selectbox(undef,'show', + $ENV{'form.show'}, + undef,undef,undef, + (10,20,50,100)); $scrout.=< +per page.

ENDDOCUMENT - return $scrout; + $r->print($scrout); + return; } ###################################################################### ###################################################################### @@ -393,8 +469,8 @@ Returns a scalar which holds html for th ###################################################################### ###################################################################### -sub advanced_search_form{ - my ($closebutton) = @_; +sub print_advanced_search_form{ + my ($r,$closebutton) = @_; my $advanced_buttons = <<"END";

@@ -406,6 +482,7 @@ END if (!defined($ENV{'form.viewselect'})) { $ENV{'form.viewselect'} ="Detailed Citation View"; } + my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search'); my $scrout=<<"ENDHEADER"; @@ -418,15 +495,13 @@ END } - - -

Advanced Catalog Search

-
+$bodytag Enter terms or phrases separated by search operators such as AND, OR, or NOT.
$advanced_buttons $hidden_fields + \n"; $scrout.=&searchphrasefield_with_related('title', 'title' , $ENV{'form.title'}); @@ -543,32 +625,33 @@ LASTREVISIONDATEEND (&Apache::loncommon::copyrightids), ); # ------------------------------------------- Compute customized metadata field - $scrout.=< -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 NOT.
-Example: grandmother=75 OR grandfather=85 -
-CUSTOMMETADATA - $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'}); - $scrout.=< -SHOW SPECIAL METADATA FIELDS: - -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.=< +#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 NOT.
+#Example: grandmother=75 OR grandfather=85 +#
+#CUSTOMMETADATA +# $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'}); +# $scrout.=< +#SHOW SPECIAL METADATA FIELDS: +# +#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.=< ENDDOCUMENT - return $scrout; + $r->print($scrout); + return; } ###################################################################### @@ -576,40 +659,91 @@ ENDDOCUMENT =pod -=item &reconstruct_persistent_form_data +=item &get_persistent_form_data + +Inputs: filename of database + +Outputs: returns undef on database errors. + +This function is the reverse of &make_persistent() for form data. +Retrieve persistent data from %persistent_db. Retrieved items will have their +values unescaped. If a form value already exists in $ENV, it will not be +overwritten. Form values that are array references may have values appended +to them. + +=cut + +###################################################################### +###################################################################### +sub get_persistent_form_data { + my $filename = shift; + return 0 if (! -e $filename); + return undef if (! tie(%persistent_db,'GDBM_File',$filename, + &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); + # + # Loop through the keys, looking for 'form.' + foreach my $name (keys(%persistent_db)) { + next if ($name !~ /^form./); + next if (exists($ENV{$name})); + my @values = map { + &Apache::lonnet::unescape($_); + } split(',',$persistent_db{$name}); + next if (@values <1); + if ($arrays_allowed{$name}) { + $ENV{$name} = [@values]; + } else { + $ENV{$name} = $values[0] if ($values[0]); + } + } + untie (%persistent_db); + return 1; +} +###################################################################### +###################################################################### + +=pod + +=item &get_persistent_data + +Inputs: filename of database, ref to array of values to recover. + +Outputs: array of values. Returns undef on error. This function is the reverse of &make_persistent(); Retrieve persistent data from %persistent_db. Retrieved items will have their values unescaped. If the item contains commas (before unescaping), the -returned value will be an array pointer. Items will be returned in the -environment in $ENV{"form.$name"}. +returned value will be an array pointer. =cut ###################################################################### ###################################################################### -sub reconstruct_persistent_form_data { - foreach my $name (keys %persistent_db) { - # &Apache::lonnet::logthis("Reconstructing $name = $persistent_db{$name}"); - my @Values = split(',',$persistent_db{$name}); - my @value = map { &Apache::lonnet::unescape($_) } @Values; - $name = 'form.'.$name; - if (exists($ENV{$name})) { - if (ref($ENV{$name})) { - # Assume it is an array reference - $ENV{$name} = [@{$ENV{$name}},@value]; - } else { - $ENV{$name} = [$ENV{$name},@value]; - } +sub get_persistent_data { + my $filename = shift; + my @Vars = @{shift()}; + my @Values; # Return array + return undef if (! -e $filename); + return undef if (! tie(%persistent_db,'GDBM_File',$filename, + &GDBM_READER(),0640)); + foreach my $name (@Vars) { + if (! exists($persistent_db{$name})) { + push @Values, undef; + next; + } + my @values = map { + &Apache::lonnet::unescape($_); + } split(',',$persistent_db{$name}); + if (@values <= 1) { + push @Values,$values[0]; } else { - if (@value > 1) { - $ENV{$name} = [@value]; - } else { - $ENV{$name} = $value[0]; - } + push @Values,\@values; } } - return; + untie (%persistent_db); + return @Values; } ###################################################################### @@ -619,7 +753,9 @@ sub reconstruct_persistent_form_data { =item &make_persistent() -Store (environment) variables away to the %persistent_db. +Inputs: Hash of values to save, filename of persistent database. + +Store variables away to the %persistent_db. Values will be escaped. Values that are array pointers will have their elements escaped and concatenated in a comma seperated string. @@ -629,15 +765,45 @@ elements escaped and concatenated in a c ###################################################################### sub make_persistent { my %save = %{shift()}; - foreach my $name (keys %save) { - next if ($name !~ /^form\./ || $name =~ /submit/); + my $filename = shift; + return undef if (! tie(%persistent_db,'GDBM_File', + $filename,&GDBM_WRCREAT(),0640)); + foreach my $name (keys(%save)) { my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); # We handle array references, but not recursively. my $store = join(',', map { &Apache::lonnet::escape($_); } @values ); - $name=~s/^form\.//; $persistent_db{$name} = $store; } - return ''; + untie(%persistent_db); + return 1; +} + +###################################################################### +###################################################################### + +=pod + +=item &make_form_data_persistent() + +Inputs: filename of persistent database. + +Store most form variables away to the %persistent_db. +Values will be escaped. Values that are array pointers will have their +elements escaped and concatenated in a comma seperated string. + +=cut + +###################################################################### +###################################################################### +sub make_form_data_persistent { + my $r = shift; + my $filename = shift; + my %save; + foreach (keys(%ENV)) { + next if (!/^form/ || /submit/); + $save{$_} = $ENV{$_}; + } + return &make_persistent(\%save,$filename); } ###################################################################### @@ -969,6 +1135,7 @@ sub parse_advanced_search { $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g; } # Preprocess the category form element. + $ENV{'form.category'} = 'any' if (ref($ENV{'form.category'})); if ($ENV{'form.category'} ne 'any') { my @extensions = &Apache::loncommon::filecategorytypes ($ENV{'form.category'}); @@ -983,7 +1150,7 @@ sub parse_advanced_search { } } unless ($fillflag) { - &output_blank_field_error($r,$closebutton); + &output_blank_field_error($r,$closebutton,'phase=disp_adv'); return ; } # Turn the form input into a SQL-based query @@ -1055,21 +1222,21 @@ sub parse_advanced_search { } # Process form information for custom metadata querying my $customquery=undef; - if ($ENV{'form.custommetadata'}) { - $pretty_search_string .=$font."Custom Metadata Search: ". - $ENV{'form.custommetadata'}."
\n"; - $customquery=&build_custommetadata_query('custommetadata', - $ENV{'form.custommetadata'}); - } +# if ($ENV{'form.custommetadata'}) { +# $pretty_search_string .=$font."Custom Metadata Search: ". +# $ENV{'form.custommetadata'}."
\n"; +# $customquery=&build_custommetadata_query('custommetadata', +# $ENV{'form.custommetadata'}); +# } my $customshow=undef; - if ($ENV{'form.customshow'}) { - $pretty_search_string .=$font."Custom Metadata Display: ". - $ENV{'form.customshow'}."
\n"; - $customshow=$ENV{'form.customshow'}; - $customshow=~s/[^\w\s]//g; - my @fields=split(/\s+/,$customshow); - $customshow=join(" ",@fields); - } +# if ($ENV{'form.customshow'}) { +# $pretty_search_string .=$font."Custom Metadata Display: ". +# $ENV{'form.customshow'}."
\n"; +# $customshow=$ENV{'form.customshow'}; +# $customshow=~s/[^\w\s]//g; +# my @fields=split(/\s+/,$customshow); +# $customshow=join(" ",@fields); +# } ## --------------------------------------------------------------- ## Deal with restrictions to given domains ## @@ -1084,15 +1251,15 @@ sub parse_advanced_search { $domain_hash{$_}++; } if ($domain_hash{'any'}) { - $pretty_domains_string = "Searching all domains."; + $pretty_domains_string = "In all LON-CAPA domains."; } else { if (@allowed_domains > 1) { - $pretty_domains_string = "Searching domains:"; + $pretty_domains_string = "In LON-CAPA domains:"; } else { - $pretty_domains_string = "Searching domain "; + $pretty_domains_string = "In LON-CAPA domain "; } foreach (sort @allowed_domains) { - $pretty_domains_string .= "$_ "; + $pretty_domains_string .= "".$_." "; } foreach (keys(%Apache::lonnet::libserv)) { if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) { @@ -1140,7 +1307,7 @@ sub parse_basic_search { # Check to see if enough is filled in unless (&filled($ENV{'form.basicexp'})) { - &output_blank_field_error($r,$closebutton); + &output_blank_field_error($r,$closebutton,'phase=disp_basic'); return OK; } my $pretty_search_string = ''.$ENV{'form.basicexp'}.''; @@ -1376,7 +1543,6 @@ sub build_date_queries { ###################################################################### ###################################################################### - sub copyright_check { my $Metadata = shift; # Check copyright tags and skip results the user cannot use @@ -1396,6 +1562,152 @@ sub copyright_check { return 1; } + +###################################################################### +###################################################################### + +=pod + +=item &ensure_db_and_table + +Ensure we can get lonmysql to connect to the database and the table we +need exists. + +Inputs: $r, table id + +Returns: undef on error, 1 if the table exists. + +=cut + +###################################################################### +###################################################################### +sub ensure_db_and_table { + my ($r,$table) = @_; + ## + ## Sanity check the table id. + ## + if (! defined($table) || $table eq '' || $table =~ /\D/ ) { + $r->print("Unable to retrieve search results. ". + "Unable to determine the table results were stored in. ". + ""); + return undef; + } + ## + ## Make sure we can connect and the table exists. + ## + my $connection_result = &Apache::lonmysql::connect_to_db(); + if (!defined($connection_result)) { + $r->print("Unable to connect to the MySQL database where your results". + " are stored. "); + &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to". + " connect to database."); + &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); + return undef; + } + my $table_check = &Apache::lonmysql::check_table($table); + if (! defined($table_check)) { + $r->print("A MySQL error has occurred."); + &Apache::lonnet::logthis("lonmysql was unable to determine the status". + " of table ".$table); + return undef; + } elsif (! $table_check) { + $r->print("The table of results could not be found."); + &Apache::lonnet::logthis("The user requested a table, ".$table. + ", that could not be found."); + return undef; + } + return 1; +} + +###################################################################### +###################################################################### + +=pod + +=item &print_sort_form + +=cut + +###################################################################### +###################################################################### +sub print_sort_form { + my ($r,$pretty_query_string) = @_; + ## + my %SortableFields = + (id => 'Default', + title => 'Title', + author => 'Author', + subject => 'Subject', + url => 'URL', + version => 'Version Number', + mime => 'Mime type', + lang => 'Language', + owner => 'Owner/Publisher', + copyright => 'Copyright', + hostname => 'Host', + creationdate => 'Creation Date', + lastrevisiondate => 'Revision Date', + ); + ## + my $table = $ENV{'form.table'}; + return if (! &ensure_db_and_table($r,$table)); + ## + ## Get the number of results + ## + my $total_results = &Apache::lonmysql::number_of_rows($table); + if (! defined($total_results)) { + $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()); + return; + } + my $result; + $result.=< + + +Results + +$bodytag +
+ +END + +#

Sort Results

+#Sort by: }; + return $result; } ###################################################################### @@ -1484,50 +1882,90 @@ sub write_status { ###################################################################### ###################################################################### sub run_search { - my ($r,$query,$customquery,$customshow,$serverlist) = @_; + my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_; + my $connection = $r->connection; # # Timing variables # my $starttime = time; - my $max_time = 120; # seconds for the search to complete + my $max_time = 30; # seconds for the search to complete + # + # Print run_search header + # + $r->print(< +Search Status +$bodytag + + +END + # Check to see if $pretty_string has more than one carriage return. + # Assume \n s are following
s and truncate the value. + # (there is probably a better way)... + my @Lines = split /
/,$pretty_string; + if (@Lines > 2) { + $pretty_string = join '
',(@Lines[0..2],'....
'); + } + $r->print("Search: ".$pretty_string); + $r->rflush(); # # Determine the servers we need to contact. # my @Servers_to_contact; if (defined($serverlist)) { - @Servers_to_contact = @$serverlist; + if (ref($serverlist) eq 'ARRAY') { + @Servers_to_contact = @$serverlist; + } else { + @Servers_to_contact = ($serverlist); + } } else { @Servers_to_contact = sort(keys(%Apache::lonnet::libserv)); } my %Server_status; - # - # 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:". + my $table =$ENV{'form.table'}; + 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; } ## - ## form.table needs to be stored in the persistent database... - ## - $ENV{'form.table'}=$table; - # - # Prepare for the big loop. - # + ## Prepare for the big loop. + ## my $hitcountsum; my $server; my $status; - while ((time - $starttime < $max_time) && + my $revise = &revise_button(); + $r->print(< + + + + + + + +
VIEW: @@ -435,6 +510,13 @@ ENDHEADER $ENV{'form.viewselect'}, undef,undef,undef, sort(keys(%Views))); + $scrout.=' '; + $scrout.=&selectbox(undef,'show', + $ENV{'form.show'}, + undef,undef,undef, + (10,20,50,100)); + $scrout.=' '. + 'Per Page'; $scrout.="Related
Words
StatusTotal MatchesTime Remaining
$revise
+ +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) { @@ -1537,46 +1975,44 @@ sub run_search { $customshow,[$server]); ($server) = keys(%$reply); $Server_status{$server} = $reply->{$server}; - # &write_status($r,"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}); - # &write_status($r,"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 - # &write_status($r,"$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? - &write_status("Unable to open search results file for ". + $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; @@ -1587,31 +2023,47 @@ sub run_search { # 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()); + $r->print(&Apache::lonmysql::get_error()); } - # &write_status($r,&Apache::lonmysql::get_debug()); + # $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}); - #&write_status($r,"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); + &update_seconds($r,0); &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. - &write_status($r,"Search completed."); - if ($hitcountsum) { - &write_status($r,$hitcountsum." successful matches to your query."); - } else { - &write_status($r,"There were no successful matches to your query."); + $r->print(""); + if ($ENV{'form.catalogmode'} ne 'groupsearch') { + $r->print(""); } return; } @@ -1620,37 +2072,43 @@ sub run_search { ###################################################################### =pod -=item &display_buttons +=item &prev_next_buttons =cut ###################################################################### ###################################################################### -sub display_buttons { +sub prev_next_buttons { my ($current_min,$show,$total,$parms) = @_; return '' if ($show eq 'all'); # No links if you get them all at once. my $links; ## ## Prev my $prev_min = $current_min - $show; - $prev_min = 0 if $prev_min < 0; + $prev_min = 1 if $prev_min < 1; if ($prev_min < $current_min) { $links .= qq{ -prev +prev }; + } else { + $links .= 'prev'; } ## ## Pages.... Someday. ## - + $links .= qq{   +reload +}; ## ## Next my $next_min = $current_min + $show; - my $next_min = $current_min if ($next_min > $total); + $next_min = $current_min if ($next_min > $total); if ($next_min != $current_min) { - $links .= qq{ -next + $links .= qq{   +next }; + } else { + $links .= ' next'; } return $links; } @@ -1666,7 +2124,9 @@ sub display_buttons { ###################################################################### ###################################################################### sub display_results { - my ($r,$mode,$importbutton,$closebutton) = @_; + my ($r,$importbutton,$closebutton) = @_; + my $connection = $r->connection; + $r->print(&search_results_header($importbutton,$closebutton)); ## ## Set viewing function ## @@ -1679,105 +2139,105 @@ sub display_results { ## ## Get the catalog controls setup ## - my $action = "/adm/searchcat"; - if ($mode eq 'Basic') { - $action .= "?reqinterface=basic"; - } elsif ($mode eq 'Advanced') { - $action .= "?reqinterface=advanced"; + 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 store import results.'); + $r->rflush(); + return; + } } - $r->print(< -$hidden_fields - - -$importbutton -$closebutton -
-CATALOGCONTROLS - if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { - $r->print('Unable to tie hash to db file'); - $r->rflush(); - return; - } ## ## Prepare the table for querying ## 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 $table_check = &Apache::lonmysql::check_table($table); - if (! defined($table_check)) { - $r->print("A MySQL error has occurred."); - &Apache::lonnet::logthis("lonmysql was unable to determine the status". - " of table ".$table); - return; - } elsif (! $table_check) { - $r->print("The table of results could not be found."); - &Apache::lonnet::logthis("The user requested a table, ".$table. - ", that could not be found."); - return; - } + return if (! &ensure_db_and_table($r,$table)); ## ## Get the number of 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 ## - $ENV{'form.startwith'} = 0 if (! exists($ENV{'form.startwith'})); - $ENV{'form.show'} = 'all' if (! exists($ENV{'form.show'})); - my $min = $ENV{'form.startwith'}; + $ENV{'form.start'} = 1 if (! exists($ENV{'form.start'})); + $ENV{'form.show'} = 'all' if (! exists($ENV{'form.show'})); + my $min = $ENV{'form.start'}; my $max; if ($ENV{'form.show'} eq 'all') { $max = $total_results ; } else { - $max = $min + $ENV{'form.show'}; + $max = $min + $ENV{'form.show'} - 1; + $max = $total_results if ($max > $total_results); } ## ## Output links (if necessary) for 'prev' and 'next' pages. ## - + $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" + ); + 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 ## my @Results = &Apache::lonmysql::get_rows($table, - 'id>'.$min.' AND id<='.$max); + 'id>='.$min.' AND id<='.$max); ## ## 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; } @@ -1797,13 +2257,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.=< - -$title -BEGINNING # conditional output of script functions dependent on the mode in # which the search was invoked if ($ENV{'form.catalogmode'} eq 'interactive'){ @@ -2048,16 +2494,16 @@ BEGINNING function select_data(title,url) { changeTitle(title); changeURL(url); - self.close(); + parent.close(); } function changeTitle(val) { - if (opener.inf.document.forms.resinfo.elements.t) { - opener.inf.document.forms.resinfo.elements.t.value=val; + if (parent.opener.inf.document.forms.resinfo.elements.t) { + parent.opener.inf.document.forms.resinfo.elements.t.value=val; } } function changeURL(val) { - if (opener.inf.document.forms.resinfo.elements.u) { - opener.inf.document.forms.resinfo.elements.u.value=val; + if (parent.opener.inf.document.forms.resinfo.elements.u) { + parent.opener.inf.document.forms.resinfo.elements.u.value=val; } } @@ -2069,13 +2515,13 @@ SCRIPT -SCRIPT - $result.=< - function displayinfo(val) { - popwin.document.forms.popremain.sdetails.value=val; - } - function openhelp(val) { - openhelpwin=open('/adm/help/searchcat.html','helpscreen', - 'scrollbars=1,width=400,height=300'); - openhelpwin.focus(); - } - function abortsearch(val) { - popwin.close(); + parent.statusframe.document.forms.statusform.elements.Queue.value; } SCRIPT $result.=< - - -

$title

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

Search query: $pretty_query

"; - } return $result; } ###################################################################### ###################################################################### +sub search_status_header { + return <Search Status +$bodytag +

Search Status

+Sending search request to LON-CAPA servers.
+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=1"."&start=1"; + return $results_link; +} + +###################################################################### +###################################################################### +sub print_frames_interface { + my $r = shift; + 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 = &results_link(); + my $result = <<"ENDFRAMES"; + + + +LON-CAPA Digital Library Search Results + + + + + + +ENDFRAMES + + $r->print($result); + return; +} + +###################################################################### +###################################################################### =pod @@ -2154,10 +2625,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'}
@@ -2172,6 +2643,7 @@ $values{'extrashow'}

$values{'shortabstract'}

+
END return $result; } @@ -2184,19 +2656,19 @@ END =item &summary_view() =cut - ###################################################################### ###################################################################### 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; } @@ -2206,6 +2678,28 @@ END =pod +=item &compact_view() + +=cut + +###################################################################### +###################################################################### +sub compact_view { + my ($prefix,%values) = @_; + my $result=< +$values{'title'} +$values{'author'}
+END + return $result; +} + + +###################################################################### +###################################################################### + +=pod + =item &fielded_format_view() =cut @@ -2213,8 +2707,9 @@ END ###################################################################### ###################################################################### sub fielded_format_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=<URL: $values{'url'}
@@ -2233,6 +2728,7 @@ sub fielded_format_view { Abstract: $values{'shortabstract'}
$values{'extrashow'}

+
END return $result; } @@ -2251,8 +2747,9 @@ END ###################################################################### ###################################################################### sub xml_sgml_view { - my %values = @_; + my ($prefix,%values) = @_; my $result=< <LonCapaResource> <url>$values{'url'}</url> @@ -2281,6 +2778,7 @@ sub xml_sgml_view { </LonCapaResource> $values{'extrashow'} +
END return $result; } @@ -2313,12 +2811,21 @@ sub filled { =item &output_blank_field_error() +Output a complete page that indicates the user has not filled in enough +information to do a search. + +Inputs: $r (Apache request handle), $closebutton, $parms. + +Returns: nothing + +$parms is extra information to include in the 'Revise search request' link. + =cut ###################################################################### ###################################################################### sub output_blank_field_error { - my ($r,$closebutton)=@_; + my ($r,$closebutton,$parms)=@_; # make query information persistent to allow for subsequent revision $r->print(< @@ -2327,21 +2834,20 @@ sub output_blank_field_error { BEGINNING $r->print(< - +$bodytag

Search Catalog

$hidden_fields - +Revise search request  $closebutton
-

Helpful Message

+

Unactionable search query.

-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. +You did not fill in enough information for the search to be started. +You need to fill in relevant fields on the search page in order +for a query to be processed.

@@ -2375,7 +2881,7 @@ sub output_date_error { The LearningOnline Network with CAPA - +$bodytag

Search Catalog

@@ -2384,7 +2890,7 @@ $hidden_fields onClick='this.form.submit();' /> $closebutton
-

Helpful Message

+

Error

$message