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.120 and 1.145

-version 1.120, 2002/06/10 23:55:47
+version 1.145, 2002/07/28 20:02:14
  Line 31
  # 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
  #
- ###
+ ###############################################################################
+ ###############################################################################
+ =pod
+ =head1 NAME
+ lonsearchcat - LONCAPA Search Interface
+ =head1 SYNOPSIS
+ Search interface to LON-CAPAs digital library
+ =head1 DESCRIPTION
+ This module enables searching for a distributed browseable catalog.
+ This is part of the LearningOnline Network with CAPA project
+ 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.
+ =head1 Internals
+ =over 4
+ =cut
+ ###############################################################################
+ ###############################################################################
  ###############################################################################
  ##                                                                           ##
  ## ORGANIZATION OF THIS PERL MODULE                                          ##
  ##                                                                           ##
  ## 1. Modules used by this module                                            ##
- ## 2. Choices for different output views (detailed, summary, xml, etc)       ##
+ ## 2. Variables used throughout the module                                   ##
- ## 3. BEGIN block (to be run once after compilation)                         ##
+ ## 3. handler subroutine called via Apache and mod_perl                      ##
- ## 4. Handling routine called via Apache and mod_perl                        ##
+ ## 4. Other subroutines                                                      ##
- ## 5. Other subroutines                                                      ##
  ##                                                                           ##
  ###############################################################################
- Line 55  use Apache::lonnet();
+ Line 87  use Apache::lonnet();
  use Apache::File();
  use CGI qw(:standard);
  use Text::Query;
+ use DBI;
  use GDBM_File;
  use Apache::loncommon();
+ use Apache::lonmysql();
  # ---------------------------------------- variables used throughout the module
- # -- information holders
+ ######################################################################
- my %hostdomains; # matches host name to host domain
+ ######################################################################
- my %hostips; # matches host name to host ip
- my %hitcount; # stores number of hits per host
+ =pod
+ =item Global variables
+ =over 4
+ =item $importbutton
+ button to take the select results and go to group sorting
+ =item %groupsearch_db
+ Database hash used to save values for the groupsearch RAT interface.
+ =item $diropendb
+ The full path to the (temporary) search database file.  This is set and
+ used in &handler() and is also used in &output_results().
+ =item %Views
+ Hash which associates an output view description with the function
+ that produces it.  Adding a new view type should be as easy as
+ adding a line to the definition of this hash and making sure the function
+ takes the proper parameters.
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
  # -- 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
- my $hidden;
  # -- miscellaneous variables
- my $scrout; # string that holds portions of the screen output
+ my %groupsearch_db;     # database hash
- my $yourself; # allows for quickly limiting to oneself
+ my $diropendb = "";    # db file
- my %hash;
+ #             View Description           Function Pointer
+ my %Views = ("Detailed Citation View" => \&detailed_citation_view,
- # ------------------------------------------ choices for different output views
+              "Summary View"           => \&summary_view,
- # Detailed Citation View ---> sub detailed_citation_view
+              "Fielded Format"         => \&fielded_format_view,
- # Summary View ---> sub summary_view
+              "XML/SGML"               => \&xml_sgml_view );
- # Fielded Format ---> sub fielded_format_view
+ my $persistent_db_file;
- # XML/SGML ---> sub xml_sgml_view
+ my %persistent_db;
- my $basicviewselect=<<END;
+ my $hidden_fields;
- <select name='basicviewselect'>
+ ######################################################################
- <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
- my $advancedviewselect=<<END;
- <select name='advancedviewselect'>
- <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
- # ----------------------------------------------------------------------- BEGIN
+ =pod
- BEGIN {
-     {
+ =item &handler() - main handler invoked by httpd child
- 	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- 				 '/hosts.tab');
+ =item Variables
- 	while (<$fh>) {
- 	    $_=~/(\w+?)\:(\w+?)\:(\w+?)\:(.*)/; chomp;
+ =over 4
- 	    if ($3 eq 'library') {
- 		$hostdomains{$1}=$2;
+ =item $hidden
- 		$hostips{$1}=$4;
- 	    }
- 	}
-     }
- }
- #------------------------------------------------------------- global variables
+ holds 'hidden' html forms
- my $diropendb = "";
- my $domain = "";
- # ----------------------------- Handling routine called via Apache and mod_perl
+ =item $scrout
+ string that holds portions of the screen output
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
  sub handler {
      my $r = shift;
-     untie %hash;
+     #
+     untie %groupsearch_db if (tied(%groupsearch_db));
+     #
+     my $closebutton;  # button that closes the search window
+                       # This button is different for the RAT compared to
+                       # normal invocation.
+     #
      $r->content_type('text/html');
      $r->send_http_header;
      return OK if $r->header_only;
+     ##
-     $domain  = $r->dir_config('lonDefDomain');
+     ## Pick up form fields passed in the links.
-     $diropendb= "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_searchcat.db";
+     ##
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
-              ['catalogmode','launch','acts','mode','form','element']);
+              ['catalogmode','launch','acts','mode','form','element',
+               'reqinterface','persistent_db_id','table']);
+     ##
+     ## Initialize global variables
+     ##
+     my $domain  = $r->dir_config('lonDefDomain');
+     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
+             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
+     #
+     # 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.persistent_db_id'} = time;
+     }
+     $persistent_db_file = "/home/httpd/perl/tmp/".
+         &Apache::lonnet::escape($domain).
+             '_'.&Apache::lonnet::escape($ENV{'user.name'}).
+                 '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
+     #
+     # Read in the database.  It should (hopefully) not be catastrophic to
+     #    fail in this exercise.
+     if (-e $persistent_db_file) {
+         # Read in the previous values, if we can.
+ 	if (tie(%persistent_db,'GDBM_File',$persistent_db_file,
+                 &GDBM_READER,0640)) {
+             &reconstruct_persistent_form_data($r);
+             untie (%persistent_db);
+ 	}
+     }
+     ##
+     ## Clear out old values from groupsearch database
+     ##
      if ($ENV{'form.launch'} eq '1') {
- 	if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ 	if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
  	    &start_fresh_session();
- 	    untie %hash;
+ 	    untie %groupsearch_db;
- 	}
+ 	} else {
- 	else {
  	    $r->print('<html><head></head><body>Unable to tie hash to db '.
  		      'file</body></html>');
  	    return OK;
  	}
      }
+     ##
- # --------------------------- Produce some output, so people know it is working
+     ## Configure dynamic components of interface
+     ##
-     $r->print("\n");
+     $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
-     $r->rflush;
+         $ENV{'form.persistent_db_id'}.'" />';
- # ----------------------------------- configure dynamic components of interface
      if ($ENV{'form.catalogmode'} eq 'interactive') {
- 	$hidden="<input type='hidden' name='catalogmode' value='interactive'>".
- 	    "\n";
          $closebutton="<input type='button' name='close' value='CLOSE' ".
  	    "onClick='self.close()'>"."\n";
-     }
+     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
-     elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
- 	$hidden=<<END;
- <input type='hidden' name='catalogmode' value='groupsearch'>
- END
          $closebutton=<<END;
  <input type='button' name='close' value='CLOSE' onClick='self.close()'>
  END
- Line 170  END
+ Line 245  END
  onClick='javascript:select_group()'>
  END
      }
