--- loncom/interface/lonsearchcat.pm 2002/06/27 14:46:00 1.132 +++ 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.132 2002/06/27 14:46:00 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.144 2002/07/26 16:37:58 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -40,7 +40,7 @@ =head1 NAME -lonsearchcat +lonsearchcat - LONCAPA Search Interface =head1 SYNOPSIS @@ -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 @@ -107,17 +109,28 @@ button that closes the search window =item $importbutton -button to take the selecte results and go to group sorting +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 The full path to the (temporary) search database file. This is set and used in &handler() and is also used in &output_results(). +=item %Views + +Hash which associates an output view description with the function +that produces it. Adding a new view type should be as easy as +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 @@ -130,9 +143,16 @@ 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, + "Fielded Format" => \&fielded_format_view, + "XML/SGML" => \&xml_sgml_view ); + ###################################################################### ###################################################################### @@ -160,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'); @@ -212,28 +235,52 @@ END onClick='javascript:select_group()'> END } - $hidden .= < - - - -END + $hidden .= &make_persistent({ "form.mode" => $ENV{'form.mode'}, + "form.form" => $ENV{'form.form'}, + "form.element" => $ENV{'form.element'}, + "form.date" => 2 }); ## ## What are we doing? ## - if ($ENV{'form.basicsubmit'} eq 'SEARCH') { - # Perform basic search and give results - return &basicsearch($r,$hidden); - } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - # Perform advanced search and give results - return &advancedsearch($r,$hidden); - } elsif ($ENV{'form.reqinterface'} eq 'advanced') { + my $searchtype; + $searchtype = 'Basic' if ($ENV{'form.basicsubmit'} eq 'SEARCH'); + $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH'); + if ($searchtype) { + # We are running a search + my ($query,$customquery,$customshow,$libraries) = + (undef,undef,undef,undef); + my $pretty_string; + if ($searchtype eq 'Basic') { + ($query,$pretty_string) = &parse_basic_search($r); + } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { + ($query,$customquery,$customshow,$libraries,$pretty_string) + = &parse_advanced_search($r); + 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); + &display_results($r,$searchtype,$hidden,$importbutton, + $closebutton); + + $r->rflush(); + } else { + # + # We need to get information to search on + # + # Set the default view if it is not already set. + if (!defined($ENV{'form.viewselect'})) { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } # Output the advanced interface - $r->print(&advanced_search_form($closebutton,$hidden)); - return OK; - } else { - # Output normal search interface - $r->print(&basic_search_form($closebutton,$hidden)); + if ($ENV{'form.reqinterface'} eq 'advanced') { + $r->print(&advanced_search_form($closebutton,$hidden)); + } else { + # Output normal search interface + $r->print(&basic_search_form($closebutton,$hidden)); + } } return OK; } @@ -284,20 +331,21 @@ ENDDOCUMENT ' '; # $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'}); # $scrout.='Search historic archives'; - $scrout.=<Advanced Search + my $checkbox = &simplecheckbox('related',$ENV{'form.related'}); + $scrout.=<Advanced Search +$checkbox use related words +

   $closebutton - - - +END + $scrout.=&selectbox(undef,'viewselect', + $ENV{'form.viewselect'}, + undef,undef,undef, + sort(keys(%Views))); + $scrout.=<

@@ -330,6 +378,9 @@ $closebutton

