loncom/interface/lonsearchcat.pm - diff

Return to lonsearchcat.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonsearchcat.pm between versions 1.124 and 1.212

-version 1.124, 2002/06/20 14:31:31
+version 1.212, 2004/04/19 21:46:50
  Line 25
  #
  # 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
- #
  ###############################################################################
  ###############################################################################
- Line 40
+ Line 32
  =head1 NAME
- lonsearchcat
+ lonsearchcat - LONCAPA Search Interface
  =head1 SYNOPSIS
- Line 56  described at http://www.lon-capa.org.
+ Line 48  described at http://www.lon-capa.org.
  lonsearchcat presents the user with an interface to search the LON-CAPA
  digital library.  lonsearchcat also initiates the execution of a search
  by sending the search parameters to LON-CAPA servers.  The progress of
- search (on a server basis) is displayed to the user in a seperate window.
+ search (on a server basis) is displayed to the user in a separate window.
  =head1 Internals
- Line 67  search (on a server basis) is displayed
+ Line 59  search (on a server basis) is displayed
  ###############################################################################
  ###############################################################################
- ##                                                                           ##
- ## ORGANIZATION OF THIS PERL MODULE                                          ##
- ##                                                                           ##
- ## 1. Modules used by this module                                            ##
- ## 2. Choices for different output views (detailed, summary, xml, etc)       ##
- ## 3. BEGIN block (to be run once after compilation)                         ##
- ## 4. Handling routine called via Apache and mod_perl                        ##
- ## 5. Other subroutines                                                      ##
- ##                                                                           ##
- ###############################################################################
  package Apache::lonsearchcat;
- # ------------------------------------------------- modules used by this module
  use strict;
- use Apache::Constants qw(:common);
+ use Apache::Constants qw(:common :http);
  use Apache::lonnet();
  use Apache::File();
  use CGI qw(:standard);
  use Text::Query;
  use GDBM_File;
  use Apache::loncommon();
+ use Apache::lonmysql();
- # ---------------------------------------- variables used throughout the module
+ use Apache::lonmeta;
+ use Apache::lonhtmlcommon;
+ use Apache::lonlocal;
+ use LONCAPA::lonmetadata();
+ use HTML::Entities();
  ######################################################################
  ######################################################################
+ ##
- =pod
+ ## Global variables
+ ##
- =item Global variables
- =over 4
- =item %hostdomains
- matches host name to host domain
- =item %hostips
- matches host name to host ip
- =item %hitcount
- stores number of hits per host
- =item $closebutton
- button that closes the search window
- =item $importbutton
- button to take the selecte results and go to group sorting
- =item %hash
- The ubiquitous database hash
- =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().
- =back
- =cut
  ######################################################################
  ######################################################################
+ my %groupsearch_db;  # Database hash used to save values for the
+                      # groupsearch RAT interface.
+ my %persistent_db;   # gdbm hash which holds data which is supposed to
+                      # persist across calls to lonsearchcat.pm
- # -- information holders
+ # The different view modes and associated functions
- my %hostdomains; # matches host name to host domain
- my %hostips;     # matches host name to host ip
- my %hitcount;    # stores number of hits per host
- # -- dynamically rendered interface components
- my $closebutton;  # button that closes the search window
- my $importbutton; # button to take the selected results and go to group sorting
- # -- miscellaneous variables
- my $yourself; # allows for quickly limiting to oneself
- my %hash;     # database hash
- # ------------------------------------------ choices for different output views
- # Detailed Citation View ---> sub detailed_citation_view
- # Summary View ---> sub summary_view
- # Fielded Format ---> sub fielded_format_view
- # XML/SGML ---> sub xml_sgml_view
- #------------------------------------------------------------- global variables
- my $diropendb = "";
- my $domain = "";
- # ----------------------------------------------------------------------- BEGIN
- =pod
- =item BEGIN block
- Load %hostdomains and %hostips with data from lonnet.pm.  Only library
+ my %Views = ("detailed" => \&detailed_citation_view,
- servers are considered.
+ 	     "summary"  => \&summary_view,
+ 	     "fielded"  => \&fielded_format_view,
- =cut
+ 	     "xml"      => \&xml_sgml_view,
+ 	     "compact"  => \&compact_view);
- BEGIN {
-     foreach (keys (%Apache::lonnet::libserv)) {
-         $hostdomains{$_}=$Apache::lonnet::hostdom{$_};
-         $hostips{$_}=$Apache::lonnet::hostip{$_};
-     }
- }
- ######################################################################
- ######################################################################
- =pod
- =item &handler() - main handler invoked by httpd child
- =item Variables
- =over 4
- =item $hidden
- holds 'hidden' html forms
- =item $scrout
- string that holds portions of the screen output
- =back
- =cut
  ######################################################################
  ######################################################################
  sub handler {
      my $r = shift;
-     untie %hash;
+ #    &set_defaults();
+     #
-     $r->content_type('text/html');
+     # set form defaults
+     #
+     my $hidden_fields;# Hold all the hidden fields used to keep track
+                       # of the search system state
+     my $importbutton; # button to take the selected results and go to group
+                       # sorting
+     my $diropendb;    # The full path to the (temporary) search database file.
+                       # This is set and used in &handler() and is also used in
+                       # &output_results().
+     my $bodytag;  # LON-CAPA standard body tag, gotten from
+                   # &Apache::lonnet::bodytag.
+                   # No title, no table, just a <body> tag.
+     my $loaderror=&Apache::lonnet::overloaderror($r);
+     if ($loaderror) { return $loaderror; }
+     my $closebutton;  # button that closes the search window
+                       # This button is different for the RAT compared to
+                       # normal invocation.
+     #
+     &Apache::loncommon::content_type($r,'text/html');
      $r->send_http_header;
      return OK if $r->header_only;
+     ##
-     my $domain  = $r->dir_config('lonDefDomain');
+     ## Prevent caching of the search interface window.  Hopefully this means
-     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
+     ## we will get the launch=1 passed in a little more.
-             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
+     &Apache::loncommon::no_cache($r);
+     ##
+     ## Pick up form fields passed in the links.
+     ##
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
-              ['catalogmode','launch','acts','mode','form','element',
+              ['catalogmode','launch','acts','mode','form','element','pause',
-               'reqinterface']);
+               'phase','persistent_db_id','table','start','show',
+               'cleargroupsort','titleelement']);
      ##
-     ## Clear out old values from database
+     ## 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 ($ENV{'form.launch'} eq '1') {
+     if (exists($ENV{'form.pause'})) {
- 	if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+         sleep(1);
+         delete($ENV{'form.pause'});
+     }
+     ##
+     ## Initialize global variables
+     ##
+     my $domain  = $r->dir_config('lonDefDomain');
+     $diropendb= "/home/httpd/perl/tmp/$ENV{'user.domain'}_$ENV{'user.name'}_searchcat.db";
+     #
+     # set the name of the persistent database
+     #          $ENV{'form.persistent_db_id'} can only have digits in it.
+     if (! exists($ENV{'form.persistent_db_id'}) ||
+         ($ENV{'form.persistent_db_id'} =~ /\D/) ||
+         ($ENV{'form.launch'} eq '1')) {
+         $ENV{'form.persistent_db_id'} = time;
+     }
+     $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';
+     ##
+     &Apache::lonhtmlcommon::clear_breadcrumbs();
+     if (exists($ENV{'request.course.id'}) && $ENV{'request.course.id'} ne '') {
+         &Apache::lonhtmlcommon::add_breadcrumb
+              ({href=>'/adm/searchcat?'.
+                    'catalogmode='.$ENV{'form.catalogmode'}.
+                    '&launch='.$ENV{'form.launch'}.
+                    '&mode='.$ENV{'form.mode'},
+               text=>"Course and Catalog Search",
+               bug=>'Searching',});
+     } else {
+         &Apache::lonhtmlcommon::add_breadcrumb
+              ({href=>'/adm/searchcat?'.
+                    'catalogmode='.$ENV{'form.catalogmode'}.
+                    '&launch='.$ENV{'form.launch'}.
+                    '&mode='.$ENV{'form.mode'},
+               text=>"Catalog Search",
+               bug=>'Searching',});
+     }
+     #
+     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(<<END);
+ <html>
+ <head><title>LON-CAPA Search Error</title></head>
+ $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.
+ </body>
+ </html>
+ END
+             return OK;
+         }
+     }
+     ##
+     ## Clear out old values from groupsearch database
+     ##
+     untie %groupsearch_db if (tied(%groupsearch_db));
+     if (($ENV{'form.cleargroupsort'} eq '1') ||
+         (($ENV{'form.launch'} eq '1') &&
+          ($ENV{'form.catalogmode'} eq 'groupsearch'))) {
+ 	if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
  	    &start_fresh_session();
- 	    untie %hash;
+ 	    untie %groupsearch_db;
+             delete($ENV{'form.cleargroupsort'});
  	} else {
- 	    $r->print('<html><head></head><body>Unable to tie hash to db '.
+             # This is a stupid error to give to the user.
- 		      'file</body></html>');
+             # It really tells them nothing.
+ 	    $r->print('<html><head></head>'.$bodytag.
+                       'Unable to tie hash to db file</body></html>');
  	    return OK;
  	}
      }
      ##
-     ## Produce some output, so people know it is working
+     ## Configure hidden fields
      ##
-     $r->print("\n");
+     $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
-     $r->rflush;
+         $ENV{'form.persistent_db_id'}.'" />'."\n";
+     if (exists($ENV{'form.catalogmode'})) {
+         $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
+                 $ENV{'form.catalogmode'}.'" />'."\n";
+     }
+     if (exists($ENV{'form.form'})) {
+         $hidden_fields .= '<input type="hidden" name="form" value="'.
+                 $ENV{'form.form'}.'" />'."\n";
+     }
+     if (exists($ENV{'form.element'})) {
+         $hidden_fields .= '<input type="hidden" name="element" value="'.
+                 $ENV{'form.element'}.'" />'."\n";
+     }
+     if (exists($ENV{'form.titleelement'})) {
+         $hidden_fields .= '<input type="hidden" name="titleelement" value="'.
+                 $ENV{'form.titleelement'}.'" />'."\n";
+     }
+     if (exists($ENV{'form.mode'})) {
+         $hidden_fields .= '<input type="hidden" name="mode" value="'.
+                 $ENV{'form.mode'}.'" />'."\n";
+     }
      ##
      ## Configure dynamic components of interface
      ##
-     my $hidden;       # Holds 'hidden' html forms
      if ($ENV{'form.catalogmode'} eq 'interactive') {
- 	$hidden="<input type='hidden' name='catalogmode' value='interactive'>".
+         $closebutton="<input type='button' name='close' value='CLOSE' ";
- 	    "\n";
+         if ($ENV{'form.phase'} =~ /(results|run_search)/) {
-         $closebutton="<input type='button' name='close' value='CLOSE' ".
+ 	    $closebutton .="onClick='parent.close()'";
- 	    "onClick='self.close()'>"."\n";
+         } else {
+             $closebutton .="onClick='self.close()'";
+         }
+         $closebutton .=">\n";
      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
- 	$hidden=<<END;
+         $closebutton="<input type='button' name='close' value='CLOSE' ";
- <input type='hidden' name='catalogmode' value='groupsearch'>
+         if ($ENV{'form.phase'} =~ /(results|run_search)/) {
- END
+ 	    $closebutton .="onClick='parent.close()'";
-         $closebutton=<<END;
+         } else {
- <input type='button' name='close' value='CLOSE' onClick='self.close()'>
+             $closebutton .="onClick='self.close()'";
- END
+         }
+         $closebutton .= ">";
          $importbutton=<<END;
  <input type='button' name='import' value='IMPORT'
  onClick='javascript:select_group()'>
  END
+     } else {
+         $closebutton = '';
+         $importbutton = '';
+     }
+     ##
+     ## Sanity checks on form elements
+     ##
+     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'}));
+     #
+     $ENV{'form.searchmode'} = 'basic';
+     if ($ENV{'form.phase'} eq 'adv_search' ||
+         $ENV{'form.phase'} eq 'disp_adv') {
+         $ENV{'form.searchmode'} = 'advanced';
+     } elsif ($ENV{'form.phase'} eq 'course_search') {
+         $ENV{'form.searchmode'} = 'course_search';
+     }
+     #
+     if ($ENV{'form.searchmode'} eq 'advanced') {
+         &Apache::lonhtmlcommon::add_breadcrumb
+             ({href=>'/adm/searchcat?phase=disp_adv&'.
+                   'catalogmode='.$ENV{'form.catalogmode'}.
+                   '&launch='.$ENV{'form.launch'}.
+                   '&mode='.$ENV{'form.mode'},
+                   text=>"Advanced Search",
+                   bug=>'Searching',});
+     } elsif ($ENV{'form.searchmode'} eq 'course search') {
+         &Apache::lonhtmlcommon::add_breadcrumb
+             ({href=>'/adm/searchcat?phase=disp_adv&'.
+                   'catalogmode='.$ENV{'form.catalogmode'}.
+                   '&launch='.$ENV{'form.launch'}.
+                   '&mode='.$ENV{'form.mode'},
+                   text=>"Course Search",
+                   bug=>'Searching',});
      }
-     $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
      ##
-     ##  What are we doing?
+     ## Switch on the phase
      ##