-     $hidden .= <<END;
+     ##
- <input type='hidden' name='mode'    value='$ENV{'form.mode'}'>
+     ##  Do a search, if needed.
- <input type='hidden' name='form'    value='$ENV{'form.form'}'>
+     ##
- <input type='hidden' name='element' value='$ENV{'form.element'}'>
+     my $searchtype;
- <input type='hidden' name='date' value='2'>
+     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');
- END
+     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');
- # ------------------------------------------------------ Determine current user
+     if ($searchtype) {
-     $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
+         ##
+         ## make query information persistent to allow for subsequent revision
+         ##
+         tie(%persistent_db,'GDBM_File',$persistent_db_file,&GDBM_WRCREAT,0640);
+         &make_persistent(\%ENV);
+         untie(%persistent_db);
+         #
+         # We are running a search
+         my ($query,$customquery,$customshow,$libraries) =
+             (undef,undef,undef,undef);
+         my $pretty_string;
+         if ($searchtype eq 'Basic') {
+             ($query,$pretty_string) = &parse_basic_search($r,$closebutton);
+         } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
+             ($query,$customquery,$customshow,$libraries,$pretty_string)
+                 = &parse_advanced_search($r,$closebutton);
+             return OK if (! defined($query));
+         }
+         # Output some information to the user.
+         $r->print(&search_results_header($searchtype,$pretty_string));
+         $r->print("Sending search request to LON-CAPA servers.<br />\n");
+         $r->rflush();
+         &run_search($r,$query,$customquery,$customshow,$libraries);
+         ##
+         ## Display the results
+         ##
+         &display_results($r,$searchtype,$importbutton,$closebutton);
+         $r->rflush();
+     } else {
+         #
+         # Set the default view if it is not already set.
+         if (!defined($ENV{'form.viewselect'})) {
+             $ENV{'form.viewselect'} ="Detailed Citation View";
+         }
+         #
+         # remove the requested interface from the environment.
+         my $interface;
+         if ($ENV{'form.reqinterface'}) {
+             $interface = lc($ENV{'form.reqinterface'});
+         } else {
+             $interface = 'basic';
+         }
+         ##
+         ## Determine course of action
+         ##
+         if ($interface eq 'display') {
+             # &display_results($closebutton));
+         } elsif ($interface eq 'advanced') {
+             $r->print(&advanced_search_form($closebutton));
+         } elsif ($interface eq 'basic') {
+             # Output normal search interface
+             $r->print(&basic_search_form($closebutton));
+         }
+     }
+     untie (%persistent_db);
+     return OK;
+ }
- # --- Now, depending on the interface actions, do one of three things here:
+ ######################################################################
- # --- 1. a basic search
+ ######################################################################
- # --- 2. an advanced search
- # --- 3. output a search interface
- # ----------------------------------- See if a search invocation should be done
+ =pod
-     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
- 	untie %hash; return &basicsearch($r,\%ENV);
-     }
-     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
- 	untie %hash; return &advancedsearch($r,\%ENV);
-     }
- # ----------------------------- Else, begin building search interface to output
+ =item &basic_search_form()
-     $scrout=''; # building a part of screen output
-     $scrout.=&searchphrasefield('Limit by title','title',
- 			$ENV{'form.title'});
-     $scrout.=&searchphrasefield('Limit by author','author',
+ Returns a scalar which holds html for the basic search form.
- 			$ENV{'form.author'});
-     $scrout.=&searchphrasefield('Limit by subject','subject',
+ =cut
- 			$ENV{'form.subject'});
-     $scrout.=&searchphrasefield('Limit by keywords','keywords',
+ ######################################################################
- 			$ENV{'form.keywords'});
+ ######################################################################
-     $scrout.=&searchphrasefield('Limit by URL','url',
+ sub basic_search_form{
- 			$ENV{'form.url'});
+     my ($closebutton) = @_;
+     my $scrout=<<"ENDDOCUMENT";
+ <html>
+ <head>
+ <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_fields
+ <h3>Basic Search</h3>
+ <p>
+ Enter terms or phrases separated by AND, OR, or NOT
+ then press SEARCH below.
+ </p>
+ <p>
+ <table>
+ <tr><td>
+ ENDDOCUMENT
+     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).
+         '&nbsp;';
+ #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});
+ #    $scrout.='<font color="#800000">Search historic archives</font>';
+     my $checkbox = &simplecheckbox('related',$ENV{'form.related'});
+     $scrout.=<<END;
+ </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr>
+ <tr><td>$checkbox use related words</td><td></td></tr>
+ </table>
+ </p>
+ <p>
+ &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;
+ $closebutton
+ END
+     $scrout.=&selectbox(undef,'viewselect',
+ 			$ENV{'form.viewselect'},
+ 			undef,undef,undef,
+ 			sort(keys(%Views)));
+     $scrout.=<<ENDDOCUMENT;
+ <input type="button" value="HELP" onClick="openhelp()" />
+ </p>
+ </form>
+ </body>
+ </html>
+ ENDDOCUMENT
+     return $scrout;
+ }
+ ######################################################################
+ ######################################################################
- #    $scrout.=&searchphrasefield('Limit by version','version',
+ =pod
- #			$ENV{'form.version'});
-     $scrout.=&searchphrasefield('Limit by notes','notes',
+ =item &advanced_search_form()
- 			$ENV{'form.notes'});
-     $scrout.=&searchphrasefield('Limit by abstract','abstract',
+ Returns a scalar which holds html for the advanced search form.
- 			$ENV{'form.abstract'});
-     $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});
+ =cut
-     $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'});
+ ######################################################################
+ ######################################################################
+ sub advanced_search_form{
+     my ($closebutton) = @_;
+     my $advanced_buttons = <<"END";
+ <p>
+ <input type="submit" name="advancedsubmit" value='SEARCH' />
+ <input type="reset" name="reset" value='RESET' />
+ $closebutton
+ <input type="button" value="HELP" onClick="openhelp()" />
+ </p>
+ END
+     if (!defined($ENV{'form.viewselect'})) {
+         $ENV{'form.viewselect'} ="Detailed Citation View";
+     }
+     my $scrout=<<"ENDHEADER";
+ <html>
+ <head>
+ <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>Advanced Catalog Search</h1>
+ <hr />
+ Enter terms or phrases separated by search operators
+ such as AND, OR, or NOT.<br />
+ <form method="post" action="/adm/searchcat">
+ $advanced_buttons
+ $hidden_fields
+ <table>
+ <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>
+ <td>
+ ENDHEADER
+     $scrout.=&selectbox(undef,'viewselect',
+ 			$ENV{'form.viewselect'},
+ 			undef,undef,undef,
+ 			sort(keys(%Views)));
+     $scrout.="</td><td>Related<br />Words</td></tr>\n";
+     $scrout.=&searchphrasefield_with_related('title',   'title'   ,
+                                              $ENV{'form.title'});
+     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});
+     $scrout.=&searchphrasefield_with_related('subject', 'subject' ,
+                                              $ENV{'form.subject'});
+     $scrout.=&searchphrasefield_with_related('keywords','keywords',
+                                              $ENV{'form.keywords'});
+     $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});
+     $scrout.=&searchphrasefield_with_related('notes',   'notes'   ,
+                                              $ENV{'form.notes'});
+     $scrout.=&searchphrasefield_with_related('abstract','abstract',
+                                              $ENV{'form.abstract'});
+     # Hack - an empty table row.
+     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
+     $scrout.=&searchphrasefield('file<br />extension','mime',
+                         $ENV{'form.mime'});
+     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
+     $scrout.=&searchphrasefield('publisher<br />owner','owner',
+ 				$ENV{'form.owner'});
+     $scrout.="</table>\n";
+     $ENV{'form.category'}='any' unless length($ENV{'form.category'});
+     $scrout.=&selectbox('File Category','category',
+ 			$ENV{'form.category'},
+ 			'any','Any category',
+ 			undef,
+ 			(&Apache::loncommon::filecategories()));
+     $ENV{'form.language'}='any' unless length($ENV{'form.language'});
+     #----------------------------------------------------------------
+     # Allow restriction to multiple domains.
+     #   I make the crazy assumption that there will never be a domain 'any'.
+     #
+     $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));
+     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}
+                            :  ($ENV{'form.domains'}) );
+     my %domain_hash = ();
+     foreach (@allowed_domains) {
+         $domain_hash{$_}++;
+     }
+     my @domains =&Apache::loncommon::get_domains();
+     # adjust the size of the select box
+     my $size = 4;
+     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
+     $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
+         'DOMAINS</b></font><br />'.
+             '<select name="domains" size="'.$size.'" multiple>'."\n".
+                 '<option name="any" value="any" '.
+                     ($domain_hash{'any'}? 'selected ' :'').
+                         '>all domains</option>'."\n";
+     foreach my $dom (sort @domains) {
+         $scrout.="<option name=\"$dom\" ".
+             ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";
+     }
+     $scrout.="</select>\n";
+     #----------------------------------------------------------------
      $scrout.=&selectbox('Limit by language','language',
  			$ENV{'form.language'},'any','Any Language',
  			\&{Apache::loncommon::languagedescription},
  			(&Apache::loncommon::languageids),
  			);
  # ------------------------------------------------ Compute date selection boxes
      $scrout.=<<CREATIONDATESTART;
  <p>