END + if (!defined($ENV{'form.viewselect'})) { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } my $scrout=<<"ENDHEADER"; @@ -354,37 +405,29 @@ $hidden ENDHEADER - $scrout.=&searchphrasefield('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('URL','url', - $ENV{'form.url'}); -# $scrout.=&searchphrasefield('Limit by version','version', -# $ENV{'form.version'}); - $scrout.=&searchphrasefield('notes','notes', - $ENV{'form.notes'}); - $scrout.=&searchphrasefield('abstract','abstract', - $ENV{'form.abstract'}); + $scrout.=&selectbox(undef,'viewselect', + $ENV{'form.viewselect'}, + undef,undef,undef, + sort(keys(%Views))); + $scrout.="\n"; + $scrout.=&searchphrasefield_with_related('title', 'title' , + $ENV{'form.title'}); + $scrout.=&searchphrasefield('author', 'author' ,$ENV{'form.author'}); + $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_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.="
VIEW: - - - -
Related
Words
  
   
  
   
\n"; @@ -395,10 +438,17 @@ ENDHEADER undef, (&Apache::loncommon::filecategories())); $ENV{'form.language'}='any' unless length($ENV{'form.language'}); - # + #---------------------------------------------------------------- # Allow restriction to multiple domains. # I make the crazy assumption that there will never be a domain 'any'. # + $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'})); + my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} + : ($ENV{'form.domains'}) ); + my %domain_hash = (); + foreach (@allowed_domains) { + $domain_hash{$_}++; + } my @domains =&Apache::loncommon::get_domains(); # adjust the size of the select box my $size = 4; @@ -407,18 +457,19 @@ ENDHEADER if ((scalar @domains) == 1) { $scrout .=''."\n"; } else { - $scrout.=''. + $scrout.="\n".''. 'DOMAINS
'. '\n"; } - # - # - # + #---------------------------------------------------------------- $scrout.=&selectbox('Limit by language','language', $ENV{'form.language'},'any','Any Language', \&{Apache::loncommon::languagedescription}, @@ -517,23 +568,26 @@ to be somewhat persistent. ###################################################################### sub make_persistent { + my %save = %{shift()}; my $persistent=''; - foreach (keys %ENV) { - if (/^form\./ && !/submit/) { - my $name=$_; - my $key=$name; - $ENV{$key}=~s/\'//g; # do not mess with html field syntax + foreach my $name (keys %save) { + if ($name =~ /^form\./ && $name !~ /submit/) { + my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); $name=~s/^form\.//; - $persistent.=< + foreach (@values) { + s/\"/\'/g; # do not mess with html field syntax + next if (! $_ ); + $persistent.=< END + } } } return $persistent; } - ###################################################################### +# HTML form building functions # ###################################################################### =pod @@ -542,6 +596,13 @@ END =over 4 +=cut + +############################################### +############################################### + +=pod + =item &simpletextfield() Inputs: $name,$value,$size @@ -549,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 @@ -556,91 +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 = ". + &Apache::loncommon::languagedescription($ENV{'form.language'}). + "
\n"; } if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') { push @queries,"(copyright like \"$ENV{'form.copyright'}\")"; + $pretty_search_string.=$font."copyright = ". + &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}). + "
\n"; } + # # Evaluate date windows my $datequery=&build_date_queries( $ENV{'form.creationdatestart_month'}, @@ -792,25 +993,30 @@ sub advancedsearch { # Test to see if date windows are legitimate if ($datequery=~/^Incorrect/) { &output_date_error($r,$datequery); - return OK; - } - elsif ($datequery) { + return ; + } elsif ($datequery) { + # Here is where you would set up pretty_search_string to output + # date query information. push @queries,$datequery; } # Process form information for custom metadata querying - my $customquery=''; + 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'}); } - my $customshow=''; + 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); } - ## + ## --------------------------------------------------------------- ## Deal with restrictions to given domains ## my $libraries_to_query = undef; @@ -819,52 +1025,37 @@ sub advancedsearch { my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} : ($ENV{'form.domains'}) ); my %domain_hash = (); + my $pretty_domains_string; foreach (@allowed_domains) { $domain_hash{$_}++; } - foreach (keys(%Apache::lonnet::libserv)) { - if ($_ eq 'any') { - $libraries_to_query = undef; - last; + if ($domain_hash{'any'}) { + $pretty_domains_string = "Searching all domains."; + } else { + if (@allowed_domains > 1) { + $pretty_domains_string = "Searching domains:"; + } else { + $pretty_domains_string = "Searching domain "; } - if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) { - push @$libraries_to_query,$_; + foreach (sort @allowed_domains) { + $pretty_domains_string .= "$_ "; + } + foreach (keys(%Apache::lonnet::libserv)) { + 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"); - } + $pretty_search_string .= $pretty_domains_string."
\n"; # - # 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). if (@queries) { $query=join(" AND ",@queries); $query="select * from metadata where $query"; - my $reply; # reply hash reference - unless ($customquery or $customshow) { - $reply=&Apache::lonnet::metadata_query($query,undef,undef, - $libraries_to_query); - } - else { - $reply=&Apache::lonnet::metadata_query($query, - $customquery,$customshow, - $libraries_to_query); - } - &output_results('Advanced',$r,$customquery,$reply,$hidden); - return OK; } elsif ($customquery) { - my $reply; # reply hash reference - $reply=&Apache::lonnet::metadata_query('', - $customquery,$customshow, - $libraries_to_query); - &output_results('Advanced',$r,$customquery,$reply,$hidden); - return OK; + $query = ''; } - # should not get to this point - return 'Error. Should not have gone to this point.'; + return ($query,$customquery,$customshow,$libraries_to_query, + $pretty_search_string); } ###################################################################### @@ -872,16 +1063,16 @@ sub advancedsearch { =pod -=item &basicsearch() +=item &parse_basic_search() -Parse basic search form. +Parse the basic search form and return a scalar containing an sql query. =cut ###################################################################### ###################################################################### -sub basicsearch { - my ($r,$hidden)=@_; +sub parse_basic_search { + my ($r)=@_; # Clean up fields for safety for my $field ('basicexp') { $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g; @@ -898,27 +1089,61 @@ sub basicsearch { &output_blank_field_error($r); return OK; } - + my $pretty_search_string = ''.$ENV{'form.basicexp'}.''; + my $search_string = $ENV{'form.basicexp'}; + if ($ENV{'form.related'}) { + my @New_Words; + ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'}); + if (@New_Words) { + $pretty_search_string .= " with related words: @New_Words."; + } else { + $pretty_search_string .= " with no related words."; + } + } # Build SQL query string based on form page my $query=''; my $concatarg=join('," ",', ('title', 'author', 'subject', 'notes', 'abstract', 'keywords')); $concatarg='title' if $ENV{'form.titleonly'}; + $query=&build_SQL_query('concat('.$concatarg.')',$search_string); + $pretty_search_string .= "
\n"; + return 'select * from metadata where '.$query,$pretty_search_string; +} - $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,$query,$reply,$hidden); +=pod - return OK; -} +=item &related_version + +Modifies an input string to include related words. Words in the string +are replaced with parenthesized lists of 'OR'd words. For example +"torque" is replaced with "(torque OR word1 OR word2 OR ...)". + +Note: Using this twice on a string is probably silly. +=cut + +###################################################################### +###################################################################### +sub related_version { + my $search_string = shift; + my $result = $search_string; + my %New_Words = (); + while ($search_string =~ /(\w+)/cg) { + my $word = $1; + next if (lc($word) =~ /\b(or|and|not)\b/); + my @Words = &Apache::loncommon::get_related_words($word); + @Words = ($#Words>4? @Words[0..4] : @Words); + foreach (@Words) { $New_Words{$_}++;} + my $replacement = join " OR ", ($word,@Words); + $result =~ s/(\b)$word(\b)/$1($replacement)$2/g; + } + return $result,sort(keys(%New_Words)); +} ###################################################################### ###################################################################### @@ -1089,6 +1314,400 @@ sub build_date_queries { ###################################################################### ###################################################################### +=pod + +=item ©right_check() + +=cut + +###################################################################### +###################################################################### + +sub copyright_check { + my $Metadata = shift; + # Check copyright tags and skip results the user cannot use + my (undef,undef,$resdom,$resname) = split('/', + $Metadata->{'url'}); + # Check for priv + if (($Metadata->{'copyright'} eq 'priv') && + (($ENV{'user.name'} ne $resname) && + ($ENV{'user.domain'} ne $resdom))) { + return 0; + } + # Check for domain + if (($Metadata->{'copyright'} eq 'domain') && + ($ENV{'user.domain'} ne $resdom)) { + return 0; + } + return 1; +} + +##################################################################### +##################################################################### + +=pod + +=item MySQL Table Description + +MySQL table creation requires a precise description of the data to be +stored. The use of the correct types to hold data is vital to efficient +storage and quick retrieval of records. The columns must be described in +the following format: + +=cut + +## +## Restrictions: +## columns of type 'text' and 'blob' cannot have defaults. +## 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/; + +my %Datatypes = + ( id =>{ type => 'INT', + restrictions => 'NOT NULL', + primary_key => 'yes', + auto_inc => 'yes' + }, + title =>{ type=>'TEXT'}, + author =>{ type=>'TEXT'}, + subject =>{ type=>'TEXT'}, + url =>{ type=>'TEXT', + restrictions => 'NOT NULL' }, + keywords =>{ type=>'TEXT'}, + version =>{ type=>'TEXT'}, + notes =>{ type=>'TEXT'}, + abstract =>{ type=>'TEXT'}, + mime =>{ type=>'TEXT'}, + lang =>{ type=>'TEXT'}, + owner =>{ type=>'TEXT'}, + copyright =>{ type=>'TEXT'}, + hostname =>{ type=>'TEXT'}, + #-------------------------------------------------- + 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'}, + ); + +###################################################################### +###################################################################### + +=pod + +=item &write_status() + +=cut + +###################################################################### +###################################################################### +sub write_status { + my ($r,$string) = @_; + $r->print("
".$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() @@ -1106,20 +1725,29 @@ contacted, etc.) sub output_results { # &Apache::lonnet::logthis("output_results:".time); my $fnum; # search result counter - my ($mode,$r,$query,$replyref,$hidden)=@_; + my ($mode,$r,$replyref,$hidden)=@_; my %rhash=%{$replyref}; my $compiledresult=''; my $timeremain=300; # (seconds) my $elapsetime=0; my $resultflag=0; my $tflag=1; - my $viewselect=$ENV{'form.viewselect'}; + ## + ## 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(); - # spit out the results header - $r->print(&search_results_header($mode)); + my $persistent=&make_persistent(\%ENV); + # + # Begin producing output $r->rflush(); + # # begin showing the cataloged results my $action = "/adm/searchcat"; if ($mode eq 'Basic') { @@ -1140,7 +1768,6 @@ $persistent CATALOGCONTROLS # # make the pop-up window for status - # $r->print(&make_popwin(%rhash)); $r->rflush(); ## @@ -1217,12 +1844,13 @@ CATALOGCONTROLS } # 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 ($extrashow,$customfields,$customhash) = + &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 { @@ -1234,6 +1862,21 @@ CATALOGCONTROLS chomp $result; next unless $result; %Fields = &parse_raw_result($result,$rkey); + # + # Check copyright tags and skip results the user cannot use + my (undef,undef,$resdom,$resname) = split('/',$Fields{'url'}); + # Check for priv + if (($Fields{'copyright'} eq 'priv') && + (($ENV{'user.name'} ne $resname) && + ($ENV{'user.domain'} ne $resdom))) { + next; + } + # Check for domain + if (($Fields{'copyright'} eq 'domain') && + ($ENV{'user.domain'} ne $resdom)) { + next; + } + # $Fields{'extrashow'}=$extrashow; if ($extrashow) { foreach my $field (@customfields) { @@ -1255,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.=< $fnum++; } - if ($viewselect eq 'Detailed Citation View') { - $compiledresult.=&detailed_citation_view - (%Fields, hostname => $rkey ); - } - elsif ($viewselect eq 'Summary View') { - $compiledresult.=&summary_view - (%Fields, hostname => $rkey ); - } - elsif ($viewselect eq 'Fielded Format') { - $compiledresult.=&fielded_format_view - (%Fields, hostname => $rkey ); - } - elsif ($viewselect eq 'XML/SGML') { - $compiledresult.=&xml_sgml_view - (%Fields, hostname => $rkey ); - } + # Render the result into html + $compiledresult.= &$viewfunction(%Fields, hostname => $rkey ); if ($compiledresult or $servercount!=$servernum) { $compiledresult.="
"; } } - untie %hash; + untie %groupsearch_db; } if ($compiledresult) { $resultflag=1; $r->print($compiledresult); } - my $percent=sprintf('%3.0f',($servercount/$servernum*100)); } # End of foreach loop over servers remaining } # End of big loop - while($serversleft && $timeremain) unless ($resultflag) { $r->print("\nThere were no results that matched your query\n"); } -# $r->print(''."\n"); $r->rflush(); + $r->print(''. + "\n"); $r->print("\n\n"); + $r->rflush(); return; } @@ -1365,12 +1995,16 @@ sub parse_raw_result { &Apache::loncommon::copyrightdescription($Fields{'copyright'}); $Fields{'mimetag'} = &Apache::loncommon::filedescription($Fields{'mime'}); + if ($Fields{'author'}=~/^(\s*|error)$/) { + $Fields{'author'}="Unknown Author"; + } # Put spaces in the keyword list, if needed. $Fields{'keywords'}=~ s/,([A-z])/, $1/g; if ($Fields{'title'}=~ /^\s*$/ ) { $Fields{'title'}='Untitled'; } unless ($ENV{'user.adv'}) { + # What is this anyway? $Fields{'keywords'} = '- not displayed -'; $Fields{'notes'} = '- not displayed -'; $Fields{'abstract'} = '- not displayed -'; @@ -1469,7 +2103,7 @@ Checked for existance & 'edit' mode. ###################################################################### ###################################################################### sub search_results_header { - my ($mode) = @_; + my ($mode,$pretty_query) = @_; $mode = lc($mode); my $title; if ($mode eq 'advanced') { @@ -1571,6 +2205,9 @@ SCRIPT

$title

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

Search query: $pretty_query

"; + } return $result; } @@ -1596,16 +2233,13 @@ sub make_popwin { # rows of 10 each. No longer used to index images. my $sn=1; foreach my $sk (sort keys %rhash) { - # 'print(< @@ -1904,7 +2538,7 @@ Output a full html page with an error me sub output_date_error { my ($r,$message)=@_; # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); + my $persistent=&make_persistent(\%ENV); $r->print(< @@ -1936,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 @@ -1944,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{$_}; } } }