--- loncom/interface/lonsearchcat.pm	2006/03/21 21:07:31	1.259
+++ loncom/interface/lonsearchcat.pm	2006/07/17 19:47:20	1.273
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Search Catalog
 #
-# $Id: lonsearchcat.pm,v 1.259 2006/03/21 21:07:31 albertel Exp $
+# $Id: lonsearchcat.pm,v 1.273 2006/07/17 19:47:20 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -78,6 +78,8 @@ use HTML::Entities();
 use Parse::RecDescent;
 use Apache::lonnavmaps;
 use Apache::lonindexer();
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
 
 ######################################################################
 ######################################################################
@@ -153,7 +155,7 @@ sub handler {
     ##
     my $domain  = $r->dir_config('lonDefDomain');
     $diropendb= "/home/httpd/perl/tmp/".
-        "$env{'user.domain'}_$env{'user.name'}_searchcat.db";
+        "$env{'user.domain'}_$env{'user.name'}_sel_res.db";
     #
     # set the name of the persistent database
     #          $env{'form.persistent_db_id'} can only have digits in it.
@@ -164,8 +166,8 @@ sub handler {
     }
 
     my $persistent_db_file = "/home/httpd/perl/tmp/".
-        &Apache::lonnet::escape($domain).
-            '_'.&Apache::lonnet::escape($env{'user.name'}).
+        &escape($domain).
+            '_'.&escape($env{'user.name'}).
                 '_'.$env{'form.persistent_db_id'}.'_persistent_search.db';
     ##
     &Apache::lonhtmlcommon::clear_breadcrumbs();
@@ -199,8 +201,9 @@ sub handler {
 		    'We were unable to retrieve data describing your search. '.
 		    'This is a serious error and has been logged. '.
 		    'Please alert your LON-CAPA administrator.';
-		return &Apache::loncommon::simple_error_page($r,'Search Error',
-							     $msg);
+		&Apache::loncommon::simple_error_page($r,'Search Error',
+						      $msg);
+		return OK;
             }
         }
     } else {
@@ -212,7 +215,7 @@ sub handler {
     untie %groupsearch_db if (tied(%groupsearch_db));
     if (($env{'form.cleargroupsort'} eq '1') || 
         (($env{'form.launch'} eq '1') && 
-         ($env{'form.catalogmode'} eq 'groupsearch'))) {
+         ($env{'form.catalogmode'} eq 'import'))) {
 	if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
 	    &start_fresh_session();
 	    untie %groupsearch_db;
@@ -221,8 +224,9 @@ sub handler {
             # This is a stupid error to give to the user.  
             # It really tells them nothing.
 	    my $msg = 'Unable to tie hash to db file.';
-	    return &Apache::loncommon::simple_error_page($r,'Search Error',
-							 $msg);
+	    &Apache::loncommon::simple_error_page($r,'Search Error',
+						  $msg);
+	    return OK;
 	}
     }
     ##
@@ -256,7 +260,7 @@ sub handler {
             $closebutton .="onClick='self.close()'";
         }
         $closebutton .=">\n";
-    } elsif ($env{'form.catalogmode'} eq 'groupsearch') {
+    } elsif ($env{'form.catalogmode'} eq 'import') {
         $closebutton="<input type='button' name='close' value='CLOSE' ";
         if ($env{'form.phase'} =~ /(results|run_search)/) {
 	    $closebutton .="onClick='parent.close()'";
@@ -363,16 +367,18 @@ END
 	    my $msg = 
 		'Unable to create table in which to store search results. '.
 		'The search has been aborted.';
-	    return &Apache::loncommon::simple_error_page($r,'Search Error',
-							 $msg);
+	    &Apache::loncommon::simple_error_page($r,'Search Error',
+						  $msg);
+	    return OK;
         }
         delete($env{'form.launch'});
         if (! &make_form_data_persistent($r,$persistent_db_file)) {
 	    my $msg=
 		'Unable to properly store search information. '.
 		'The search has been aborted.';
-	    return &Apache::loncommon::simple_error_page($r,'Search Error',
-							 $msg);
+	    &Apache::loncommon::simple_error_page($r,'Search Error',
+						  $msg);
+	    return OK;
 	}
         ##
         ## Print out the frames interface
@@ -547,7 +553,7 @@ sub course_search {
                 } else {
                     $url .= '?symb=';
                 }
-                $url .= &Apache::lonnet::escape($resource->symb());
+                $url .= &escape($resource->symb());
                 my $title = $resource->compTitle();
                 $r->print('<br /><a href="'.$url.'" target="cat">'.
                      ($title?$title:$url).'</a>&nbsp;&nbsp;-&nbsp;'.$disctype.'<br />');
@@ -583,7 +589,7 @@ sub checkonthis {
     my ($extension)=($url=~/\.(\w+)$/);
     if (&Apache::loncommon::fileembstyle($extension) eq 'ssi' &&
 	($url) && ($fulltext)) {
-	$result.=&Apache::lonnet::ssi_body($url.'?symb='.&Apache::lonnet::escape($symb));
+	$result.=&Apache::lonnet::ssi_body($url.'?symb='.&escape($symb));
     }
     $result=~s/\s+/ /gs;
     my $applies = 0;
@@ -599,7 +605,7 @@ sub checkonthis {
 	   $href=&Apache::lonenc::encrypted($href)
 	       .'?symb='.&Apache::lonenc::encrypted($symb);
        } else {
-	   $href.='?symb='.&Apache::lonnet::escape($symb);
+	   $href.='?symb='.&escape($symb);
        }
        $r->print('<a href="'.$href.'" target="cat">'.($title?$title:$url).
 		 '</a><br />');
@@ -654,11 +660,10 @@ Prints the form for the basic search.  S
 ######################################################################
 sub print_basic_search_form {
     my ($r,$closebutton,$hidden_fields) = @_;
-    my $result = ($env{'form.catalogmode'} ne 'groupsearch');
+    my $result = ($env{'form.catalogmode'} ne 'import');
     my $bread_crumb =
-        &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Search_Basic',
-                                   undef,undef,
-                                   $env{'form.catalogmode'} ne 'groupsearch');
+        &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Basic',
+					    $env{'form.catalogmode'} ne 'import');
     my $scrout = &Apache::loncommon::start_page('Search').$bread_crumb;
     if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'})) {
         # Define interface components
@@ -700,10 +705,8 @@ sub print_basic_search_form {
         }
         $scrout.='<table>'.
             '<tr><td align="center" valign="top">'.
-            &Apache::lonhtmlcommon::textbox
-            ('basicexp',
-             &HTML::Entities::encode($env{'form.basicexp'},'<>&"'),50
-             ).
+            &Apache::lonhtmlcommon::textbox('basicexp',
+					    $env{'form.basicexp'},50).
              '<br />'.
             '<font size="-1">'.&searchhelp().'</font>'.'</td>'.
             '<td><font size="-1">'.
@@ -790,10 +793,8 @@ Prints the advanced search form.
 sub print_advanced_search_form{
     my ($r,$closebutton,$hidden_fields) = @_;
     my $bread_crumb = 
-        &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching',
-                                            'Search_Advanced',
-                                            undef,undef,
-                                  $env{'form.catalogmode'} ne 'groupsearch');
+        &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Advanced',
+					    $env{'form.catalogmode'} ne 'import');
     my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
 				       'reset' => 'Reset',
 				       'help' => 'Help');