-     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
+     if ($ENV{'form.phase'} eq 'disp_basic') {
-         # Perform basic search and give results
+         &print_basic_search_form($r,$closebutton,$hidden_fields);
- 	return &basicsearch($r,\%ENV,$hidden);
+     } elsif ($ENV{'form.phase'} eq 'disp_adv') {
-     } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
+         &print_advanced_search_form($r,$closebutton,$hidden_fields);
-         # Perform advanced search and give results
+     } elsif ($ENV{'form.phase'} eq 'results') {
- 	return &advancedsearch($r,\%ENV,$hidden);
+         &display_results($r,$importbutton,$closebutton,$diropendb);
-     } elsif ($ENV{'form.reqinterface'} eq 'advanced') {
+     } elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) {
-         # Output the advanced interface
+         my ($query,$customquery,$customshow,$libraries,$pretty_string) =
-         $r->print(&advanced_search_form($closebutton,$hidden));
+             &get_persistent_data($persistent_db_file,
-         return OK;
+                  ['query','customquery','customshow',
-     } else {
+                   'libraries','pretty_string']);
-         # Output normal search interface
+         if ($ENV{'form.phase'} eq 'sort') {
-         $r->print(&basic_search_form($closebutton,$hidden));
+             &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 'course_search') {
+         &course_search($r);
+     } elsif(($ENV{'form.phase'} eq 'basic_search') ||
+             ($ENV{'form.phase'} eq 'adv_search')) {
+         # Set up table
+         if (! defined(&create_results_table())) {
+ 	    my $errorstring=&Apache::lonmysql::get_error();
+             &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
+                                      'needed table.  lonmysql error:'.
+                                      $errorstring);
+             $r->print(<<END);
+ <html><head><title>Search Error</title></head>
+ $bodytag
+ Unable to create table in which to store search results.
+ The search has been aborted.
+ </body>
+ </html>
+ END
+             return OK;
+         }
+         delete($ENV{'form.launch'});
+         if (! &make_form_data_persistent($r,$persistent_db_file)) {
+             $r->print(<<END);
+ <html><head><title>Search Error</title></head>
+ $bodytag
+ Unable to properly store search information.  The search has been aborted.
+ </body>
+ </html>
+ END
+             return OK;
+         }
+         #
+         # We are running a search
+         my ($query,$customquery,$customshow,$libraries) =
+             (undef,undef,undef,undef);
+         my $pretty_string;
+         if ($ENV{'form.phase'} eq 'basic_search') {
+             ($query,$pretty_string,$libraries) =
+                 &parse_basic_search($r,$closebutton,$hidden_fields);
+         } else {                      # Advanced search
+             ($query,$customquery,$customshow,$libraries,$pretty_string)
+                 = &parse_advanced_search($r,$closebutton,$hidden_fields);
+             return OK if (! defined($query));
+         }
+         &make_persistent({ query => $query,
+                            customquery => $customquery,
+                            customshow => $customshow,
+                            libraries => $libraries,
+                            pretty_string => $pretty_string },
+                          $persistent_db_file);
+         ##
+         ## Print out the frames interface
+         ##
+         &print_frames_interface($r);
      }
      return OK;
  }
  ######################################################################
  ######################################################################
+ ##
+ ##   Course Search
+ ##
+ ######################################################################
+ ######################################################################
+ {   # Scope the course search to avoid global variables
+ #
+ # Variables For course search
+ my %alreadyseen;
+ my %hash;
+ my $totalfound;
+ sub course_search {
+     my $r=shift;
+     my $bodytag=&Apache::loncommon::bodytag('Course Search').
+ 	&Apache::loncommon::help_open_bug('Searching');
+     my $pretty_search_string = '<b>'.$ENV{'form.courseexp'}.'</b>';
+     my $search_string = $ENV{'form.courseexp'};
+     my @New_Words;
+     if ($ENV{'form.crsrelated'}) {
+         ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
+         if (@New_Words) {
+             $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
+         } else {
+             $pretty_search_string .= ' '.&mt('with no related words').".";
+         }
+     }
+     my $fulltext=$ENV{'form.crsfulltext'};
+     my @allwords=($search_string,@New_Words);
+     $totalfound=0;
+     $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
+ 	      $bodytag.'<hr /><center><font size="+2" face="arial">'.$pretty_search_string.'</font></center><hr />');
+     $r->rflush();
+ # ======================================================= Go through the course
+     undef %alreadyseen;
+     %alreadyseen=();
+     my $c=$r->connection;
+     if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
+             &GDBM_READER(),0640)) {
+         foreach (keys %hash) {
+             if ($c->aborted()) { last; }
+             if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
+                 &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
+                              @allwords);
+             }
+         }
+         untie(%hash);
+     }
+     unless ($totalfound) {
+ 	$r->print('<p>'.&mt('No resources found').'.</p>');
+     }
+ # =================================================== Done going through course
+     $r->print('</body></html>');
+ }
- =pod
+ # =============================== This pulls up a resource and its dependencies
- =item &basic_search_form()
- Returns a scalar which holds html for the basic search form.
+ sub checkonthis {
+     my ($r,$url,$level,$title,$fulltext,@allwords)=@_;
+     $alreadyseen{$url}=1;
+     $r->rflush();
+     my $result=&Apache::lonnet::metadata($url,'title').' '.
+                &Apache::lonnet::metadata($url,'subject').' '.
+                &Apache::lonnet::metadata($url,'abstract').' '.
+                &Apache::lonnet::metadata($url,'keywords');
+     if (($url) && ($fulltext)) {
+ 	$result.=&Apache::lonnet::ssi_body($url);
+     }
+     $result=~s/\s+/ /gs;
+     my $applies=0;
+     foreach (@allwords) {
+         if ($_=~/\w/) {
+ 	   if ($result=~/$_/si) {
+ 	      $applies++;
+            }
+        }
+     }
+ # Does this resource apply?
+     if ($applies) {
+        $r->print('<br />');
+        for (my $i=0;$i<=$level*5;$i++) {
+            $r->print('&nbsp;');
+        }
+        $r->print('<a href="'.$url.'" target="cat">'.
+ 		 ($title?$title:$url).'</a><br />');
+        $totalfound++;
+     } elsif ($fulltext) {
+        $r->print(' .');
+     }
+     $r->rflush();
+ # Check also the dependencies of this one
+     my $dependencies=
+                 &Apache::lonnet::metadata($url,'dependencies');
+     foreach (split(/\,/,$dependencies)) {
+        if (($_=~/^\/res\//) && (!$alreadyseen{$_})) {
+           &checkonthis($r,$_,$level+1,'',$fulltext,@allwords);
+        }
+     }
+ }
- =cut
+ sub untiehash {
+     if (tied(%hash)) {
+         untie(%hash);
+     }
+ }
- ######################################################################
+ } # End of course search scoping
- ######################################################################
- sub basic_search_form{
+ sub search_html_header {
-     my ($closebutton,$hidden) = @_;
+     my $Str = <<ENDHEADER;
-     my $scrout=<<"ENDDOCUMENT";
  <html>
  <head>
  <title>The LearningOnline Network with CAPA</title>
- Line 311  sub basic_search_form{
+ Line 511  sub basic_search_form{
      }
  </script>
  </head>
- <body bgcolor="#FFFFFF">
+ ENDHEADER
- <img align='right' src='/adm/lonIcons/lonlogos.gif' />
+     return $Str;
- <h1>Search Catalog</h1>
+ }
- <form method="post" action="/adm/searchcat">
- $hidden
+ ######################################################################
- <h3>Basic Search</h3>
+ ######################################################################
+ =pod
+ =item &print_basic_search_form()
+ Prints the form for the basic search.  Sorry the name is so cryptic.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub print_basic_search_form {
+     my ($r,$closebutton,$hidden_fields) = @_;
+     my $bodytag=&Apache::loncommon::bodytag('Search').
+         &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Finding_Resources',
+                                             undef,undef,! $ENV{'form.launch'});
+     my $scrout = &search_html_header().$bodytag;
+     if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
+         my $Statement=&searchhelp();
+         $scrout.=(<<ENDDOCUMENT);
+ <form name="loncapa_search" method="post" action="/adm/searchcat">
+ <input type="hidden" name="phase" value="basic_search" />
+ $hidden_fields
  <p>
- Enter terms or phrases separated by AND, OR, or NOT then press SEARCH below.
+ $Statement.
  </p>
  <p>
  <table>
  <tr><td>
  ENDDOCUMENT
-     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).
+         $scrout.='&nbsp;'.
-         '&nbsp;';
+             &Apache::lonhtmlcommon::textbox('basicexp',
- #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});
+                                         $ENV{'form.basicexp'},40).
- #    $scrout.='<font color="#800000">Search historic archives</font>';
+                                         '&nbsp;';
-     $scrout.=<<ENDDOCUMENT;
+         my $relatedcheckbox =
- </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>
+             &Apache::lonhtmlcommon::checkbox('related',
+                                              $ENV{'form.related'});
+         my $domain = $r->dir_config('lonDefDomain');
+         my $domaincheckbox =
+             &Apache::lonhtmlcommon::checkbox('domains',
+                                              $ENV{'form.domains'});
+         my $srch=&mt('Search');
+         my $header=&mt('Advanced Search');
+         my $userelatedwords=&mt('use related words');
+         my $onlysearchdomain=&mt('only search domain');
+         my $view=&viewoptions();
+         $scrout.=<<END;
+ </td><td><a
+ href="/adm/searchcat?phase=disp_adv&catalogmode=$ENV{'form.catalogmode'}&launch=$ENV{'form.launch'}&mode=$ENV{'form.mode'}"
+ >$header</a></td></tr>
+ <tr><td>$relatedcheckbox $userelatedwords</td>
+     <td>$domaincheckbox $onlysearchdomain <b>$domain</b></td></tr>
+ </table>
  </p>
+ $view
  <p>
- &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;
+ &nbsp;<input type="submit" name="basicsubmit" value='$srch' />&nbsp;
  $closebutton
- <!-- basic view selection -->
+ END
- <select name='basicviewselect'>
+     $scrout.=<<ENDDOCUMENT;
- <option value='Detailed Citation View' selected="true">
- Detailed Citation View</option>
- <option value='Summary View'>Summary View</option>
- <option value='Fielded Format'>Fielded Format</option>
- <option value='XML/SGML'>XML/SGML</option>
- </select>
- <!-- end of basic view selection -->
- <input type="button" value="HELP" onClick="openhelp()" />
  </p>
  </form>
+ ENDDOCUMENT
+     }
+     if ($ENV{'request.course.id'}) {
+ 	my %lt=&Apache::lonlocal::texthash(
+ 					   'srch' => 'Search',
+                                            'header' => 'Course Search',
+ 	 'note' => 'Enter terms or phrases, then press "Search" below',
+ 	 'use' => 'use related words',
+ 	 'full' =>'fulltext search (time consuming)'
+ 					   );
+         $scrout.=(<<ENDCOURSESEARCH);
+ <hr />
+ <h1>$lt{'header'}</h1>
+ <form name="course_search" method="post" action="/adm/searchcat">
+ <input type="hidden" name="phase" value="course_search" />
+ $hidden_fields
+ <p>
+ $lt{'note'}.
+ </p>
+ <p>
+ <table>
+ <tr><td>
+ ENDCOURSESEARCH
+         $scrout.='&nbsp;'.
+             &Apache::lonhtmlcommon::textbox('courseexp',
+                                   $ENV{'form.courseexp'},40);
+         my $crscheckbox =
+             &Apache::lonhtmlcommon::checkbox('crsfulltext',
+                                    $ENV{'form.crsfulltext'});
+         my $relcheckbox =
+             &Apache::lonhtmlcommon::checkbox('crsrelated',
+ 				   $ENV{'form.crsrelated'});
+         $scrout.=(<<ENDENDCOURSE);
+ </td></tr>
+ <tr><td>$relcheckbox $lt{'use'}</td><td></td></tr>
+ <tr><td>$crscheckbox $lt{'full'}</td><td></td></tr>
+ </table><p>
+ &nbsp;<input type="submit" name="coursesubmit" value='$lt{'srch'}' />
+ </p>
+ ENDENDCOURSE
+     }
+     $scrout.=(<<ENDDOCUMENT);
  </body>
  </html>
  ENDDOCUMENT
-     return $scrout;
+     $r->print($scrout);
+     return;
  }
  ######################################################################
  ######################################################################
- Line 358  ENDDOCUMENT
+ Line 634  ENDDOCUMENT
  =item &advanced_search_form()
- Returns a scalar which holds html for the advanced search form.
+ Prints the advanced search form.
  =cut
  ######################################################################
  ######################################################################
+ sub print_advanced_search_form{
- sub advanced_search_form{
+     my ($r,$closebutton,$hidden_fields) = @_;
-     my ($closebutton,$hidden) = @_;
+     my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
-     my $scrout=<<"ENDHEADER";
+ 				       'reset' => 'Reset',
- <html>
+ 				       'help' => 'Help');
- <head>
+     my $advanced_buttons = <<"END";
- <title>The LearningOnline Network with CAPA</title>
- <script type="text/javascript">
-     function openhelp(val) {
- 	openhelpwin=open('/adm/help/searchcat.html','helpscreen',
- 	     'scrollbars=1,width=600,height=300');
- 	openhelpwin.focus();
-     }
- </script>
- </head>
- <body bgcolor="#FFFFFF">
- <img align='right' src='/adm/lonIcons/lonlogos.gif' />
- <h1>Search Catalog</h1>
- <form method="post" action="/adm/searchcat">
- $hidden
- <hr />
- <h3>Advanced Search</h3>
- ENDHEADER
-     $scrout.=&searchphrasefield('Limit by title','title',
- 			$ENV{'form.title'});
-     $scrout.=&searchphrasefield('Limit by author','author',
- 			$ENV{'form.author'});
-     $scrout.=&searchphrasefield('Limit by subject','subject',
- 			$ENV{'form.subject'});
-     $scrout.=&searchphrasefield('Limit by keywords','keywords',
- 			$ENV{'form.keywords'});
-     $scrout.=&searchphrasefield('Limit by URL','url',
- 			$ENV{'form.url'});
- #    $scrout.=&searchphrasefield('Limit by version','version',
- #			$ENV{'form.version'});
-     $scrout.=&searchphrasefield('Limit by notes','notes',
- 			$ENV{'form.notes'});
-     $scrout.=&searchphrasefield('Limit by abstract','abstract',
- 			$ENV{'form.abstract'});
-     $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.language'}='any' unless length($ENV{'form.language'});
-     $scrout.=&selectbox('Limit by language','language',
- 			$ENV{'form.language'},'any','Any Language',
- 			\&{Apache::loncommon::languagedescription},
- 			(&Apache::loncommon::languageids),
- 			);
- # ------------------------------------------------ Compute date selection boxes
-     $scrout.=<<CREATIONDATESTART;
- <p>
- <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>
- </font>
- <br />
- between:
- CREATIONDATESTART
-     $scrout.=&dateboxes('creationdatestart',1,1,1976,
- 			$ENV{'form.creationdatestart_month'},
- 			$ENV{'form.creationdatestart_day'},
- 			$ENV{'form.creationdatestart_year'},
- 			);
-     $scrout.="and:\n";
-     $scrout.=&dateboxes('creationdateend',12,31,2051,
- 			$ENV{'form.creationdateend_month'},
- 			$ENV{'form.creationdateend_day'},
- 			$ENV{'form.creationdateend_year'},
- 			);
-     $scrout.="</p>";
-     $scrout.=<<LASTREVISIONDATESTART;
- <p>
- <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:
- </b></font>
- <br />between:
- LASTREVISIONDATESTART
-     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
- 			$ENV{'form.lastrevisiondatestart_month'},
- 			$ENV{'form.lastrevisiondatestart_day'},
- 			$ENV{'form.lastrevisiondatestart_year'},
- 			);
-     $scrout.=<<LASTREVISIONDATEEND;
- and:
- LASTREVISIONDATEEND
-     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,
- 			$ENV{'form.lastrevisiondateend_month'},
- 			$ENV{'form.lastrevisiondateend_day'},
- 			$ENV{'form.lastrevisiondateend_year'},
- 			);
-     $scrout.='</p>';
-     $scrout.=&searchphrasefield('Limit by publisher/owner','owner',
- 				$ENV{'form.owner'});
-     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
-     $scrout.=&selectbox('Limit by copyright/distribution','copyright',
- 			 $ENV{'form.copyright'},
- 			 'any','Any copyright/distribution',
- 			 \&{Apache::loncommon::copyrightdescription},
- 			 (&Apache::loncommon::copyrightids),
- 			 );
- # ------------------------------------------- Compute customized metadata field
-     $scrout.=<<CUSTOMMETADATA;
- <p>
- <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>
- </font>
- For resource-specific metadata, enter in an expression in the form of
- <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />
- <b>Example:</b> grandmother=75 OR grandfather=85
- <br />
- CUSTOMMETADATA
-     $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
-     $scrout.=<<CUSTOMSHOW;
  <p>
