Diff for /loncom/interface/lonsearchcat.pm between versions 1.91 and 1.221

version 1.91, 2001/04/02 13:15:26 version 1.221, 2004/05/04 15:20:17
Line 1 Line 1
 # The LearningOnline Network  # The LearningOnline Network with CAPA
 # Search Catalog  # Search Catalog
 #  #
 # 03/08/2001 Scott Harrison  # $Id$
 # Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001  
 # Scott Harrison: 03/20/2001, 03/21/2001, 03/22/2001, 03/26/2001, 03/27/2001  
 # Scott Harrison: 04/02/2001  
 #  #
 # Functions  # Copyright Michigan State University Board of Trustees
 #  #
 # handler(server reference) : interacts with the Apache server layer  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #                             (for /adm/searchcat URLs)  #
 # simpletextfield(name,value) : returns HTML formatted string for simple text  # LON-CAPA is free software; you can redistribute it and/or modify
 #                               field  # it under the terms of the GNU General Public License as published by
 # simplecheckbox(name,value) : returns HTML formatted string for simple  # the Free Software Foundation; either version 2 of the License, or
 #                              checkbox  # (at your option) any later version.
 # searchphrasefield(title,name,value) : returns HTML formatted string for  #
 #                                       a search expression phrase field  # LON-CAPA is distributed in the hope that it will be useful,
 # dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML  # but WITHOUT ANY WARRANTY; without even the implied warranty of
 #                                                          formatted string  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 #                                                          for a calendar date  # GNU General Public License for more details.
 # selectbox(title,name,value,%HASH=options) : returns HTML formatted string for  #
 #                                             a selection box field  # You should have received a copy of the GNU General Public License
 # advancedsearch(server reference, environment reference) : perform a complex  # along with LON-CAPA; if not, write to the Free Software
 #                                  multi-field logical query  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 # filled(field) : determines whether a given field has been filled  #
 # basicsearch(server reference, environment reference) : perform a simple  # /home/httpd/html/adm/gpl.txt
 #                               single-field logical query  #
 # output_blank_field_error(server reference) : outputs a message saying that  # http://www.lon-capa.org/
 #                                              more fields need to be filled in  #
 # output_results(output mode,  ###############################################################################
 #                server reference,   ###############################################################################
 #                environment reference,  
 #                reply list reference) : outputs results from search  =pod 
 # build_SQL_query(field name, logic) : builds a SQL query string from a  
 #                                      logical expression with AND/OR keywords  =head1 NAME
 # recursive_SQL_query_build(field name, reverse notation expression) :   
 #                 builds a SQL query string from a reverse notation expression  lonsearchcat - LONCAPA Search Interface
 #                 logical expression with AND/OR keywords  
 # build_custommetadata_query(field_name, logic_statement) : builds a perl  =head1 SYNOPSIS
 #                regular expression from a logical expression with AND/OR  
 #                keywords  Search interface to LON-CAPAs digital library
 # detailed_citation_view, summary_view, fielded_format_view, xml_sgml_view:  
 #   four different ways to view metadata records.  Outputs a HTML-ified string.  =head1 DESCRIPTION
 #   Input arguments are title, author, subject, url, keywords, version, notes,  
 #   short abstract, mime, language, creation date, last revision date, owner,  This module enables searching for a distributed browseable catalog.
 #   copyright, hostname, httphost, and extra custom metadata to show.  
 # build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,  This is part of the LearningOnline Network with CAPA project
 #                    lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :  described at http://www.lon-capa.org.
 #         Builds a SQL logic query to check time/date entries.  
 # output_date_error(server reference, error message) : outputs  lonsearchcat presents the user with an interface to search the LON-CAPA
 #         an error message specific to bad date format.  digital library.  lonsearchcat also initiates the execution of a search
 # make_persistent() : makes a set of hidden HTML fields to make  by sending the search parameters to LON-CAPA servers.  The progress of 
 #                     SQL search interface information to be persistent  search (on a server basis) is displayed to the user in a separate window.
   
   =head1 Internals
   
   =over 4
   
   =cut
   
   ###############################################################################
   ###############################################################################
   
 package Apache::lonsearchcat;  package Apache::lonsearchcat;
   
 use strict;  use strict;
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common :http);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::File();  use Apache::File();
 use CGI qw(:standard);  use CGI qw(:standard);
 use Text::Query;  use Text::Query;
   use GDBM_File;
   use Apache::loncommon();
   use Apache::lonmysql();
   use Apache::lonmeta;
   use Apache::lonhtmlcommon;
   use Apache::lonlocal;
   use LONCAPA::lonmetadata();
   use HTML::Entities();
   
   ######################################################################
   ######################################################################
   ##
   ## Global variables
   ##
   ######################################################################
   ######################################################################
   my %groupsearch_db;  # Database hash used to save values for the 
                        # groupsearch RAT interface.
   my %persistent_db;   # gdbm hash which holds data which is supposed to
                        # persist across calls to lonsearchcat.pm
   
   # The different view modes and associated functions
   
   my %Views = ("detailed" => \&detailed_citation_view,
        "summary"  => \&summary_view,
        "fielded"  => \&fielded_format_view,
        "xml"      => \&xml_sgml_view,
        "compact"  => \&compact_view);
   
 # ---------------------------------------- variables used throughout the module  ######################################################################
 my %language;  ######################################################################
 my $scrout;  
 my %metadatafields;  
 my %cprtag;  
 my %mimetag;  
 my $closebutton;  
   
 # ------ form selection elements that allow for choosing different output views  
 # Detailed Citation View ---> sub detailed_citationview  
 # Summary View ---> sub summary_view  
 # Fielded Format ---> sub fielded_format_view  
 # XML/SGML ---> sub xml_sgml_view  
 my $basicviewselect=<<END;  
 <select name='basicviewselect'>  
 <option value='Detailed Citation View'>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'>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  
   
 # ----------------------------- Handling routine called via Apache and mod_perl  
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
   #    &set_defaults();
 # -------------------------------------- see if called from an interactive mode      #
     map {      # set form defaults
        my ($name, $value) = split(/=/,$_);      #
        $value =~ tr/+/ /;      my $hidden_fields;# Hold all the hidden fields used to keep track
        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;                        # of the search system state
        if ($name eq 'catalogmode') {      my $importbutton; # button to take the selected results and go to group 
    $ENV{'form.'.$name}=$value;                        # sorting
        }      my $diropendb;    # The full path to the (temporary) search database file.
     } (split(/&/,$ENV{'QUERY_STRING'}));                        # This is set and used in &handler() and is also used in 
                         # &output_results().
     $r->content_type('text/html');      my $bodytag;  # LON-CAPA standard body tag, gotten from 
                     # &Apache::lonnet::bodytag. 
                     # No title, no table, just a <body> tag.
   
       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
       #
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
       &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
       ##
     %metadatafields=();      ## Prevent caching of the search interface window.  Hopefully this means
       ## we will get the launch=1 passed in a little more.
     my $hidden='';      &Apache::loncommon::no_cache($r);
     if ($ENV{'form.catalogmode'} eq 'interactive') {      ## 
  $hidden=<<END;      ## Pick up form fields passed in the links.
 <input type='hidden' name='catalogmode' value='interactive'>      ##
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element','pause',
                 'phase','persistent_db_id','table','start','show',
                 'cleargroupsort','titleelement']);
       ##
       ## The following is a trick - we wait a few seconds if asked to so
       ##     the daemon running the search can get ahead of the daemon
       ##     printing the results.  We only need (theoretically) to do
       ##     this once, so the pause indicator is deleted
       ##
       if (exists($ENV{'form.pause'})) {
           sleep(1);
           delete($ENV{'form.pause'});
       }
       ##
       ## Initialize global variables
       ##
       my $domain  = $r->dir_config('lonDefDomain');
       $diropendb= "/home/httpd/perl/tmp/".
           "$ENV{'user.domain'}_$ENV{'user.name'}_searchcat.db";
       #
       # set the name of the persistent database
       #          $ENV{'form.persistent_db_id'} can only have digits in it.
       if (! exists($ENV{'form.persistent_db_id'}) ||
           ($ENV{'form.persistent_db_id'} =~ /\D/) ||
           ($ENV{'form.launch'} eq '1')) {
           $ENV{'form.persistent_db_id'} = time;
       }
       $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $persistent_db_file = "/home/httpd/perl/tmp/".
           &Apache::lonnet::escape($domain).
               '_'.&Apache::lonnet::escape($ENV{'user.name'}).
                   '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
       ##
       &Apache::lonhtmlcommon::clear_breadcrumbs();
       if (exists($ENV{'request.course.id'}) && $ENV{'request.course.id'} ne '') {
           &Apache::lonhtmlcommon::add_breadcrumb
                ({href=>'/adm/searchcat?'.
                      'catalogmode='.$ENV{'form.catalogmode'}.
                      '&launch='.$ENV{'form.launch'}.
                      '&mode='.$ENV{'form.mode'},
                 text=>"Course and Catalog Search",
                 bug=>'Searching',});
       } else {
           &Apache::lonhtmlcommon::add_breadcrumb
                ({href=>'/adm/searchcat?'.
                      'catalogmode='.$ENV{'form.catalogmode'}.
                      '&launch='.$ENV{'form.launch'}.
                      '&mode='.$ENV{'form.mode'},
                 text=>"Catalog Search",
                 bug=>'Searching',});
       }
       #
       if ($ENV{'form.phase'} !~ m/(basic|adv|course)_search/) {
           if (! &get_persistent_form_data($persistent_db_file)) {
               if ($ENV{'form.phase'} =~ /(run_search|results)/) {
                   &Apache::lonnet::logthis('lonsearchcat:'.
                                            'Unable to recover data from '.
                                            $persistent_db_file);
                   $r->print(<<END);
   <html>
   <head><title>LON-CAPA Search Error</title></head>
   $bodytag
   We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
 END  END
         $closebutton=<<END;                  return OK;
 <input type="button" name="close" value='CLOSE' onClick="self.close()">              }
           }
       } else {
           &clean_up_environment();
       }
       ##
       ## Clear out old values from groupsearch database
       ##
       untie %groupsearch_db if (tied(%groupsearch_db));
       if (($ENV{'form.cleargroupsort'} eq '1') || 
           (($ENV{'form.launch'} eq '1') && 
            ($ENV{'form.catalogmode'} eq 'groupsearch'))) {
    if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
       &start_fresh_session();
       untie %groupsearch_db;
               delete($ENV{'form.cleargroupsort'});
    } else {
               # This is a stupid error to give to the user.  
               # It really tells them nothing.
       $r->print('<html><head></head>'.$bodytag.
                         'Unable to tie hash to db file</body></html>');
       return OK;
    }
       }
       ##
       ## Configure hidden fields
       ##
       $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
           $ENV{'form.persistent_db_id'}.'" />'."\n";
       if (exists($ENV{'form.catalogmode'})) {
           $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
                   $ENV{'form.catalogmode'}.'" />'."\n";
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= '<input type="hidden" name="form" value="'.
                   $ENV{'form.form'}.'" />'."\n";
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= '<input type="hidden" name="element" value="'.
                   $ENV{'form.element'}.'" />'."\n";
       }
       if (exists($ENV{'form.titleelement'})) {
           $hidden_fields .= '<input type="hidden" name="titleelement" value="'.
                   $ENV{'form.titleelement'}.'" />'."\n";
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= '<input type="hidden" name="mode" value="'.
                   $ENV{'form.mode'}.'" />'."\n";
       }
       ##
       ## Configure dynamic components of interface
       ##
       if ($ENV{'form.catalogmode'} eq 'interactive') {
           $closebutton="<input type='button' name='close' value='CLOSE' ";
           if ($ENV{'form.phase'} =~ /(results|run_search)/) {
       $closebutton .="onClick='parent.close()'";
           } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .=">\n";
       } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
           $closebutton="<input type='button' name='close' value='CLOSE' ";
           if ($ENV{'form.phase'} =~ /(results|run_search)/) {
       $closebutton .="onClick='parent.close()'";
           } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .= ">";
           $importbutton=<<END;
   <input type='button' name='import' value='IMPORT'
   onClick='javascript:select_group()'>
 END  END
       } else {
           $closebutton = '';
           $importbutton = '';
       }
       ##
       ## Sanity checks on form elements
       ##
       if (!defined($ENV{'form.viewselect'})) {
           if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
               ($ENV{'form.catalogmode'} eq 'interactive')) {
               $ENV{'form.viewselect'} ="Compact View";
           } else {
               $ENV{'form.viewselect'} ="Detailed Citation View";
           }
     }      }
       $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
 # ------------------------------------------------ First, check out environment      $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
     $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};      #
       $ENV{'form.searchmode'} = 'basic' if (! exists($ENV{'form.searchmode'}));
 # --------------------------------- Compute various listings of metadata values      if ($ENV{'form.phase'} eq 'adv_search' ||
               $ENV{'form.phase'} eq 'disp_adv') {
     %language=();          $ENV{'form.searchmode'} = 'advanced';
     $language{'any'}='Any language';      } elsif ($ENV{'form.phase'} eq 'course_search') {
     {          $ENV{'form.searchmode'} = 'course_search';
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');      }
  map {      #
     $_=~/(\w+)\s+([\w\s\-]+)/; chomp;      if ($ENV{'form.searchmode'} eq 'advanced') {
     $language{$1}=$2;          &Apache::lonhtmlcommon::add_breadcrumb
  } <$fh>;              ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Advanced Search",
                     bug=>'Searching',});
       } elsif ($ENV{'form.searchmode'} eq 'course search') {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Course Search",
                     bug=>'Searching',});
       }
       ##
       ## Switch on the phase
       ##
       if ($ENV{'form.phase'} eq 'disp_basic') {
           &print_basic_search_form($r,$closebutton,$hidden_fields);
       } elsif ($ENV{'form.phase'} eq 'disp_adv') {
           &print_advanced_search_form($r,$closebutton,$hidden_fields);
       } elsif ($ENV{'form.phase'} eq 'results') {
           &display_results($r,$importbutton,$closebutton,$diropendb);
       } elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) {
           my ($query,$customquery,$customshow,$libraries,$pretty_string) =
               &get_persistent_data($persistent_db_file,
                    ['query','customquery','customshow',
                     'libraries','pretty_string']);
           if ($ENV{'form.phase'} eq 'sort') {
               &print_sort_form($r,$pretty_string);
           } elsif ($ENV{'form.phase'} eq 'run_search') {
               &run_search($r,$query,$customquery,$customshow,
                           $libraries,$pretty_string);
           }
       } elsif ($ENV{'form.phase'} eq 'course_search') {
           &course_search($r);
       } elsif(($ENV{'form.phase'} eq 'basic_search') ||
               ($ENV{'form.phase'} eq 'adv_search')) {
           # Set up table
           if (! defined(&create_results_table())) {
       my $errorstring=&Apache::lonmysql::get_error();
               &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
                                        'needed table.  lonmysql error:'.
                                        $errorstring);
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to create table in which to store search results.  
   The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           #
           # We are running a search
           my ($query,$customquery,$customshow,$libraries) = 
               (undef,undef,undef,undef);
           my $pretty_string;
           if ($ENV{'form.phase'} eq 'basic_search') {
               ($query,$pretty_string,$libraries) = 
                   &parse_basic_search($r,$closebutton,$hidden_fields);
           } else {                      # Advanced search
               ($query,$customquery,$customshow,$libraries,$pretty_string) 
                   = &parse_advanced_search($r,$closebutton,$hidden_fields);
               return OK if (! defined($query));
           }
           &make_persistent({ query => $query,
                              customquery => $customquery,
                              customshow => $customshow,
                              libraries => $libraries,
                              pretty_string => $pretty_string },
                            $persistent_db_file);
           ##
           ## Print out the frames interface
           ##
           &print_frames_interface($r);
     }      }
       return OK;
   } 
   
     %cprtag=();  #
     $cprtag{'any'}='Any copyright/distribution';  # The mechanism used to store values away and retrieve them does not
     {  # handle the case of missing environment variables being significant.
  my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');  #
  map {  # This routine sets non existant checkbox form elements to ''.
     $_=~/(\w+)\s+([\w\s\-]+)/; chomp;  #
     $cprtag{$1}=$2;  sub clean_up_environment {
  } <$fh>;      if ($ENV{'form.phase'} eq 'basic_search') {
           if (! exists($ENV{'form.related'})) {
               $ENV{'form.related'} = '';
           }
           if (! exists($ENV{'form.domains'})) {
               $ENV{'form.domains'} = '';
           }
       } elsif ($ENV{'form.phase'} eq 'adv_search') {
           foreach my $field ('title','keywords','notes',
                              'abstract','standards','mime') {
               if (! exists($ENV{'form.'.$field.'_related'})) {
                   $ENV{'form.'.$field.'_related'} = '';
               }
           }
       } elsif ($ENV{'form.phase'} eq 'course_search') {
           if (! exists($ENV{'form.crsrelated'})) {
               $ENV{'form.crsrelated'} = '';
           }
     }      }
   }
   
     %mimetag=();  ######################################################################
     $mimetag{'any'}='Any type';  ######################################################################
     {  ##
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');  ##   Course Search
  map {  ##
     $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;  ######################################################################
     $mimetag{$1}=".$1 $3";  ######################################################################
  } <$fh>;  {   # Scope the course search to avoid global variables
   #
   # Variables For course search
   my %alreadyseen;
   my %hash;
   my $totalfound;
   
   sub course_search {
       my $r=shift;
       my $bodytag=&Apache::loncommon::bodytag('Course Search');
       my $pretty_search_string = '<b>'.$ENV{'form.courseexp'}.'</b>';
       my $search_string = $ENV{'form.courseexp'};
       my @New_Words;
       if ($ENV{'form.crsrelated'}) {
           ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
           if (@New_Words) {
               $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= ' '.&mt('with no related words').".";
           }
     }      }
       my $fulltext=$ENV{'form.crsfulltext'};
 # ----------------------------------- See if a search invocation should be done      my @allwords=($search_string,@New_Words);
     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {      $totalfound=0;
  return &basicsearch($r,\%ENV);      $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
         $bodytag.'<hr /><center><font size="+2" face="arial">'.$pretty_search_string.'</font></center><hr />');
       $r->rflush();
   # ======================================================= Go through the course
       undef %alreadyseen;
       %alreadyseen=();
       my $c=$r->connection;
       if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
           foreach (keys %hash) {
               if ($c->aborted()) { last; }
               if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
                   &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
                                @allwords);
               }
           }
           untie(%hash);
     }      }
     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {      unless ($totalfound) {
  return &advancedsearch($r,\%ENV);   $r->print('<p>'.&mt('No resources found').'.</p>');
     }      }
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
 # ----------------------------- Else, begin building search interface to output  # =============================== This pulls up a resource and its dependencies
     $scrout=''; # building a part of screen output  
     $scrout.=&searchphrasefield('Limit by title','title',  
  $ENV{'form.title'});  
   
     $scrout.=&searchphrasefield('Limit by author','author',  
  $ENV{'form.author'});  
   
     $scrout.=&searchphrasefield('Limit by subject','subject',  sub checkonthis {
  $ENV{'form.subject'});      my ($r,$url,$level,$title,$fulltext,@allwords)=@_;
       $alreadyseen{$url}=1;
       $r->rflush();
       my $result=&Apache::lonnet::metadata($url,'title').' '.
                  &Apache::lonnet::metadata($url,'subject').' '.
                  &Apache::lonnet::metadata($url,'abstract').' '.
                  &Apache::lonnet::metadata($url,'keywords');
       if (($url) && ($fulltext)) {
    $result.=&Apache::lonnet::ssi_body($url);
       }
       $result=~s/\s+/ /gs;
       my $applies=0;
       foreach (@allwords) {
           if ($_=~/\w/) {
      if ($result=~/$_/si) {
         $applies++;
              }
          }
       }
   # Does this resource apply?
       if ($applies) {
          $r->print('<br />');
          for (my $i=0;$i<=$level*5;$i++) {
              $r->print('&nbsp;');
          }
          $r->print('<a href="'.$url.'" target="cat">'.
    ($title?$title:$url).'</a><br />');
          $totalfound++;
       } elsif ($fulltext) {
          $r->print(' .');
       }
       $r->rflush();
   # Check also the dependencies of this one
       my $dependencies=
                   &Apache::lonnet::metadata($url,'dependencies');
       foreach (split(/\,/,$dependencies)) {
          if (($_=~/^\/res\//) && (!$alreadyseen{$_})) {
             &checkonthis($r,$_,$level+1,'',$fulltext,@allwords);
          }
       }
   }
   
     $scrout.=&searchphrasefield('Limit by keywords','keywords',  sub untiehash {
  $ENV{'form.keywords'});      if (tied(%hash)) {
           untie(%hash);
       }
   }
   
     $scrout.=&searchphrasefield('Limit by URL','url',  } # End of course search scoping
  $ENV{'form.url'});  
   
     $scrout.=&searchphrasefield('Limit by version','version',  sub search_html_header {
  $ENV{'form.version'});      my $Str = <<ENDHEADER;
   <html>
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   ENDHEADER
       return $Str;
   }
   
     $scrout.=&searchphrasefield('Limit by notes','notes',  ######################################################################
  $ENV{'form.notes'});  ######################################################################
   
     $scrout.=&searchphrasefield('Limit by abstract','abstract',  =pod 
  $ENV{'form.abstract'});  
   
     $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});  =item &print_basic_search_form() 
     $scrout.=&selectbox('Limit by MIME type','mime',  
  $ENV{'form.mime'},%mimetag);  
   
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});  Prints the form for the basic search.  Sorry the name is so cryptic.
   
     $scrout.=&selectbox('Limit by language','language',  =cut
  $ENV{'form.language'},%language);  
       ######################################################################
   ######################################################################
 # ------------------------------------------------ Compute date selection boxes  sub print_basic_search_form {
     $scrout.=<<CREATIONDATESTART;      my ($r,$closebutton,$hidden_fields) = @_;
       my $bodytag=&Apache::loncommon::bodytag('Search').
           &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Searching',
                                               undef,undef,! $ENV{'form.launch'});
       my $scrout = &search_html_header().$bodytag;
       if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
           # Define interface components
           my $userelatedwords=
               &mt('[_1] use related words',
                   &Apache::lonhtmlcommon::checkbox
                   ('related',$ENV{'form.related'},'related'));
           my $onlysearchdomain=
               &mt('[_1] only search domain [_2]',
                   &Apache::lonhtmlcommon::checkbox('domains',
                                                    $ENV{'form.domains'},
                                                    $r->dir_config('lonDefDomain')
                                                    ),
                   $r->dir_config('lonDefDomain')
                   );
           my $adv_search_link = 
               '<a href="/adm/searchcat?'.
               'phase=disp_adv&'.
               'catalogmode='.$ENV{'form.catalogmode'}.
               '&launch='.$ENV{'form.launch'}.
               '&mode='.$ENV{'form.mode'}.
               '">'.&mt('Advanced Search').'</a>';
           #
           $scrout.='<form name="loncapa_search" method="post" '.
               'action="/adm/searchcat">'.
               '<input type="hidden" name="phase" value="basic_search" />'.
               $hidden_fields;
           #
           $scrout .= '<center>'.$/;
           if ($ENV{'request.course.id'}) {
               $scrout .= '<h1>'.&mt('LON-CAPA Catalog Search').'</h1>';
           } else {
               # No need to tell them they are searching
               $scrout.= ('<br />'x2);
           }
           $scrout.='<table>'.
               '<tr><td align="center" valign="top">'.
               &Apache::lonhtmlcommon::textbox('basicexp',
                                               $ENV{'form.basicexp'},50).'<br />'.
               '<font size="-1">'.&searchhelp().'</font>'.'</td>'.
               '<td><font size="-1">'.
               '<nobr>'.('&nbsp;'x3).$adv_search_link.'</nobr>'.'<br />'.
               '<nobr>'.('&nbsp;'x1).$userelatedwords.'</nobr>'.'<br />'.
               '<nobr>'.('&nbsp;'x1).$onlysearchdomain.'</nobr>'.'<br />'.
               '</font></td>'.
               '</tr>'.$/;
           #
   #        $scrout .= '<tr><td align="center">'.
   #            '<font size="-1">'.
   #            $userelatedwords.('&nbsp;'x3).
   #            $onlysearchdomain.('&nbsp;'x2).$adv_search_link.
   #            '</font>'.
   #            '</td></tr>'.$/;
           $scrout .= '<tr><td align="center" colspan="2">'.
               '<font size="-1">'.
               '<input type="submit" name="basicsubmit" '.
               'value="'.&mt('Search').'" />'.
               ('&nbsp;'x2).$closebutton.('&nbsp;'x2).&viewoptions().
               '</font>'.
               '</td></tr>'.$/;
           $scrout .= '</table>'.$/.'</center>'.'</form>';
       }
       if ($ENV{'request.course.id'}) {
    my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
                                              'header' => 'Course Search',
    'note' => 'Enter terms or phrases, then press "Search" below',
    'use' => 'use related words',
    'full' =>'fulltext search (time consuming)'
      );
           $scrout.=(<<ENDCOURSESEARCH);
   <form name="loncapa_search" method="post" action="/adm/searchcat">
   <center>
   <hr />
   <h1>$lt{'header'}</h1>    
   <input type="hidden" name="phase" value="course_search" />
   $hidden_fields
 <p>  <p>
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>  $lt{'note'}.
 </font>  </p>
 <br>  
 between:  
 CREATIONDATESTART  
     $scrout.=&dateboxes('creationdatestart',1,1,1976,  
  $ENV{'form.creationdatestart_month'},  
  $ENV{'form.creationdatestart_day'},  
  $ENV{'form.creationdatestart_year'},  
  );  
     $scrout.=<<CREATIONDATEEND;  
 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>  <p>
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:  <table>
 </b></font>  <tr><td>
 <br>between:  ENDCOURSESEARCH
 LASTREVISIONDATESTART          $scrout.='&nbsp;'.
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,              &Apache::lonhtmlcommon::textbox('courseexp',
  $ENV{'form.lastrevisiondatestart_month'},                                    $ENV{'form.courseexp'},40);
  $ENV{'form.lastrevisiondatestart_day'},          my $crscheckbox = 
  $ENV{'form.lastrevisiondatestart_year'},              &Apache::lonhtmlcommon::checkbox('crsfulltext',
  );                                     $ENV{'form.crsfulltext'});
     $scrout.=<<LASTREVISIONDATEEND;          my $relcheckbox = 
 and:              &Apache::lonhtmlcommon::checkbox('crsrelated',
 LASTREVISIONDATEEND     $ENV{'form.crsrelated'});
     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,          $scrout.=(<<ENDENDCOURSE);
  $ENV{'form.lastrevisiondateend_month'},  </td></tr>
  $ENV{'form.lastrevisiondateend_day'},  <tr><td>$relcheckbox $lt{'use'}</td><td></td></tr>
  $ENV{'form.lastrevisiondateend_year'},  <tr><td>$crscheckbox $lt{'full'}</td><td></td></tr>
  );  </table><p>
     $scrout.='</p>';  &nbsp;<input type="submit" name="coursesubmit" value='$lt{'srch'}' />
   </p>
     $scrout.=&searchphrasefield('Limit by publisher/owner','owner',  </center>
  $ENV{'form.owner'});  </form>
 # $metadatafields{'owner'});  ENDENDCOURSE
       }
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});      $scrout.=(<<ENDDOCUMENT);
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',  </body>
  $ENV{'form.copyright'},%cprtag);  </html>
   ENDDOCUMENT
       $r->print($scrout);
       return;
   }
   ######################################################################
   ######################################################################
   
 # ------------------------------------------- Compute customized metadata field  =pod 
     $scrout.=<<CUSTOMMETADATA;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>  
 </font>  
 For resource-specific metadata, enter in an expression in the form of   
 <i>key</i>=<i>value</i> separated by operators such as AND or OR.<br>  
 <b>Example:</b> grandmother=75 OR grandfather=85  
 <br>  
 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;  =item &advanced_search_form() 
 <p>  
 <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>  
 </font>  
 Enter in a space-separated list of special metadata fields to show  
 in a fielded listing for each record result.  
 <br>  
 CUSTOMSHOW  
 $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});  
 $scrout.=' <i>initial users of this system do not need to worry about this option</i>';  
   
 # ---------------------------------------------------------------- Print screen  Prints the advanced search form.
     $r->print(<<ENDDOCUMENT);  
 <html>  =cut
 <head>  
 <title>The LearningOnline Network with CAPA</title>  ######################################################################
 </head>  ######################################################################
 <body bgcolor="#FFFFFF">  sub print_advanced_search_form{
 <img align=right src=/adm/lonIcons/lonlogos.gif>      my ($r,$closebutton,$hidden_fields) = @_;
 <h1>Search Catalog</h1>      my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search').
 <form method="post" action="/adm/searchcat">          &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching',
 $hidden                                              'Searching',
 <hr>                                              undef,undef,
 <h3>Basic Search</h3>                                              ! $ENV{'form.launch'});
 <p>  
 Enter terms or phrases separated by search operators      my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
 such as AND or OR then press SEARCH below.  Terms should be specific         'reset' => 'Reset',
 to the title, author, subject, notes, or abstract information associated         'help' => 'Help');
 with a resource.      my $advanced_buttons=<<"END";
 <br>  <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
 ENDDOCUMENT  <input type="reset" name="reset" value='$lt{"reset"}' />
     $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'}));  
     $r->print(<<ENDDOCUMENT);  
 <font color="#800000">Search historic archives</font>  
 <br>  
 <input type="submit" name="basicsubmit" value='SEARCH' />  
 <input type="reset" name="reset" value='RESET' />  
 $closebutton  $closebutton
 $basicviewselect  END
 </p>      my $scrout=&search_html_header();
 <hr>      $scrout .= <<"ENDHEADER";
 <h3>Advanced Search</h3>  $bodytag
 $scrout  <form method="post" action="/adm/searchcat" name="advsearch">
 <p>  <p>
 <input type="submit" name="advancedsubmit" value='SEARCH' />  $advanced_buttons
 <input type="reset" name="reset" value='RESET' />  ENDHEADER
 $closebutton      $scrout.=('&nbsp;'x2).&viewoptions().'</p>'.$hidden_fields. 
 $advancedviewselect          '<input type="hidden" name="phase" value="adv_search" />';
 </p>      my %fields=&Apache::lonmeta::fieldnames();
       #
       $scrout .= '<h3>'.&mt('Standard Metadata').'</h3>';
       $scrout .= "<table>\n";
       $scrout .= '<tr><td>&nbsp;</td><td colspan="2"><font size="-1">'.
           ('&nbsp;'x2).&searchhelp()."</font></td></tr>\n";
       my %related_word_search = 
           ('title'    => 1,
            'author'   => 0,
            'owner'    => 0,
            'authorspace'  => 0,
            'modifyinguser'=> 0,
            'keywords' => 1,
            'notes'    => 1,
            'abstract' => 1,
            'standards'=> 1,
            'mime'     => 1,
            );
       #
       foreach my $field ('title','author','owner','authorspace','modifyinguser',
        'keywords','notes','abstract','standards','mime') {
    $scrout.='<tr><td align="right">'.&titlefield($fields{$field}).'</td><td>'.
       &Apache::lonmeta::prettyinput($field,
                                             $ENV{'form.'.$field},
                                             $field,
                                             'advsearch',
     $related_word_search{$field},
                                             '</td><td align="left">',
                                             $ENV{'form.'.$field.'_related'},
                                             50);
           if ($related_word_search{$field}) {
               $scrout .= 'related words';
           } else {
               $scrout .= '</td><td>&nbsp;';
           }
           $scrout .= '</td></tr>'.$/;
       }
       foreach my $field ('lowestgradelevel','highestgradelevel') {
    $scrout.='<tr>'.
               '<td align="right">'.&titlefield($fields{$field}).'</td>'.
               '<td colspan="2">'.
       &Apache::lonmeta::prettyinput($field,
                                             $ENV{'form.'.$field},
                                             $field,
                                             'advsearch',
     0).
                                             '</td></tr>'.$/;
       }
       $scrout.='<tr><td align="right">'.
    &titlefield(&mt('MIME Type Category')).'</td><td colspan="2">'. 
       &Apache::loncommon::filecategoryselect('category',
      $ENV{'form.category'}).
       '</td></tr>'.$/;
       $scrout.='<tr><td align="right" valign="top">'.
    &titlefield(&mt('Domains')).'</td><td colspan="2">'. 
       &Apache::loncommon::domain_select('domains',
      $ENV{'form.domains'},1).
       '</td></tr>'.$/;
       #
       # Misc metadata
       $scrout.='<tr><td align="right" valign="top">'.
    &titlefield(&mt('Copyright/Distribution')).'</td><td colspan="2">'.
           &Apache::lonmeta::selectbox('copyright',
                                       '',,
                                       \&Apache::loncommon::copyrightdescription,
                                       ( undef,
                                         &Apache::loncommon::copyrightids)
                                       ).'</td></tr>'.$/;
       $scrout.='<tr><td align="right" valign="top">'.
    &titlefield(&mt('Language')).'</td><td colspan="2">'.
           &Apache::lonmeta::selectbox('language',
                                       'notset',,
                                       \&Apache::loncommon::languagedescription,
                                       ('any',&Apache::loncommon::languageids)
                                       ).'</td></tr>';
       $scrout .= "</table>\n";    
       #
       # Dynamic metadata
       $scrout .= '<h3>'.&mt('Problem Statistics').'</h3>';
       $scrout .= "<table>\n";
       $scrout .= '<tr><td>&nbsp;</td><td align="center">'.&mt('Minimum').'</td>'.
           '<td align="center">'.&mt('Maximum').'</td></tr>'."\n";
       foreach my $statistic 
           ({ name=>'stdno',
              description=>'Number of Students',},
            { name => 'avetries',
              description=>'Average tries to answer correctly',},
            { name => 'difficulty',
              description=>'Degree of difficulty',},
            { name => 'disc',
              description=>'Degree of discrimination'}) {
           $scrout .= '<tr><td align="right">'.
               &titlefield(&mt($statistic->{'description'})).
               '</td><td align="center">'.
               '<input type="text" name="'.$statistic->{'name'}.'_min" '.
               'value="" size="6" />'.
               '</td><td align="center">'.
               '<input type="text" name="'.$statistic->{'name'}.'_max" '.
               'value="" size="6" />'.
               '</td></tr>'.$/;
       }
       $scrout .= "</table>\n";
       $scrout .= '<h3>'.&mt('Evaluation Data').'</h3>';
       $scrout .= "<table>\n";
       $scrout .= '<tr><td>&nbsp;</td><td align="center">'.&mt('Minimum').'</td>'.
           '<td align="center">'.&mt('Maximum').'</td></tr>'."\n";
       foreach my $evaluation
           ( { name => 'clear',
               description => 'Material presented in clear way'},
             { name =>'depth',
               description => 'Material covered with sufficient depth'},
             { name => 'helpful',
               description => 'Material is helpful'},
             { name => 'correct',
               description => 'Material appears to be correct'},
             { name => 'technical',
               description => 'Resource is technically correct'}){
           $scrout .= '<tr><td align="right">'.
               &titlefield(&mt($evaluation->{'description'})).
               '</td><td align="center">'.
               '<input type="text" name="'.$evaluation->{'name'}.'_min" '.
               'value="" size="6" />'.
               '</td><td align="center">'.
               '<input type="text" name="'.$evaluation->{'name'}.'_max" '.
               'value="" size="6" />'.
               '</td></tr>'.$/;
       }
       $scrout .= "</table>\n";
       #
       # Creation/Modification date limits
       $scrout .= '<h3>'.&mt('Creation and Modification dates').'</h3>';
       $scrout .= "\n<table>\n";
       my $cafter = 
           &Apache::lonhtmlcommon::date_setter('advsearch',         # formname
                                               'creationdate1', # fieldname
                                               0,           # current value
                                               '',          # special 
                                               1,           # includeempty
                                               '',          # state
                                               1,           # no_hh_mm_ss
                                               );
       my $cbefore = 
           &Apache::lonhtmlcommon::date_setter('advsearch',         # formname
                                               'creationdate2', # fieldname
                                               0,           # current value
                                               '',          # special 
                                               1,           # includeempty
                                               '',          # state
                                               1,           # no_hh_mm_ss
                                               );
       $scrout .= &mt('<tr><td align="right">Created between</td>'.
                      '<td>[_1]</td></tr>'.
                      '<tr><td align="right">and </td>'.
                      '<td>[_2]</td></tr>',$cafter,$cbefore);
       my $lafter = 
           &Apache::lonhtmlcommon::date_setter('advsearch',
                                               'revisiondate1', 
                                               0,           # current value
                                               '',          # special 
                                               1,           # includeempty
                                               '',          # state
                                               1,           # no_hh_mm_ss
                                               );
       my $lbefore = 
           &Apache::lonhtmlcommon::date_setter('advsearch',
                                               'revisiondate2',
                                               0,           # current value
                                               '',          # special 
                                               1,           # includeempty
                                               '',          # state
                                               1,           # no_hh_mm_ss
                                               );
       $scrout .= &mt('<tr><td align="right">Last modified between </td>'.
                      '<td>[_1]</td></tr>'.
                      '<tr><td align="right">and</td>'.
                      '<td>[_2]</td></tr>',$lafter,$lbefore);
       $scrout.="</table>\n";
       $scrout.=<<ENDDOCUMENT;
   $advanced_buttons
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return OK;      $r->print($scrout);
 }       return;
   }
   
 # --------------------------------------------------------- Various form fields  ######################################################################
   ######################################################################
   
 sub simpletextfield {  =pod 
     my ($name,$value)=@_;  
     return '<input type=text name=\''.$name.  =item &titlefield()
    '\' size=20 value=\''.$value.'\' />';  
 }  Inputs: title text
   
 sub simplecheckbox {  Outputs: titletext with font wrapper
     my ($name,$value)=@_;  
     my $checked='';  =cut
     $checked="CHECKED" if $value eq 'on';  
     return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';  ######################################################################
 }  ######################################################################
   sub titlefield {
 sub searchphrasefield {      my $title=shift;
     my ($title,$name,$value)=@_;      return $title;
     my $instruction=<<END;  }
 Enter terms or phrases separated by search operators such  
 as AND or OR.  ######################################################################
 END  ######################################################################
     my $uctitle=uc($title);  
     return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".  =pod 
    "</FONT> $instruction<br>".  
            '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';  =item viewoptiontext()
 }  
   Inputs: codename for view option
 sub dateboxes {  
     my ($name,$defaultmonth,$defaultday,$defaultyear,  Outputs: displayed text
  $currentmonth,$currentday,$currentyear)=@_;  
     ($defaultmonth,$defaultday,$defaultyear)=('','','');  =cut
     my $month=<<END;  
 <select name="${name}_month">  ######################################################################
 <option value='$defaultmonth'> </option>  ######################################################################
 <option value="1">January</option>  sub viewoptiontext {
 <option value="2">February</option>      my $code=shift;
 <option value="3">March</option>      my %desc=&Apache::lonlocal::texthash
 <option value="4">April</option>          ('detailed' => "Detailed Citation View",
 <option value="5">May</option>           'xml' => 'XML/SGML',
 <option value="6">June</option>           'compact' => 'Compact View',
 <option value="7">July</option>           'fielded' => 'Fielded Format',
 <option value="8">August</option>           'summary' => 'Summary View');
 <option value="9">September</option>      return $desc{$code};
 <option value="10">October</option>  }
 <option value="11">November</option>  
 <option value="12">December</option>  ######################################################################
 </select>  ######################################################################
 END  
     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);  =pod 
     my $day=<<END;  
 <select name="${name}_day">  =item viewoptions()
 <option value='$defaultday'> </option>  
 <option value="1">1</option>  Inputs: none
 <option value="2">2</option>  
 <option value="3">3</option>  Outputs: text for box with view options
 <option value="4">4</option>  
 <option value="5">5</option>  =cut
 <option value="6">6</option>  
 <option value="7">7</option>  ######################################################################
 <option value="8">8</option>  ######################################################################
 <option value="9">9</option>  sub viewoptions {
 <option value="10">10</option>      my $scrout="\n".'<nobr>';
 <option value="11">11</option>      if (! defined($ENV{'form.viewselect'})) { 
 <option value="12">12</option>          $ENV{'form.viewselect'}='detailed'; 
 <option value="13">13</option>      }
 <option value="14">14</option>      $scrout.=&Apache::lonmeta::selectbox('viewselect',
 <option value="15">15</option>   $ENV{'form.viewselect'},
 <option value="16">16</option>   \&viewoptiontext,
 <option value="17">17</option>   sort(keys(%Views)));
 <option value="18">18</option>      $scrout.= '&nbsp;&nbsp;';
 <option value="19">19</option>      my $countselect = &Apache::lonmeta::selectbox('show',
 <option value="20">20</option>                                                    $ENV{'form.show'},
 <option value="21">21</option>                                                    undef,
 <option value="22">22</option>                                                    (10,20,50,100,1000,10000));
 <option value="23">23</option>      $scrout .= ('&nbsp;'x2).&mt('[_1] Records per Page',$countselect).
 <option value="24">24</option>          '</nobr>'.$/;
 <option value="25">25</option>      return $scrout;
 <option value="26">26</option>  }
 <option value="27">27</option>  
 <option value="28">28</option>  ######################################################################
 <option value="29">29</option>  ######################################################################
 <option value="30">30</option>  
 <option value="31">31</option>  =pod 
 </select>  
 END  =item searchhelp()
     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);  
     my $year=<<END;  Inputs: none
 <select name="${name}_year">  
 <option value='$defaultyear'> </option>  Outputs: return little blurb on how to enter searches
 <option value="1976">1976</option>  
 <option value="1977">1977</option>  =cut
 <option value="1978">1978</option>  
 <option value="1979">1979</option>  ######################################################################
 <option value="1980">1980</option>  ######################################################################
 <option value="1981">1981</option>  sub searchhelp {
 <option value="1982">1982</option>      return &mt('Enter terms or phrases separated by AND, OR, or NOT');
 <option value="1983">1983</option>  }
 <option value="1984">1984</option>  
 <option value="1985">1985</option>  ######################################################################
 <option value="1986">1986</option>  ######################################################################
 <option value="1987">1987</option>  
 <option value="1988">1988</option>  =pod 
 <option value="1989">1989</option>  
 <option value="1990">1990</option>  =item &get_persistent_form_data()
 <option value="1991">1991</option>  
 <option value="1992">1992</option>  Inputs: filename of database
 <option value="1993">1993</option>  
 <option value="1994">1994</option>  Outputs: returns undef on database errors.
 <option value="1995">1995</option>  
 <option value="1996">1996</option>  This function is the reverse of &make_persistent() for form data.
 <option value="1997">1997</option>  Retrieve persistent data from %persistent_db.  Retrieved items will have their
 <option value="1998">1998</option>  values unescaped.  If a form value already exists in $ENV, it will not be
 <option value="1999">1999</option>  overwritten.  Form values that are array references may have values appended
 <option value="2000">2000</option>  to them.
 <option value="2001">2001</option>  
 <option value="2002">2002</option>  =cut
 <option value="2003">2003</option>  
 <option value="2004">2004</option>  ######################################################################
 <option value="2005">2005</option>  ######################################################################
 <option value="2006">2006</option>  sub get_persistent_form_data {
 <option value="2007">2007</option>      my $filename = shift;
 <option value="2008">2008</option>      return 0 if (! -e $filename);
 <option value="2009">2009</option>      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
 <option value="2010">2010</option>                             &GDBM_READER(),0640));
 <option value="2011">2011</option>      #
 <option value="2012">2012</option>      # These make sure we do not get array references printed out as 'values'.
 <option value="2013">2013</option>      my %arrays_allowed = ('form.domains'=>1);
 <option value="2014">2014</option>      #
 <option value="2015">2015</option>      # Loop through the keys, looking for 'form.'
 <option value="2016">2016</option>      foreach my $name (keys(%persistent_db)) {
 <option value="2017">2017</option>          next if ($name !~ /^form./);
 <option value="2018">2018</option>          # Kludgification begins!
 <option value="2019">2019</option>          if ($name eq 'form.domains' && 
 <option value="2020">2020</option>              $ENV{'form.searchmode'} eq 'basic' &&
 <option value="2021">2021</option>              $ENV{'form.phase'} ne 'disp_basic') {
 <option value="2022">2022</option>              next;
 <option value="2023">2023</option>          }
 <option value="2024">2024</option>          # End kludge (hopefully)
 <option value="2025">2025</option>          next if (exists($ENV{$name}));
 <option value="2026">2026</option>          my @values = map { 
 <option value="2027">2027</option>              &Apache::lonnet::unescape($_);
 <option value="2028">2028</option>          } split(',',$persistent_db{$name});
 <option value="2029">2029</option>          next if (@values <1);
 <option value="2030">2030</option>          if ($arrays_allowed{$name}) {
 <option value="2031">2031</option>              $ENV{$name} = [@values];
 <option value="2032">2032</option>          } else {
 <option value="2033">2033</option>              $ENV{$name} = $values[0] if ($values[0]);
 <option value="2034">2034</option>          }
 <option value="2035">2035</option>      }
 <option value="2036">2036</option>      untie (%persistent_db);
 <option value="2037">2037</option>      return 1;
 <option value="2038">2038</option>  }
 <option value="2039">2039</option>  
 <option value="2040">2040</option>  ######################################################################
 <option value="2041">2041</option>  ######################################################################
 <option value="2042">2042</option>  
 <option value="2043">2043</option>  =pod 
 <option value="2044">2044</option>  
 <option value="2045">2045</option>  =item &get_persistent_data()
 <option value="2046">2046</option>  
 <option value="2047">2047</option>  Inputs: filename of database, ref to array of values to recover.
 <option value="2048">2048</option>  
 <option value="2049">2049</option>  Outputs: array of values.  Returns undef on error.
 <option value="2050">2050</option>  
 <option value="2051">2051</option>  This function is the reverse of &make_persistent();
 </select>  Retrieve persistent data from %persistent_db.  Retrieved items will have their
 END  values unescaped.  If the item contains commas (before unescaping), the
     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);  returned value will be an array pointer. 
     return "$month$day$year";  
   =cut
   
   ######################################################################
   ######################################################################
   sub get_persistent_data {
       my $filename = shift;
       my @Vars = @{shift()};
       my @Values;   # Return array
       return undef if (! -e $filename);
       return undef if (! tie(%persistent_db,'GDBM_File',$filename,
                              &GDBM_READER(),0640));
       foreach my $name (@Vars) {
           if (! exists($persistent_db{$name})) {
               push @Values, undef;
               next;
           }
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           if (@values <= 1) {
               push @Values,$values[0];
           } else {
               push @Values,\@values;
           }
       }
       untie (%persistent_db);
       return @Values;
 }  }
   
 sub selectbox {  ######################################################################
     my ($title,$name,$value,%options)=@_;  ######################################################################
     my $uctitle=uc($title);  
     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".  
  "</b></font><br>".'<select name="'.$name.'">';  
     map {  
         $selout.='<option value=\''.$_.'\'';  
         if ($_ eq $value) { $selout.=' selected'; }  
         $selout.='>'.$options{$_}.'</option>';  
     } sort keys %options;  
     return $selout.'</select>';  
 }  
   
 # ----------------------------------------------- Performing an advanced search  
 sub advancedsearch {  
     my ($r,$envhash)=@_;  
     my %ENV=%{$envhash};  
   
   =pod 
   
   =item &make_persistent() 
   
   Inputs: Hash of values to save, filename of persistent database.
   
   Store 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 separated string.  
   
   =cut
   
   ######################################################################
   ######################################################################
   sub make_persistent {
       my %save = %{shift()};
       my $filename = shift;
       return undef if (! tie(%persistent_db,'GDBM_File',
                              $filename,&GDBM_WRCREAT(),0640));
       foreach my $name (keys(%save)) {
           my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
           # We handle array references, but not recursively.
           my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
           $persistent_db{$name} = $store;
       }
       untie(%persistent_db);
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &make_form_data_persistent() 
   
   Inputs: filename of persistent database.
   
   Store most form 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 separated string.  
   
   =cut
   
   ######################################################################
   ######################################################################
   sub make_form_data_persistent {
       my $r = shift;
       my $filename = shift;
       my %save;
       foreach (keys(%ENV)) {
           next if (!/^form/ || /submit/);
           $save{$_} = $ENV{$_};
       }
       return &make_persistent(\%save,$filename);
   }
   
   ######################################################################
   ######################################################################
   
   =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,$hidden_fields)=@_;
       my @BasicFields = ('title','author','subject','keywords','url','version',
                          'notes','abstract','extension','owner',
   #                       'custommetadata','customshow',
                          'modifyinguser','standards','mime');
       my @StatsFields = ('stdno','avetries','difficulty','disc');
       my @EvalFields = ('clear','depth','helpful','correct','technical');
     my $fillflag=0;      my $fillflag=0;
       my $pretty_search_string = "<br />\n";
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('title','author','subject','keywords','url','version',      for my $field (@BasicFields,
    'creationdatestart_month','creationdatestart_day',                     'creationdatestart_month','creationdatestart_day',
    'creationdatestart_year','creationdateend_month',     'creationdatestart_year','creationdateend_month',
    'creationdateend_day','creationdateend_year',     'creationdateend_day','creationdateend_year',
    'lastrevisiondatestart_month','lastrevisiondatestart_day',     'lastrevisiondatestart_month','lastrevisiondatestart_day',
    'lastrevisiondatestart_year','lastrevisiondateend_month',     'lastrevisiondatestart_year','lastrevisiondateend_month',
    'lastrevisiondateend_day','lastrevisiondateend_year',     'lastrevisiondateend_day','lastrevisiondateend_year') {
    'notes','abstract','mime','language','owner',   $ENV{'form.'.$field}=~s/[^\w\/\s\(\)\=\-\"\']//g;
    'custommetadata','customshow') {          $ENV{'form.'.$field}=~s/(not\s*$|^\s*(and|or)|)//gi;
  $ENV{"form.$field"}=~s/[^\w\s\(\)\=\-\"\']//g;      }
     }      foreach ('mode','form','element') {
    # is this required?  Hmmm.
    next if (! exists($ENV{'form.'.$_}));
    $ENV{'form.'.$_}=&Apache::lonnet::unescape($ENV{'form.'.$_});
    $ENV{'form.'.$_}=~s/[^\w\/\s\(\)\=\-\"\']//g;
       }
       # Preprocess the category form element.
       $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) ||
                                         ref($ENV{'form.category'}));
       #
     # Check to see if enough information was filled in      # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',      for my $field (@BasicFields) {
    'notes','abstract','mime','language','owner',   if (&filled($ENV{'form.'.$field})) {
    'custommetadata') {  
  if (&filled($ENV{"form.$field"})) {  
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      for my $field ('lowestgradelevel','highestgradelevel') {
  &output_blank_field_error($r);          if ( $ENV{'form.'.$field} =~ /^\d+$/ &&
  return OK;               $ENV{'form.'.$field} > 0) {
               $fillflag++;
           }
       }
       if (! $fillflag) {
    &output_blank_field_error($r,$closebutton,
                                     'phase=disp_adv',$hidden_fields);
    return ;
     }      }
   
   
     # Turn the form input into a SQL-based query      # Turn the form input into a SQL-based query
     my $query='';      my $query='';
   
     my @queries;      my @queries;
       my $font = '<font color="#800000" face="helvetica">';
     # Evaluate logical expression AND/OR/NOT phrase fields.      # Evaluate logical expression AND/OR/NOT phrase fields.
     foreach my $field ('title','author','subject','notes','abstract','url',      foreach my $field (@BasicFields) {
        'keywords','version','owner') {  
  if ($ENV{'form.'.$field}) {   if ($ENV{'form.'.$field}) {
     push @queries,&build_SQL_query($field,$ENV{'form.'.$field});              my $searchphrase = $ENV{'form.'.$field};
  }              $pretty_search_string .= $font."$field</font> contains <b>".
                   $searchphrase."</b>";
               if ($ENV{'form.'.$field.'_related'}) {
                   my @New_Words;
                   ($searchphrase,@New_Words) = &related_version($searchphrase);
                   if (@New_Words) {
                       $pretty_search_string .= " with related words: ".
                           "<b>@New_Words</b>.";
                   } else {
                       $pretty_search_string .= " with no related words.";
                   }
               }
               $pretty_search_string .= "<br />\n";
       push @queries,&build_SQL_query($field,$searchphrase);
           }
       }
       #
       # Make the 'mime' from 'form.category' and 'form.extension'
       #
       my $searchphrase;
       if (exists($ENV{'form.category'})    && 
           $ENV{'form.category'} !~ /^\s*$/ &&
           $ENV{'form.category'} ne 'any')     {
           my @extensions = &Apache::loncommon::filecategorytypes
                                                      ($ENV{'form.category'});
           if (scalar(@extensions) > 0) {
               $searchphrase = join(' OR ',@extensions);
           }
       }
       if (defined($searchphrase)) {
           push @queries,&build_SQL_query('mime',$searchphrase);
           $pretty_search_string .=$font.'mime</font> contains <b>'.
               $searchphrase.'</b><br />';
     }      }
       #
     # Evaluate option lists      # Evaluate option lists
       if ($ENV{'form.lowestgradelevel'}        &&
           $ENV{'form.lowestgradelevel'} ne '0' &&
           $ENV{'form.lowestgradelevel'} =~ /^\d+$/) {
    push(@queries,
                '(lowestgradelevel>='.$ENV{'form.lowestgradelevel'}.')');
           $pretty_search_string.="lowestgradelevel>=".
               $ENV{'form.lowestgradelevel'}."<br />\n";
       }
       if ($ENV{'form.highestgradelevel'}        &&
           $ENV{'form.highestgradelevel'} ne '0' &&
           $ENV{'form.highestgradelevel'} =~ /^\d+$/) {
    push(@queries,
                '(highestgradelevel<='.$ENV{'form.highestgradelevel'}.')');
           $pretty_search_string.="highestgradelevel<=".
               $ENV{'form.highestgradelevel'}."<br />\n";
       }
     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  push @queries,"(language like \"$ENV{'form.language'}\")";   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') {      if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
  push @queries,"(copyright like \"$ENV{'form.copyright'}\")";   push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
           $pretty_search_string.=$font."copyright</font> = ".
               &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}).
                   "<br \>\n";
       }
       #
       # Statistics
       foreach my $field (@StatsFields,@EvalFields) {
           my ($min,$max);
           if (exists($ENV{'form.'.$field.'_min'}) && 
               $ENV{'form.'.$field.'_min'} ne '') {
               $min = $ENV{'form.'.$field.'_min'};
           }
           if (exists($ENV{'form.'.$field.'_max'}) &&
               $ENV{'form.'.$field.'_max'} ne '') {
               $max = $ENV{'form.'.$field.'_max'};
           }
           next if (! defined($max) && ! defined($min));
           if (defined($min) && defined($max)) {
               ($min,$max) = sort {$a <=>$b} ($min,$max);
           }
           if (defined($min) && $min =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
               push(@queries,'('.$field.'>'.$min.')');
               $pretty_search_string.=$font.$field.'</font>&gt;'.$min.'<br />';
           }
           if (defined($max) && $max =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
               push(@queries,'('.$field.'<'.$max.')');
               $pretty_search_string.=$font.$field.'</font>&lt;'.$max.'<br />';
           }
     }      }
       #
     # Evaluate date windows      # Evaluate date windows
     my $datequery=&build_date_queries(      my $cafter =
  $ENV{'form.creationdatestart_month'},          &Apache::lonhtmlcommon::get_date_from_form('creationdate1');
  $ENV{'form.creationdatestart_day'},      my $cbefore = 
  $ENV{'form.creationdatestart_year'},          &Apache::lonhtmlcommon::get_date_from_form('creationdate2');
  $ENV{'form.creationdateend_month'},      if ($cafter > $cbefore) {
  $ENV{'form.creationdateend_day'},          my $tmp = $cafter;
  $ENV{'form.creationdateend_year'},          $cafter = $cbefore;
  $ENV{'form.lastrevisiondatestart_month'},          $cbefore = $tmp;
  $ENV{'form.lastrevisiondatestart_day'},      }
  $ENV{'form.lastrevisiondatestart_year'},      my $mafter = 
  $ENV{'form.lastrevisiondateend_month'},          &Apache::lonhtmlcommon::get_date_from_form('revisiondate1');
  $ENV{'form.lastrevisiondateend_day'},      my $mbefore =
  $ENV{'form.lastrevisiondateend_year'},          &Apache::lonhtmlcommon::get_date_from_form('revisiondate2');
  );      if ($mafter > $mbefore) {
     # Test to see if date windows are legitimate          my $tmp = $mafter;
     if ($datequery=~/^Incorrect/) {          $mafter = $mbefore;
  &output_date_error($r,$datequery);          $mbefore = $tmp;
  return OK;      }
     }      my ($datequery,$error,$prettydate)=&build_date_queries($cafter,$cbefore,
     elsif ($datequery) {                                                             $mafter,$mbefore);
       if (defined($error)) {
           &output_date_error($r,$error,$closebutton,$hidden_fields);
       } elsif (defined($datequery)) {
           # Here is where you would set up pretty_search_string to output
           # date query information.
           $pretty_search_string .= '<br />'.$prettydate.'<br />';
  push @queries,$datequery;   push @queries,$datequery;
     }      }
       #
     # Process form information for custom metadata querying      # Process form information for custom metadata querying
     my $customquery='';      my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {      ##
  $customquery=&build_custommetadata_query('custommetadata',      ## The custom metadata search was removed q long time ago mostly 
       $ENV{'form.custommetadata'});      ## because I was unable to figureout exactly how it worked and could
     }      ## not imagine people actually using it.  MH
     my $customshow='';      ##
     if ($ENV{'form.customshow'}) {      # if ($ENV{'form.custommetadata'}) {
  $customshow=$ENV{'form.customshow'};      #    $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
  $customshow=~s/[^\w\s]//g;      #    $ENV{'form.custommetadata'}."</b><br />\n";
  my @fields=split(/\s+/,$customshow);      #    $customquery=&build_custommetadata_query('custommetadata',
  $customshow=join(" ",@fields);      #                                             $ENV{'form.custommetadata'});
     }      # }
     # Send query statements over the network to be processed by either the SQL      my $customshow=undef;
     # database or a recursive scheme of 'grep'-like actions (for custom      # if ($ENV{'form.customshow'}) {
     # metadata).      # $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
       #                         $ENV{'form.customshow'}."</b><br />\n";
       #    $customshow=$ENV{'form.customshow'};
       #    $customshow=~s/[^\w\s]//g;
       #    my @fields=split(/\s+/,$customshow);
       #    $customshow=join(" ",@fields);
       # }
       ##
       ## Deal with restrictions to given domains
       ## 
       my ($libraries_to_query,$pretty_domains_string) = 
           &parse_domain_restrictions();
       $pretty_search_string .= $pretty_domains_string."<br />\n";
       #
     if (@queries) {      if (@queries) {
  $query=join(" AND ",@queries);   $query="select * from metadata where ".join(" AND ",@queries);
  $query="select * from metadata where $query";      } elsif ($customquery) {
  my $reply; # reply hash reference          $query = '';
  unless ($customquery or $customshow) {      }
     $reply=&Apache::lonnet::metadata_query($query);  #    &Apache::lonnet::logthis('query = '.$/.$query);
  }      return ($query,$customquery,$customshow,$libraries_to_query,
  else {              $pretty_search_string);
     $reply=&Apache::lonnet::metadata_query($query,  
    $customquery,$customshow);  
  }  
  &output_results('Advanced',$r,$envhash,$customquery,$reply);  
     }  
     elsif ($customquery) {  
  my $reply; # reply hash reference  
  $reply=&Apache::lonnet::metadata_query('',  
        $customquery,$customshow);  
  &output_results('Advanced',$r,$envhash,$customquery,$reply);  
     }  
     $r->print(' '); # just in case.. hrrmm..  
     return OK;  
 }  }
   
 # ---------------------------------------------------- see if a field is filled  sub parse_domain_restrictions {
 sub filled {      my $libraries_to_query = undef;
     my ($field)=@_;      # $ENV{'form.domains'} can be either a scalar or an array reference.
     if ($field=~/\S/) {      # We need an array.
  return 1;      if (! exists($ENV{'form.domains'}) || $ENV{'form.domains'} eq '') {
     }          return (undef,'');
     else {      }
  return 0;      my @allowed_domains;
       if (ref($ENV{'form.domains'})) {
           @allowed_domains =  @{$ENV{'form.domains'}};
       } else {
           @allowed_domains = ($ENV{'form.domains'});
       }
       #
       my %domain_hash = ();
       my $pretty_domains_string;
       foreach (@allowed_domains) {
           $domain_hash{$_}++;
       }
       if ($domain_hash{'any'}) {
           $pretty_domains_string = "In all LON-CAPA domains.";
       } else {
           if (@allowed_domains > 1) {
               $pretty_domains_string = "In LON-CAPA domains:";
           } else {
               $pretty_domains_string = "In LON-CAPA domain ";
           }
           foreach (sort @allowed_domains) {
               $pretty_domains_string .= "<b>".$_."</b> ";
           }
           foreach (keys(%Apache::lonnet::libserv)) {
               if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
                   push @$libraries_to_query,$_;
               }
           }
     }      }
       return ($libraries_to_query,$pretty_domains_string);
 }  }
   
 # --------------------------------------------------- Performing a basic search  ######################################################################
 sub basicsearch {  ######################################################################
     my ($r,$envhash)=@_;  
     my %ENV=%{$envhash};  
   
   =pod 
   
   =item &parse_basic_search() 
   
   Parse the basic search form and return a scalar containing an sql query.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub parse_basic_search {
       my ($r,$closebutton)=@_;
       #
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('basicexp') {      for my $field ('basicexp') {
  $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;   $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
     }      }
       foreach ('mode','form','element') {
     # Check to see if enough is filled in   # is this required?  Hmmm.
     unless (&filled($ENV{'form.basicexp'})) {   next unless (exists($ENV{"form.$_"}));
  &output_blank_field_error($r);   $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
    $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
       }
       my ($libraries_to_query,$pretty_domains_string) = 
           &parse_domain_restrictions();
       #
       # Check to see if enough of a query is filled in
       my $search_string = $ENV{'form.basicexp'};
       $search_string =~ s/(not\s*$|^\s*(and|or)|)//gi;
       if (! &filled($search_string)) {
    &output_blank_field_error($r,$closebutton,'phase=disp_basic');
  return OK;   return OK;
     }      }
       my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
       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      # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',',
        ('title', 'author', 'subject', 'notes', 'abstract'));         ('title', 'author', 'subject', 'notes', 'abstract',
     $query='select * from metadata where concat(' . $concatarg . ') like %' .                          'keywords'));
    $ENV{'form.basicexp'} . '%';      $concatarg='title' if $ENV{'form.titleonly'};
       $query=&build_SQL_query('concat_ws(" ",'.$concatarg.')',$search_string);
       if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
           $pretty_search_string .= ' '.$pretty_domains_string;
       }
       $pretty_search_string .= "<br />\n";
       my $final_query = 'SELECT * FROM metadata WHERE '.$query;
       # &Apache::lonnet::logthis($final_query);
       return ($final_query,$pretty_search_string,
               $libraries_to_query);
   }
   
     # Get reply (either a hash reference to filehandles or bad connection)  ######################################################################
     my $reply=&Apache::lonnet::metadata_query($query);  ######################################################################
   
     # Output search results  =pod 
     &output_results('Basic',$r,$envhash,$query,$reply);  
   
     return OK;  =item &related_version()
   
   Modifies an input string to include related words.  Words in the string
   are replaced with parenthesized lists of 'OR'd words.  For example
   "torque" is replaced with "(torque OR word1 OR word2 OR ...)".  
   
   Note: Using this twice on a string is probably silly.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub related_version {
       my $search_string = shift;
       my $result = $search_string;
       my %New_Words = ();
       while ($search_string =~ /(\w+)/cg) {
           my $word = $1;
           next if (lc($word) =~ /\b(or|and|not)\b/);
           my @Words = &Apache::loncommon::get_related_words($word);
           @Words = ($#Words>4? @Words[0..4] : @Words);
           foreach (@Words) { $New_Words{$_}++;}
           my $replacement = join " OR ", ($word,@Words);
           $result =~ s/(\b)$word(\b)/$1($replacement)$2/g;
       }
       return $result,sort(keys(%New_Words));
 }  }
   
 # ---------------- Message to output when there are not enough fields filled in  ######################################################################
 sub output_blank_field_error {  ######################################################################
     my ($r)=@_;  
     # make query information persistent to allow for subsequent revision  
     my $persistent=&make_persistent();  
   
     $r->print(<<BEGINNING);  =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',
     -parse => 'Text::Query::ParseAdvanced',
     -build => 'Text::Query::Build');
       $q->prepare($logic_statement);
       my $matchexp=${$q}{'matchexp'}; chomp $matchexp;
       my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);
       return $sql_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',
     -parse => 'Text::Query::ParseAdvanced',
     -build => 'Text::Query::BuildAdvancedString');
       $q->prepare($logic_statement);
       my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
       # quick fix to change literal into xml tag-matching
       # will eventually have to write a separate builder module
       # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
       $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to 
                    /\\<$1\\>?#           \<wordone\>
                      \[\^\\<\]?#        [^\<]         
                      \*$2\[\^\\<\]?#           *wordtwo[^\<]
                      \*\\<\\\/$1\\>?#                        *\<\/wordone\>
                      /g;
       return $matchexp;
   }
   
   ######################################################################
   ######################################################################
   
   =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);
       return $pattern unless @matches;
       foreach my $match (@matches) {
           $match=~/\[ (\w+)\s(.*) \]/;
           my ($key,$value)=($1,$2);
           my $replacement='';
           if ($key eq 'literal') {
               $replacement="($dkey LIKE \"\%$value\%\")";
           } elsif (lc($key) eq 'not') {
               $value=~s/LIKE/NOT LIKE/;
   #          $replacement="($dkey not like $value)";
               $replacement="$value";
           } elsif ($key eq 'and') {
               $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
               $replacement="($1 AND $2)";
    } elsif ($key eq 'or') {
               $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
               $replacement="($1 OR $2)";
    }
    substr($pattern,
                  index($pattern,$match),
                  length($match),
                  $replacement);
       }
       &recursive_SQL_query_build($dkey,$pattern);
   }
   
   ######################################################################
   ######################################################################
   
   =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 ($cafter,$cbefore,$mafter,$mbefore) = @_;
       my ($result,$error,$pretty_string);
       #
       # Verify the input
       if (! defined($cafter) && ! defined($cbefore) &&
           ! defined($mafter) && ! defined($mbefore)) {
           # This is an okay situation, so return undef for the error
           return (undef,undef,undef);
       }
       if ((defined($cafter)  && ! defined($cbefore)) ||
           (defined($cbefore) && ! defined($cafter))) {
           # This is bad, so let them know
           $error = &mt('Incorrect entry for the creation date.  '.
                       'You must specify both the beginning and ending dates.');
       }
       if (! defined($error) && 
           ((defined($mafter)  && ! defined($mbefore)) ||
           (defined($mbefore) && ! defined($mafter)))) {
           # This is also bad, so let them know
           $error = &mt('Incorrect entry for the last revision date.  '.
                        'You must specify both the beginning and ending dates.');
       }
       if (! defined($error)) {
           #
           # Build the queries
           my @queries;
           if (defined($cbefore) && defined($cafter)) {
               my (undef,undef,undef,$caday,$camon,$cayear) = localtime($cafter);
               my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore);
               # Correct for year being relative to 1900
               $cayear+=1900; $cbyear+=1900;
               my $cquery=
                   '(creationdate BETWEEN '.
                   "'".$cayear.'-'.$camon.'-'.$caday."'".
                   ' AND '.
                   "'".$cbyear.'-'.$cbmon.'-'.$cbday." 23:59:59')";
               $pretty_string .= '<br />' if (defined($pretty_string));
               $pretty_string .= 
                   &mt('created between [_1] and [_2]',
                       &Apache::lonlocal::locallocaltime($cafter),
                       &Apache::lonlocal::locallocaltime($cbefore+24*60*60-1));
               push(@queries,$cquery);
               $pretty_string =~ s/ 00:00:00//g;
           }
           if (defined($mbefore) && defined($mafter)) {
               my (undef,undef,undef,$maday,$mamon,$mayear) = localtime($mafter);
               my (undef,undef,undef,$mbday,$mbmon,$mbyear) = localtime($mbefore);
               # Correct for year being relative to 1900
               $mayear+=1900; $mbyear+=1900;
               my $mquery=
                   '(lastrevisiondate BETWEEN '.
                   "'".$mayear.'-'.$mamon.'-'.$maday."'".
                   ' AND '.
                   "'".$mbyear.'-'.$mbmon.'-'.$mbday." 23:59:59')";
               push(@queries,$mquery);
               $pretty_string .= '<br />' if (defined($pretty_string));
               $pretty_string .= 
                   &mt('last revised between [_1] and [_2]',
                       &Apache::lonlocal::locallocaltime($mafter),
                       &Apache::lonlocal::locallocaltime($mbefore+24*60*60-1));
               $pretty_string =~ s/ 00:00:00//g;
           }
           if (@queries) {
               $result .= join(" AND ",@queries);
           }
       }
       return ($result,$error,$pretty_string);
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &copyright_check()
   
   Inputs: $Metadata, a hash pointer of metadata for a resource.
   
   Returns: 1 if the resource is available to the user making the query, 
            0 otherwise.
   
   =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 &ensure_db_and_table()
   
   Ensure we can get lonmysql to connect to the database and the table we
   need exists.
   
   Inputs: $r, table id
   
   Returns: undef on error, 1 if the table exists.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub ensure_db_and_table {
       my ($r,$table) = @_;
       ##
       ## Sanity check the table id.
       ##
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to retrieve search results.  ".
                     "Unable to determine the table results were stored in.  ".
                     "</body></html>");
           return undef;
       }
       ##
       ## Make sure we can connect and the table exists.
       ##
       my $connection_result = &Apache::lonmysql::connect_to_db();
       if (!defined($connection_result)) {
           $r->print("Unable to connect to the MySQL database where your results".
                     " are stored. </body></html>");
           &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to".
                                    " connect to database.");
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return undef;
       }
       my $table_check = &Apache::lonmysql::check_table($table);
       if (! defined($table_check)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the status".
                                    " of table ".$table);
           return undef;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return undef;
       }
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &print_sort_form()
   
   The sort feature is not implemented at this time.  This form just prints 
   a link to change the search query.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_sort_form {
       my ($r,$pretty_query_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       ##
       my %SortableFields=&Apache::lonlocal::texthash( 
            id        => 'Default',
            title     => 'Title',
            author    => 'Author',
            subject   => 'Subject',
            url       => 'URL',
            version   => 'Version Number',
            mime      => 'Mime type',
            lang      => 'Language',
            owner     => 'Owner/Publisher',
            copyright => 'Copyright',
            hostname  => 'Host',
            creationdate     => 'Creation Date',
            lastrevisiondate => 'Revision Date'
        );
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       my $result;
       $result.=<<END;
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <script>
 BEGINNING      function change_sort() {
     $r->print(<<RESULTS);          var newloc = "/adm/searchcat?phase=results";
           newloc += "&persistent_db_id=$ENV{'form.persistent_db_id'}";
           newloc += "&sortby=";
           newloc += document.forms.statusform.elements.sortby.value;
           parent.resultsframe.location= newloc;
       }
   </script>
   <title>Results</title>
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <form name="statusform" action="" method="post">
 <h1>Search Catalog</h1>  <input type="hidden" name="Queue" value="" />
 <form method="post" action="/adm/searchcat">  END
 $persistent  
 <input type='button' value='Revise search request'  #<h2>Sort Results</h2>
 onClick='this.form.submit();'>  #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
 $closebutton  #    $ENV{'form.sortby'} = 'id' if (! defined($ENV{'form.sortby'}));
 <hr>  #    foreach (keys(%SortableFields)) {
 <h3>Helpful Message</h3>  #        $result.="<option name=\"$_\"";
   #        if ($_ eq $ENV{'form.sortby'}) {
   #            $result.=" selected ";
   #        }
   #        $result.=" >$SortableFields{$_}</option>\n";
   #    }
   #    $result.="</select>\n";
       my $revise = &revise_button();
       $result.=<<END;
 <p>  <p>
 Incorrect search query due to blank entry fields.  There are $total_results matches to your query. $revise
 You need to fill in the relevant  </p><p>
 fields on the search page in order for a query to be  Search:$pretty_query_string
 processed.  
 </p>  </p>
   </form>
 </body>  </body>
 </html>  </html>
 RESULTS  END
       $r->print($result);
       return;
 }  }
   
 # ----------------------------- format and output results based on a reply list  #####################################################################
 sub output_results {  #####################################################################
     my ($mode,$r,$envhash,$query,@replylist)=@_;  
     my %ENV=%{$envhash};  
     my $compiledresult='';  
   
     foreach my $reply (@replylist) {  
   
  my @results;  
   
  my $replyfile='';  
  $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting  
  $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
  $reply=~/(.*?)\_/;  
  my $hostname=$1;  
  sleep 3; # temporary fix, need to check for completion and status  
  {  
     while (1) {  
  last if -e $replyfile;  
  sleep 1;  
     }  
     # QUESTION: how should I handle this error condition..  
     # I'm sure there is syntax elsewhere I can use..  
     my $fh=Apache::File->new($replyfile) or  
  ($r->print('file cannot be opened') and return OK);  
     @results=<$fh>;  
  }  
   
  my $customshow='';  =pod
  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;  
     }  
  }  
  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;  
     my $shortabstract=$abstract;  
     $shortabstract=substr($abstract,0,200) if length($abstract)>200;  
     $fields[7]=$shortabstract;  
     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;  =item MySQL Table Description
 <hr align='left' width='200' noshade />  
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   #####################################################################
   #####################################################################
   #
   # These should probably be scoped but I don't have time right now...
   #
   my @Datatypes;
   my @Fullindicies;
       
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &create_results_table()
   
   Creates the table of search results by calling lonmysql.  Stores the
   table id in $ENV{'form.table'}
   
   Inputs: none.
   
   Returns: the identifier of the table on success, undef on error.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub set_up_table_structure {
       my ($datatypes,$fullindicies) = 
           &LONCAPA::lonmetadata::describe_metadata_storage();
       # Copy the table description before modifying it...
       @Datatypes = @{$datatypes};
       unshift(@Datatypes,{name => 'id',  
           type => 'MEDIUMINT',
           restrictions => 'UNSIGNED NOT NULL',
           primary_key  => 'yes',
           auto_inc     => 'yes' });
       @Fullindicies = @{$fullindicies};
       return;
   }
   
   sub create_results_table {
       &set_up_table_structure();
       my $table = &Apache::lonmysql::create_table
           ( { columns => \@Datatypes,
               FULLTEXT => [{'columns' => \@Fullindicies},],
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item Search Status update functions
   
   Each of the following functions changes the values of one of the
   input fields used to display the search status to the user.  The names
   should be explanatory.
   
   Inputs: Apache request handler ($r), text to display.
   
   Returns: Nothing.
   
   =over 4
   
   =item &update_count_status()
   
   =item &update_status()
   
   =item &update_seconds()
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub update_count_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.count.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   sub update_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.status.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   {
       my $max_time  = 40;  # seconds for the search to complete
       my $start_time = 0;
       my $last_time = 0;
   
   sub reset_timing {
       $start_time = 0;
       $last_time = 0;
   }
   
   sub time_left {
       if ($start_time == 0) {
           $start_time = time;
       }
       my $time_left = $max_time - (time - $start_time);
       $time_left = 0 if ($time_left < 0);
       return $time_left;
   }
   
   sub update_seconds {
       my ($r) = @_;
       my $time = &time_left();
       if (($last_time-$time) > 0) {
           $r->print("<script>".
                     "document.statusform.seconds.value = '$time'".
                     "</script>\n");
           $r->rflush();
       }
       $last_time = $time;
   }
   
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &revise_button()
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revise_phase = 'disp_basic';
       $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
       my $newloc = '/adm/searchcat'.
           '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
               '&cleargroupsort=1'.
               '&phase='.$revise_phase;
       my $result = qq{<input type="button" value="Revise search" name="revise"} .
           qq{ onClick="parent.location='$newloc';" /> };
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &run_search()
   
   Executes a search query by sending it the the other servers and putting the
   results into MySQL.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub run_search {
       my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $connection = $r->connection;
       #
       # Print run_search header
       #
       $r->print(<<END);
   <html>
   <head><title>Search Status</title></head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
 END  END
     $compiledresult.=<<END;      # Check to see if $pretty_string has more than one carriage return.
 <p>      # Assume \n s are following <br /> s and truncate the value.
       # (there is probably a better way)...
       my @Lines = split /<br \/>/,$pretty_string;
       if (@Lines > 2) {
           $pretty_string = join '<br \>',(@Lines[0..2],'....<br />');
       }
       $r->print(&mt("Search: [_1]",$pretty_string));
       $r->rflush();
       #
       # Determine the servers we need to contact.
       my @Servers_to_contact;
       if (defined($serverlist)) {
           if (ref($serverlist) eq 'ARRAY') {
               @Servers_to_contact = @$serverlist;
           } else {
               @Servers_to_contact = ($serverlist);
           }
       } else {
           @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
       }
       my %Server_status;
       #
       # Check on the mysql table we will use to store results.
       my $table =$ENV{'form.table'};
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to determine table id to store search results in.".
                     "The search has been aborted.</body></html>");
           return;
       }
       my $table_status = &Apache::lonmysql::check_table($table);
       if (! defined($table_status)) {
           $r->print("Unable to determine status of table.</body></html>");
           &Apache::lonnet::logthis("Bogus table id of $table for ".
                                    "$ENV{'user.name'} @ $ENV{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           return;
       }
       if (! $table_status) {
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           &Apache::lonnet::logthis("lonmysql debug = ".
                                    &Apache::lonmysql::get_debug());
           &Apache::lonnet::logthis('table status = "'.$table_status.'"');
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
           return;
       }
       ##
       ## Prepare for the big loop.
       my $hitcountsum;
       my $server; 
       my $status;
       my $revise = &revise_button();
       $r->print(<<END);
   <table>
   <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
   <tr>
   <td><input type="text" name="status"  value="" size="30" /></td>
   <td><input type="text" name="count"   value="" size="10" /></td>
   <td><input type="text" name="seconds" value="" size="8" /></td>
   <td>$revise</td>
   </tr>
   </table>
   </form>
 END  END
            $compiledresult.=<<END if $ENV{'form.catalogmode'} eq 'interactive';      $r->rflush();
       &reset_timing();
       &update_seconds($r);
       &update_status($r,&mt('contacting [_1]',$Servers_to_contact[0]));
       while (&time_left() &&
              ((@Servers_to_contact) || keys(%Server_status))) {
           &update_seconds($r);
           #
           # Send out a search request
           if (@Servers_to_contact) {
               # Contact one server
               my $server = shift(@Servers_to_contact);
               &update_status($r,&mt('contacting [_1]',$server));
               my $reply=&Apache::lonnet::metadata_query($query,$customquery,
                                                         $customshow,[$server]);
               ($server) = keys(%$reply);
               $Server_status{$server} = $reply->{$server};
           } else {
               # wait a sec. to give time for files to be written
               # This sleep statement is here instead of outside the else 
               # block because we do not want to pause if we have servers
               # left to contact.  
               if (scalar (keys(%Server_status))) {
                   &update_status($r,
                          &mt('waiting on [_1]',join(' ',keys(%Server_status))));
               }
               sleep(1)
           }
           #
           # Loop through the servers we have contacted but do not
           # have results from yet, looking for results.
           while (my ($server,$status) = each(%Server_status)) {
               last if ($connection->aborted());
               &update_seconds($r);
               if ($status eq 'con_lost') {
                   delete ($Server_status{$server});
                   next;
               }
               $status=~/^([\.\w]+)$/; 
              my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
               if (-e $datafile && ! -e "$datafile.end") {
                   &update_status($r,&mt('Receiving results from [_1]',$server));
                   next;
               }
               last if ($connection->aborted());
               if (-e "$datafile.end") {
                   &update_status($r,&mt('Reading results from [_1]',$server));
                   if (-z "$datafile") {
                       delete($Server_status{$server});
                       next;
                   }
                   my $fh;
                   if (!($fh=Apache::File->new($datafile))) { 
                       $r->print("Unable to open search results file for ".
                                     "server $server.  Omitting from search");
                       delete($Server_status{$server}); 
                      next;
                   }
                   # Read in the whole file.
                   while (my $result = <$fh>) {
                       last if ($connection->aborted());
                       #
                       # Records are stored one per line
                       chomp($result);
                       next if (! $result);
                       #
                       # Parse the result.
                       my %Fields = &parse_raw_result($result,$server);
                       $Fields{'hostname'} = $server;
                       #
                       # Skip based on copyright
                       next if (! &copyright_check(\%Fields));
                       #
                       # Store the result in the mysql database
                       my $result = &Apache::lonmysql::store_row($table,\%Fields);
                       if (! defined($result)) {
                           $r->print(&Apache::lonmysql::get_error());
                       }
                       #
                       $hitcountsum ++;
                       &update_seconds($r);
                       if ($hitcountsum % 50 == 0) {
                           &update_count_status($r,$hitcountsum);
                       }
                   }
                   $fh->close();
                   # $server is only deleted if the results file has been 
                   # found and (successfully) opened.  This may be a bad idea.
                   delete($Server_status{$server});
               }
               last if ($connection->aborted());
               &update_count_status($r,$hitcountsum);
           }
           last if ($connection->aborted());
           &update_seconds($r);
       }
       &update_status($r,&mt('Search Complete [_1]',$server));
       &update_seconds($r);
       #
       &Apache::lonmysql::disconnect_from_db(); # This is unneccessary
       #
       # We have run out of time or run out of servers to talk to and
       # results to get, so let the client know the top frame needs to be
       # loaded from /adm/searchcat
       $r->print("</body></html>");
       if ($ENV{'form.catalogmode'} ne 'groupsearch') {
           $r->print("<script>".
                         "window.location='/adm/searchcat?".
                         "phase=sort&".
                         "persistent_db_id=$ENV{'form.persistent_db_id'}';".
                     "</script>");
       }
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &prev_next_buttons()
   
   Returns html for the previous and next buttons on the search results page.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub prev_next_buttons {
       my ($current_min,$show,$total,$parms) = @_;
       return '' if ($show eq 'all'); # No links if you get them all at once.
       #
       # Create links
       my $prev_min = $current_min - $show;
       $prev_min = 1 if $prev_min < 1;
       my $prevlink = 
           qq{<a href="/adm/searchcat?$parms&start=$prev_min&show=$show">};
       #
       my $next_min = $current_min + $show;
       $next_min = $current_min if ($next_min > $total);
       my $nextlink =
           qq{<a href="/adm/searchcat?$parms&start=$next_min&show=$show">};
       my $reloadlink = 
           qq{<a href="/adm/searchcat?$parms&start=$current_min&$show=$show">};
       #
       # Determine which parameters to pass
       my $String = '[_1]prev[_2] &nbsp; [_3]reload[_4] &nbsp; [_5]next[_6]';
       if ($prev_min == $current_min) {
           $String =~ s:\[_[12]\]::g;
       }
       if ($next_min == $current_min) {
           $String =~ s:\[_[56]\]::g;
       }
       my $links = &mt($String,
                       $prevlink,  '</a>',
                       $reloadlink,'</a>',
                       $nextlink,  '</a>');
       return $links;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &display_results()
   
   Prints the results out for selection and perusal.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub display_results {
       my ($r,$importbutton,$closebutton,$diropendb) = @_;
       my $connection = $r->connection;
       $r->print(&search_results_header($importbutton,$closebutton));
       ##
       ## Set viewing function
       ##
       my $viewfunction = $Views{$ENV{'form.viewselect'}};
       if (!defined($viewfunction)) {
           $r->print("Internal Error - Bad view selected.\n");
           $r->rflush();
           return;
       }
       ##
       ## $checkbox_num is a count of the number of checkboxes output on the 
       ## page this is used only during catalogmode=groupsearch.
       my $checkbox_num = 0;
       ##
       ## Get the catalog controls setup
       ##
       my $action = "/adm/searchcat?phase=results";
       ##
       ## Deal with groupsearch by opening the groupsearch db file.
       if ($ENV{'form.catalogmode'} eq 'groupsearch') {
           if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                     &GDBM_WRCREAT(),0640)) {
               $r->print('Unable to store import results.</form></body></html>');
               $r->rflush();
               return;
           } 
       }
       ##
       ## Prepare the table for querying
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       ##
       ## Determine how many results we need to get
       $ENV{'form.start'} = 1      if (! exists($ENV{'form.start'}));
       $ENV{'form.show'}  = 'all'  if (! exists($ENV{'form.show'}));
       my $min = $ENV{'form.start'};
       my $max;
       if ($ENV{'form.show'} eq 'all') {
           $max = $total_results ;
       } else {
           $max = $min + $ENV{'form.show'} - 1;
           $max = $total_results if ($max > $total_results);
       }
       ##
       ## Output links (if necessary) for 'prev' and 'next' pages.
       $r->print
           ('<center>'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                               "table=".$ENV{'form.table'}.
                               "&phase=results".
                               "&persistent_db_id=".$ENV{'form.persistent_db_id'})
            ."</center>\n"
            );
       if ($total_results == 0) {
           $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="2">'.
                     '<h3>'.&mt('There are currently no results').'.</h3>'.
                     "</form></body></html>");
           return;
       } else {
           $r->print
               ("<center>Results $min to $max out of $total_results</center>\n");
       }
       ##
       ## Get results from MySQL table
       my @Results = &Apache::lonmysql::get_rows($table,
                                                 'id>='.$min.' AND id<='.$max);
       ##
       ## Loop through the results and output them.
       foreach my $row (@Results) {
           if ($connection->aborted()) {
               &cleanup();
               return;
           }
           my %Fields = %{&parse_row(@$row)};
           my $output="<p>\n";
           if (! defined($Fields{'title'}) || $Fields{'title'} eq '') {
               $Fields{'title'} = 'Untitled';
           }
           my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'},
                                          $Fields{'id'},$checkbox_num++);
           # Render the result into html
           $output.= &$viewfunction($prefix,%Fields);
           # Print them out as they come in.
           $r->print($output);
           $r->rflush();
       }
       if (@Results < 1) {
           $r->print(&mt("There were no results matching your query"));
       } else {
           $r->print
               ('<center>'.
                &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                                   "table=".$ENV{'form.table'}.
                                   "&phase=results".
                                   "&persistent_db_id=".
                                   $ENV{'form.persistent_db_id'})
                ."</center>\n"
                );
       }
       $r->print("</form></body></html>");
       $r->rflush();
       untie %groupsearch_db if (tied(%groupsearch_db));
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
   
   Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub catalogmode_output {
       my $output = '';
       my ($title,$url,$fnum,$checkbox_num) = @_;
       if ($ENV{'form.catalogmode'} eq 'interactive') {
           $title=~ s/\'/\\\'/g;
           if ($ENV{'form.catalogmode'} eq 'interactive') {
               $output.=<<END 
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
 onClick="javascript:select_data('$title','$url')">  onClick="javascript:select_data('$title','$url')">
 </font>  </font>
 <br>  
 END  END
             my $httphost=$ENV{'HTTP_HOST'};          }
       } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
           $groupsearch_db{"pre_${fnum}_link"}=$url;
           $groupsearch_db{"pre_${fnum}_title"}=$title;
           $output.=<<END;
   <font size='-1'>
   <input type="checkbox" name="returnvalues" value="SELECT"
   onClick="javascript:queue($checkbox_num,$fnum)" />
   </font>
   END
       }
       return $output;
   }
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &parse_row()
   
     my $viewselect;  Parse a row returned from the database.
     if ($mode eq 'Basic') {  
  $viewselect=$ENV{'form.basicviewselect'};  =cut
     }  
     elsif ($mode eq 'Advanced') {  ######################################################################
  $viewselect=$ENV{'form.advancedviewselect'};  ######################################################################
     }  sub parse_row {
       my @Row = @_;
             if ($viewselect eq 'Detailed Citation View') {      my %Fields;
  $compiledresult.=&detailed_citation_view(@fields,      if (! scalar(@Datatypes)) {
  $hostname,$httphost,          &set_up_table_structure();
  $extrashow2);      }
     }      for (my $i=0;$i<=$#Row;$i++) {
             elsif ($viewselect eq 'Summary View') {          $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
  $compiledresult.=&summary_view(@fields,$hostname,$httphost,      }
        $extrashow2);      $Fields{'language'} = 
     }          &Apache::loncommon::languagedescription($Fields{'language'});
             elsif ($viewselect eq 'Fielded Format') {      $Fields{'copyrighttag'} =
  $compiledresult.=&fielded_format_view(@fields,$hostname,          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
       $httphost,$extrashow2);      $Fields{'mimetag'} =
     }          &Apache::loncommon::filedescription($Fields{'mime'});
             elsif ($viewselect eq 'XML/SGML') {      return \%Fields;
  $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,  }
  $extrashow2);  
     }  
   
   ###########################################################
   ###########################################################
   
   =pod
   
   =item &parse_raw_result()
   
   Takes a line from the file of results and parse it.  Returns a hash 
   with keys according to column labels
   
   In addition, the following tags are set by calling the appropriate 
   lonnet function: 'language', 'copyrighttag', 'mimetag'.
   
   The 'title' field is set to "Untitled" if the title field is blank.
   
   'abstract' and 'keywords' are truncated to 200 characters.
   
   =cut
   
   ###########################################################
   ###########################################################
   sub parse_raw_result {
       my ($result,$hostname) = @_;
       # conclude from self to others regarding fields
       my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash
           (map {
               &Apache::lonnet::unescape($_);
           } (split(/\,/,$result)) );
       return %Fields;
   }
   
   ###########################################################
   ###########################################################
   
   =pod
   
   =item &handle_custom_fields()
   
   =cut
   
   ###########################################################
   ###########################################################
   sub handle_custom_fields {
       my @results = @{shift()};
       my $customshow='';
       my $extrashow='';
       my @customfields;
       if ($ENV{'form.customshow'}) {
           $customshow=$ENV{'form.customshow'};
           $customshow=~s/[^\w\s]//g;
           my @fields=map {
               "<font color=\"#008000\">$_:</font><!-- $_ -->";
           } split(/\s+/,$customshow);
           @customfields=split(/\s+/,$customshow);
           if ($customshow) {
               $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
           }
       }
       my $customdata='';
       my %customhash;
       foreach my $result (@results) {
           if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
               my $tmp=$result;
               $tmp=~s/^custom\=//;
               my ($k,$v)=map {&Apache::lonnet::unescape($_);
                           } split(/\,/,$tmp);
               $customhash{$k}=$v;
         }          }
       }
       return ($extrashow,\@customfields,\%customhash);
   }
   
  unless ($compiledresult) {  ######################################################################
     $compiledresult="There were no results that matched your query";  ######################################################################
  }  
   
  # make query information persistent to allow for subsequent revision  =pod
  my $persistent=&make_persistent();  
   
  $r->print(<<BEGINNING);  =item &search_results_header()
 <html>  
 <head>  Output the proper html headers and javascript code to deal with different 
 <title>The LearningOnline Network with CAPA</title>  calling modes.
 BEGINNING  
         $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'interactive';  Takes most inputs directly from %ENV, except $mode.  
 <script>  
   =over 4
   
   =item $mode is either (at this writing) 'Basic' or 'Advanced'
   
   =back
   
   The following environment variables are checked:
   
   =over 4
   
   =item 'form.catalogmode' 
   
   Checked for 'interactive' and 'groupsearch'.
   
   =item 'form.mode'
   
   Checked for existance & 'edit' mode.
   
   =item 'form.form'
   
   Contains the name of the form that has the input fields to set
   
   =item 'form.element'
   
   the name of the input field to put the URL into
   
   =item 'form.titleelement'
   
   the name of the input field to put the title into
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub search_results_header {
       my ($importbutton,$closebutton) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $result = '';
       # output beginning of search page
       # conditional output of script functions dependent on the mode in
       # which the search was invoked
       if ($ENV{'form.catalogmode'} eq 'interactive'){
    if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') {
               $result.=<<SCRIPT;
   <script type="text/javascript">
     function select_data(title,url) {      function select_data(title,url) {
  changeTitle(title);   changeTitle(title);
  changeURL(url);   changeURL(url);
    parent.close();
     }      }
     function changeTitle(val) {      function changeTitle(val) {
  if (opener.inf.document.forms.resinfo.elements.t) {   if (parent.opener.inf.document.forms.resinfo.elements.t) {
     opener.inf.document.forms.resinfo.elements.t.value=val;      parent.opener.inf.document.forms.resinfo.elements.t.value=val;
  }   }
     }      }
     function changeURL(val) {      function changeURL(val) {
  if (opener.inf.document.forms.resinfo.elements.u) {   if (parent.opener.inf.document.forms.resinfo.elements.u) {
     opener.inf.document.forms.resinfo.elements.u.value=val;      parent.opener.inf.document.forms.resinfo.elements.u.value=val;
  }   }
     }      }
 </script>  </script>
 SCRIPT  SCRIPT
         $r->print(<<RESULTS);          } elsif ($ENV{'form.mode'} eq 'edit') {
 </head>              my $form = $ENV{'form.form'};
 <body bgcolor="#ffffff">              my $element = $ENV{'form.element'};
 <img align=right src=/adm/lonIcons/lonlogos.gif>              my $titleelement = $ENV{'form.titleelement'};
 <h1>Search Catalog</h1>      my $changetitle;
 <form method="post" action="/adm/searchcat">      if (!$titleelement) {
 $customdata   $changetitle='function changeTitle(val) {}';
 <input type='button' value='Revise search request'      } else {
 onClick='this.form.submit();'>      $changetitle=<<END;
 $closebutton  function changeTitle(val) {
 $persistent      if (parent.targetwin.document) {
 <hr>          parent.targetwin.document.forms["$form"].elements["$titleelement"].value=val;
 <h3>Search Query</h3>      } else {
 RESULTS   var url = 'forms[\"$form\"].elements[\"$titleelement\"].value';
     if ($mode eq 'Basic') {          alert("Unable to transfer data to "+url);
  $r->print(<<RESULTS);  
 <p>  
 <b>Basic search:</b> $ENV{'form.basicexp'}  
 </p>  
 RESULTS  
     }      }
     elsif ($mode eq 'Advanced') {  }
  $r->print(<<RESULTS);  END
 <p>              }
 <b>Advanced search</b>  
 $query              $result.=<<SCRIPT;
 </p>  <script type="text/javascript">
 RESULTS  function select_data(title,url) {
       changeURL(url);
       changeTitle(title);
       parent.close();
   }
   $changetitle
   function changeURL(val) {
       if (parent.targetwin.document) {
           parent.targetwin.document.forms["$form"].elements["$element"].value=val;
       } else {
    var url = 'forms[\"$form\"].elements[\"$element\"].value';
           alert("Unable to transfer data to "+url);
     }      }
  $r->print(<<RESULTS);  }
 <h3>Search Results</h3>  </script>
 $compiledresult  SCRIPT
 </body>          }
 </html>      }
 RESULTS      $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
   <script type="text/javascript">
       function queue(checkbox_num,val) {
           if (document.forms.results.returnvalues.length != "undefined" &&
               typeof(document.forms.results.returnvalues.length) == "number") {
               if (document.forms.results.returnvalues[checkbox_num].checked) {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
               } else {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
               }
           } else {
               if (document.forms.results.returnvalues.checked) {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
               } else {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
               }
           }
     }      }
       function select_group() {
    parent.window.location=
       "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
       parent.statusframe.document.forms.statusform.elements.Queue.value;
       }
   </script>
   SCRIPT
       $result.=<<END;
   </head>
   $bodytag
   <form name="results" method="post" action="" >
   <input type="hidden" name="Queue" value="" />
   $importbutton
   END
       return $result;
 }  }
   
 # ------------------------------------------------------------- build_SQL_query  ######################################################################
 sub build_SQL_query {  ######################################################################
     my ($field_name,$logic_statement)=@_;  sub search_status_header {
     my $q=new Text::Query('abc',      my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
   -parse => 'Text::Query::ParseAdvanced',      return <<ENDSTATUS;
   -build => 'Text::Query::Build');  <html><head><title>Search Status</title></head>
     $q->prepare($logic_statement);  $bodytag
     my $matchexp=${$q}{'matchexp'}; chomp $matchexp;  <h3>Search Status</h3>
     my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);  Sending search request to LON-CAPA servers.<br />
     return $sql_query;  ENDSTATUS
 }  }
   
 # ------------------------------------------------- build custom metadata query  sub results_link {
 sub build_custommetadata_query {      my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
     my ($field_name,$logic_statement)=@_;          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
     my $q=new Text::Query('abc',      my $results_link = $basic_link."&phase=results".
   -parse => 'Text::Query::ParseAdvanced',          "&pause=1"."&start=1";
   -build => 'Text::Query::BuildAdvancedString');      return $results_link;
     $q->prepare($logic_statement);  
     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;  
     $matchexp=~s/(\w+)\\\=([\w\\\+]+)/\\\<$1\\\>\[\^\\\<\]\*$2\[\^\\\<\]\*\\\<\\\/$1\\\>/g;  
     return $matchexp;  
 }  }
   
 # - Recursively parse a reverse notation expression into a SQL query expression  ######################################################################
 sub recursive_SQL_query_build {  ######################################################################
     my ($dkey,$pattern)=@_;  sub print_frames_interface {
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);      my $r = shift;
     return $pattern unless @matches;      my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
     foreach my $match (@matches) {          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
  $match=~/\[ (\w+)\s(.*) \]/;      my $run_search_link = $basic_link."&phase=run_search";
  my ($key,$value)=($1,$2);      my $results_link = &results_link();
  my $replacement='';      my $result = <<"ENDFRAMES";
  if ($key eq 'literal') {  <html>
     $replacement="($dkey like \"\%$value\%\")";  <head>
  }  <script>
  elsif ($key eq 'and') {  var targetwin = opener;
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  var queue = '';
     $replacement="($1 AND $2)";  </script>
  }  <title>LON-CAPA Digital Library Search Results</title>
  elsif ($key eq 'or') {  </head>
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  <frameset rows="150,*">
     $replacement="($1 OR $2)";      <frame name="statusframe"  src="$run_search_link">
  }      <frame name="resultsframe" src="$results_link">
  substr($pattern,  </frameset>
        index($pattern,$match),  </html>
        length($match),  ENDFRAMES
        $replacement  
        );      $r->print($result);
     }      return;
     &recursive_SQL_query_build($dkey,$pattern);  
 }  }
   
 # ------------------------------------------------------ Detailed Citation View  ######################################################################
   ######################################################################
   
   =pod 
   
   =item Metadata Viewing Functions
   
   Output is a HTML-ified string.
   
   Input arguments are title, author, subject, url, keywords, version,
   notes, short abstract, mime, language, creation date,
   last revision date, owner, copyright, hostname, and
   extra custom metadata to show.
   
   =over 4
   
   =item &detailed_citation_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my ($title,$author,$subject,$url,$keywords,$version,      my ($prefix,%values) = @_;
  $notes,$shortabstract,$mime,$lang,      my $icon=
  $creationdate,$lastrevisiondate,$owner,$copyright,      my $result;
  $hostname,$httphost,$extrashow)=@_;      $result .= '<b>'.$prefix.
           '<img src="'.&Apache::loncommon::icon($values{'url'}).' " />'.
           '<a href="http://'.$ENV{'HTTP_HOST'}.$values{'url'}.'" '.
           'target="search_preview">'.$values{'title'}."</a></b>\n";
       $result .= "<p>\n";
       $result .= '<b>'.$values{'author'}.'</b>,'.
           ' <i>'.$values{'owner'}.'</i><br />';
       foreach my $field 
           (
            { name=>'subject',
              translate => '<b>Subject:</b>&nbsp;[_1]',},
            { name=>'keywords',
              translate => '<b>Keywords:</b>&nbsp;[_1]',},
            { name=>'notes',
              translate => '<b>Notes:</b>&nbsp;[_1]',},
            { name=>'mimetag',
              translate => '<b>MIME Type:</b>&nbsp;[_1]',},
            { name=>'standards',
              translate => '<b>Standards:</b>[_1]',},
            { name=>'copyrighttag',
              translate => '<b>Copyright/Distribution:</b>&nbsp;[_1]',},
            { name=>'stdno',
              translate => '<b>Number of Students:</b>&nbsp;[_1]',},
            { name=>'avetries',
              translate => '<b>Average Tries:</b>&nbsp;[_1]',},
            { name=>'disc',
              translate => '<b>Degree of Discrimination:</b>&nbsp;[_1]',},
            { name=>'difficulty',
              translate => '<b>Degree of Difficulty:</b>&nbsp;[_1]',},
            { name=>'clear',
              translate => '<b>Clear:</b>&nbsp;[_1]',},
            { name=>'depth',
              translate => '<b>Depth:</b>&nbsp;[_1]',},
            { name=>'helpful',
              translate => '<b>Helpful:</b>&nbsp;[_1]',},
            { name=>'correct',
              translate => '<b>Correcy:</b>&nbsp;[_1]',},
            { name=>'technical',
              translate => '<b>Technical:</b>&nbsp;[_1]',},
            ) {
           $result.= &mt($field->{'translate'},$values{$field->{'name'}}).
               "<br />\n";
       }
       $result .= "</p>".$values{'extrashow'}.
           '<p>'.$values{'shortabstract'}.'</p>';
       $result .= '<hr align="left" width="200" noshade />'."\n";
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &summary_view() 
   
   =cut
   ######################################################################
   ######################################################################
   sub summary_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <i>$owner</i>, last revised $lastrevisiondate  $prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
 <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>     target='search_preview'>$values{'author'}</a><br />
 <h3>$author</h3>  $values{'title'}<br />
 </p>  $values{'owner'} -- $values{'lastrevisiondate'}<br />
 <p>  $values{'copyrighttag'}<br />
 <b>Subject:</b> $subject<br>  $values{'extrashow'}
 <b>Keyword(s):</b> $keywords<br>  
 <b>Notes:</b> $notes<br>  
 <b>MIME Type:</b> $mimetag{$mime}<br>  
 <b>Language:</b> $language{$lang}<br>  
 <b>Copyright/Distribution:</b> $cprtag{$copyright}<br>  
 </p>  
 $extrashow  
 <p>  
 $shortabstract  
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
   
 # ---------------------------------------------------------------- Summary View  ######################################################################
 sub summary_view {  ######################################################################
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  =pod 
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost,$extrashow)=@_;  =item &compact_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />  $prefix <img src="$icon" /> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"  target='search_preview'>
 $title<br />  $values{'title'}</a>
 $owner -- $lastrevisiondate<br />  <b>$values{'author'}</b><br />
 $cprtag{$copyright}<br />  
 $extrashow  
 </p>  
 END  END
     return $result;      return $result;
 }  }
   
 # -------------------------------------------------------------- Fielded Format  
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &fielded_format_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my ($title,$author,$subject,$url,$keywords,$version,      my ($prefix,%values) = @_;
  $notes,$shortabstract,$mime,$lang,      my $icon=&Apache::loncommon::icon($values{'url'});
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost,$extrashow)=@_;  
     my $result=<<END;      my $result=<<END;
 <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>  $prefix <img src="$icon" />
   <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
                 target='search_preview'>$values{'url'}</a>
 <br />  <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{$mime}<br />  <b>MIME Type:</b> $values{'mimetag'}<br />
 <b>Language:</b> $language{$lang}<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{$copyright}<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>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
   
 # -------------------------------------------------------------------- XML/SGML  ######################################################################
   ######################################################################
   
   =pod 
   
   =item &xml_sgml_view() 
   
   =back 
   
   =cut
   
   ######################################################################
   ######################################################################
 sub xml_sgml_view {  sub xml_sgml_view {
     my ($title,$author,$subject,$url,$keywords,$version,      my ($prefix,%values) = @_;
  $notes,$shortabstract,$mime,$lang,      my $xml = <<END;
  $creationdate,$lastrevisiondate,$owner,$copyright,  <LonCapaResource>
  $hostname,$httphost,$extrashow)=@_;  <url>$values{'url'}</url>
   <title>$values{'title'}</title>
   <author>$values{'author'}</author>
   <subject>$values{'subject'}</subject>
   <keywords>$values{'keywords'}</keywords>
   <notes>$values{'notes'}</notes>
   <mimeInfo>
   <mime>$values{'mime'}</mime>
   <mimetag>$values{'mimetag'}</mimetag>
   </mimeInfo>
   <languageInfo>
   <language>$values{'language'}</language>
   <languagetag>$values{'languagetag'}</languagetag>
   </languageInfo>
   <creationdate>$values{'creationdate'}</creationdate>
   <lastrevisiondate>$values{'lastrevisiondate'}</lastrevisiondate>
   <owner>$values{'owner'}</owner>
   <copyrightInfo>
   <copyright>$values{'copyright'}</copyright>
   <copyrighttag>$values{'copyrighttag'}</copyrighttag>
   </copyrightInfo>
   <repositoryLocation>$values{'hostname'}</repositoryLocation>
   <shortabstract>$values{'shortabstract'}</shortabstract>
   </LonCapaResource>
   END
       $xml = &HTML::Entities::encode($xml,'<>&');
     my $result=<<END;      my $result=<<END;
   $prefix
 <pre>  <pre>
 &lt;LonCapaResource&gt;  $xml
 &lt;url&gt;$url&lt;/url&gt;  
 &lt;title&gt;$title&lt;/title&gt;  
 &lt;author&gt;$author&lt;/author&gt;  
 &lt;subject&gt;$subject&lt;/subject&gt;  
 &lt;keywords&gt;$keywords&lt;/keywords&gt;  
 &lt;notes&gt;$notes&lt;/notes&gt;  
 &lt;mimeInfo&gt;  
 &lt;mime&gt;$mime&lt;/mime&gt;  
 &lt;mimetag&gt;$mimetag{$mime}&lt;/mimetag&gt;  
 &lt;/mimeInfo&gt;  
 &lt;languageInfo&gt;  
 &lt;language&gt;$lang&lt;/language&gt;  
 &lt;languagetag&gt;$language{$lang}&lt;/languagetag&gt;  
 &lt;/languageInfo&gt;  
 &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;  
 &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;  
 &lt;owner&gt;$owner&lt;/owner&gt;  
 &lt;copyrightInfo&gt;  
 &lt;copyright&gt;$copyright&lt;/copyright&gt;  
 &lt;copyrighttag&gt;$cprtag{$copyright}&lt;/copyrighttag&gt;  
 &lt;/copyrightInfo&gt;  
 &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;  
 &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;  
 &lt;/LonCapaResource&gt;  
 </pre>  </pre>
 $extrashow  $values{'extrashow'}
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
   
 sub build_date_queries {  ######################################################################
     my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,  ######################################################################
  $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;  
     my @queries;  =pod 
     if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {  
  unless ($cmonth1 and $cday1 and $cyear1 and  =item &filled() see if field is filled.
  $cmonth2 and $cday2 and $cyear2) {  
     return "Incorrect entry for the creation date.  You must specify ".  =cut
    "a starting month, day, and year and an ending month, ".  
    "day, and year.";  ######################################################################
  }  ######################################################################
  my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);  sub filled {
  $cnumeric1+=0;      my ($field)=@_;
  my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);      if ($field=~/\S/ && $field ne 'any') {
  $cnumeric2+=0;          return 1;
  if ($cnumeric1>$cnumeric2) {      } else {
     return "Incorrect entry for the creation date.  The starting ".          return 0;
    "date must occur before the ending date.";  
  }  
  my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".  
            "$cyear2-$cmonth2-$cday2 23:59:59')";  
  push @queries,$cquery;  
     }  
     if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {  
  unless ($lmonth1 and $lday1 and $lyear1 and  
  $lmonth2 and $lday2 and $lyear2) {  
     return "Incorrect entry for the last revision date.  You must ".  
    "specify a starting month, day, and year and an ending ".  
    "month, day, and year.";  
  }  
  my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);  
  $lnumeric1+=0;  
  my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);  
  $lnumeric2+=0;  
  if ($lnumeric1>$lnumeric2) {  
     return "Incorrect entry for the last revision date.  The ".  
    "starting date must occur before the ending date.";  
  }  
  my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".  
            "$lyear2-$lmonth2-$lday2 23:59:59')";  
  push @queries,$lquery;  
     }  
     if (@queries) {  
  return join(" AND ",@queries);  
     }      }
     return '';  
 }  }
   
 sub output_date_error {  ######################################################################
     my ($r,$message)=@_;  ######################################################################
     # make query information persistent to allow for subsequent revision  
     my $persistent=&make_persistent();  =pod 
   
   =item &output_blank_field_error()
   
   Output a complete page that indicates the user has not filled in enough
   information to do a search.
   
   Inputs: $r (Apache request handle), $closebutton, $parms.
   
   Returns: nothing
   
   $parms is extra information to include in the 'Revise search request' link.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub output_blank_field_error {
       my ($r,$closebutton,$parms,$hidden_fields)=@_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       # make query information persistent to allow for subsequent revision
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
 <head>  <head>
Line 1117  sub output_date_error { Line 3064  sub output_date_error {
 BEGINNING  BEGINNING
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
   <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}"
   >Revise search request</a>&nbsp;
   $closebutton
   <hr />
   <h3>Unactionable search query.</h3>
   <p>
   You did not fill in enough information for the search to be started.
   You need to fill in relevant fields on the search page in order 
   for a query to be processed.
   </p>
   </body>
   </html>
   RESULTS
   }
   
   ######################################################################
   ######################################################################
   
   =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,$closebutton,$hidden_fields)=@_;
       # make query information persistent to allow for subsequent revision
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       $r->print(<<RESULTS);
   <html>
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   $bodytag
   <img align='right' src='/adm/lonIcons/lonlogos.gif' />
   <h1>Search Catalog</h1>
   <form method="post" action="/adm/searchcat">
   $hidden_fields
 <input type='button' value='Revise search request'  <input type='button' value='Revise search request'
 onClick='this.form.submit();'>  onClick='this.form.submit();' />
 $closebutton  $closebutton
 <hr>  <hr />
 <h3>Helpful Message</h3>  <h3>Error</h3>
 <p>  <p>
 $message  $message
 </p>  </p>
Line 1135  $message Line 3130  $message
 RESULTS  RESULTS
 }  }
   
 sub make_persistent {  ######################################################################
     my $persistent='';  ######################################################################
       
     map {  =pod 
  if (/^form\./ && !/submit/) {  
     my $name=$_;  =item &start_fresh_session()
     my $key=$name;  
     $ENV{$key}=~s/\'//g; # do not mess with html field syntax  Cleans the global %groupsearch_db by removing all fields which begin with
     $name=~s/^form\.//;  'pre_' or 'store'.
     $persistent.=<<END;  
 <input type='hidden' name='$name' value='$ENV{$key}' />  =cut
 END  
   ######################################################################
   ######################################################################
   sub start_fresh_session {
       delete $groupsearch_db{'mode_catalog'};
       foreach (keys %groupsearch_db) {
           if ($_ =~ /^pre_/) {
               delete $groupsearch_db{$_};
         }          }
     } (keys %ENV);          if ($_ =~ /^store/) {
     return $persistent;      delete $groupsearch_db{$_};
    }
       }
 }  }
   
 1;  1;
   
   sub cleanup {
       if (tied(%groupsearch_db)) {
           unless (untie(%groupsearch_db)) {
     &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
           }
       }
       &untiehash();
       &Apache::lonmysql::disconnect_from_db();
   }
   
 __END__  __END__
   
   =pod
   
   =back 
   
   =cut

Removed from v.1.91  
changed lines
  Added in v.1.221


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