--- loncom/interface/lonsearchcat.pm	2002/06/26 16:04:13	1.130
+++ loncom/interface/lonsearchcat.pm	2002/07/08 14:52:19	1.138
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Search Catalog
 #
-# $Id: lonsearchcat.pm,v 1.130 2002/06/26 16:04:13 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.138 2002/07/08 14:52:19 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -107,7 +107,7 @@ 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   
 
@@ -212,25 +212,36 @@ END
 onClick='javascript:select_group()'>
 END
     }
-    $hidden .= <<END;
-<input type='hidden' name='mode'    value='$ENV{'form.mode'}'>
-<input type='hidden' name='form'    value='$ENV{'form.form'}'>
-<input type='hidden' name='element' value='$ENV{'form.element'}'>
-<input type='hidden' name='date' value='2'>
-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);
+    my $searchtype;
+    $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');
+    $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');
+    if ($searchtype) {
+        my ($query,$customquery,$customshow,$libraries) = 
+            (undef,undef,undef,undef);
+        if ($searchtype eq 'Basic') {
+            $query = &parse_basic_search($r);
+        } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
+            ($query,$customquery,$customshow,$libraries) 
+                = &parse_advanced_search($r);
+            return OK if (! defined($query));
+        }
+        # Send query statements over the network to be processed by 
+        # either the SQL database or a recursive scheme of 'grep'-like 
+        # actions (for custom metadata).
+        $r->rflush();
+        my $reply=&Apache::lonnet::metadata_query($query,$customquery,
+                                               $customshow,$libraries);
+        &output_results($searchtype,$r,$reply,$hidden);
     } elsif ($ENV{'form.reqinterface'} eq 'advanced') {
         # 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));
@@ -273,7 +284,7 @@ sub basic_search_form{
 $hidden
 <h3>Basic Search</h3>
 <p>
-Enter terms or quoted phrases separated by AND, OR, or NOT 
+Enter terms or phrases separated by AND, OR, or NOT 
 then press SEARCH below.
 </p>
 <p>
@@ -346,7 +357,7 @@ END
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Advanced Catalog Search</h1>
 <hr />
-Enter terms or quoted phrases separated by search operators 
+Enter terms or phrases separated by search operators 
 such as AND, OR, or NOT.<br />
 <form method="post" action="/adm/searchcat">
 $advanced_buttons
@@ -364,22 +375,13 @@ $hidden
 <!-- end of view selection -->
 </td></tr>
 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.=&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('notes',   'notes'   ,$ENV{'form.notes'});
+    $scrout.=&searchphrasefield('abstract','abstract',$ENV{'form.abstract'});
     # Hack - an empty table row.
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
     $scrout.=&searchphrasefield('file<br />extension','mime',
@@ -388,13 +390,45 @@ ENDHEADER
     $scrout.=&searchphrasefield('publisher<br />owner','owner',
 				$ENV{'form.owner'});
     $scrout.="</table>\n";
-#    $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});
-#    $scrout.=&selectbox('Limit by MIME type','mime',
-#			$ENV{'form.mime'},
-#			'any','Any type',
-#			\&{Apache::loncommon::filedescriptionex},
-#			(&Apache::loncommon::fileextensions));
+    $ENV{'form.category'}='any' unless length($ENV{'form.category'});
+    $scrout.=&selectbox('File Category','category',
+			$ENV{'form.category'},
+			'any','Any category',
+			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;
+    my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
+    # standalone machines do not get to choose a domain to search.
+    if ((scalar @domains) == 1) {
+        $scrout .='<input type="hidden" name="domains" value="any" />'."\n";
+    } else {
+        $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
+            'DOMAINS</b></font><br />'.
+                '<select name="domains" size="'.$size.'" multiple>'."\n".
+                    '<option name="any" value="any" '.
+                        ($domain_hash{'any'}? 'selected ' :'').
+                        '>all domains</option>'."\n";
+        foreach my $dom (sort @domains) {
+            $scrout.="<option name=\"$dom\" ".
+                ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";
+        }
+        $scrout.="</select>\n";
+    }
+    #----------------------------------------------------------------
     $scrout.=&selectbox('Limit by language','language',
 			$ENV{'form.language'},'any','Any Language',
 			\&{Apache::loncommon::languagedescription},
@@ -493,16 +527,19 @@ to be somewhat persistent.
 ######################################################################
 
 sub make_persistent {
+    my %save = %{shift()};
     my $persistent='';
-    foreach (keys %ENV) {
+    foreach (keys %save) {
 	if (/^form\./ && !/submit/) {
 	    my $name=$_;
-	    my $key=$name;
-	    $ENV{$key}=~s/\'//g; # do not mess with html field syntax
+            my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
 	    $name=~s/^form\.//;
-	    $persistent.=<<END;
-<input type="hidden" name="$name" value="$ENV{$key}" />
+            foreach (@values) {
+                s/\"/\'/g; # do not mess with html field syntax
+                $persistent.=<<END;
+<input type="hidden" name="$name" value="$_" />
 END
+            }
         }
     }
     return $persistent;
@@ -667,7 +704,7 @@ sub selectbox {
     if (! defined($functionref)) { $functionref = sub { $_[0]}; }
     my $uctitle=uc($title);
     my $selout="\n".'<p><font color="#800000" face="helvetica">'.
-        '<b>'.$uctitle.':</b></font><br /><select name="'.$name.'">';
+        '<b>'.$uctitle.': </b></font><select name="'.$name.'">';
     foreach ($anyvalue,@idlist) {
         $selout.='<option value="'.$_.'"';
         if ($_ eq $default and !/^any$/) {
@@ -686,16 +723,28 @@ sub selectbox {
 
 =pod 
 
-=item &advancedsearch()
+=item &parse_advanced_search()
+
+Parse advanced search form and return the following:
+
+=over 4
+
+=item $query Scalar containing an SQL query.
+
+=item $customquery Scalar containing a custom query.
 
-Parse advanced search results.
+=item $customshow Scalar containing commands to show custom metadata.
+
+=item $libraries_to_query Reference to array of domains to search.
+
+=back
 
 =cut
 
 ######################################################################
 ######################################################################
-sub advancedsearch {
-    my ($r,$hidden)=@_;
+sub parse_advanced_search {
+    my ($r)=@_;
     my $fillflag=0;
     # Clean up fields for safety
     for my $field ('title','author','subject','keywords','url','version',
@@ -706,7 +755,7 @@ sub advancedsearch {
 		   'lastrevisiondatestart_year','lastrevisiondateend_month',
 		   'lastrevisiondateend_day','lastrevisiondateend_year',
 		   'notes','abstract','mime','language','owner',
-		   'custommetadata','customshow') {
+		   'custommetadata','customshow','category') {
 	$ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }
     foreach ('mode','form','element') {
@@ -715,6 +764,12 @@ sub advancedsearch {
 	$ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
 	$ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }
+    # Preprocess the category form element.
+    if ($ENV{'form.category'} ne 'any') {
+        my @extensions = &Apache::loncommon::filecategorytypes
+            ($ENV{'form.category'});
+        $ENV{'form.mime'} = join ' OR ',@extensions;
+    }
     # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',
 		   'notes','abstract','mime','language','owner',
@@ -725,7 +780,7 @@ sub advancedsearch {
     }
     unless ($fillflag) {
 	&output_blank_field_error($r);
-	return OK;
+	return ;
     }
     # Turn the form input into a SQL-based query
     my $query='';
@@ -735,15 +790,16 @@ sub advancedsearch {
 		       'keywords','version','owner','mime') {
 	if ($ENV{'form.'.$field}) {
 	    push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
-	}
+        }
+    }
+    # I dislike the hack below.
+    if ($ENV{'form.category'}) {
+        $ENV{'form.mime'}='';
     }
     # Evaluate option lists
     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
 	push @queries,"(language like \"$ENV{'form.language'}\")";
     }
-#    if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
-#	push @queries,"(mime like \"$ENV{'form.mime'}\")";
-#    }
     if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
 	push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
     }
@@ -765,49 +821,53 @@ sub advancedsearch {
     # Test to see if date windows are legitimate
     if ($datequery=~/^Incorrect/) {
 	&output_date_error($r,$datequery);
-	return OK;
+	return ;
     }
     elsif ($datequery) {
 	push @queries,$datequery;
     }
     # Process form information for custom metadata querying
-    my $customquery='';
+    my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {
 	$customquery=&build_custommetadata_query('custommetadata',
 				      $ENV{'form.custommetadata'});
     }
-    my $customshow='';
+    my $customshow=undef;
     if ($ENV{'form.customshow'}) {
 	$customshow=$ENV{'form.customshow'};
 	$customshow=~s/[^\w\s]//g;
 	my @fields=split(/\s+/,$customshow);
 	$customshow=join(" ",@fields);
     }
-    # 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).
+    ## ---------------------------------------------------------------
+    ## Deal with restrictions to given domains
+    ## 
+    my $libraries_to_query = undef;
+    # $ENV{'form.domains'} can be either a scalar or an array reference.
+    # We need an array.
+    my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
+                           :  ($ENV{'form.domains'}) );
+    my %domain_hash = ();
+    foreach (@allowed_domains) {
+        $domain_hash{$_}++;
+    }
+    foreach (keys(%Apache::lonnet::libserv)) {
+        if ($_ eq 'any') {
+            $libraries_to_query = undef;
+            last;
+        }
+        if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
+            push @$libraries_to_query,$_;
+        }
+    }
+    #
     if (@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);
-	}
-	else {
-	    $reply=&Apache::lonnet::metadata_query($query,
-						   $customquery,$customshow);
-	}
-	&output_results('Advanced',$r,$customquery,$reply,$hidden);
-        return OK;
     } elsif ($customquery) {
-	my $reply; # reply hash reference
-	$reply=&Apache::lonnet::metadata_query('',
-					       $customquery,$customshow);
-	&output_results('Advanced',$r,$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);
 }
 
 ######################################################################
@@ -815,16 +875,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;
@@ -850,16 +910,7 @@ sub basicsearch {
     $concatarg='title' if $ENV{'form.titleonly'};
 
     $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);
-
-    return OK;
+    return 'select * from metadata where '.$query;
 }
 
 
@@ -1049,20 +1100,39 @@ 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 = undef;
+    if ($ENV{'form.viewselect'} eq 'Detailed Citation View') {
+        $viewfunction = \&detailed_citation_view;
+    } elsif ($ENV{'form.viewselect'} eq 'Summary View') {
+        $viewfunction = \&summary_view;
+    } elsif ($ENV{'form.viewselect'} eq 'Fielded Format') {
+        $viewfunction = \&fielded_format_view;
+    } elsif ($ENV{'form.viewselect'} eq 'XML/SGML') {
+        $viewfunction = \&xml_sgml_view;
+    }
+    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
+    my $persistent=&make_persistent(\%ENV);
+    #
+    # Begin producing output
     $r->print(&search_results_header($mode));
     $r->rflush();
+    #
     # begin showing the cataloged results
     my $action = "/adm/searchcat";
     if ($mode eq 'Basic') { 
@@ -1083,7 +1153,6 @@ $persistent
 CATALOGCONTROLS
     #
     # make the pop-up window for status
-    #
     $r->print(&make_popwin(%rhash));
     $r->rflush();
     ##
@@ -1160,7 +1229,8 @@ 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);
@@ -1177,6 +1247,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) {
@@ -1211,22 +1296,8 @@ END
 # <input type="hidden" name="url$fnum" value="$url" />
                     $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.="<hr align='left' width='200' noshade />";
                 }
@@ -1237,14 +1308,15 @@ END
 	    $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('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush(); 
+    $r->print('<script type="text/javascript">'.'popwin.close()</script>'.
+              "\n"); 
     $r->print("</body>\n</html>\n");
+    $r->rflush(); 
     return;
 }
 
@@ -1308,6 +1380,9 @@ 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*$/ ) { 
@@ -1539,16 +1614,13 @@ sub make_popwin {
     # rows of 10 each.  No longer used to index images.
     my $sn=1;
     foreach my $sk (sort keys %rhash) {
-	# '<a href="
 	$grid.="'<a href=\"";
-	# javascript:displayinfo('+
 	$grid.="javascript:opener.displayinfo('+";
-	# "'"+'key
 	$grid.="\"'\"+'";
 	$grid.=$sk;
 	my $hc;
 	if ($rhash{$sk} eq 'con_lost') {
-	    $hc="BAD CONNECTION, CONTACT SYSTEM ADMINISTRATOR ";
+	    $hc="BAD CONNECTION ";
 	}
 	else {
 	    $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";
@@ -1801,7 +1873,7 @@ sub filled {
 sub output_blank_field_error {
     my ($r)=@_;
     # make query information persistent to allow for subsequent revision
-    my $persistent=&make_persistent();
+    my $persistent=&make_persistent(\%ENV);
 
     $r->print(<<BEGINNING);
 <html>
@@ -1847,7 +1919,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(<<RESULTS);
 <html>