- <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
+ <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
- </font>
+ <input type="reset" name="reset" value='$lt{"reset"}' />
- Enter in a space-separated list of special metadata fields to show
- in a fielded listing for each record result.
- <br />
- CUSTOMSHOW
-     $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
-     $scrout.=<<ENDDOCUMENT;
- <p>
- <input type="submit" name="advancedsubmit" value='SEARCH' />
- <input type="reset" name="reset" value='RESET' />
  $closebutton
- <!-- advance view select -->
+ <input type="button" value="$lt{'help'}" onClick="openhelp()" />
- <select name='advancedviewselect'>
+ END
- <option value='Detailed Citation View' selected="true">
+     my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search').
- Detailed Citation View</option>
+         &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching',
- <option value='Summary View'>Summary View</option>
+                                             'Finding_Resources',
- <option value='Fielded Format'>Fielded Format</option>
+                                             undef,undef,
- <option value='XML/SGML'>XML/SGML</option>
+                                             ! $ENV{'form.launch'});
- </select>
+     my $searchhelp=&searchhelp();
- <!-- end of advanced view select -->
+     my $scrout=&search_html_header();
- <input type="button" value="HELP" onClick="openhelp()" />
+     $scrout .= <<"ENDHEADER";
- </p>
+ $bodytag
+ <form method="post" action="/adm/searchcat" name="advsearch">
+ $advanced_buttons
+ ENDHEADER
+     $scrout.=('&nbsp;'x2).&viewoptions().'</p>'.$hidden_fields.
+         '<input type="hidden" name="phase" value="adv_search" />';
+     my %fields=&Apache::lonmeta::fieldnames();
+     #
+     $scrout.= '<p>'.$searchhelp.'</p>'.
+         "<table>\n";
+     my %related_word_search =
+         ('title'=>1,
+          'author'=>0,
+          'owner'=>0,
+          'authorspace'=>0,
+          'modifyinguser'=>0,
+          'keywords'=>1,
+          'notes'=>1,
+          'abstract'=>1,
+          'standards'=>1,
+          'mime'=>1,
+          );
+     #
+     foreach my $field ('title','author','owner','authorspace','modifyinguser',
+ 	     'keywords','notes','abstract','standards','mime') {
+ 	$scrout.='<tr><td align="right">'.&titlefield($fields{$field}).'</td><td>'.
+ 	    &Apache::lonmeta::prettyinput($field,
+                                           $ENV{'form.'.$field},
+                                           $field,
+                                           'advsearch',
+ 					  $related_word_search{$field},
+                                           '</td><td align="left">',
+                                           $ENV{'form.'.$field.'_related'},
+);
+         if ($related_word_search{$field}) {
+             $scrout .= 'related words';
+         } else {
+             $scrout .= '</td><td>&nbsp;';
+         }
+         $scrout .= '</td></tr>'.$/;
+     }
+     foreach my $field ('lowestgradelevel','highestgradelevel') {
+ 	$scrout.='<tr>'.
+             '<td align="right">'.&titlefield($fields{$field}).'</td>'.
+             '<td colspan="2">'.
+ 	    &Apache::lonmeta::prettyinput($field,
+                                           $ENV{'form.'.$field},
+                                           $field,
+                                           'advsearch',
+).
+                                           '</td></tr>'.$/;
+     }
+     $scrout.='<tr><td align="right">'.
+ 	&titlefield(&mt('MIME Type Category')).'</td><td colspan="2">'.
+ 	    &Apache::loncommon::filecategoryselect('category',
+ 						   $ENV{'form.category'}).
+ 	    '</td></tr>'.$/;
+     $scrout.='<tr><td align="right" valign="top">'.
+ 	&titlefield(&mt('Domains')).'</td><td colspan="2">'.
+ 	    &Apache::loncommon::domain_select('domains',
+ 						   $ENV{'form.domains'},1).
+ 	    '</td></tr>'.$/;
+     $scrout .= "</table>\n<br />\n<table>\n";
+     my %dates=&Apache::lonlocal::texthash
+         ('creationdatestart'     => 'Creation Date After',
+          'creationdateend'       => 'Creation Date Before',
+          'lastrevisiondatestart' => 'Last Revision Date After',
+          'lastrevisiondateend'   => 'Last Revision Date Before');
+     foreach my $field (sort keys %dates) {
+ 	$scrout.='<tr>'.
+             '<td align="right">'.&titlefield($dates{$field}).'</td><td>'.
+ 	    &Apache::lonhtmlcommon::date_setter('advsearch',$field,0,'',1).
+ 	    '</td></tr>'.$/;
+     }
+     $scrout.="</table>\n";
+     $scrout.=<<ENDDOCUMENT;
+ $advanced_buttons
  </form>
  </body>
  </html>
  ENDDOCUMENT
-     return $scrout;
+     $r->print($scrout);
+     return;
  }
  ######################################################################
- Line 512  ENDDOCUMENT
+ Line 750  ENDDOCUMENT
  =pod
- =item &make_persistent()
+ =item &titlefield()
- Returns a scalar which holds the current ENV{'form.*'} values in
+ Inputs: title text
- a 'hidden' html input tag.
+ Outputs: titletext with font wrapper
  =cut
  ######################################################################
  ######################################################################