- Line 246  CREATIONDATESTART
+ Line 508  CREATIONDATESTART
  			$ENV{'form.creationdatestart_day'},
  			$ENV{'form.creationdatestart_year'},
  			);
-     $scrout.=<<CREATIONDATEEND;
+     $scrout.="and:\n";
- and:
- CREATIONDATEEND
      $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:
- Line 276  LASTREVISIONDATEEND
+ Line 535  LASTREVISIONDATEEND
  			$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'},
- Line 287  LASTREVISIONDATEEND
+ Line 542  LASTREVISIONDATEEND
  			 \&{Apache::loncommon::copyrightdescription},
  			 (&Apache::loncommon::copyrightids),
  			 );
  # ------------------------------------------- Compute customized metadata field
      $scrout.=<<CUSTOMMETADATA;
  <p>
- Line 298  For resource-specific metadata, enter in
+ Line 552  For resource-specific metadata, enter in
  <b>Example:</b> grandmother=75 OR grandfather=85
  <br />
  CUSTOMMETADATA
- $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
+     $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
- $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
      $scrout.=<<CUSTOMSHOW;
  <p>
  <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
- Line 309  Enter in a space-separated list of speci
+ Line 561  Enter in a space-separated list of speci
  in a fielded listing for each record result.
  <br />
  CUSTOMSHOW
- $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
+     $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
- $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
+     $scrout.=<<ENDDOCUMENT;
+ $advanced_buttons
- # ---------------------------------------------------------------- Print screen
-     $r->print(<<ENDDOCUMENT);
- <html>
- <head>
- <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>Basic Search</h3>
- <p>
- Enter terms or phrases separated by search operators
- such as AND, OR, or NOT then press SEARCH below.  Terms should be specific
- to the title, author, subject, notes, or abstract information associated
- with a resource.
- <br />
- ENDDOCUMENT
-     $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'}));
-     $r->print(' ');
-     $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'}));
-     $r->print('<font color="#800000">Title only</font> ');
- #    $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'}));
- # <font color="#800000">Search historic archives</font>
-     $r->print(<<ENDDOCUMENT);
- <br />
- <input type="submit" name="basicsubmit" value='SEARCH' />
- <input type="reset" name="reset" value='RESET' />
- $closebutton
- $basicviewselect
- <input type="button" value="HELP" onClick="openhelp()" />
- </p>
- <hr />
- <h3>Advanced Search</h3>
- $scrout
- <p>
- <input type="submit" name="advancedsubmit" value='SEARCH' />
- <input type="reset" name="reset" value='RESET' />
- $closebutton
- $advancedviewselect
- <input type="button" value="HELP" onClick="openhelp()" />
- </p>
  </form>
  </body>
  </html>
  ENDDOCUMENT
-     return OK;
+     return $scrout;
  }