@@ -1148,7 +1149,7 @@ sub get_persistent_form_data {
         # End kludge (hopefully)
         next if (exists($env{$name}));
         my @values = map { 
-            &Apache::lonnet::unescape($_);
+            &unescape($_);
         } split(',',$persistent_db{$name});
         next if (@values <1);
         if ($arrays_allowed{$name}) {
@@ -1194,7 +1195,7 @@ sub get_persistent_data {
             next;
         }
         my @values = map { 
-            &Apache::lonnet::unescape($_);
+            &unescape($_);
         } split(',',$persistent_db{$name});
         if (@values <= 1) {
             push @Values,$values[0];
@@ -1231,7 +1232,7 @@ sub make_persistent {
     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 );
+        my $store = join(',', map { &escape($_); } @values );
         $persistent_db{$name} = $store;
     }
     untie(%persistent_db);
@@ -1314,7 +1315,7 @@ sub parse_advanced_search {
     foreach ('mode','form','element') {
 	# is this required?  Hmmm.
 	next if (! exists($env{'form.'.$_}));
-	$env{'form.'.$_}=&Apache::lonnet::unescape($env{'form.'.$_});
+	$env{'form.'.$_}=&unescape($env{'form.'.$_});
 	$env{'form.'.$_}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }
     # Preprocess the category form element.
@@ -1539,12 +1540,12 @@ sub parse_domain_restrictions {
         $domain_hash{$_}++;
     }
     if ($domain_hash{'any'}) {
-        $pretty_domains_string = "In all LON-CAPA domains.";
+        $pretty_domains_string = &mt("in all LON-CAPA domains.");
     } else {
         if (@allowed_domains > 1) {
-            $pretty_domains_string = "In LON-CAPA domains:";
+            $pretty_domains_string = &mt("in LON-CAPA domains:");
         } else {
-            $pretty_domains_string = "In LON-CAPA domain ";
+            $pretty_domains_string = &mt("in LON-CAPA domain ");
         }
         foreach (sort @allowed_domains) {
             $pretty_domains_string .= "<b>".$_."</b> ";
@@ -1582,7 +1583,7 @@ sub parse_basic_search {
     foreach ('mode','form','element') {
 	# is this required?  Hmmm.
 	next unless (exists($env{"form.$_"}));
-	$env{"form.$_"}=&Apache::lonnet::unescape($env{"form.$_"});
+	$env{"form.$_"}=&unescape($env{"form.$_"});
 	$env{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }
     my ($libraries_to_query,$pretty_domains_string) = &parse_domain_restrictions();
@@ -1613,6 +1614,9 @@ sub parse_basic_search {
     #}
     my $final_query = 'SELECT * FROM metadata WHERE '.join(" AND ",@Queries);
     #
+    if ($env{'form.related'}) {
+	$pretty_search_string.=' '.&mt('(including related words)');
+    }
     if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
         $pretty_search_string .= ' '.$pretty_domains_string;
     }
@@ -2103,17 +2107,17 @@ sub print_sort_form {
 END
 
     my $start_page = &Apache::loncommon::start_page('Results',$js,
-						    {'only_body' => 1});
+						    {'no_title' => 1});
     my $breadcrumbs=
-        &Apache::lonhtmlcommon::breadcrumbs
-        (undef,'Searching','Searching',undef,undef,
-         $env{'form.catalogmode'} ne 'groupsearch');
+        &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
+					    $env{'form.catalogmode'} ne 'import');
 
     my $result = <<END;
 $start_page
 $breadcrumbs
-<form name="statusform" action="" method="POST">
-<input type="hidden" name="Queue" value="" />
+<form name="statusform" action="" method="post" target="_top">
+<input type="hidden" name="catalogmode" value="import" />
+<input type="hidden" name="acts" value="" />
 END
 
 #<h2>Sort Results</h2>
@@ -2132,7 +2136,7 @@ END
 <p>
 There are $total_results matches to your query. $revise
 </p><p>
-Search:$pretty_query_string
+Search: $pretty_query_string
 </p>
 </form>
 END
@@ -2334,15 +2338,15 @@ sub run_search {
     # Print run_search header
     #
     my $start_page = &Apache::loncommon::start_page('Search Status',undef,
-						    {'only_body' => 1});
-    my $breadcrumbs = &Apache::lonhtmlcommon::breadcrumbs
-        (undef,'Searching','Searching',undef,undef,
-         $env{'form.catalogmode'} ne 'groupsearch');
+						    {'no_title' => 1});
+    my $breadcrumbs =
+	&Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
+					    $env{'form.catalogmode'} ne 'import');
     $r->print(<<END);
 $start_page
 $breadcrumbs
 <form name="statusform" action="" method="post">
-<input type="hidden" name="Queue" value="" />
+<input type="hidden" name="acts" value="" />
 END
     # Remove leading and trailing <br />
     $pretty_string =~ s:^\s*<br />::i;
@@ -2527,7 +2531,7 @@ END
     # results to get, so let the client know the top frame needs to be
     # loaded from /adm/searchcat
     $r->print(&Apache::loncommon::end_page());
-#    if ($env{'form.catalogmode'} ne 'groupsearch') {
+#    if ($env{'form.catalogmode'} ne 'import') {
         $r->print("<script>".
                       "window.location='/adm/searchcat?".
                       "phase=sort&".
@@ -2594,15 +2598,15 @@ sub display_results {
     }
     ##
     ## $checkbox_num is a count of the number of checkboxes output on the 
-    ## page this is used only during catalogmode=groupsearch.
+    ## page this is used only during catalogmode=import.
     my $checkbox_num = 0;
     ##
     ## Get the catalog controls setup
     ##
     my $action = "/adm/searchcat?phase=results";
     ##
-    ## Deal with groupsearch by opening the groupsearch db file.
-    if ($env{'form.catalogmode'} eq 'groupsearch') {
+    ## Deal with import by opening the import db file.
+    if ($env{'form.catalogmode'} eq 'import') {
         if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                   &GDBM_WRCREAT(),0640)) {
             $r->print('Unable to store import results.</form>'.
@@ -2825,7 +2829,7 @@ onClick="javascript:select_data('$title'
 </font>
 END
         }
-    } elsif ($env{'form.catalogmode'} eq 'groupsearch') {
+    } elsif ($env{'form.catalogmode'} eq 'import') {
         $groupsearch_db{"pre_${fnum}_link"}=$url;
         $groupsearch_db{"pre_${fnum}_title"}=$title;
         $output.=<<END;
@@ -2857,7 +2861,7 @@ sub parse_row {
         &set_up_table_structure();
     }
     for (my $i=0;$i<=$#Row;$i++) {
-        $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
+        $Fields{$Datatypes[$i]->{'name'}}=&unescape($Row[$i]);
     }
     $Fields{'language'} = 
         &Apache::loncommon::languagedescription($Fields{'language'});
@@ -2894,7 +2898,7 @@ sub parse_raw_result {
     # conclude from self to others regarding fields
     my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash
         (map {
-            &Apache::lonnet::unescape($_);
+            &unescape($_);
         } (split(/\,/,$result)) );
     return %Fields;
 }
@@ -2932,7 +2936,7 @@ sub handle_custom_fields {
         if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
             my $tmp=$result;
             $tmp=~s/^custom\=//;
-            my ($k,$v)=map {&Apache::lonnet::unescape($_);
+            my ($k,$v)=map {&unescape($_);
                         } split(/\,/,$tmp);
             $customhash{$k}=$v;
         }
@@ -2964,7 +2968,7 @@ The following environment variables are
 
 =item 'form.catalogmode' 
 
-Checked for 'interactive' and 'groupsearch'.
+Checked for 'interactive' and 'import'.
 
 =item 'form.mode'
 
@@ -3056,28 +3060,28 @@ function changeURL(val) {
 SCRIPT
         }
     }
-    $js.=<<SCRIPT if $env{'form.catalogmode'} eq 'groupsearch';
+    $js.=<<SCRIPT if $env{'form.catalogmode'} eq 'import';
 <script type="text/javascript">
     function queue(checkbox_num,val) {
         if (document.forms.results.returnvalues.length != "undefined" &&
             typeof(document.forms.results.returnvalues.length) == "number") {
             if (document.forms.results.returnvalues[checkbox_num].checked) {
-                parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
+                parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b';
             } else {
-                parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
+                parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b';
             }
         } else {
             if (document.forms.results.returnvalues.checked) {
-                parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
+                parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b';
             } else {
-                parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
+                parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b';
             }
         }
     }
     function select_group() {
 	parent.window.location=
-    "/adm/groupsort?mode=$env{'form.mode'}&catalogmode=groupsearch&acts="+
-	    parent.statusframe.document.forms.statusform.elements.Queue.value;
+    "/adm/groupsort?mode=$env{'form.mode'}&catalogmode=import&acts="+
+	    parent.statusframe.document.forms.statusform.elements.acts.value;
     }
 </script>
 SCRIPT
@@ -3086,25 +3090,12 @@ SCRIPT
 						     {'only_body' =>1});
     my $result=<<END;
 $start_page
-<form name="results" method="post" action="/adm/searchcat" >
-<input type="hidden" name="Queue" value="" />
+<form name="results" method="post" action="/adm/searchcat">
 $importbutton
 END
     return $result;
 }
 
-######################################################################
-######################################################################
-sub search_status_header {
-    my $start_page = &Apache::loncommon::start_page('Search Status',undef,
-						    {'only_body' => 1});
-    return <<ENDSTATUS;
-$start_page
-<h3>Search Status</h3>
-Sending search request to LON-CAPA servers.<br />
-ENDSTATUS
-}
-
 sub results_link {
     my $basic_link   = "/adm/searchcat?"."&table=".$env{'form.table'}.
         "&persistent_db_id=".$env{'form.persistent_db_id'};
@@ -3121,22 +3112,27 @@ sub print_frames_interface {
         "&persistent_db_id=".$env{'form.persistent_db_id'};
     my $run_search_link = $basic_link."&phase=run_search";
     my $results_link = &results_link();
-    my $html     = &Apache::lonxml::xmlbegin();
-    my $head     = &Apache::loncommon::headtag('LON-CAPA Digital Library Search Results');
-    my $end_head = &Apache::loncommon::endheadtag();
-    my $result = <<"ENDFRAMES";
-$html
-$head
-<script>
+    my $js = <<JS;
+<script type="text/javascript">
 var targetwin = opener;
 var queue = '';
 </script>
-$end_head
-<frameset rows="150,*">
+JS
+
+    my $start_page =
+        &Apache::loncommon::start_page('LON-CAPA Digital Library Search Results',
+				       $js,
+				       {'frameset'    => 1,
+					'add_entries' => {
+					    'rows' => "150,*",},});
+    my $end_page =
+        &Apache::loncommon::end_page({'frameset' => 1});
+
+    my $result = <<"ENDFRAMES";
+$start_page
     <frame name="statusframe"  src="$run_search_link">
     <frame name="resultsframe" src="$results_link">
-</frameset>
-</html>
+$end_page
 ENDFRAMES
 
     $r->print($result);
@@ -3206,7 +3202,7 @@ sub detailed_citation_view {
     my $jumpurl=$values{'url'};
     $jumpurl=~s/^\/ext\//http\:\/\//;
     $result .= '<b>'.$prefix.
-        '<img src="'.&Apache::loncommon::icon($values{'url'}).' " />'.'&nbsp;'.
+        '<img src="'.&Apache::loncommon::icon($values{'url'}).'" />'.'&nbsp;'.
         '<a href="'.$jumpurl.'" '.
         'target="search_preview">'.$values{'title'}."</a></b>\n";
     $result .= "<p>\n";
@@ -3272,25 +3268,25 @@ sub detailed_citation_view {
         next if (! exists($values{$field->{'name'}}) ||
                  $values{$field->{'name'}} eq '');
         if (exists($field->{'type'}) && $field->{'type'} eq 'list') {
-            $result .= '<b>'.&mt($field->{'translate'}).'</b><ul>';
+            $result .= '<b>'.&mt($field->{'translate'}).'</b>';
             foreach my $item (split(',',$values{$field->{'name'}})){
-                $result .= '<li>'.
-                    '<a target="search_preview" '.
-                    'href="'.$jumpurl.'">'.$item.'</a></li>';
+                $result .= 
+		  &Apache::lonhtmlcommon::crumbs($item,
+		  (($env{'form.catalogmode'} eq 'import')?'_top':'preview'),
+		  '/res',
+		  (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),2,0,1);
             }
-            $result .= '</ul>';
         } elsif (exists($field->{'format'}) && $field->{'format'} ne ''){
             $result.= &mt($field->{'translate'},
                           sprintf($field->{'format'},
                                   $values{$field->{'name'}}))."<br />\n";
         } else {
             if ($field->{'special'} eq 'url link') {
-                $result.= 
-                     &mt($field->{'translate'},
-                         '<a href="'.$jumpurl.'" '.
-                         'target="search_preview">'.
-                         $values{$field->{'name'}}.
-                         '</a>');
+                $result.=
+		  &Apache::lonhtmlcommon::crumbs($jumpurl,
+		  (($env{'form.catalogmode'} eq 'import')?'_top':'preview'),
+		  '',
+		  (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),3,0,1);
             } else {
                 $result.= &mt($field->{'translate'},
                               $values{$field->{'name'}});
@@ -3347,10 +3343,14 @@ sub summary_view {
     }
     my $jumpurl=$values{'url'};
     $jumpurl=~s/^\/ext\//http\:\/\//;
+    my $link=&Apache::lonhtmlcommon::crumbs($jumpurl,
+		  (($env{'form.catalogmode'} eq 'import')?'':'preview'),
+		  '',
+		  (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),2,0,1);
 
     $result.=<<END;
 <a href="$jumpurl" 
-   target='search_preview'>$values{'title'}</a><br />
+   target='search_preview'>$values{'title'}</a>$link
 $values{'author'}, $values{'owner'} -- $values{'lastrevisiondate'}<br />
 $values{'copyrighttag'}<br />
 $values{'extrashow'}
@@ -3384,7 +3384,10 @@ sub compact_view {
     my ($prefix,%values) = @_;
     my $jumpurl=$values{'url'};
     $jumpurl=~s/^\/ext\//http\:\/\//;
-
+    my $link=&Apache::lonhtmlcommon::crumbs($jumpurl,
+		  (($env{'form.catalogmode'} eq 'import')?'_top':'preview'),
+		  '',
+		  (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),1,1,1).' ';
     my $result = 
         $prefix.'<img src="'.&Apache::loncommon::icon($values{'url'}).'">';
     if (exists($env{'form.sortfield'}) && 
@@ -3394,7 +3397,7 @@ sub compact_view {
         $result .= '&nbsp;'.$tmp.'&nbsp;';
     }
     $result.='&nbsp;<a href="'.$jumpurl.'" target="search_preview">'.
-        $values{'title'}.'</a>'.('&nbsp;'x2).
+        $values{'title'}.'</a>'.('&nbsp;'x2).$link.
         '<b>'.$values{'author'}.'</b> ('.$values{'domain'}.')<br />';
     return $result;
 }