+ sub titlefield {
- sub make_persistent {
+     my $title=shift;
-     my $persistent='';
+     return $title;
-     foreach (keys %ENV) {
- 	if (/^form\./ && !/submit/) {
- 	    my $name=$_;
- 	    my $key=$name;
- 	    $ENV{$key}=~s/\'//g; # do not mess with html field syntax
- 	    $name=~s/^form\.//;
- 	    $persistent.=<<END;
- <input type='hidden' name='$name' value='$ENV{$key}' />
- END
-         }
-     }
-     return $persistent;
  }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item viewoptiontext()
+ Inputs: codename for view option
+ Outputs: displayed text
+ =cut
+ ######################################################################
+ ######################################################################
+ sub viewoptiontext {
+     my $code=shift;
+     my %desc=&Apache::lonlocal::texthash
+         ('detailed' => "Detailed Citation View",
+          'xml' => 'XML/SGML',
+          'compact' => 'Compact View',
+          'fielded' => 'Fielded Format',
+          'summary' => 'Summary View');
+     return $desc{$code};
+ }
  ######################################################################
  ######################################################################
  =pod
- =item HTML form building functions
+ =item viewoptions()
- =over 4
+ Inputs: none
+ Outputs: text for box with view options
+ =cut
- =item &simpletextfield()
+ ######################################################################
+ ######################################################################
+ sub viewoptions {
+     my $scrout="\n".'<nobr>';
+     if (! defined($ENV{'form.viewselect'})) {
+         $ENV{'form.viewselect'}='detailed';
+     }
+     $scrout.=&Apache::lonmeta::selectbox('viewselect',
+ 			$ENV{'form.viewselect'},
+ 			\&viewoptiontext,
+ 			sort(keys(%Views)));
+     $scrout.= '&nbsp;&nbsp;';
+     $scrout.=&Apache::lonmeta::selectbox('show',
+ 			$ENV{'form.show'},
+ 			undef,
+ 			(10,20,50,100,1000,10000));
+     $scrout .= ('&nbsp;'x2).&mt('Records per Page').'</nobr>'.$/;
+     return $scrout;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
- Inputs: $name,$value,$size
+ =item searchhelp()
- Returns a text input field with the given name, value, and size.
+ Inputs: none
- If size is not specified, a value of 20 is used.
- =item &simplecheckbox()
+ Outputs: return little blurb on how to enter searches
- Inputs: $name,$value
+ =cut
- Returns a simple check box with the given $name.
+ ######################################################################
- If $value eq 'on' the box is checked.
+ ######################################################################
+ sub searchhelp {
+     return &mt('Enter terms or phrases separated by AND, OR, or NOT');
+ }
- =item &searchphrasefield()
+ ######################################################################
+ ######################################################################
- Inputs: $title,$name,$value
+ =pod
- Returns html for a title line and an input field for entering search terms.
+ =item &get_persistent_form_data()
- 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.
- =item &dateboxes()
+ Inputs: filename of database
- =item &selectbox()
+ Outputs: returns undef on database errors.
- =back
+ 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.domains'=>1);
+     #
+     # Loop through the keys, looking for 'form.'
+     foreach my $name (keys(%persistent_db)) {
+         next if ($name !~ /^form./);
+         # Kludgification begins!
+         if ($name eq 'form.domains' &&
+             $ENV{'form.searchmode'} eq 'basic' &&
+             $ENV{'form.phase'} ne 'disp_basic') {
+             next;
+         }
+         # End kludge (hopefully)
+         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;
+ }
- sub simpletextfield {
+ ######################################################################
-     my ($name,$value,$size)=@_;
+ ######################################################################
-     $size = 20 if (! defined($size));
-     return '<input type="text" name="'.$name.
+ =pod
-         '" size="'.$size.'" value="'.$value.'" />';
- }
+ =item &get_persistent_data()
- sub simplecheckbox {
+ Inputs: filename of database, ref to array of values to recover.
-     my ($name,$value)=@_;
-     my $checked='';
+ Outputs: array of values.  Returns undef on error.
-     $checked="CHECKED" if $value eq 'on';
-     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';
+ 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
- sub searchphrasefield {
+ returned value will be an array pointer.
-     my ($title,$name,$value)=@_;
-     my $instruction=<<END;
+ =cut
- Enter terms or phrases separated by search operators such as AND, OR, or NOT.
- END
+ ######################################################################
-     my $uctitle=uc($title);
+ ######################################################################
-     return "\n".
+ sub get_persistent_data {
-         '<p><font color="#800000" face="helvetica"><b>'.$uctitle.':</b>'.
+     my $filename = shift;
-         "</FONT> $instruction<br />".&simpletextfield($name,$value,80);
+     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 {
+             push @Values,\@values;
+         }
+     }
+     untie (%persistent_db);
+     return @Values;
  }
- sub dateboxes {
+ ######################################################################
-     my ($name,$defaultmonth,$defaultday,$defaultyear,
+ ######################################################################
- 	$currentmonth,$currentday,$currentyear)=@_;
-     ($defaultmonth,$defaultday,$defaultyear)=('','','');
+ =pod
-     #
-     # Day
+ =item &make_persistent()
-     my $day=<<END;
- <select name="${name}_day">
+ Inputs: Hash of values to save, filename of persistent database.
- <option value='$defaultday'> </option>
- END
+ Store variables away to the %persistent_db.
-     for (my $i = 1; $i<=31; $i++) {
+ Values will be escaped.  Values that are array pointers will have their
- 	$day.="<option value=\"$i\">$i</option>\n";
+ elements escaped and concatenated in a comma separated string.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub make_persistent {
+     my %save = %{shift()};
+     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 );
+         $persistent_db{$name} = $store;
      }
-     $day.="</select>\n";
+     untie(%persistent_db);
-     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);
+     return 1;
-     #
+ }
-     # Month
-     my $month=<<END;
+ ######################################################################
- <select name="${name}_month">
+ ######################################################################
- <option value='$defaultmonth'> </option>
- END
+ =pod
-     my $i = 1;
-     foreach (qw/January February March April May June
+ =item &make_form_data_persistent()
- 	     July August September October November December /){
- 	$month .="<option value=\"$i\">$_</option>\n";
+ Inputs: filename of persistent database.
- 	$i++;
-     }
+ Store most form variables away to the %persistent_db.
-     $month.="</select>\n";
+ Values will be escaped.  Values that are array pointers will have their
-     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
+ elements escaped and concatenated in a comma separated string.
-     #
-     # Year (obviously)
+ =cut
-     my $year=<<END;
- <select name="${name}_year">
+ ######################################################################
- <option value='$defaultyear'> </option>
+ ######################################################################
- END
+ sub make_form_data_persistent {
-     my $maxyear = 2051;
+     my $r = shift;
-     for (my $i = 1976; $i<=$maxyear; $i++) {
+     my $filename = shift;
- 	$year.="<option value=\"$i\">$i</option>\n";
+     my %save;
-     }
+     foreach (keys(%ENV)) {
-     $year.="</select>\n";
+         next if (!/^form/ || /submit/);
-     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);
+         $save{$_} = $ENV{$_};
-     return "$month$day$year";
- }
- sub selectbox {
-     my ($title,$name,$value,$anyvalue,$anytag,$functionref,@idlist)=@_;
-     my $uctitle=uc($title);
-     my $selout="\n".'<p><font color="#800000" face="helvetica">'.
-         '<b>'.$uctitle.':</b></font><br /><select name="'.$name.'">';
-     foreach ($anyvalue,@idlist) {
-         $selout.='<option value="'.$_.'"';
-         if ($_ eq $value and !/^any$/) {
- 	    $selout.=' selected >'.&{$functionref}($_).'</option>';
- 	}
- 	elsif ($_ eq $value and /^$anyvalue$/) {
- 	    $selout.=' selected >'.$anytag.'</option>';
- 	}
-         else {$selout.='>'.&{$functionref}($_).'</option>';}
      }
-     return $selout.'</select>';
+     return &make_persistent(\%save,$filename);
  }
  ######################################################################
- Line 675  sub selectbox {
+ Line 1008  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.
+ =item $customshow Scalar containing commands to show custom metadata.
+ =item $libraries_to_query Reference to array of domains to search.
+ =back
  =cut
  ######################################################################
  ######################################################################
- sub advancedsearch {
+ sub parse_advanced_search {
-     my ($r,$envhash,$hidden)=@_;
+     my ($r,$closebutton,$hidden_fields)=@_;
-     my %ENV=%{$envhash};
      my $fillflag=0;
+     my $pretty_search_string = "<br />\n";
      # Clean up fields for safety
      for my $field ('title','author','subject','keywords','url','version',
  		   'creationdatestart_month','creationdatestart_day',
- Line 693  sub advancedsearch {
+ Line 1040  sub advancedsearch {
  		   'lastrevisiondatestart_month','lastrevisiondatestart_day',
  		   'lastrevisiondatestart_year','lastrevisiondateend_month',
  		   'lastrevisiondateend_day','lastrevisiondateend_year',
- 		   'notes','abstract','mime','language','owner',
+ 		   'notes','abstract','extension','language','owner',
- 		   'custommetadata','customshow') {
+ 		   'custommetadata','customshow','category') {
  	$ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
      }
      foreach ('mode','form','element') {
- Line 703  sub advancedsearch {
+ Line 1050  sub advancedsearch {
  	$ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  	$ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
      }
+     # Preprocess the category form element.
+     $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) ||
+                                       ref($ENV{'form.category'}));
+     #
      # Check to see if enough information was filled in
      for my $field ('title','author','subject','keywords','url','version',
- 		   'notes','abstract','mime','language','owner',
+ 		   'notes','abstract','category','extension','language',
- 		   'custommetadata') {
+                    'owner','custommetadata') {
  	if (&filled($ENV{"form.$field"})) {
  	    $fillflag++;
  	}
      }
-     unless ($fillflag) {
+     if (! $fillflag) {
- 	&output_blank_field_error($r);
+ 	&output_blank_field_error($r,$closebutton,
- 	return OK;
+                                   'phase=disp_adv',$hidden_fields);
+ 	return ;
      }
      # Turn the form input into a SQL-based query
      my $query='';
      my @queries;
+     my $font = '<font color="#800000" face="helvetica">';
      # Evaluate logical expression AND/OR/NOT phrase fields.
      foreach my $field ('title','author','subject','notes','abstract','url',
- 		       'keywords','version','owner') {
+ 		       'keywords','version','owner','standards') {
  	if ($ENV{'form.'.$field}) {
- 	    push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
+             my $searchphrase = $ENV{'form.'.$field};
- 	}
+             $pretty_search_string .= $font."$field</font> contains <b>".
+                 $searchphrase."</b>";
+             if ($ENV{'form.'.$field.'_related'}) {
+                 my @New_Words;
+                 ($searchphrase,@New_Words) = &related_version($searchphrase);
+                 if (@New_Words) {
+                     $pretty_search_string .= " with related words: ".
+                         "<b>@New_Words</b>.";
+                 } else {
+                     $pretty_search_string .= " with no related words.";
+                 }
+             }
+             $pretty_search_string .= "<br />\n";
+ 	    push @queries,&build_SQL_query($field,$searchphrase);
+         }
+     }
+     #
+     # Make the 'mime' from 'form.category' and 'form.extension'
+     #
+     my $searchphrase;
+     if (exists($ENV{'form.category'})    &&
+         $ENV{'form.category'} !~ /^\s*$/ &&
+         $ENV{'form.category'} ne 'any')     {
+         my @extensions = &Apache::loncommon::filecategorytypes
+                                                    ($ENV{'form.category'});
+         if (scalar(@extensions) > 0) {
+             $searchphrase = join(' OR ',@extensions);
+         }
      }
+     if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) {
+         $searchphrase .= ' OR ' if (defined($searchphrase));
+         my @extensions = split(/,/,$ENV{'form.extension'});
+         $searchphrase .= join(' OR ',@extensions);
+     }
+     if (defined($searchphrase)) {
+         push @queries,&build_SQL_query('mime',$searchphrase);
+         $pretty_search_string .=$font.'mime</font> contains <b>'.
+             $searchphrase.'</b><br />';
+     }
+     #
      # Evaluate option lists
      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  	push @queries,"(language like \"$ENV{'form.language'}\")";
-     }
+         $pretty_search_string.=$font."language</font>= ".
-     if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
+             &Apache::loncommon::languagedescription($ENV{'form.language'}).
- 	push @queries,"(mime like \"$ENV{'form.mime'}\")";
+                 "<br />\n";
      }
      if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
  	push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
+         $pretty_search_string.=$font."copyright</font> = ".
+             &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}).
+                 "<br \>\n";
      }
+     #
      # Evaluate date windows
      my $datequery=&build_date_queries(
  			$ENV{'form.creationdatestart_month'},
- Line 752  sub advancedsearch {
+ Line 1147  sub advancedsearch {
  			);
      # Test to see if date windows are legitimate
      if ($datequery=~/^Incorrect/) {
- 	&output_date_error($r,$datequery);
+ 	&output_date_error($r,$datequery,$closebutton,$hidden_fields);
- 	return OK;
+ 	return ;
-     }
+     } elsif ($datequery) {
-     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'}) {
+     ##
- 	$customquery=&build_custommetadata_query('custommetadata',
+     ## The custom metadata search was removed q long time ago mostly
- 				      $ENV{'form.custommetadata'});
+     ## because I was unable to figureout exactly how it worked and could
-     }
+     ## not imagine people actually using it.  MH
-     my $customshow='';
+     ##
-     if ($ENV{'form.customshow'}) {
+     # if ($ENV{'form.custommetadata'}) {
- 	$customshow=$ENV{'form.customshow'};
+     #    $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
- 	$customshow=~s/[^\w\s]//g;
+     #    $ENV{'form.custommetadata'}."</b><br />\n";
- 	my @fields=split(/\s+/,$customshow);
+     #    $customquery=&build_custommetadata_query('custommetadata',
- 	$customshow=join(" ",@fields);
+     #                                             $ENV{'form.custommetadata'});
-     }
+     # }
-     # Send query statements over the network to be processed by either the SQL
+     my $customshow=undef;
-     # database or a recursive scheme of 'grep'-like actions (for custom
+     # if ($ENV{'form.customshow'}) {
-     # metadata).
+     # $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
+     #                         $ENV{'form.customshow'}."</b><br />\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,$pretty_domains_string) =
+         &parse_domain_restrictions();
+     $pretty_search_string .= $pretty_domains_string."<br />\n";
+     #
      if (@queries) {
  	$query=join(" AND ",@queries);
  	$query="select * from metadata where $query";
- 	my $reply; # reply hash reference
+     } elsif ($customquery) {
- 	unless ($customquery or $customshow) {
+         $query = '';
- 	    $reply=&Apache::lonnet::metadata_query($query);
+     }
- 	}
+     return ($query,$customquery,$customshow,$libraries_to_query,
- 	else {
+             $pretty_search_string);
- 	    $reply=&Apache::lonnet::metadata_query($query,
+ }
- 						   $customquery,$customshow);
- 	}
+ sub parse_domain_restrictions {
- 	&output_results('Advanced',$r,$envhash,$customquery,$reply,$hidden);
+     my $libraries_to_query = undef;
+     # $ENV{'form.domains'} can be either a scalar or an array reference.
+     # We need an array.
+     if (! exists($ENV{'form.domains'})) {
+         return (undef,'');
+     }
+     my @allowed_domains;
+     if (ref($ENV{'form.domains'})) {
+         @allowed_domains =  @{$ENV{'form.domains'}};
+     } else {
+         @allowed_domains = ($ENV{'form.domains'});
      }
-     elsif ($customquery) {
+     #
- 	my $reply; # reply hash reference
+     my %domain_hash = ();
- 	$reply=&Apache::lonnet::metadata_query('',
+     my $pretty_domains_string;
- 					       $customquery,$customshow);
+     foreach (@allowed_domains) {
- 	&output_results('Advanced',$r,$envhash,$customquery,$reply,$hidden);
+         $domain_hash{$_}++;
      }
-     # should not get to this point
+     if ($domain_hash{'any'}) {
-     return 'Error.  Should not have gone to this point.';
+         $pretty_domains_string = "In all LON-CAPA domains.";
+     } else {
+         if (@allowed_domains > 1) {
+             $pretty_domains_string = "In LON-CAPA domains:";
+         } else {
+             $pretty_domains_string = "In LON-CAPA domain ";
+         }
+         foreach (sort @allowed_domains) {
+             $pretty_domains_string .= "<b>".$_."</b> ";
+         }
+         foreach (keys(%Apache::lonnet::libserv)) {
+             if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
+                 push @$libraries_to_query,$_;
+             }
+         }
+     }
+     return ($libraries_to_query,$pretty_domains_string);
  }
  ######################################################################
- Line 802  sub advancedsearch {
+ Line 1238  sub advancedsearch {
  =pod
- =item &basicsearch()
+ =item &parse_basic_search()
+ Parse the basic search form and return a scalar containing an sql query.
  =cut
  ######################################################################
  ######################################################################
- sub basicsearch {
+ sub parse_basic_search {
-     my ($r,$envhash,$hidden)=@_;
+     my ($r,$closebutton)=@_;
-     my %ENV=%{$envhash};
+     #
      # Clean up fields for safety
      for my $field ('basicexp') {
  	$ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
- Line 821  sub basicsearch {
+ Line 1259  sub basicsearch {
  	$ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  	$ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
      }
+     my ($libraries_to_query,$pretty_domains_string) =
-     # Check to see if enough is filled in
+         &parse_domain_restrictions();
+     #
+     # Check to see if enough of a query is filled in
      unless (&filled($ENV{'form.basicexp'})) {
- 	&output_blank_field_error($r);
+ 	&output_blank_field_error($r,$closebutton,'phase=disp_basic');
  	return OK;
      }
+     my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
+     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: <b>@New_Words</b>.";
+         } else {
+             $pretty_search_string .= " with no related words.";
+         }
+     }
+     #
      # Build SQL query string based on form page
      my $query='';
-     my $concatarg=join(',"    ",',
+     my $concatarg=join(',',
  		       ('title', 'author', 'subject', 'notes', 'abstract',
                          'keywords'));
      $concatarg='title' if $ENV{'form.titleonly'};
+     $query=&build_SQL_query('concat_ws(" ",'.$concatarg.')',$search_string);
+     if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
+         $pretty_search_string .= ' '.$pretty_domains_string;
+     }
+     $pretty_search_string .= "<br />\n";
+     my $final_query = 'SELECT * FROM metadata WHERE '.$query;
+     # &Apache::lonnet::logthis($final_query);
+     return ($final_query,$pretty_search_string,
+             $libraries_to_query);
+ }
-     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
+ ######################################################################
+ ######################################################################
-     # Get reply (either a hash reference to filehandles or bad connection)
+ =pod
-     my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);
-     # Output search results
+ =item &related_version()
-     &output_results('Basic',$r,$envhash,$query,$reply,$hidden);
+ 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 ...)".
-     return OK;
+ 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));
+ }
  ######################################################################
  ######################################################################