- # ------------------------------------------------------------- make persistent
+ ######################################################################
- sub make_persistent {
+ ######################################################################
-     my $persistent='';
+ =pod
-     foreach (keys %ENV) {
- 	if (/^form\./ && !/submit/) {
+ =item &reconstruct_persistent_form_data
- 	    my $name=$_;
- 	    my $key=$name;
+ This function is the reverse of &make_persistent();
- 	    $ENV{$key}=~s/\'//g; # do not mess with html field syntax
+ Retrieve persistent data from %persistent_db.  Retrieved items will have their
- 	    $name=~s/^form\.//;
+ values unescaped.  If the item contains commas (before unescaping), the
- 	    $persistent.=<<END;
+ returned value will be an array pointer.  Items will be returned in the
- <input type='hidden' name='$name' value='$ENV{$key}' />
+ environment in $ENV{"form.$name"}.
- END
+ =cut
+ ######################################################################
+ ######################################################################
+ sub reconstruct_persistent_form_data {
+     foreach my $name (keys %persistent_db) {
+         # &Apache::lonnet::logthis("Reconstructing $name = $persistent_db{$name}");
+         my @Values = split(',',$persistent_db{$name});
+         my @value = map { &Apache::lonnet::unescape($_) } @Values;
+         $name = 'form.'.$name;
+         if (exists($ENV{$name})) {
+             if (ref($ENV{$name})) {
+                 # Assume it is an array reference
+                 $ENV{$name} = [@{$ENV{$name}},@value];
+             } else {
+                 $ENV{$name} = [$ENV{$name},@value];
+             }
+         } else {
+             if (@value > 1) {
+                 $ENV{$name} = [@value];
+             } else {
+                 $ENV{$name} = $value[0];
+             }
          }
      }
-     return $persistent;
+     return;
  }
- # --------------------------------------------------------- Various form fields
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &make_persistent()
+ Store (environment) variables away to the %persistent_db.
+ Values will be escaped.  Values that are array pointers will have their
+ elements escaped and concatenated in a comma seperated string.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub make_persistent {
+     my %save = %{shift()};
+     foreach my $name (keys %save) {
+         next if ($name !~ /^form\./ || $name =~ /submit/);
+         my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
+         # We handle array references, but not recursively.
+         my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
+         $name=~s/^form\.//;
+         $persistent_db{$name} = $store;
+     }
+     return '';
+ }
+ ######################################################################
+ #                HTML form building functions                        #
+ ######################################################################
+ =pod
+ =item HTML form building functions
+ =over 4
+ =cut
+ ###############################################
+ ###############################################
+ =pod
+ =item &simpletextfield()
+ Inputs: $name,$value,$size
+ Returns a text input field with the given name, value, and size.
+ If size is not specified, a value of 20 is used.
+ =cut
+ ###############################################
+ ###############################################
  sub simpletextfield {
-     my ($name,$value)=@_;
+     my ($name,$value,$size)=@_;
-     return '<input type=text name=\''.$name.
+     $size = 20 if (! defined($size));
- 	   '\' size=20 value=\''.$value.'\' />';
+     return '<input type="text" name="'.$name.
+         '" size="'.$size.'" value="'.$value.'" />';
  }
+ ###############################################
+ ###############################################
+ =pod
+ =item &simplecheckbox()
+ Inputs: $name,$value
+ Returns a simple check box with the given $name.
+ If $value eq 'on' the box is checked.
+ =cut
+ ###############################################
+ ###############################################
  sub simplecheckbox {
      my ($name,$value)=@_;
      my $checked='';
-     $checked="CHECKED" if $value eq 'on';
+     $checked="checked" if $value eq 'on';
-     return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';
+     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';
  }
+ ###############################################
+ ###############################################
+ =pod
+ =item &fieldtitle()
+ Input: $title
+ Returns a scalar with html which will display $title as a search
+ field heading.
+ =cut
+ ###############################################
+ ###############################################
+ sub fieldtitle {
+     my $title = uc(shift());
+     return '<font color="#800000" face="helvetica"><b>'.$title.
+         ':&nbsp;</b></font>';
+ }
+ ###############################################
+ ###############################################
+ =pod
+ =item &searchphrasefield()
+ Inputs: $title,$name,$value
+ Returns html for a title line and an input field for entering search terms.
+ The entry field (which is where the $name and $value are used) is a 50 column
+ simpletextfield.  The html returned is for a row in a three column table.
+ =cut
+ ###############################################
+ ###############################################
  sub searchphrasefield {
      my ($title,$name,$value)=@_;
-     my $instruction=<<END;
+     return '<tr><td>'.&fieldtitle($title).'</td><td>'.
- Enter terms or phrases separated by search operators such
+         &simpletextfield($name,$value,50)."</td><td>&nbsp;</td></tr>\n";
- as AND, OR, or NOT.
- END
-     my $uctitle=uc($title);
-     return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".
- 	   "</FONT> $instruction<br />".
-            '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';
  }
+ ###############################################
+ ###############################################
+ =pod
+ =item &searchphrasefield_with_related()
+ Inputs: $title,$name,$value
+ Returns html for a title line and an input field for entering search terms
+ and a check box for 'related words'.  The entry field (which is where the
+ $name and $value are used) is a 50 column simpletextfield.  The name of
+ the related words checkbox is "$name_related".
+ =cut
+ ###############################################
+ ###############################################
+ sub searchphrasefield_with_related {
+     my ($title,$name,$value)=@_;
+     return '<tr><td>'.&fieldtitle($title).'</td><td>'.
+         &simpletextfield($name,$value,50).'</td><td align="center">&nbsp;'.
+             &simplecheckbox($name.'_related',$ENV{'form.'.$name.'_related'}).
+                 "&nbsp;</td></tr>\n";
+ }
+ ###############################################
+ ###############################################
+ =pod
+ =item &dateboxes()
+ Returns html selection form elements for the specification of
+ the day, month, and year.
+ =cut
+ ###############################################
+ ###############################################
  sub dateboxes {
      my ($name,$defaultmonth,$defaultday,$defaultyear,
  	$currentmonth,$currentday,$currentyear)=@_;
- Line 459  END
+ Line 833  END
      return "$month$day$year";
  }
+ ###############################################
+ ###############################################
+ =pod
+ =item &selectbox()
+ Returns a scalar containing an html <select> form.
+ Inputs:
+ =over 4
+ =item $title
+ Printed above the select box, in uppercase.  If undefined, only a select
+ box will be returned, with no additional html.
+ =item $name
+ The name element of the <select> tag.
+ =item $default
+ The default value of the form.  Can be $anyvalue, or in @idlist.
+ =item $anyvalue
+ The <option value="..."> used to indicate a default of
+ none of the values.  Can be undef.
+ =item $anytag
+ The text associate with $anyvalue above.
+ =item $functionref
+ Each element in @idlist will be passed as a parameter
+ to the function referenced here.  The return value of the function should
+ be a scalar description of the items.  If this value is undefined the
+ description of each item in @idlist will be the item name.
+ =item @idlist
+ The items to be selected from.  One of these or $anyvalue will be the
+ value returned by the form element, $ENV{form.$name}.
+ =back
+ =cut
+ ###############################################
  sub selectbox {
-     my ($title,$name,$value,$anyvalue,$anytag,$functionref,@idlist)=@_;
+     my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;
-     my $uctitle=uc($title);
+     if (! defined($functionref)) { $functionref = sub { $_[0]}; }
-     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
+     my $selout='';
- 	"</b></font><br />".'<select name="'.$name.'">';
+     if (defined($title)) {
-     foreach ($anyvalue,@idlist) {
+         my $uctitle=uc($title);
-         $selout.='<option value=\''.$_.'\'';
+         $selout="\n".'<p><font color="#800000" face="helvetica">'.
-         if ($_ eq $value and !/^any$/) {
+             '<b>'.$uctitle.': </b></font>';
- 	    $selout.=' selected>'.&{$functionref}($_).'</option>';
+     }
+     $selout .= '<select name="'.$name.'">';
+     unshift @idlist,$anyvalue if (defined($anyvalue));
+     foreach (@idlist) {
+         $selout.='<option value="'.$_.'"';
+         if ($_ eq $default and !/^any$/) {
+ 	    $selout.=' selected >'.&{$functionref}($_).'</option>';
  	}
- 	elsif ($_ eq $value and /^$anyvalue$/) {
+ 	elsif ($_ eq $default and /^$anyvalue$/) {
- 	    $selout.=' selected>'.$anytag.'</option>';
+ 	    $selout.=' selected >'.$anytag.'</option>';
  	}
          else {$selout.='>'.&{$functionref}($_).'</option>';}
      }
-     return $selout.'</select>';
+     return $selout.'</select>'.(defined($title)?'</p>':' ');
  }
- # ----------------------------------------------- Performing an advanced search
+ ######################################################################
- sub advancedsearch {
+ #                End of HTML form building functions                 #
-     my ($r,$envhash)=@_;
+ ######################################################################
-     my %ENV=%{$envhash};
+ =pod
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
+ =pod
+ =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 parse_advanced_search {
+     my ($r,$closebutton)=@_;
      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 492  sub advancedsearch {
+ Line 959  sub advancedsearch {
  		   'lastrevisiondatestart_year','lastrevisiondateend_month',
  		   'lastrevisiondateend_day','lastrevisiondateend_year',
  		   'notes','abstract','mime','language','owner',
- 		   'custommetadata','customshow') {
+ 		   'custommetadata','customshow','category') {
  	$ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
      }
      foreach ('mode','form','element') {
- Line 501  sub advancedsearch {
+ Line 968  sub advancedsearch {
  	$ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  	$ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
      }
+     # Preprocess the category form element.
+     if ($ENV{'form.category'} ne 'any') {
+         my @extensions = &Apache::loncommon::filecategorytypes
+             ($ENV{'form.category'});
+         $ENV{'form.mime'} = join ' OR ',@extensions;
+     }
      # Check to see if enough information was filled in
      for my $field ('title','author','subject','keywords','url','version',
  		   'notes','abstract','mime','language','owner',
- Line 510  sub advancedsearch {
+ Line 983  sub advancedsearch {
  	}
      }
      unless ($fillflag) {
- 	&output_blank_field_error($r);
+ 	&output_blank_field_error($r,$closebutton);
- 	return OK;
+ 	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','mime') {
  	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);
+         }
+     }
+     # I dislike the hack below.
+     if ($ENV{'form.category'}) {
+         $ENV{'form.mime'}='';
      }
      # Evaluate option lists
      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  	push @queries,"(language like \"$ENV{'form.language'}\")";
-     }
+         $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 553  sub advancedsearch {
+ Line 1046  sub advancedsearch {
  			);
      # Test to see if date windows are legitimate
      if ($datequery=~/^Incorrect/) {
- 	&output_date_error($r,$datequery);
+ 	&output_date_error($r,$datequery,$closebutton);
- 	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'}) {
+         $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
+             $ENV{'form.custommetadata'}."</b><br />\n";
  	$customquery=&build_custommetadata_query('custommetadata',
  				      $ENV{'form.custommetadata'});
      }
-     my $customshow='';
+     my $customshow=undef;
      if ($ENV{'form.customshow'}) {
+         $pretty_search_string .=$font."Custom Metadata Display</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);
      }
-     # Send query statements over the network to be processed by either the SQL
+     ## ---------------------------------------------------------------
-     # database or a recursive scheme of 'grep'-like actions (for custom
+     ## Deal with restrictions to given domains
-     # metadata).
+     ##
+     my $libraries_to_query = undef;
+     # $ENV{'form.domains'} can be either a scalar or an array reference.
+     # We need an array.
+     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}
+                            :  ($ENV{'form.domains'}) );
+     my %domain_hash = ();
+     my $pretty_domains_string;
+     foreach (@allowed_domains) {
+         $domain_hash{$_}++;
+     }
+     if ($domain_hash{'any'}) {
+         $pretty_domains_string = "Searching all domains.";
+     } else {
+         if (@allowed_domains > 1) {
+             $pretty_domains_string = "Searching domains:";
+         } else {
+             $pretty_domains_string = "Searching domain ";
+         }
+         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,$_;
+             }
+         }
+     }
+     $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);
- 	}
- 	else {
- 	    $reply=&Apache::lonnet::metadata_query($query,
- 						   $customquery,$customshow);
- 	}
- 	&output_results('Advanced',$r,$envhash,$customquery,$reply);
      }
-     elsif ($customquery) {
+     return ($query,$customquery,$customshow,$libraries_to_query,
- 	my $reply; # reply hash reference
+             $pretty_search_string);
- 	$reply=&Apache::lonnet::metadata_query('',
+ }
- 					       $customquery,$customshow);
- 	&output_results('Advanced',$r,$envhash,$customquery,$reply);
+ ######################################################################
-     }
+ ######################################################################
-     # should not get to this point
-     return 'Error.  Should not have gone to this point.';
+ =pod
- }
+ =item &parse_basic_search()
- # --------------------------------------------------- Performing a basic search
- sub basicsearch {
+ Parse the basic search form and return a scalar containing an sql query.
-     my ($r,$envhash)=@_;
-     my %ENV=%{$envhash};
+ =cut
+ ######################################################################
+ ######################################################################
+ sub parse_basic_search {
+     my ($r,$closebutton)=@_;
      # Clean up fields for safety
      for my $field ('basicexp') {
  	$ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
- Line 616  sub basicsearch {
+ Line 1140  sub basicsearch {
      # Check to see if enough is filled in
      unless (&filled($ENV{'form.basicexp'})) {
- 	&output_blank_field_error($r);
+ 	&output_blank_field_error($r,$closebutton);
  	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(',"    ",',
- 		       ('title', 'author', 'subject', 'notes', 'abstract'));
+ 		       ('title', 'author', 'subject', 'notes', 'abstract',
+                         'keywords'));
      $concatarg='title' if $ENV{'form.titleonly'};
+     $query=&build_SQL_query('concat('.$concatarg.')',$search_string);
+     $pretty_search_string .= "<br />\n";
+     return 'select * from metadata where '.$query,$pretty_search_string;
+ }
-     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
-     # Get reply (either a hash reference to filehandles or bad connection)
+ ######################################################################
-     my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);
+ ######################################################################
-     # Output search results
+ =pod
-     &output_results('Basic',$r,$envhash,$query,$reply);
+ =item &related_version
-     return OK;
+ 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 ...)".
- # ------------------------------------------------------------- build_SQL_query
+ 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));
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =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
+ ######################################################################
+ ######################################################################
  sub build_SQL_query {
      my ($field_name,$logic_statement)=@_;
      my $q=new Text::Query('abc',
- Line 650  sub build_SQL_query {
+ Line 1224  sub build_SQL_query {
      return $sql_query;
  }
- # ------------------------------------------------- build custom metadata query
+ ######################################################################
+ ######################################################################
+ =pod
+ =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)=@_;
      my $q=new Text::Query('abc',
- Line 660  sub build_custommetadata_query {
+ Line 1247  sub build_custommetadata_query {
      my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
      # quick fix to change literal into xml tag-matching
      # will eventually have to write a separate builder module
-     my $oldmatchexp=$matchexp;
+     # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
-     $matchexp=~s/(\w+)\\\=([\w\\\+]+)/\\\<$1\\\>\[\^\\\<\]\*$2\[\^\\\<\]\*\\\<\\\/$1\\\>/g;
+     $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to
+                  /\\<$1\\>?#           \<wordone\>
+                    \[\^\\<\]?#        [^\<]
+                    \*$2\[\^\\<\]?#           *wordtwo[^\<]
+                    \*\\<\\\/$1\\>?#                        *\<\/wordone\>
+                    /g;
      return $matchexp;
  }
- # - Recursively parse a reverse notation expression into a SQL query expression
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &recursive_SQL_query_build()
+ Recursively constructs an SQL query.  Takes as input $dkey and $pattern.
+ =cut
+ ######################################################################
+ ######################################################################
  sub recursive_SQL_query_build {
      my ($dkey,$pattern)=@_;
      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
- Line 699  sub recursive_SQL_query_build {
+ Line 1303  sub recursive_SQL_query_build {
      &recursive_SQL_query_build($dkey,$pattern);
  }
- # ------------------------------------------------------------ Build date query
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &build_date_queries()
+ Builds a SQL logic query to check time/date entries.
+ Also reports errors (check for /^Incorrect/).
+ =cut
+ ######################################################################
+ ######################################################################
  sub build_date_queries {
      my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
  	$lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
- Line 748  sub build_date_queries {
+ Line 1365  sub build_date_queries {
      return '';
  }
- # ----------------------------- format and output results based on a reply list
+ ######################################################################
- # There are two windows that this function writes to.  The main search
+ ######################################################################
- # window ("srch") has a listing of the results.  A secondary window ("popwin")
- # gives the status of the network search (time elapsed, number of machines
- # contacted, etc.)
- sub output_results {
-     my $fnum; # search result counter
-     my ($mode,$r,$envhash,$query,$replyref)=@_;
-     my %ENV=%{$envhash};
-     my %rhash=%{$replyref};
-     my $compiledresult='';
-     my $timeremain=300;
-     my $elapsetime=0;
-     my $resultflag=0;
-     my $tflag=1;
-     # make query information persistent to allow for subsequent revision
+ =pod
-     my $persistent=&make_persistent();
+ =item &copyright_check()
+ =cut
+ ######################################################################
+ ######################################################################
+ sub copyright_check {
+     my $Metadata = shift;
+     # Check copyright tags and skip results the user cannot use
+     my (undef,undef,$resdom,$resname) = split('/',
+                                               $Metadata->{'url'});
+     # Check for priv
+     if (($Metadata->{'copyright'} eq 'priv') &&
+         (($ENV{'user.name'} ne $resname) &&
+          ($ENV{'user.domain'} ne $resdom))) {
+         return 0;
+     }
+     # Check for domain
+     if (($Metadata->{'copyright'} eq 'domain') &&
+         ($ENV{'user.domain'} ne $resdom)) {
+         return 0;
+     }
+     return 1;
+ }
+ #####################################################################
+ #####################################################################
+ =pod
+ =item MySQL Table Description
+ MySQL table creation requires a precise description of the data to be
+ stored.  The use of the correct types to hold data is vital to efficient
+ storage and quick retrieval of records.  The columns must be described in
+ the following format:
+ =cut
+ ##
+ ## Restrictions:
+ ##    columns of type 'text' and 'blob' cannot have defaults.
+ ##    columns of type 'enum' cannot be used for FULLTEXT.
+ ##
+ my @DataOrder = qw/id title author subject url keywords version notes
+     abstract mime lang owner copyright creationdate lastrevisiondate hostname
+     idx_title idx_author idx_subject idx_abstract idx_mime idx_language
+     idx_owner idx_copyright/;
+ my %Datatypes =
+     ( id        =>{ type         => 'INT',
+                     restrictions => 'NOT NULL',
+                     primary_key  => 'yes',
+                     auto_inc     => 'yes'
+                     },
+       title     =>{ type=>'TEXT'},
+       author    =>{ type=>'TEXT'},
+       subject   =>{ type=>'TEXT'},
+       url       =>{ type=>'TEXT',
+                     restrictions => 'NOT NULL' },
+       keywords  =>{ type=>'TEXT'},
+       version   =>{ type=>'TEXT'},
+       notes     =>{ type=>'TEXT'},
+       abstract  =>{ type=>'TEXT'},
+       mime      =>{ type=>'TEXT'},
+       lang      =>{ type=>'TEXT'},
+       owner     =>{ type=>'TEXT'},
+       copyright =>{ type=>'TEXT'},
+       hostname  =>{ type=>'TEXT'},
+       #--------------------------------------------------
+       creationdate     =>{ type=>'DATETIME'},
+       lastrevisiondate =>{ type=>'DATETIME'},
+       #--------------------------------------------------
+       idx_title     =>{ type=>'FULLTEXT', target=>'title'},
+       idx_author    =>{ type=>'FULLTEXT', target=>'author'},
+       idx_subject   =>{ type=>'FULLTEXT', target=>'subject'},
+       idx_abstract  =>{ type=>'FULLTEXT', target=>'abstract'},
+       idx_mime      =>{ type=>'FULLTEXT', target=>'mime'},
+       idx_language  =>{ type=>'FULLTEXT', target=>'lang'},
+       idx_owner     =>{ type=>'FULLTEXT', target=>'owner'},
+       idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},
+       );
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &write_status()
+ =cut
+ ######################################################################
+ ######################################################################
+ sub write_status {
+     my ($r,$string) = @_;
+     $r->print("<pre>".$string."</pre>\n");
+     $r->rflush();
+     return;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &run_search
+ =cut
+ ######################################################################
+ ######################################################################
+ sub run_search {
+     my ($r,$query,$customquery,$customshow,$serverlist) = @_;
+     #
+     # Timing variables
+     #
+     my $starttime = time;
+     my $max_time  = 120;  # seconds for the search to complete
+     #
+     # Determine the servers we need to contact.
+     #
+     my @Servers_to_contact;
+     if (defined($serverlist)) {
+         @Servers_to_contact = @$serverlist;
+     } else {
+         @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
+     }
+     my %Server_status;
+     #
+     # Create Table
+     #
+     my $table = &Apache::lonmysql::create_table
+         ( { columns => \%Datatypes,
+             column_order => \@DataOrder,
+         } );
+     if (! defined($table)) {
+         # What do I do now?  Print out an error page.
+         &Apache::lonnet::logthis("lonmysql attempted to create a table ".
+                                  "and this was the result:".
+                                  &Apache::lonmysql::get_error());
+         $r->print("An internal error occured with the database.<br />".
+                   "The error has been logged, but you should probably alert".
+                   " your system administrator.");
+         return;
+     }
+     ##
+     ## form.table needs to be stored in the persistent database...
+     ##
+     $ENV{'form.table'}=$table;
+     #
+     # Prepare for the big loop.
+     #
+     my $hitcountsum;
+     my $server;
+     my $status;
+     while ((time - $starttime < $max_time) &&
+            ((@Servers_to_contact) || keys(%Server_status))) {
+         # Send out a search request if it needs to be done.
+         if (@Servers_to_contact) {
+             # Contact one server
+             my $server = shift(@Servers_to_contact);
+             my $reply=&Apache::lonnet::metadata_query($query,$customquery,
+                                                       $customshow,[$server]);
+             ($server) = keys(%$reply);
+             $Server_status{$server} = $reply->{$server};
+             # &write_status($r,"Contacted:$server:reply:".
+             #                   $Server_status{$server});
+             if ($max_time - (time - $starttime) < 20) {
+                 # If there are less than 20 seconds to go in the search,
+                 # give the newly contacted servers 20 more seconds to
+                 # respond....
+                 $max_time += 20;
+             }
+         } else {
+             sleep(1); # wait a sec. to give time for files to be written
+         }
+         while (my ($server,$status) = each(%Server_status)) {
+             if ($status eq 'con_lost') {
+                 delete ($Server_status{$server});
+                 # &write_status($r,"server $server is not responding.");
+                 next;
+             }
+             $status=~/^([\.\w]+)$/;
+        	    my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
+             if (-e $datafile && ! -e "$datafile.end") {
+                 # Let the user know we are receiving data from the server
+                 # &write_status($r,"$server:Receiving file");
+                 next;
+             }
+             if (-e "$datafile.end") {
+                 if (-z "$datafile") {
+                     delete($Server_status{$server});
+                     next;
+                 }
+                 my $fh;
+                 if (!($fh=Apache::File->new($datafile))) {
+                     # Error opening file...
+                     # Tell the user and exit...?
+                     # Should I give up on opening it?
+                     &write_status("Unable to open search results file for ".
+                                   "server $server.  Omitting from search");
+                     next;
+                 }
+                 # Read in the whole file.
+                 while (my $result = <$fh>) {
+                     # handle custom fields?  Someday we will!
+                     chomp($result);
+                     next unless $result;
+                     # Parse the result.
+                     my %Fields = &parse_raw_result($result,$server);
+                     $Fields{'hostname'} = $server;
+                     next if (! &copyright_check(\%Fields));
+                     # Store the result in the mysql database
+                     my $result = &Apache::lonmysql::store_row($table,\%Fields);
+                     if (! defined($result)) {
+                         &write_status($r,&Apache::lonmysql::get_error());
+                     }
+                     # &write_status($r,&Apache::lonmysql::get_debug());
+                     $hitcountsum ++;
+                 } # End of foreach (@results)
+                 $fh->close();
+                 # $server is only deleted if the results file has been
+                 # found and (successfully) opened.  This may be a bad idea.
+                 delete($Server_status{$server});
+                 #&write_status($r,"Received $new_count more results from ".
+                 #              $server.".");
+             }
+         }
+         # Finished looping through the servers
+     }
+     &Apache::lonmysql::disconnect_from_db();
+     # Let the user know
+     #
+     # We have run out of time or run out of servers to talk to and
+     # results to get.
+     &write_status($r,"Search completed.");
+     if ($hitcountsum) {
+         &write_status($r,$hitcountsum." successful matches to your query.");
+     } else {
+         &write_status($r,"There were no successful matches to your query.");
+     }
+     return;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &display_buttons
+ =cut
+ ######################################################################
+ ######################################################################
+ sub display_buttons {
+     my ($current_min,$show,$total,$parms) = @_;
+     return '' if ($show eq 'all'); # No links if you get them all at once.
+     my $links;
+     ##
+     ## Prev
+     my $prev_min = $current_min - $show;
+     $prev_min = 0 if $prev_min < 0;
+     if ($prev_min < $current_min) {
+         $links .= qq{
+ <a href="/adm/searchcat?$parms&startwith=$prev_min&show=$show">prev</a>
+ };
+     }
+     ##
+     ## Pages.... Someday.
+     ##
+     ##
+     ## Next
+     my $next_min = $current_min + $show;
+     my $next_min = $current_min if ($next_min > $total);
+     if ($next_min != $current_min) {
+         $links .= qq{
+ <a href="/adm/searchcat?$parms&startwith=$next_min&show=$show">next</a>
+ };
+     }
+     return $links;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &display_results
+ =cut
+ ######################################################################
+ ######################################################################
+ sub display_results {
+     my ($r,$mode,$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;
+     }
+     ##
+     ## Get the catalog controls setup
+     ##
+     my $action = "/adm/searchcat";
+     if ($mode eq 'Basic') {
+         $action .= "?reqinterface=basic";
+     } elsif ($mode eq 'Advanced') {
+         $action .= "?reqinterface=advanced";
+     }
+     $r->print(<<CATALOGCONTROLS);
+ <form name='results' method="post" action="$action">
+ $hidden_fields
+ <input type='hidden' name='acts' value='' />
+ <input type='button' value='Revise search request'
+ onClick='this.form.submit();' />
+ $importbutton
+ $closebutton
+ <hr />
+ CATALOGCONTROLS
+     if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+         $r->print('Unable to tie hash to db file</body></html>');
+         $r->rflush();
+         return;
+     }
+     ##
+     ## Prepare the table for querying
+     ##
+     my $table = $ENV{'form.table'};
+     my $connection_result = &Apache::lonmysql::connect_to_db();
+     if (!defined($connection_result)) {
+         &write_status($r,&Apache::lonmysql::get_error());
+     }
+     my $table_check = &Apache::lonmysql::check_table($table);
+     if (! defined($table_check)) {
+         $r->print("A MySQL error has occurred.</body></html>");
+         &Apache::lonnet::logthis("lonmysql was unable to determine the status".
+                                  " of table ".$table);
+         return;
+     } elsif (! $table_check) {
+         $r->print("The table of results could not be found.");
+         &Apache::lonnet::logthis("The user requested a table, ".$table.
+                                  ", that could not be found.");
+         return;
+     }
+     ##
+     ## 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.</body></html>");
+         &Apache::lonnet::logthis("lonmysql was unable to determine the number".
+                                  " of rows in table ".$table);
+         &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
+         &Apache::lonnet::logthis(&Apache::lonmysql::get_debug());
+         return;
+     }
+     if ($total_results == 0) {
+         $r->print("There were no results matching your query.\n".
+                   "</form></body></html>");
+         return;
+     }
+     ##
+     ## Determine how many results we need to get
+     ##
+     $ENV{'form.startwith'} = 0      if (! exists($ENV{'form.startwith'}));
+     $ENV{'form.show'}      = 'all'  if (! exists($ENV{'form.show'}));
+     my $min = $ENV{'form.startwith'};
+     my $max;
+     if ($ENV{'form.show'} eq 'all') {
+         $max = $total_results ;
+     } else {
+         $max = $min + $ENV{'form.show'};
+     }
+     ##
+     ## Output links (if necessary) for 'prev' and 'next' pages.
+     ##
+     ##
+     ## 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) {
+         my %Fields = %{&parse_row(@$row)};
+         my $output="<p>\n";
+         $output.=&catalogmode_output($Fields{'title'},$Fields{'url'});
+         # Render the result into html
+         $output.= &$viewfunction(%Fields);
+         $output.="</p>\n<hr align='left' width='200' noshade />";
+         # Print them out as they come in.
+         $r->print($output);
+         $r->rflush();
+     }
+     if (@Results < 1) {
+         $r->print("There were no results matching your query");
+     }
+     $r->print("</body></html>");
+     $r->rflush();
+     untie %groupsearch_db;
+     return;
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &catalogmode_output($title,$url)
+ Returns html needed for the various catalog modes.  Gets inputs from
+ $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db and $fnum
+ (local variable).
+ =cut
+ ######################################################################
+ ######################################################################
+ {
+ my $fnum;
+ sub catalogmode_output {
+     my $output = '';
+     my ($title,$url) = @_;
+     if ($ENV{'form.catalogmode'} eq 'interactive') {
+         $title=~ s/\'/\\'/g; # ' Escape single quotes.
+         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
+         }
+     }
+     if ($ENV{'form.catalogmode'} eq 'groupsearch') {
+         $fnum+=0;
+         $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($fnum)" />
+ </font>
+ END
+         $fnum++;
+     }
+     return $output;
+ }
+ }
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &parse_row
+ Parse a row returned from the database.
+ =cut
+ ######################################################################
+ ######################################################################
+ sub parse_row {
+     my @Row = @_;
+     my %Fields;
+     for (my $i=0;$i<=$#Row;$i++) {
+         $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]);
+     }
+     $Fields{'language'} =
+         &Apache::loncommon::languagedescription($Fields{'lang'});
+     $Fields{'copyrighttag'} =
+         &Apache::loncommon::copyrightdescription($Fields{'copyright'});
+     $Fields{'mimetag'} =
+         &Apache::loncommon::filedescription($Fields{'mime'});
+     return \%Fields;
+ }
+ ###########################################################
+ ###########################################################
+ =pod
+ =item &parse_raw_result()
+ Takes a line from the file of results and parse it.  Returns a hash
+ with keys for the following fields:
+ 'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes',
+ 'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate',
+ 'lastrevisiondate'.
+ In addition, the following tags are set by calling the appropriate
+ lonnet function: 'language', 'cprtag', '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) = @_;
+     # Check for a comma - if it is there then we do not need to unescape the
+     # string.  There seems to be some kind of problem with some items in
+     # the database - the entire string gets sent out unescaped...?
+     unless ($result =~ /,/) {
+         $result = &Apache::lonnet::unescape($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;
+     my %Fields =
+         ( title     => &Apache::lonnet::unescape($title),
+           author    => &Apache::lonnet::unescape($author),
+           subject   => &Apache::lonnet::unescape($subject),
+           url       => &Apache::lonnet::unescape($url),
+           keywords  => &Apache::lonnet::unescape($keywords),
+           version   => &Apache::lonnet::unescape($version),
+           notes     => &Apache::lonnet::unescape($notes),
+           abstract  => &Apache::lonnet::unescape($abstract),
+           mime      => &Apache::lonnet::unescape($mime),
+           lang      => &Apache::lonnet::unescape($lang),
+           owner     => &Apache::lonnet::unescape($owner),
+           copyright => &Apache::lonnet::unescape($copyright),
+           creationdate     => &Apache::lonnet::unescape($creationdate),
+           lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate)
+         );
+     $Fields{'language'} =
+         &Apache::loncommon::languagedescription($Fields{'lang'});
+     $Fields{'copyrighttag'} =
+         &Apache::loncommon::copyrightdescription($Fields{'copyright'});
+     $Fields{'mimetag'} =
+         &Apache::loncommon::filedescription($Fields{'mime'});
+     if ($Fields{'author'}=~/^(\s*|error)$/) {
+         $Fields{'author'}="Unknown Author";
+     }
+     # Put spaces in the keyword list, if needed.
+     $Fields{'keywords'}=~ s/,([A-z])/, $1/g;
+     if ($Fields{'title'}=~ /^\s*$/ ) {
+         $Fields{'title'}='Untitled';
+     }
+     unless ($ENV{'user.adv'}) {
+         # What is this anyway?
+         $Fields{'keywords'} = '- not displayed -';
+         $Fields{'notes'}    = '- not displayed -';
+         $Fields{'abstract'} = '- not displayed -';
+         $Fields{'subject'}  = '- not displayed -';
+     }
+     if (length($Fields{'abstract'})>200) {
+         $Fields{'abstract'} =
+             substr($Fields{'abstract'},0,200).'...';
+     }
+     if (length($Fields{'keywords'})>200) {
+         $Fields{'keywords'} =
+             substr($Fields{'keywords'},0,200).'...';
+     }
+     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'
+ =item 'form.element'
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
+ sub search_results_header {
+     my ($mode,$pretty_query) = @_;
+     $mode = lc($mode);
+     my $title;
+     if ($mode eq 'advanced') {
+         $title = "Advanced Search Results";
+     } elsif ($mode eq 'basic') {
+         $title = "Basic Search Results";
+     }
+     my $result = '';
      # output beginning of search page
- 	$r->print(<<BEGINNING);
+     $result.=<<BEGINNING;
  <html>
  <head>
- <title>The LearningOnline Network with CAPA</title>
+ <title>$title</title>
  BEGINNING
      # 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);
- Line 800  SCRIPT
+ Line 2065  SCRIPT
          } elsif ($ENV{'form.mode'} eq 'edit') {
              my $form = $ENV{'form.form'};
              my $element = $ENV{'form.element'};
-             $r->print(<<SCRIPT)
+             $result.=<<SCRIPT;
  <script type="text/javascript">
  function select_data(title,url) {
      changeURL(url);
- Line 820  function changeURL(val) {
+ Line 2085  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) {
  //	alert('DEBUG: Should be storing '+title+' and '+url);
- Line 840  SCRIPT
+ Line 2105  SCRIPT
      }
  </script>
  SCRIPT
-     $r->print(<<SCRIPT);
+     $result.=<<SCRIPT;
  <script type="text/javascript">
      function displayinfo(val) {
  	popwin.document.forms.popremain.sdetails.value=val;
- Line 855  SCRIPT
+ Line 2120  SCRIPT
      }
  </script>
  SCRIPT
-     $r->rflush();
+     $result.=<<END;
-     # begin showing the cataloged results
-     $r->print(<<CATALOGBEGIN);
  </head>
  <body bgcolor="#ffffff">
  <img align=right src=/adm/lonIcons/lonlogos.gif>
- <h1>Search Catalog</h1>
+ <h1>$title</h1>
- CATALOGBEGIN
+ END
-         $r->print(<<CATALOGCONTROLS);
+     if ($pretty_query) {
- <form name='results' method="post" action="/adm/searchcat">
+         $result .= "<p>Search query: $pretty_query</p>";
- $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>');
+     return $result;
-     $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;
+ =pod
-     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) { $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') {
- 		   my $titleesc=$title;
- 		   $titleesc=~s/\'/\\'/; # '
-                    $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');
+ =item Metadata Viewing Functions
- <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
- onClick="javascript:select_data('$titleesc','$url')">
- </font>
- <br />
- END
-                 }
-                 if ($ENV{'form.catalogmode'} eq 'groupsearch') {
- 		    $fnum+=0;
- 		    $hash{"pre_${fnum}_link"}=$url;
- 		    $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;
+ Output is a HTML-ified string.
-         }
+ Input arguments are title, author, subject, url, keywords, version,
-         else {
+ notes, short abstract, mime, language, creation date,
- 	    $r->print('<html><head></head><body>Unable to tie hash to db '.
+ last revision date, owner, copyright, hostname, and
- 		  'file</body></html>');
+ extra custom metadata to show.
- 	}
- 	if ($compiledresult) {
- 	    $resultflag=1;
- 	}
- 	$r->print(<<RESULTS);
+ =over 4
- $compiledresult
- RESULTS
-         my $percent=sprintf('%3.0f',($servercount/$servernum*100));
-     }
-   }
-     unless ($resultflag) {
-         $r->print("\nThere were no results that matched your query\n");
-     }
- #    $r->print('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush();
-     $r->print(<<RESULTS);
- </body>
- </html>
- RESULTS
- }
- # ------------------------------------------------------ Detailed Citation View
+ =item &detailed_citation_view()
+ =cut
+ ######################################################################
+ ######################################################################
  sub detailed_citation_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my %values = @_;
- 	$notes,$shortabstract,$mime,$lang,
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
- 	$hostname,$httphost,$extrashow)=@_;
      my $result=<<END;
- <i>$owner</i>, last revised $lastrevisiondate
+ <h3><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></h3>
- <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{'cprtag'}<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>
  END
      return $result;
  }
- # ---------------------------------------------------------------- Summary View
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &summary_view()
+ =cut
+ ######################################################################
+ ######################################################################
  sub summary_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my %values = @_;
- 	$notes,$shortabstract,$mime,$lang,
- 	$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 />
+ <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>
  END
      return $result;
  }
- # -------------------------------------------------------------- Fielded Format
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &fielded_format_view()
+ =cut
+ ######################################################################
+ ######################################################################
  sub fielded_format_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my %values = @_;
- 	$notes,$shortabstract,$mime,$lang,
- 	$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>
+ <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>
  END
      return $result;
  }
- # -------------------------------------------------------------------- XML/SGML
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &xml_sgml_view()
+ =back
+ =cut
+ ######################################################################
+ ######################################################################
  sub xml_sgml_view {
-     my ($title,$author,$subject,$url,$keywords,$version,
+     my %values = @_;
- 	$notes,$shortabstract,$mime,$lang,
- 	$creationdate,$lastrevisiondate,$owner,$copyright,
- 	$hostname,$httphost,$extrashow)=@_;
-     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);
-     my $mimetag=&Apache::loncommon::filedescription($mime);
-     my $language=&Apache::loncommon::languagedescription($lang);
      my $result=<<END;
  <pre>
  &lt;LonCapaResource&gt;
- &lt;url&gt;$url&lt;/url&gt;
+ &lt;url&gt;$values{'url'}&lt;/url&gt;
- &lt;title&gt;$title&lt;/title&gt;
+ &lt;title&gt;$values{'title'}&lt;/title&gt;
- &lt;author&gt;$author&lt;/author&gt;
+ &lt;author&gt;$values{'author'}&lt;/author&gt;
- &lt;subject&gt;$subject&lt;/subject&gt;
+ &lt;subject&gt;$values{'subject'}&lt;/subject&gt;
- &lt;keywords&gt;$keywords&lt;/keywords&gt;
+ &lt;keywords&gt;$values{'keywords'}&lt;/keywords&gt;
- &lt;notes&gt;$notes&lt;/notes&gt;
+ &lt;notes&gt;$values{'notes'}&lt;/notes&gt;
  &lt;mimeInfo&gt;
- &lt;mime&gt;$mime&lt;/mime&gt;
+ &lt;mime&gt;$values{'mime'}&lt;/mime&gt;
- &lt;mimetag&gt;$mimetag&lt;/mimetag&gt;
+ &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;
  &lt;/mimeInfo&gt;
  &lt;languageInfo&gt;
- &lt;language&gt;$lang&lt;/language&gt;
+ &lt;language&gt;$values{'lang'}&lt;/language&gt;
- &lt;languagetag&gt;$language&lt;/languagetag&gt;
+ &lt;languagetag&gt;$values{'language'}&lt;/languagetag&gt;
  &lt;/languageInfo&gt;
- &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;
+ &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;
- &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;
+ &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;
- &lt;owner&gt;$owner&lt;/owner&gt;
+ &lt;owner&gt;$values{'owner'}&lt;/owner&gt;
  &lt;copyrightInfo&gt;
- &lt;copyright&gt;$copyright&lt;/copyright&gt;
+ &lt;copyright&gt;$values{'copyright'}&lt;/copyright&gt;
- &lt;copyrighttag&gt;$cprtag&lt;/copyrighttag&gt;
+ &lt;copyrighttag&gt;$values{'copyrighttag'}&lt;/copyrighttag&gt;
  &lt;/copyrightInfo&gt;
- &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;
+ &lt;repositoryLocation&gt;$values{'hostname'}&lt;/repositoryLocation&gt;
- &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;
+ &lt;shortabstract&gt;$values{'shortabstract'}&lt;/shortabstract&gt;
  &lt;/LonCapaResource&gt;
  </pre>
- $extrashow
+ $values{'extrashow'}
  END
      return $result;
  }
- # ---------------------------------------------------- see if a field is filled
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &filled() see if field is filled.
+ =cut
+ ######################################################################
+ ######################################################################
  sub filled {
      my ($field)=@_;
      if ($field=~/\S/ && $field ne 'any') {
- Line 1353  sub filled {
+ Line 2306  sub filled {
      }
  }
- # ---------------- Message to output when there are not enough fields filled in
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &output_blank_field_error()
+ =cut
+ ######################################################################
+ ######################################################################
  sub output_blank_field_error {
-     my ($r)=@_;
+     my ($r,$closebutton)=@_;
      # make query information persistent to allow for subsequent revision
-     my $persistent=&make_persistent();
      $r->print(<<BEGINNING);
  <html>
  <head>
- Line 1370  BEGINNING
+ Line 2331  BEGINNING
  <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
- Line 1387  processed.
+ Line 2348  processed.
  RESULTS
  }
- # ----------------------------------------------------------- Output date error
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &output_date_error()
+ 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)=@_;
      # make query information persistent to allow for subsequent revision
-     my $persistent=&make_persistent();
+     $r->print(<<RESULTS);
-     $r->print(<<BEGINNING);
  <html>
  <head>
  <title>The LearningOnline Network with CAPA</title>
- BEGINNING
-     $r->print(<<RESULTS);
  </head>
  <body bgcolor="#ffffff">
  <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
- Line 1418  $message
+ Line 2393  $message
  RESULTS
  }
- # --------- settings whenever the user causes the search window to be launched
+ ######################################################################
+ ######################################################################
+ =pod
+ =item &start_fresh_session()
+ Cleans the global %groupsearch_db by removing all fields which begin with
+ 'pre_' or 'store'.
+ =cut
+ ######################################################################
+ ######################################################################
  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{$_};
  	}
      }
  }
- # ----------------------------------------------- send javascript to popwin
- sub popwin_js {
-     # Print javascript out to popwin, but make sure we dont generate
-     # any javascript errors in doing so.
-     my ($r,$text) = @_;
-     $r->print(<<"END");
- <script type="text/javascript">
-     if (! popwin.closed) {
- 	$text
-     }
- </script>
- END
-     $r->rflush();
- }
- sub popwin_imgupdate {
-     my ($r,$imgnum,$icon) = @_;
-     &popwin_js($r,'popwin.document.img'.$imgnum.'.'.
- 	       'src="/adm/lonIcons/'.$icon.'";');
- }
 ;
  __END__
- =head1 NAME
+ =pod
- Apache::lonsearchcat - mod_perl module for handling a searchable catalog
- =head1 SYNOPSIS
- Invoked by /etc/httpd/conf/srm.conf:
-  <Location /adm/searchcat>
-  PerlAccessHandler       Apache::lonacc
-  SetHandler perl-script
-  PerlHandler Apache::lonsearchcat
-  ErrorDocument     403 /adm/login
-  ErrorDocument	  500 /adm/errorhandler
-  </Location>
- =head1 INTRODUCTION
- This module enables searching for a distributed browseable catalog.
- This is part of the LearningOnline Network with CAPA project
- described at http://www.lon-capa.org.
- =head1 BEGIN SUBROUTINE
- This routine is only run once after compilation.
- =over 4
- =item *
- Initializes %hostdomains and hostips hash table (for hosts.tab).
- =back
- =head1 HANDLER SUBROUTINE
+ =back
- 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) : outputs
- an error message specific to bad date format.
- =back
  =cut

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

Removed from v.1.120
changed lines
	Added in v.1.145