- Line 855  sub basicsearch {
+ Line 1336  sub basicsearch {
  =item &build_SQL_query()
+ Builds a SQL query string from a logical expression with AND/OR keywords
+ using Text::Query and &recursive_SQL_query_builder()
  =cut
  ######################################################################
- Line 877  sub build_SQL_query {
+ Line 1361  sub build_SQL_query {
  =item &build_custommetadata_query()
+ Constructs a custom metadata query using a rather heinous regular
+ expression.
  =cut
  ######################################################################
  ######################################################################
  sub build_custommetadata_query {
      my ($field_name,$logic_statement)=@_;
-     &Apache::lonnet::logthis("Entered build_custommetadata_query:".
-                              $field_name.':'.$logic_statement);
      my $q=new Text::Query('abc',
  			  -parse => 'Text::Query::ParseAdvanced',
  			  -build => 'Text::Query::BuildAdvancedString');
- Line 899  sub build_custommetadata_query {
+ Line 1384  sub build_custommetadata_query {
                     \*$2\[\^\\<\]?#           *wordtwo[^\<]
                     \*\\<\\\/$1\\>?#                        *\<\/wordone\>
                     /g;
-     &Apache::lonnet::logthis("match expression: ".$matchexp);
      return $matchexp;
  }
- Line 910  sub build_custommetadata_query {
+ Line 1394  sub build_custommetadata_query {
  =item &recursive_SQL_query_build()
+ Recursively constructs an SQL query.  Takes as input $dkey and $pattern.
  =cut
  ######################################################################
- Line 919  sub recursive_SQL_query_build {
+ Line 1405  sub recursive_SQL_query_build {
      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
      return $pattern unless @matches;
      foreach my $match (@matches) {
- 	$match=~/\[ (\w+)\s(.*) \]/;
+         $match=~/\[ (\w+)\s(.*) \]/;
- 	my ($key,$value)=($1,$2);
+         my ($key,$value)=($1,$2);
- 	my $replacement='';
+         my $replacement='';
- 	if ($key eq 'literal') {
+         if ($key eq 'literal') {
- 	    $replacement="($dkey like \"\%$value\%\")";
+             $replacement="($dkey LIKE \"\%$value\%\")";
- 	}
+         } elsif (lc($key) eq 'not') {
- 	elsif ($key eq 'not') {
+             $value=~s/LIKE/NOT LIKE/;
- 	    $value=~s/like/not like/;
+ #          $replacement="($dkey not like $value)";
- #	    $replacement="($dkey not like $value)";
+             $replacement="$value";
- 	    $replacement="$value";
+         } elsif ($key eq 'and') {
- 	}
+             $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
- 	elsif ($key eq 'and') {
+             $replacement="($1 AND $2)";
- 	    $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
+ 	} elsif ($key eq 'or') {
- 	    $replacement="($1 AND $2)";
+             $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
- 	}
+             $replacement="($1 OR $2)";
- 	elsif ($key eq 'or') {
- 	    $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
- 	    $replacement="($1 OR $2)";
  	}
  	substr($pattern,
- 	       index($pattern,$match),
+                index($pattern,$match),
- 	       length($match),
+                length($match),
- 	       $replacement
+                $replacement);
- 	       );
      }
      &recursive_SQL_query_build($dkey,$pattern);
  }
- Line 954  sub recursive_SQL_query_build {
+ Line 1436  sub recursive_SQL_query_build {
  =item &build_date_queries()
+ Builds a SQL logic query to check time/date entries.
+ Also reports errors (check for /^Incorrect/).
  =cut
  ######################################################################
- Line 1009  sub build_date_queries {
+ Line 1494  sub build_date_queries {
  ######################################################################
  ######################################################################
  =pod
- =item &output_results()
+ =item &copyright_check()
- Format and output results based on a reply list.
+ Inputs: $Metadata, a hash pointer of metadata for a resource.
- There are two windows that this function writes to.  The main search
- window ("srch") has a listing of the results.  A secondary window ("popwin")
+ Returns: 1 if the resource is available to the user making the query,
- gives the status of the network search (time elapsed, number of machines
+otherwise.
- contacted, etc.)
  =cut
  ######################################################################
  ######################################################################
- sub output_results {
+ sub copyright_check {
-     my $fnum; # search result counter
+     my $Metadata = shift;
-     my ($mode,$r,$envhash,$query,$replyref,$hidden)=@_;
+     # Check copyright tags and skip results the user cannot use
-     my %ENV=%{$envhash};
+     my (undef,undef,$resdom,$resname) = split('/',
-     my %rhash=%{$replyref};
+                                               $Metadata->{'url'});
-     my $compiledresult='';
+     # Check for priv
-     my $timeremain=300;
+     if (($Metadata->{'copyright'} eq 'priv') &&
-     my $elapsetime=0;
+         (($ENV{'user.name'} ne $resname) &&
-     my $resultflag=0;
+          ($ENV{'user.domain'} ne $resdom))) {
-     my $tflag=1;
+         return 0;
+     }
+     # Check for domain
+     if (($Metadata->{'copyright'} eq 'domain') &&
+         ($ENV{'user.domain'} ne $resdom)) {
+         return 0;
+     }
+     return 1;
+ }
-     # make query information persistent to allow for subsequent revision
+ ######################################################################
-     my $persistent=&make_persistent();
+ ######################################################################
-     # output beginning of search page
+ =pod
- 	$r->print(<<BEGINNING);
+ =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.  ".
+                   "</body></html>");
+         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. </body></html>");
+         &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.</form></body></html>");
+         &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()
+ The sort feature is not implemented at this time.  This form just prints
+ a link to change the search query.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub print_sort_form {
+     my ($r,$pretty_query_string) = @_;
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
+     ##
+     my %SortableFields=&Apache::lonlocal::texthash(
+          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.</form></body></html>");
+         &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.=<<END;
  <html>
  <head>
- <title>The LearningOnline Network with CAPA</title>
+ <script>
- BEGINNING
+     function change_sort() {
+         var newloc = "/adm/searchcat?phase=results";
+         newloc += "&persistent_db_id=$ENV{'form.persistent_db_id'}";
+         newloc += "&sortby=";
+         newloc += document.forms.statusform.elements.sortby.value;
+         parent.resultsframe.location= newloc;
+     }
+ </script>
+ <title>Results</title>
+ </head>
+ $bodytag
+ <form name="statusform" action="" method="post">
+ <input type="hidden" name="Queue" value="" />
+ END
+ #<h2>Sort Results</h2>
+ #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
+ #    $ENV{'form.sortby'} = 'id' if (! defined($ENV{'form.sortby'}));
+ #    foreach (keys(%SortableFields)) {
+ #        $result.="<option name=\"$_\"";
+ #        if ($_ eq $ENV{'form.sortby'}) {
+ #            $result.=" selected ";
+ #        }
+ #        $result.=" >$SortableFields{$_}</option>\n";
+ #    }
+ #    $result.="</select>\n";
+     my $revise = &revise_button();
+     $result.=<<END;
+ <p>
+ There are $total_results matches to your query. $revise
+ </p><p>
+ Search:$pretty_query_string
+ </p>
+ </form>
+ </body>
+ </html>
+ END
+     $r->print($result);
+     return;
+ }
+ #####################################################################
+ #####################################################################
+ =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
+ #####################################################################
+ #####################################################################
+ #
+ # These should probably be scoped but I don't have time right now...
+ #
+ my @Datatypes;
+ my @Fullindicies;
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &create_results_table()
+ Creates the table of search results by calling lonmysql.  Stores the
+ table id in $ENV{'form.table'}
+ Inputs: none.
+ Returns: the identifier of the table on success, undef on error.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub set_up_table_structure {
+     my ($datatypes,$fullindicies) =
+         &LONCAPA::lonmetadata::describe_metadata_storage();
+     # Copy the table description before modifying it...
+     @Datatypes = @{$datatypes};
+     unshift(@Datatypes,{name => 'id',
+         type => 'MEDIUMINT',
+         restrictions => 'UNSIGNED NOT NULL',
+         primary_key  => 'yes',
+         auto_inc     => 'yes' });
+     @Fullindicies = @{$fullindicies};
+     return;
+ }
+ sub create_results_table {
+     &set_up_table_structure();
+     my $table = &Apache::lonmysql::create_table
+         ( { columns => \@Datatypes,
+             FULLTEXT => [{'columns' => \@Fullindicies},],
+         } );
+     if (defined($table)) {
+         $ENV{'form.table'} = $table;
+         return $table;
+     }
+     return undef; # Error...
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item Search Status update functions
+ Each of the following functions changes the values of one of the
+ input fields used to display the search status to the user.  The names
+ should be explanatory.
+ Inputs: Apache request handler ($r), text to display.
+ Returns: Nothing.
+ =over 4
+ =item &update_count_status()
+ =item &update_status()
+ =item &update_seconds()
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
+ sub update_count_status {
+     my ($r,$text) = @_;
+     $text =~ s/\'/\\\'/g;
+     $r->print
+         ("<script>document.statusform.count.value = ' $text'</script>\n");
+     $r->rflush();
+ }
+ sub update_status {
+     my ($r,$text) = @_;
+     $text =~ s/\'/\\\'/g;
+     $r->print
+         ("<script>document.statusform.status.value = ' $text'</script>\n");
+     $r->rflush();
+ }
+ sub update_seconds {
+     my ($r,$text) = @_;
+     $text =~ s/\'/\\\'/g;
+     $r->print
+         ("<script>document.statusform.seconds.value = ' $text'</script>\n");
+     $r->rflush();
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &revise_button()
+ Inputs: None
+ Returns: html string for a 'revise search' button.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub revise_button {
+     my $revise_phase = 'disp_basic';
+     $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
+     my $newloc = '/adm/searchcat'.
+         '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
+             '&cleargroupsort=1'.
+             '&phase='.$revise_phase;
+     my $result = qq{<input type="button" value="Revise search" name="revise"} .
+         qq{ onClick="parent.location='$newloc';" /> };
+     return $result;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &run_search()
+ Executes a search query by sending it the the other servers and putting the
+ results into MySQL.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub run_search {
+     my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
+     my $connection = $r->connection;
+     #
+     # Timing variables
+     #
+     my $starttime = time;
+     my $max_time  = 30;  # seconds for the search to complete
+     #
+     # Print run_search header
+     #
+     $r->print(<<END);
+ <html>
+ <head><title>Search Status</title></head>
+ $bodytag
+ <form name="statusform" action="" method="post">
+ <input type="hidden" name="Queue" value="" />
+ END
+     # Check to see if $pretty_string has more than one carriage return.
+     # Assume \n s are following <br /> s and truncate the value.
+     # (there is probably a better way)...
+     my @Lines = split /<br \/>/,$pretty_string;
+     if (@Lines > 2) {
+         $pretty_string = join '<br \>',(@Lines[0..2],'....<br />');
+     }
+     $r->print(&mt("Search").": ".$pretty_string);
+     $r->rflush();
+     #
+     # Determine the servers we need to contact.
+     my @Servers_to_contact;
+     if (defined($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;
+     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.</body></html>");
+         return;
+     }
+     my $table_status = &Apache::lonmysql::check_table($table);
+     if (! defined($table_status)) {
+         $r->print("Unable to determine status of table.</body></html>");
+         &Apache::lonnet::logthis("Bogus table id of $table for ".
+                                  "$ENV{'user.name'} @ $ENV{'user.domain'}");
+         &Apache::lonnet::logthis("lonmysql error = ".
+                                  &Apache::lonmysql::get_error());
+         return;
+     }
+     if (! $table_status) {
+         &Apache::lonnet::logthis("lonmysql error = ".
+                                  &Apache::lonmysql::get_error());
+         &Apache::lonnet::logthis("lonmysql debug = ".
+                                  &Apache::lonmysql::get_debug());
+         &Apache::lonnet::logthis('table status = "'.$table_status.'"');
+         $r->print("The table id,$table, we tried to use is invalid.".
+                   "The search has been aborted.</body></html>");
+         return;
+     }
+     ##
+     ## Prepare for the big loop.
+     my $hitcountsum;
+     my $server;
+     my $status;
+     my $revise = &revise_button();
+     $r->print(<<END);
+ <table>
+ <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
+ <tr>
+ <td><input type="text" name="status"  value="" size="30" /></td>
+ <td><input type="text" name="count"   value="" size="10" /></td>
+ <td><input type="text" name="seconds" value="" size="8" /></td>
+ <td>$revise</td>
+ </tr>
+ </table>
+ </form>
+ END
+     $r->rflush();
+     my $time_remaining = $max_time - (time - $starttime) ;
+     $time_remaining = 0 if ($time_remaining <0);
+     my $last_time = $time_remaining;
+     &update_seconds($r,$time_remaining);
+     &update_status($r,'contacting '.$Servers_to_contact[0]);
+     while (($time_remaining > 0) &&
+            ((@Servers_to_contact) || keys(%Server_status))) {
+         $time_remaining = $max_time - (time - $starttime) ;
+         &update_seconds($r,$time_remaining);
+         # Send out a search request if it needs to be done.
+         if (@Servers_to_contact) {
+             # Contact one server
+             my $server = shift(@Servers_to_contact);
+             &update_status($r,&mt('contacting').' '.$server);
+             my $reply=&Apache::lonnet::metadata_query($query,$customquery,
+                                                       $customshow,[$server]);
+             ($server) = keys(%$reply);
+             $Server_status{$server} = $reply->{$server};
+         } else {
+             # 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.
+             if (scalar (keys(%Server_status))) {
+                 &update_status($r,
+                        &mt('waiting on').' '.(join(' ',keys(%Server_status))));
+             }
+             sleep(1);
+         }
+         #
+         # Loop through the servers we have contacted but do not
+         # have results from yet, looking for results.
+         while (my ($server,$status) = each(%Server_status)) {
+             last if ($connection->aborted());
+             $time_remaining = $max_time - (time - $starttime) ;
+             $time_remaining = 0 if ($time_remaining < 0);
+             if ($last_time - $time_remaining > 0) {
+                 $last_time = $time_remaining;
+                 &update_seconds($r,$time_remaining);
+             }
+             if ($status eq 'con_lost') {
+                 delete ($Server_status{$server});
+                 next;
+             }
+             $status=~/^([\.\w]+)$/;
+        	    my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
+             if (-e $datafile && ! -e "$datafile.end") {
+                 &update_status($r,&mt('Receiving results from').' '.$server);
+                 next;
+             }
+             last if ($connection->aborted());
+             if (-e "$datafile.end") {
+                 &update_status($r,&mt('Reading results from').' '.$server);
+                 if (-z "$datafile") {
+                     delete($Server_status{$server});
+                     next;
+                 }
+                 my $fh;
+                 if (!($fh=Apache::File->new($datafile))) {
+                     $r->print("Unable to open search results file for ".
+                                   "server $server.  Omitting from search");
+                     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;
+                     # Parse the result.
+                     my %Fields = &parse_raw_result($result,$server);
+                     $Fields{'hostname'} = $server;
+                     next if (! &copyright_check(\%Fields));
+                     # Store the result in the mysql database
+                     my $result = &Apache::lonmysql::store_row($table,\%Fields);
+                     if (! defined($result)) {
+                         $r->print(&Apache::lonmysql::get_error());
+                     }
+                     # $r->print(&Apache::lonmysql::get_debug());
+                     $hitcountsum ++;
+                     $time_remaining = $max_time - (time - $starttime) ;
+                     $time_remaining = 0 if ($time_remaining < 0);
+                     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});
+             }
+             last if ($connection->aborted());
+             &update_count_status($r,$hitcountsum);
+         }
+         last if ($connection->aborted());
+         # Finished looping through the servers
+         $starttime = time if (@Servers_to_contact);
+         $time_remaining = $max_time - (time - $starttime) ;
+         if ($last_time - $time_remaining > 0) {
+             $last_time = $time_remaining;
+             &update_seconds($r,$time_remaining);
+         }
+     }
+     &update_status($r,&mt('Search Complete').$server);
+     &update_seconds($r,0);
+     #
+     &Apache::lonmysql::disconnect_from_db();
+     #
+     # We have run out of time or run out of servers to talk to and
+     # results to get.
+     $r->print("</body></html>");
+     if ($ENV{'form.catalogmode'} ne 'groupsearch') {
+         $r->print("<script>".
+                       "window.location='/adm/searchcat?".
+                       "phase=sort&".
+                       "persistent_db_id=$ENV{'form.persistent_db_id'}';".
+                   "</script>");
+     }
+     return;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &prev_next_buttons()
+ Returns html for the previous and next buttons on the search results page.
+ =cut
+ ######################################################################
+ ######################################################################
+ 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 = 1 if $prev_min < 1;
+     if ($prev_min < $current_min) {
+         $links .=
+             qq{<a href="/adm/searchcat?$parms&start=$prev_min&show=$show">}.
+             &mt('prev').'</a>';
+     } else {
+         $links .= &mt('prev');
+     }
+     ##
+     ## Pages.... Someday.
+     ##
+     $links .=
+         qq{&nbsp;
+            <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">}.
+                 &mt('reload').'</a>';
+     ##
+     ## Next
+     my $next_min = $current_min + $show;
+     $next_min = $current_min if ($next_min > $total);
+     if ($next_min != $current_min) {
+         $links .=
+             qq{&nbsp;
+                <a href="/adm/searchcat?$parms&start=$next_min&show=$show">}.
+                     &mt('next').'</a>';
+     } else {
+         $links .= '&nbsp;'.&mt('next');
+     }
+     return $links;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &display_results()
+ Prints the results out for selection and perusal.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub display_results {
+     my ($r,$importbutton,$closebutton,$diropendb) = @_;
+     my $connection = $r->connection;
+     $r->print(&search_results_header($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;
+     }
+     ##
+     ## $checkbox_num is a count of the number of checkboxes output on the
+     ## page this is used only during catalogmode=groupsearch.
+     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') {
+         if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
+                   &GDBM_WRCREAT(),0640)) {
+             $r->print('Unable to store import results.</form></body></html>');
+             $r->rflush();
+             return;
+         }
+     }
+     ##
+     ## Prepare the table for querying
+     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.</form></body></html>");
+         &Apache::lonnet::logthis("lonmysql was unable to determine the number".
+                                  " of rows in table ".$table);
+         &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
+         return;
+     }
+     ##
+     ## Determine how many results we need to get
+     $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'} - 1;
+         $max = $total_results if ($max > $total_results);
+     }
+     ##
+     ## Output links (if necessary) for 'prev' and 'next' pages.
+     $r->print
+         ('<center>'.
+          &prev_next_buttons($min,$ENV{'form.show'},$total_results,
+                             "table=".$ENV{'form.table'}.
+                             "&phase=results".
+                             "&persistent_db_id=".$ENV{'form.persistent_db_id'})
+          ."</center>\n"
+          );
+     if ($total_results == 0) {
+         $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="1">'.
+                   '<h3>'.&mt('There are currently no results').'.</h3>'.
+                   "</form></body></html>");
+         return;
+     } else {
+         $r->print
+             ("<center>Results $min to $max out of $total_results</center>\n");
+     }
+     ##
+     ## Get results from MySQL table
+     my @Results = &Apache::lonmysql::get_rows($table,
+                                               'id>='.$min.' AND id<='.$max);
+     ##
+     ## Loop through the results and output them.
+     foreach my $row (@Results) {
+         if ($connection->aborted()) {
+             &cleanup();
+             return;
+         }
+         my %Fields = %{&parse_row(@$row)};
+         my $output="<p>\n";
+         if (! defined($Fields{'title'}) || $Fields{'title'} eq '') {
+             $Fields{'title'} = 'Untitled';
+         }
+         my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'},
+                                        $Fields{'id'},$checkbox_num++);
+         # Render the result into html
+         $output.= &$viewfunction($prefix,%Fields);
+         # Print them out as they come in.
+         $r->print($output);
+         $r->rflush();
+     }
+     if (@Results < 1) {
+         $r->print(&mt("There were no results matching your query"));
+     } else {
+         $r->print
+             ('<center>'.
+              &prev_next_buttons($min,$ENV{'form.show'},$total_results,
+                                 "table=".$ENV{'form.table'}.
+                                 "&phase=results".
+                                 "&persistent_db_id=".
+                                 $ENV{'form.persistent_db_id'})
+              ."</center>\n"
+              );
+     }
+     $r->print("</form></body></html>");
+     $r->rflush();
+     untie %groupsearch_db if (tied(%groupsearch_db));
+     return;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
+ Returns html needed for the various catalog modes.  Gets inputs from
+ $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub catalogmode_output {
+     my $output = '';
+     my ($title,$url,$fnum,$checkbox_num) = @_;
+     if ($ENV{'form.catalogmode'} eq 'interactive') {
+         $title=~ s/\'/\\\'/g;
+         if ($ENV{'form.catalogmode'} eq 'interactive') {
+             $output.=<<END
+ <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
+ onClick="javascript:select_data('$title','$url')">
+ </font>
+ END
+         }
+     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
+         $groupsearch_db{"pre_${fnum}_link"}=$url;
+         $groupsearch_db{"pre_${fnum}_title"}=$title;
+         $output.=<<END;
+ <font size='-1'>
+ <input type="checkbox" name="returnvalues" value="SELECT"
+ onClick="javascript:queue($checkbox_num,$fnum)" />
+ </font>
+ END
+     }
+     return $output;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &parse_row()
+ Parse a row returned from the database.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub parse_row {
+     my @Row = @_;
+     my %Fields;
+     if (! scalar(@Datatypes)) {
+         &set_up_table_structure();
+     }
+     for (my $i=0;$i<=$#Row;$i++) {
+         $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
+     }
+     $Fields{'language'} =
+         &Apache::loncommon::languagedescription($Fields{'language'});
+     $Fields{'copyrighttag'} =
+         &Apache::loncommon::copyrightdescription($Fields{'copyright'});
+     $Fields{'mimetag'} =
+         &Apache::loncommon::filedescription($Fields{'mime'});
+     return \%Fields;
+ }
+ ###########################################################
+ ###########################################################
+ =pod
+ =item &parse_raw_result()
+ Takes a line from the file of results and parse it.  Returns a hash
+ with keys according to column labels
+ In addition, the following tags are set by calling the appropriate
+ lonnet function: 'language', 'copyrighttag', 'mimetag'.
+ The 'title' field is set to "Untitled" if the title field is blank.
+ 'abstract' and 'keywords' are truncated to 200 characters.
+ =cut
+ ###########################################################
+ ###########################################################
+ sub parse_raw_result {
+     my ($result,$hostname) = @_;
+     # conclude from self to others regarding fields
+     my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash
+         (map {
+             &Apache::lonnet::unescape($_);
+         } (split(/\,/,$result)) );
+     return %Fields;
+ }
+ ###########################################################
+ ###########################################################
+ =pod
+ =item &handle_custom_fields()
+ =cut
+ ###########################################################
+ ###########################################################
+ sub handle_custom_fields {
+     my @results = @{shift()};
+     my $customshow='';
+     my $extrashow='';
+     my @customfields;
+     if ($ENV{'form.customshow'}) {
+         $customshow=$ENV{'form.customshow'};
+         $customshow=~s/[^\w\s]//g;
+         my @fields=map {
+             "<font color=\"#008000\">$_:</font><!-- $_ -->";
+         } split(/\s+/,$customshow);
+         @customfields=split(/\s+/,$customshow);
+         if ($customshow) {
+             $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
+         }
+     }
+     my $customdata='';
+     my %customhash;
+     foreach my $result (@results) {
+         if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
+             my $tmp=$result;
+             $tmp=~s/^custom\=//;
+             my ($k,$v)=map {&Apache::lonnet::unescape($_);
+                         } split(/\,/,$tmp);
+             $customhash{$k}=$v;
+         }
+     }
+     return ($extrashow,\@customfields,\%customhash);
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &search_results_header()
+ Output the proper html headers and javascript code to deal with different
+ calling modes.
+ Takes most inputs directly from %ENV, except $mode.
+ =over 4
+ =item $mode is either (at this writing) 'Basic' or 'Advanced'
+ =back
+ The following environment variables are checked:
+ =over 4
+ =item 'form.catalogmode'
+ Checked for 'interactive' and 'groupsearch'.
+ =item 'form.mode'
+ Checked for existance & 'edit' mode.
+ =item 'form.form'
+ Contains the name of the form that has the input fields to set
+ =item 'form.element'
+ the name of the input field to put the URL into
+ =item 'form.titleelement'
+ the name of the input field to put the title into
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
+ sub search_results_header {
+     my ($importbutton,$closebutton) = @_;
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
+     my $result = '';
+     # output beginning of search page
      # conditional output of script functions dependent on the mode in
      # which the search was invoked
      if ($ENV{'form.catalogmode'} eq 'interactive'){
  	if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') {
-             $r->print(<<SCRIPT)
+             $result.=<<SCRIPT;
  <script type="text/javascript">
      function select_data(title,url) {
  	changeTitle(title);
  	changeURL(url);
- 	self.close();
+ 	parent.close();
      }
      function changeTitle(val) {
- 	if (opener.inf.document.forms.resinfo.elements.t) {
+ 	if (parent.opener.inf.document.forms.resinfo.elements.t) {
- 	    opener.inf.document.forms.resinfo.elements.t.value=val;
+ 	    parent.opener.inf.document.forms.resinfo.elements.t.value=val;
  	}
      }
      function changeURL(val) {
- 	if (opener.inf.document.forms.resinfo.elements.u) {
+ 	if (parent.opener.inf.document.forms.resinfo.elements.u) {
- 	    opener.inf.document.forms.resinfo.elements.u.value=val;
+ 	    parent.opener.inf.document.forms.resinfo.elements.u.value=val;
  	}
      }
  </script>
- Line 1070  SCRIPT
+ Line 2450  SCRIPT
          } elsif ($ENV{'form.mode'} eq 'edit') {
              my $form = $ENV{'form.form'};
              my $element = $ENV{'form.element'};
-             $r->print(<<SCRIPT)
+             my $titleelement = $ENV{'form.titleelement'};
+ 	    my $changetitle;
+ 	    if (!$titleelement) {
+ 		$changetitle='function changeTitle(val) {}';
+ 	    } else {
+ 		    $changetitle=<<END;
+ function changeTitle(val) {
+     if (parent.targetwin.document) {
+         parent.targetwin.document.forms["$form"].elements["$titleelement"].value=val;
+     } else {
+ 	var url = 'forms[\"$form\"].elements[\"$titleelement\"].value';
+         alert("Unable to transfer data to "+url);
+     }
+ }
+ END
+             }
+             $result.=<<SCRIPT;
  <script type="text/javascript">
  function select_data(title,url) {
      changeURL(url);
-     self.close();
+     changeTitle(title);
- }
+     parent.close();
- function changeTitle(val) {
  }
+ $changetitle
  function changeURL(val) {
-     if (window.opener.document) {
+     if (parent.targetwin.document) {
-         window.opener.document.forms["$form"].elements["$element"].value=val;
+         parent.targetwin.document.forms["$form"].elements["$element"].value=val;
      } else {
  	var url = 'forms[\"$form\"].elements[\"$element\"].value';
          alert("Unable to transfer data to "+url);
- Line 1090  function changeURL(val) {
+ Line 2487  function changeURL(val) {
  SCRIPT
          }
      }
-     $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'groupsearch';
+     $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
  <script type="text/javascript">
-     function select_data(title,url) {
+     function queue(checkbox_num,val) {
- //	alert('DEBUG: Should be storing '+title+' and '+url);
+         if (document.forms.results.returnvalues.length != "undefined" &&
-     }
+             typeof(document.forms.results.returnvalues.length) == "number") {
-     function queue(val) {
+             if (document.forms.results.returnvalues[checkbox_num].checked) {
- 	if (eval("document.forms.results.returnvalues["+val+"].checked")) {
+                 parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
- 	    document.forms.results.acts.value+='1a'+val+'b';
+             } else {
- 	}
+                 parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
- 	else {
+             }
- 	    document.forms.results.acts.value+='0a'+val+'b';
+         } else {
- 	}
+             if (document.forms.results.returnvalues.checked) {
+                 parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
+             } else {
+                 parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
+             }
+         }
      }
      function select_group() {
- 	window.location=
+ 	parent.window.location=
      "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
- 	    document.forms.results.acts.value;
+ 	    parent.statusframe.document.forms.statusform.elements.Queue.value;
      }
  </script>
  SCRIPT
-     $r->print(<<SCRIPT);
+     $result.=<<END;
- <script type="text/javascript">
-     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();
-     }
- </script>
- SCRIPT
-     $r->rflush();
-     # begin showing the cataloged results
-     $r->print(<<CATALOGBEGIN);
  </head>
- <body bgcolor="#ffffff">
+ $bodytag
- <img align=right src=/adm/lonIcons/lonlogos.gif>
+ <form name="results" method="post" action="" >
- <h1>Search Catalog</h1>
+ <input type="hidden" name="Queue" value="" />
- CATALOGBEGIN
-         $r->print(<<CATALOGCONTROLS);
- <form name='results' method="post" action="/adm/searchcat">
- $hidden
- <input type='hidden' name='acts' value='' />
- <input type='button' value='Revise search request'
- onClick='this.form.submit();' />
  $importbutton
- $closebutton
- $persistent
- <hr />
- <h3>Search Query</h3>
- CATALOGCONTROLS
-     if ($mode eq 'Basic') {
- 	$r->print(<<RESULTS);
- <p>
- <b>Basic search:</b> $ENV{'form.basicexp'}
- </p>
- RESULTS
-     }
-     elsif ($mode eq 'Advanced') {
- 	$r->print(<<RESULTS);
- <p>
- <b>Advanced search</b>
- $query
- </p>
- RESULTS
-     }
-     $r->print('<h3>Search Results</h3>');
-     $r->rflush();
-     my $servernum=(keys %rhash)+0;
-     # define server grid (shows status of multiple machines)
-     my $hcinit;
-     my $grid="'<br />'+";
-     $grid.="\n";
-     my $sn=1;
-     for 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 ";
- 	}
- 	else {
- 	    $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";
- 	    $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";
- 	}
- 	$grid.=" hitcount=".$hc;
- 	$grid.=" domain=".$hostdomains{$sk};
- 	$grid.=" IP=".$hostips{$sk};
- 	# '+"'"+'">'+
- 	$grid.="'+\"'\"+')\">'+";
- 	$grid.="\n";
- 	$grid.="'<img border=\"0\" name=\"img".$sn."\"".
- 	    " src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk."\" /></a>'+\n";
- 	$grid.="'<br />'+\n" unless $sn%10;
-         $sn++;
-     }
- 	    $r->print(<<ENDPOP);
- <script type="text/javascript">
-     popwin=open('','popwin','scrollbars=1,width=400,height=220');
-     popwin.focus();
-     popwin.document.writeln('<'+'html>');
-     popwin.document.writeln('<'+'head>');
-     popwin.document.writeln('<'+'script>');
-     popwin.document.writeln('hc=new Array();$hcinit');
-     popwin.document.writeln('<'+'/script>');
-     popwin.document.writeln('<'+'/head>'+
-         '<'+'body bgcolor="#FFFFFF">'+
- 	'<'+'image name="whirly" align="right" src="/adm/lonIcons/'+
- 	'lonanim.gif" '+
- 	'alt="animated logo" />'+
- 	'<'+'h3>Search Results Progress<'+'/h3>'+
-         '<'+'form name="popremain">'+
-         '<'+'tt>'+
- 	'<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+
- 	'<'+'br />SCANNING $servernum SERVERS'+
- 	'<'+'br clear="all" />Number of record hits found '+
- 	'<'+'input type="text" size="10" name="numhits"'+
- 	' value="0" />'+
- 	'<'+'br clear="all" />Time elapsed '+
- 	'<'+'input type="text" size="10" name="elapsetime"'+
- 	' value="0" />'+
- 	'<'+'br />'+
- 	'SERVER GRID (click on any cell for details)'+
-         $grid
-         '<'+'br />'+
- 	'Server details '+
- 	'<'+'input type="text" size="35" name="sdetails"'+
- 	' value="" />'+
- 	'<'+'br />'+
- 	' <'+'input type="button" name="button"'+
- 	' value="close this window" '+
- 	' onClick="javascript:opener.abortsearch()" />'+
- 	' <'+'input type="button" name="button"'+
- 	' value="help" onClick="javascript:opener.openhelp()" />'+
- 	'<'+'/tt>'+
-         '<'+'/form>'+
-         '<'+'/body><'+'/html>');
-     popwin.document.close();
- </script>
- ENDPOP
-     $r->rflush();
-     my $servercount=0;
-     my $hitcountsum=0;
-     my $bloop=$servernum;
-     my %orkey;
-   BLOOP: while(1) {
-       my $sn=0;
-       last BLOOP unless $bloop;
-       last BLOOP unless $timeremain;
-     RLOOP: foreach my $rkey (sort keys %rhash) {
- 	$sn++;
- 	next RLOOP if $orkey{$rkey};
- 	$servercount++;
- 	$tflag=1;
- 	$compiledresult='';
- 	my $hostname=$rkey;
- 	my $reply=$rhash{$rkey};
- 	my @results;
- 	my $replyfile='';
- 	if ($reply eq 'con_lost') {
- 	    &popwin_imgupdate($r,$sn,"srvbad.gif");
- 	    $bloop--;
- 	    $orkey{$rkey}=1;
- 	}
- 	else {
- 	    $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting
- 	    $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
- 	    $reply=~/(.*?)\_/;
- 	    {
- 		my $temp=0;
- 	      WLOOP: while (1) {
- 		  if (-e $replyfile && $tflag) {
- 		      &popwin_imgupdate($r,$sn,"srvhalf.gif");
- 		      &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
- 				 '"still transferring..."'.';');
- 		      $tflag=0;
- 		  }
- 		  if (-e "$replyfile.end") {
- 		      $bloop--;
- 		      $orkey{$rkey}=1;
- 		      if (-s $replyfile) {
- 			  &popwin_imgupdate($r,$sn,"srvgood.gif");
- 			  my $fh=Apache::File->new($replyfile) or
- 			      ($r->print('ERROR: file '.
- 					 $replyfile.' cannot be opened') and
- 			       return OK);
- 			  @results=<$fh> if $fh;
- 			  $hitcount{$rkey}=@results+0;
- 			  &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
- 				    $hitcount{$rkey}.';');
- 			  $hitcountsum+=$hitcount{$rkey};
- 			  &popwin_js($r,'popwin.document.forms.popremain.'.
- 				    'numhits.value='.$hitcountsum.';');
- 		      }
- 		      else {
- 			  &popwin_imgupdate($r,$sn,"srvempty.gif");
- 			  &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');
- 		      }
- 		      last WLOOP;
- 		  }
- 		  if ($temp>1) {
- 		      sleep 1;
- 		      $timeremain--;
- 		      $elapsetime++;
- 		      last WLOOP;
- 		  }
- 		  last WLOOP unless $timeremain;
- 		  sleep 1;
- 		  $timeremain--;
- 		  $elapsetime++;
- 		  &popwin_js($r,"popwin.document.popremain.".
- 			       "elapsetime.value=$elapsetime;");
- 		  $temp++;
- 	      }
- 	    }
- 	    &popwin_js($r,'popwin.document.whirly.'.
- 		       'src="/adm/lonIcons/lonanimend.gif";');
- 	}
- 	my $customshow='';
- 	my $extrashow='';
- 	my @customfields;
- 	if ($ENV{'form.customshow'}) {
- 	    $customshow=$ENV{'form.customshow'};
- 	    $customshow=~s/[^\w\s]//g;
- 	    my @fields=map {"<font color=\"#008000\">$_:</font><!-- $_ -->"}
- 	    split(/\s+/,$customshow);
- 	    @customfields=split(/\s+/,$customshow);
- 	    if ($customshow) {
- 		$extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
- 	    }
- 	}
- 	my $customdata='';
- 	my %customhash;
- 	foreach my $result (@results) {
- 	    if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
- 		my $tmp=$result;
- 		$tmp=~s/^custom\=//;
- 		my ($k,$v)=map {&Apache::lonnet::unescape($_);
- 			    } split(/\,/,$tmp);
- 		$customhash{$k}=$v;
- 	    }
- 	}
- 	if (keys %hash) {
- 	    untie %hash;
- 	}
- 	if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
- 	    if ($ENV{'form.launch'} eq '1') {
- 		&start_fresh_session();
- 	    }
- 	    foreach my $result (@results) {
- 		next if $result=~/^custom\=/;
- 		chomp $result;
- 		next unless $result;
- 		my @fields=map
- 		{&Apache::lonnet::unescape($_)}
- 		(split(/\,/,$result));
- 		my ($title,$author,$subject,$url,$keywords,$version,
- 		    $notes,$abstract,$mime,$lang,
- 		    $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
-                 unless ($title =~ /^\s*$/ ) { $title='<i>Untitled</i>'; }
- 		unless ($ENV{'user.adv'}) {
- 		    $keywords='<i>- not displayed -</i>';
- 		    $fields[4]=$keywords;
- 		    $notes='<i>- not displayed -</i>';
- 		    $fields[6]=$notes;
- 		    $abstract='<i>- not displayed -</i>';
- 		    $fields[7]=$abstract;
- 		    $subject='<i>- not displayed -</i>';
- 		    $fields[2]=$subject;
- 		}
- 		my $shortabstract=$abstract;
- 		$shortabstract=substr($abstract,0,200).'...' if length($abstract)>200;
- 		$fields[7]=$shortabstract;
- 		my $shortkeywords=$keywords;
- 		$shortkeywords=substr($keywords,0,200).'...' if length($keywords)>200;
- 		$fields[4]=$shortkeywords;
- 		my $extrashow2=$extrashow;
- 		if ($extrashow) {
- 		    foreach my $field (@customfields) {
- 			my $value='';
- 			if ($customhash{$url}=~/\<${field}[^\>]*\>(.*?)\<\/${field}[^\>]*\>/s) {
- 		            $value=$1;
- 			}
- 		        $extrashow2=~s/\<\!\-\- $field \-\-\>/ $value/g;
- 	            }
-                 }
- 	        $compiledresult.=<<END if $compiledresult or $servercount!=$servernum;
- <hr align='left' width='200' noshade />
- END
-                 $compiledresult.=<<END;
- <p>
  END
-                if ($ENV{'form.catalogmode'} eq 'interactive') {
+     return $result;
- 		   my $titleesc=$title;
+ }
- 		   $titleesc=~s/\'/\\'/; # '
-                    $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');
+ ######################################################################
- <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
+ ######################################################################
- onClick="javascript:select_data('$titleesc','$url')">
+ sub search_status_header {
- </font>
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
- <br />
+     return <<ENDSTATUS;
- END
+ <html><head><title>Search Status</title></head>
-                 }
+ $bodytag
-                 if ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ <h3>Search Status</h3>
- 		    $fnum+=0;
+ Sending search request to LON-CAPA servers.<br />
- 		    $hash{"pre_${fnum}_link"}=$url;
+ ENDSTATUS
- 		    $hash{"pre_${fnum}_title"}=$title;
+ }
- 		    $compiledresult.=<<END;
- <font size='-1'>
- <input type="checkbox" name="returnvalues" value="SELECT"
- onClick="javascript:queue($fnum)" />
- </font>
- <br />
- END
- # <input type="hidden" name="title$fnum" value="$title" />
- # <input type="hidden" name="url$fnum" value="$url" />
-                     $fnum++;
- 		}
- 	        my $httphost=$ENV{'HTTP_HOST'};
- 	        my $viewselect;
- 	        if ($mode eq 'Basic') {
- 		    $viewselect=$ENV{'form.basicviewselect'};
- 		}
- 	        elsif ($mode eq 'Advanced') {
- 		    $viewselect=$ENV{'form.advancedviewselect'};
- 		}
- 	        if ($viewselect eq 'Detailed Citation View') {
- 		    $compiledresult.=&detailed_citation_view(@fields,
- 						 $hostname,$httphost,
- 						 $extrashow2);
- 		}
-                 elsif ($viewselect eq 'Summary View') {
- 		    $compiledresult.=&summary_view(@fields,$hostname,$httphost,
- 				       $extrashow2);
- 	        }
-                 elsif ($viewselect eq 'Fielded Format') {
- 		    $compiledresult.=&fielded_format_view(@fields,$hostname,
- 					      $httphost,$extrashow2);
- 	        }
-                 elsif ($viewselect eq 'XML/SGML') {
- 		    $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,
- 					$extrashow2);
- 		}
-             }
-             untie %hash;
+ sub results_link {
-         }
+     my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
-         else {
+         "&persistent_db_id=".$ENV{'form.persistent_db_id'};
- 	    $r->print('<html><head></head><body>Unable to tie hash to db '.
+     my $results_link = $basic_link."&phase=results".
- 		  'file</body></html>');
+         "&pause=1"."&start=1";
- 	}
+     return $results_link;
- 	if ($compiledresult) {
+ }
- 	    $resultflag=1;
- 	}
- 	$r->print(<<RESULTS);
+ ######################################################################
- $compiledresult
+ ######################################################################
- RESULTS
+ sub print_frames_interface {
-         my $percent=sprintf('%3.0f',($servercount/$servernum*100));
+     my $r = shift;
-     }
+     my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
-   }
+         "&persistent_db_id=".$ENV{'form.persistent_db_id'};
-     unless ($resultflag) {
+     my $run_search_link = $basic_link."&phase=run_search";
-         $r->print("\nThere were no results that matched your query\n");
+     my $results_link = &results_link();
-     }
+     my $result = <<"ENDFRAMES";
- #    $r->print('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush();
+ <html>
-     $r->print(<<RESULTS);
+ <head>
- </body>
+ <script>
+ var targetwin = opener;
+ var queue = '';
+ </script>
+ <title>LON-CAPA Digital Library Search Results</title>
+ </head>
+ <frameset rows="150,*">
+     <frame name="statusframe"  src="$run_search_link">
+     <frame name="resultsframe" src="$results_link">
+ </frameset>
  </html>
- RESULTS
+ ENDFRAMES
+     $r->print($result);
+     return;
  }
  ######################################################################
- Line 1489  RESULTS
+ Line 2578  RESULTS
  =item Metadata Viewing Functions
  Output is a HTML-ified string.
  Input arguments are title, author, subject, url, keywords, version,
  notes, short abstract, mime, language, creation date,
- last revision date, owner, copyright, hostname, httphost, and
+ last revision date, owner, copyright, hostname, and
  extra custom metadata to show.
  =over 4
- Line 1503  extra custom metadata to show.
+ Line 2593  extra custom metadata to show.
  ######################################################################
  ######################################################################
  sub detailed_citation_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my ($prefix,%values) = @_;
- 	$notes,$shortabstract,$mime,$lang,
+     my $icon=&Apache::loncommon::icon($values{'url'});
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
- 	$hostname,$httphost,$extrashow)=@_;
      my $result=<<END;
- <i>$owner</i>, last revised $lastrevisiondate
+ <b>$prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"
- <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>
+     target='search_preview'>$values{'title'}</a></b>
- <h3>$author</h3>
- </p>
  <p>
- <b>Subject:</b> $subject<br />
+ <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />
- <b>Keyword(s):</b> $keywords<br />
- <b>Notes:</b> $notes<br />
+ <b>Subject:       </b> $values{'subject'}<br />
- <b>MIME Type:</b>
+ <b>Keyword(s):    </b> $values{'keywords'}<br />
- END
+ <b>Notes:         </b> $values{'notes'}<br />
-     $result.=&Apache::loncommon::filedescription($mime);
+ <b>MIME Type:     </b> $values{'mimetag'}<br />
-     $result.=<<END;
+ <b>Language:      </b> $values{'language'}<br />
- <br />
+ <b>Copyright/Distribution:</b> $values{'copyrighttag'}<br />
- <b>Language:</b>
- END
-     $result.=&Apache::loncommon::languagedescription($lang);
-     $result.=<<END;
- <br />
- <b>Copyright/Distribution:</b>
- END
-     $result.=&Apache::loncommon::copyrightdescription($copyright);
-     $result.=<<END;
- <br />
  </p>
- $extrashow
+ $values{'extrashow'}
  <p>
- $shortabstract
+ $values{'shortabstract'}
  </p>
+ <hr align='left' width='200' noshade />
  END
      return $result;
  }
- Line 1548  END
+ Line 2625  END
  =item &summary_view()
  =cut
  ######################################################################
  ######################################################################
  sub summary_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my ($prefix,%values) = @_;
- 	$notes,$shortabstract,$mime,$lang,
+     my $icon=&Apache::loncommon::icon($values{'url'});
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
- 	$hostname,$httphost,$extrashow)=@_;
-     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
      my $result=<<END;
- <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />
+ $prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"
- $title<br />
+    target='search_preview'>$values{'author'}</a><br />
- $owner -- $lastrevisiondate<br />
+ $values{'title'}<br />
- $cprtag<br />
+ $values{'owner'} -- $values{'lastrevisiondate'}<br />
- $extrashow
+ $values{'copyrighttag'}<br />
+ $values{'extrashow'}
  </p>
+ <hr align='left' width='200' noshade />
+ END
+     return $result;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &compact_view()
+ =cut
+ ######################################################################
+ ######################################################################
+ sub compact_view {
+     my ($prefix,%values) = @_;
+     my $icon=&Apache::loncommon::icon($values{'url'});
+     my $result=<<END;
+ $prefix <img src="$icon" /> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"  target='search_preview'>
+ $values{'title'}</a>
+ <b>$values{'author'}</b><br />
  END
      return $result;
  }
  ######################################################################
  ######################################################################
- Line 1580  END
+ Line 2678  END
  ######################################################################
  ######################################################################
  sub fielded_format_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my ($prefix,%values) = @_;
- 	$notes,$shortabstract,$mime,$lang,
+     my $icon=&Apache::loncommon::icon($values{'url'});
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
- 	$hostname,$httphost,$extrashow)=@_;
-     my $mimetag=&Apache::loncommon::filedescription($mime);
-     my $language=&Apache::loncommon::languagedescription($lang);
-     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
      my $result=<<END;
- <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>
+ $prefix <img src="$icon" />
+ <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"
+               target='search_preview'>$values{'url'}</a>
  <br />
- <b>Title:</b> $title<br />
+ <b>Title:</b> $values{'title'}<br />
- <b>Author(s):</b> $author<br />
+ <b>Author(s):</b> $values{'author'}<br />
- <b>Subject:</b> $subject<br />
+ <b>Subject:</b> $values{'subject'}<br />
- <b>Keyword(s):</b> $keywords<br />
+ <b>Keyword(s):</b> $values{'keywords'}<br />
- <b>Notes:</b> $notes<br />
+ <b>Notes:</b> $values{'notes'}<br />
- <b>MIME Type:</b> $mimetag<br />
+ <b>MIME Type:</b> $values{'mimetag'}<br />
- <b>Language:</b> $language<br />
+ <b>Language:</b> $values{'language'}<br />
- <b>Creation Date:</b> $creationdate<br />
+ <b>Creation Date:</b> $values{'creationdate'}<br />
- <b>Last Revision Date:</b> $lastrevisiondate<br />
+ <b>Last Revision Date:</b> $values{'lastrevisiondate'}<br />
- <b>Publisher/Owner:</b> $owner<br />
+ <b>Publisher/Owner:</b> $values{'owner'}<br />
- <b>Copyright/Distribution:</b> $cprtag<br />
+ <b>Copyright/Distribution:</b> $values{'copyrighttag'}<br />
- <b>Repository Location:</b> $hostname<br />
+ <b>Repository Location:</b> $values{'hostname'}<br />
- <b>Abstract:</b> $shortabstract<br />
+ <b>Abstract:</b> $values{'shortabstract'}<br />
- $extrashow
+ $values{'extrashow'}
  </p>
+ <hr align='left' width='200' noshade />
  END
      return $result;
  }
- Line 1623  END
+ Line 2719  END
  ######################################################################
  ######################################################################
  sub xml_sgml_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my ($prefix,%values) = @_;
- 	$notes,$shortabstract,$mime,$lang,
+     my $xml = <<END;
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
+ <LonCapaResource>
- 	$hostname,$httphost,$extrashow)=@_;
+ <url>$values{'url'}</url>
-     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
+ <title>$values{'title'}</title>
-     my $mimetag=&Apache::loncommon::filedescription($mime);
+ <author>$values{'author'}</author>
-     my $language=&Apache::loncommon::languagedescription($lang);
+ <subject>$values{'subject'}</subject>
+ <keywords>$values{'keywords'}</keywords>
+ <notes>$values{'notes'}</notes>
+ <mimeInfo>
+ <mime>$values{'mime'}</mime>
+ <mimetag>$values{'mimetag'}</mimetag>
+ </mimeInfo>
+ <languageInfo>
+ <language>$values{'language'}</language>
+ <languagetag>$values{'languagetag'}</languagetag>
+ </languageInfo>
+ <creationdate>$values{'creationdate'}</creationdate>
+ <lastrevisiondate>$values{'lastrevisiondate'}</lastrevisiondate>
+ <owner>$values{'owner'}</owner>
+ <copyrightInfo>
+ <copyright>$values{'copyright'}</copyright>
+ <copyrighttag>$values{'copyrighttag'}</copyrighttag>
+ </copyrightInfo>
+ <repositoryLocation>$values{'hostname'}</repositoryLocation>
+ <shortabstract>$values{'shortabstract'}</shortabstract>
+ </LonCapaResource>
+ END
+     $xml = &HTML::Entities::encode($xml,'<>&');
      my $result=<<END;
+ $prefix
  <pre>
- &lt;LonCapaResource&gt;
+ $xml
- &lt;url&gt;$url&lt;/url&gt;
- &lt;title&gt;$title&lt;/title&gt;
- &lt;author&gt;$author&lt;/author&gt;
- &lt;subject&gt;$subject&lt;/subject&gt;
- &lt;keywords&gt;$keywords&lt;/keywords&gt;
- &lt;notes&gt;$notes&lt;/notes&gt;
- &lt;mimeInfo&gt;
- &lt;mime&gt;$mime&lt;/mime&gt;
- &lt;mimetag&gt;$mimetag&lt;/mimetag&gt;
- &lt;/mimeInfo&gt;
- &lt;languageInfo&gt;
- &lt;language&gt;$lang&lt;/language&gt;
- &lt;languagetag&gt;$language&lt;/languagetag&gt;
- &lt;/languageInfo&gt;
- &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;
- &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;
- &lt;owner&gt;$owner&lt;/owner&gt;
- &lt;copyrightInfo&gt;
- &lt;copyright&gt;$copyright&lt;/copyright&gt;
- &lt;copyrighttag&gt;$cprtag&lt;/copyrighttag&gt;
- &lt;/copyrightInfo&gt;
- &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;
- &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;
- &lt;/LonCapaResource&gt;
  </pre>
- $extrashow
+ $values{'extrashow'}
+ <hr align='left' width='200' noshade />
  END
      return $result;
  }
- Line 1677  END
+ Line 2773  END
  sub filled {
      my ($field)=@_;
      if ($field=~/\S/ && $field ne 'any') {
- 	return 1;
+         return 1;
-     }
+     } else {
-     else {
+         return 0;
- 	return 0;
      }
  }
- Line 1691  sub filled {
+ Line 2786  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)=@_;
+     my ($r,$closebutton,$parms,$hidden_fields)=@_;
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
      # make query information persistent to allow for subsequent revision
-     my $persistent=&make_persistent();
      $r->print(<<BEGINNING);
  <html>
  <head>
- Line 1707  sub output_blank_field_error {
+ Line 2810  sub output_blank_field_error {
  BEGINNING
      $r->print(<<RESULTS);
  </head>
- <body bgcolor="#ffffff">
+ $bodytag
  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
  <h1>Search Catalog</h1>
  <form method="post" action="/adm/searchcat">
- $persistent
+ $hidden_fields
- <input type='button' value='Revise search request'
+ <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}"
- onClick='this.form.submit();' />
+ >Revise search request</a>&nbsp;
  $closebutton
  <hr />
- <h3>Helpful Message</h3>
+ <h3>Unactionable search query.</h3>
  <p>
- Incorrect search query due to blank entry fields.
+ You did not fill in enough information for the search to be started.
- You need to fill in the relevant
+ You need to fill in relevant fields on the search page in order
- fields on the search page in order for a query to be
+ for a query to be processed.
- processed.
  </p>
  </body>
  </html>
- Line 1737  RESULTS
+ Line 2839  RESULTS
  Output a full html page with an error message.
+ Inputs:
+     $r, the request pointer.
+     $message, the error message for the user.
+     $closebutton, the specialized close button needed for groupsearch.
  =cut
  ######################################################################
  ######################################################################
  sub output_date_error {
-     my ($r,$message)=@_;
+     my ($r,$message,$closebutton,$hidden_fields)=@_;
      # make query information persistent to allow for subsequent revision
-     my $persistent=&make_persistent();
+     my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
      $r->print(<<RESULTS);
  <html>
  <head>
  <title>The LearningOnline Network with CAPA</title>
  </head>
- <body bgcolor="#ffffff">
+ $bodytag
  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
  <h1>Search Catalog</h1>
  <form method="post" action="/adm/searchcat">
- $persistent
+ $hidden_fields
  <input type='button' value='Revise search request'
  onClick='this.form.submit();' />
  $closebutton
  <hr />
- <h3>Helpful Message</h3>
+ <h3>Error</h3>
  <p>
  $message
  </p>
- Line 1776  RESULTS
+ Line 2883  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
- Line 1784  Cleans the global %hash by removing all
+ Line 2891  Cleans the global %hash by removing all
  ######################################################################
  ######################################################################
  sub start_fresh_session {
-     delete $hash{'mode_catalog'};
+     delete $groupsearch_db{'mode_catalog'};
-     foreach (keys %hash) {
+     foreach (keys %groupsearch_db) {
          if ($_ =~ /^pre_/) {
-             delete $hash{$_};
+             delete $groupsearch_db{$_};
          }
          if ($_ =~ /^store/) {
- 	    delete $hash{$_};
+ 	    delete $groupsearch_db{$_};
  	}
      }
  }
- ######################################################################
+;
- ######################################################################
- =pod
- =item &popwin_js() send javascript to popwin
- =cut
- ######################################################################
+ sub cleanup {
- ######################################################################
+     if (tied(%groupsearch_db)) {
- sub popwin_js {
+         unless (untie(%groupsearch_db)) {
-     # Print javascript out to popwin, but make sure we dont generate
+ 	  &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
-     # any javascript errors in doing so.
+         }
-     my ($r,$text) = @_;
-     $r->print(<<"END");
- <script type="text/javascript">
-     if (! popwin.closed) {
- 	$text
      }
- </script>
+     &untiehash();
- END
+     &Apache::lonmysql::disconnect_from_db();
-     $r->rflush();
  }
- ######################################################################
- ######################################################################
- =pod
- =item &popwin_imgupdate()
- =cut
- ######################################################################
- ######################################################################
- sub popwin_imgupdate {
-     my ($r,$imgnum,$icon) = @_;
-     &popwin_js($r,'popwin.document.img'.$imgnum.'.'.
- 	       'src="/adm/lonIcons/'.$icon.'";');
- }
-;
  __END__
  =pod
  =back
- =over 4
- =head1 HANDLER SUBROUTINE
- This routine is called by Apache and mod_perl.
- =over 4
- =item *
- configure dynamic components of interface
- =item *
- determine current user
- =item *
- see if a search invocation should be done
- =item *
- else, begin building search interface to output
- =item *
- compute date selection boxes
- =item *
- compute customized metadata field
- =item *
- print screen
- =back
- =head1 OTHER SUBROUTINES
- =over 4
- =item *
- get_unprocessed_cgi() : reads in critical name/value pairs that may have not
- been processed and passed into %ENV by the web server
- =item *
- make_persistent() : makes a set of hidden HTML fields to make
- SQL search interface information to be persistent
- =back
- WEB INTERFACE COMPONENT FUNCTIONS
- =over 4
- =item *
- simpletextfield(name,value) : returns HTML formatted string for simple text
- field
- =item *
- simplecheckbox(name,value) : returns HTML formatted string for simple
- checkbox
- =item *
- searchphrasefield(title,name,value) : returns HTML formatted string for
- a search expression phrase field
- =item *
- dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
- formatted string for a calendar date
- =item *
- selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
- a selection box field
- =back
- SEARCH FUNCTIONS
- =over 4
- =item *
- advancedsearch(server reference, environment reference) : perform a complex
- multi-field logical query
- =item *
- basicsearch(server reference, environment reference) : perform a simple
- single-field logical query
- =item *
- build_SQL_query(field name, logic) : builds a SQL query string from a
- logical expression with AND/OR keywords
- =item *
- build_custommetadata_query(field_name, logic_statement) : builds a perl
- regular expression from a logical expression with AND/OR keywords
- =item *
- recursive_SQL_query_build(field name, reverse notation expression) :
- builds a SQL query string from a reverse notation expression
- logical expression with AND/OR keywords
- =item *
- build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,
- lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :
- Builds a SQL logic query to check time/date entries.
- =back
- OUTPUTTING RESULTS FUNCTION
- =over 4
- =item *
- output_results(output mode, server reference, environment reference,
- reply list reference) : outputs results from search
- =back
- DIFFERENT WAYS TO VIEW METADATA RECORDS
- =over 4
- =item *
- detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
- see metadata viewing notes below
- =item *
- summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
- see metadata viewing notes below
- =item *
- fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
- see metadata viewing notes below
- =item *
- xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
- see metadata viewing notes below
- =back
-   _____________________________________________________________________
-  | * Metadata viewing notes                                            |
-  | Output is a HTML-ified string.                                      |
-  | Input arguments are title, author, subject, url, keywords, version, |
-  | notes, short abstract, mime, language, creation date,               |
-  | last revision date, owner, copyright, hostname, httphost, and       |
-  | extra custom metadata to show.                                      |
-   ---------------------------------------------------------------------
- TEST CONDITIONAL FUNCTIONS
- =over 4
- =item *
- filled(field) : determines whether a given field has been filled
- =back
- ERROR FUNCTIONS
- =over 4
- =item *
- output_blank_field_error(server reference) : outputs a message saying that
- more fields need to be filled in
- =item *
- output_date_error(server reference, error message) :
- =back
  =cut

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.124
changed lines
	Added in v.1.212