[BACK]Return to lonsearchcat.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonsearchcat.pm between versions 1.121 and 1.239

version 1.121, 2002/06/18 21:36:38 version 1.239, 2005/03/16 22:46:24
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # YEAR=2001  
 # 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison  
 # 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison  
 # 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison  
 # YEAR=2002  
 # 1/17 Scott Harrison  
 # 6/17 Matthew Hall  
 #  
 ###############################################################################  ###############################################################################
 ###############################################################################  ###############################################################################
   
Line 40 Line 32
   
 =head1 NAME  =head1 NAME
   
 lonsearchcat  lonsearchcat - LONCAPA Search Interface
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
Line 56  described at http://www.lon-capa.org. Line 48  described at http://www.lon-capa.org.
 lonsearchcat presents the user with an interface to search the LON-CAPA  lonsearchcat presents the user with an interface to search the LON-CAPA
 digital library.  lonsearchcat also initiates the execution of a search  digital library.  lonsearchcat also initiates the execution of a search
 by sending the search parameters to LON-CAPA servers.  The progress of   by sending the search parameters to LON-CAPA servers.  The progress of 
 search (on a server basis) is displayed to the user in a seperate window.  search (on a server basis) is displayed to the user in a separate window.
   
 =head1 Internals  =head1 Internals
   
Line 67  search (on a server basis) is displayed Line 59  search (on a server basis) is displayed
 ###############################################################################  ###############################################################################
 ###############################################################################  ###############################################################################
   
 ##                                                                           ##  
 ## ORGANIZATION OF THIS PERL MODULE                                          ##  
 ##                                                                           ##  
 ## 1. Modules used by this module                                            ##  
 ## 2. Choices for different output views (detailed, summary, xml, etc)       ##  
 ## 3. BEGIN block (to be run once after compilation)                         ##  
 ## 4. Handling routine called via Apache and mod_perl                        ##  
 ## 5. Other subroutines                                                      ##  
 ##                                                                           ##  
 ###############################################################################  
   
 package Apache::lonsearchcat;  package Apache::lonsearchcat;
   
 # ------------------------------------------------- modules used by this module  
 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 GDBM_File;
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::lonmysql();
   use Apache::lonmeta;
   use Apache::lonhtmlcommon;
   use Apache::lonlocal;
   use LONCAPA::lonmetadata();
   use HTML::Entities();
   use Parse::RecDescent;
   use Apache::lonnavmaps;
   
 # ---------------------------------------- variables used throughout the module  ######################################################################
   ######################################################################
   ##
   ## 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);
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub handler {
       my $r = shift;
   #    &set_defaults();
       #
       # set form defaults
       #
       my $hidden_fields;# Hold all the hidden fields used to keep track
                         # of the search system state
       my $importbutton; # button to take the selected results and go to group 
                         # sorting
       my $diropendb;    # The full path to the (temporary) search database file.
                         # This is set and used in &handler() and is also used in 
                         # &output_results().
       my $bodytag;  # LON-CAPA standard body tag, gotten from 
                     # &Apache::lonnet::bodytag. 
                     # No title, no table, just a <body> tag.
   
 =pod       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
       #
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
       &Apache::loncommon::content_type($r,'text/html');
       $r->send_http_header;
       return OK if $r->header_only;
       ##
       ## Prevent caching of the search interface window.  Hopefully this means
       ## we will get the launch=1 passed in a little more.
       &Apache::loncommon::no_cache($r);
       ## 
       ## Pick up form fields passed in the links.
       ##
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element','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",
                 target=>'_top',
                 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",
                 target=>'_top',
                 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);
    my $html=&Apache::lonxml::xmlbegin();
    $r->print(<<END);
   $html
   <head>
   <title>LON-CAPA Search Error</title></head>
   $bodytag
   We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
   END
                   return OK;
               }
           }
       } 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.
       my $html=&Apache::lonxml::xmlbegin();
       $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 .= &hidden_field('catalogmode');
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= &hidden_field('form');
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= &hidden_field('element');
       }
       if (exists($ENV{'form.titleelement'})) {
           $hidden_fields .= &hidden_field('titleelement');
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= &hidden_field('mode');
       }
       ##
       ## 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
       } else {
           $closebutton = '';
           $importbutton = '';
       }
       ##
       ## Sanity checks on form elements
       ##
       if (!defined($ENV{'form.viewselect'})) {
           if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
               ($ENV{'form.catalogmode'} eq 'interactive')) {
               $ENV{'form.viewselect'} ="Compact View";
           } else {
               $ENV{'form.viewselect'} ="Detailed Citation View";
           }
       }
       $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
       $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
       #
       $ENV{'form.searchmode'} = 'basic' if (! exists($ENV{'form.searchmode'}));
       if ($ENV{'form.phase'} eq 'adv_search' ||
           $ENV{'form.phase'} eq 'disp_adv') {
           $ENV{'form.searchmode'} = 'advanced';
       } elsif ($ENV{'form.phase'} eq 'course_search') {
           $ENV{'form.searchmode'} = 'course_search';
       }
       #
       if ($ENV{'form.searchmode'} eq 'advanced') {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Advanced Search",
                     bug=>'Searching',});
       } elsif ($ENV{'form.searchmode'} eq 'course search') {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Course Search",
                     bug=>'Searching',});
       }
       ##
       ## 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')) {
           #
           # We are running a search, try to parse it
           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);
               return OK if (! defined($query));
               &make_persistent({ basicexp => $ENV{'form.basicexp'}},
                                $persistent_db_file);
           } 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);
           #
           # 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);
       my $html=&Apache::lonxml::xmlbegin();
               $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)) {
       my $html=&Apache::lonxml::xmlbegin();
       $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;
           }
           ##
           ## Print out the frames interface
           ##
           if (defined($query)) {
               &print_frames_interface($r);
           }
       }
       return OK;
   } 
   
 =item Global variables  #
   # The mechanism used to store values away and retrieve them does not
   # handle the case of missing environment variables being significant.
   #
   # This routine sets non existant checkbox form elements to ''.
   #
   sub clean_up_environment {
       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'} = '';
           }
       }
   }
   
 =over 4  sub hidden_field {
       my ($name,$value) = @_;
       if (! defined($value)) {
           $value = $ENV{'form.'.$name};
       }
       return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'.$/;
   }
   
 =item %hostdomains  ######################################################################
   ######################################################################
   ##
   ##   Course Search
   ##
   ######################################################################
   ######################################################################
   {   # Scope the course search to avoid global variables
   #
   # Variables For course search
   my %alreadyseen;
   my %hash;
   my $totalfound;
   
   sub make_symb {
       my ($id)=@_;
       my ($mapid,$resid)=split(/\./,$id);
       my $map=$hash{'map_id_'.$mapid};
       my $res=$hash{'src_'.$id};
       my $symb=&Apache::lonnet::encode_symb($map,$resid,$res);
       return $symb;
   }
   
   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;
       undef(%alreadyseen);
       if ($ENV{'form.crsrelated'}) {
           ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
           if (@New_Words) {
               $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= ' '.&mt('with no related words').".";
           }
       }
       my $fulltext=$ENV{'form.crsfulltext'};
       my $discuss=$ENV{'form.crsdiscuss'};
       my @allwords=($search_string,@New_Words);
       $totalfound=0;
       my $html=&Apache::lonxml::xmlbegin();
       $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 /><b>'.&mt('Course content').':</b><br />');
       $r->rflush();
   # ======================================================= Go through the course
       my $c=$r->connection;
       if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
           foreach (sort(keys(%hash))) {
               if ($c->aborted()) { last; }
               if (($_=~/^src\_(.+)$/)) {
    if ($hash{'randomout_'.$1} & !$ENV{'request.role.adv'}) {
       next; 
    }
    my $symb=&make_symb($1);
                   &checkonthis($r,$1,$hash{$_},0,&Apache::lonnet::gettitle($symb),
        $fulltext,$symb,@allwords);
               }
           }
           untie(%hash);
       }
       unless ($totalfound) {
    $r->print('<p>'.&mt('No matches found in resources').'.</p>');
       }
   
 matches host name to host domain  # Check discussions if requested
       if ($discuss) {
           my $totaldiscussions = 0;
           $r->print('<br /><br /><b>'.&mt('Discussion postings').':</b><br />'); 
           my $navmap = Apache::lonnavmaps::navmap->new();
           my @allres=$navmap->retrieveResources();
           my %discussiontime = &Apache::lonnet::dump('discussiontimes',
                                  $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
                                  $ENV{'course.'.$ENV{'request.course.id'}.'.num'});
           foreach my $resource (@allres) {
               my $result = '';
               my $applies = 0;
               my $symb = $resource->symb();
               my $ressymb = $symb;
               if ($symb =~ m#(___adm/\w+/\w+)/(\d+)/bulletinboard$#) {
                   $ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
                   unless ($ressymb =~ m#bulletin___\d+___adm/wrapper#) {
                       $ressymb=~s#(bulletin___\d+___)#$1adm/wrapper/#;
                   }
               }
               if (defined($discussiontime{$ressymb})) { 
                   my %contrib = &Apache::lonnet::restore($ressymb,$ENV{'request.course.id'},
                        $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
                        $ENV{'course.'.$ENV{'request.course.id'}.'.num'});
                   if ($contrib{'version'}) {
                       for (my $id=1;$id<=$contrib{'version'};$id++) {
                           unless (($contrib{'hidden'}=~/\.$id\./) || ($contrib{'deleted'}=~/\.$id\./)) { 
                               if ($contrib{$id.':subject'}) {
                                   $result .= $contrib{$id.':subject'};
                               }
                               if ($contrib{$id.':message'}) {
                                   $result .= $contrib{$id.':message'};
                               }
                               if ($contrib{$id,':attachmenturl'}) {
                                   if ($contrib{$id,':attachmenturl'} =~ m-/([^/]+)$-) {
                                       $result .= $1;
                                   }
                               }
                               $applies = &checkwords($result,$applies,@allwords);
                           }
                       }
                   }
               }
   # Does this discussion apply?
               if ($applies) {
                   my ($map,$ind,$url)=&Apache::lonnet::decode_symb($ressymb);
                   my $disctype = &mt('resource');
                   if ($url =~ m#/bulletinboard$#) {
                       if ($url =~m#^adm/wrapper/adm/.*/bulletinboard$#) {
                           $url =~s#^adm/wrapper##;
                       }
                       $disctype = &mt('bulletin board');
                   } else {
                       $url = '/res/'.$url;
                   }
                   if ($url =~ /\?/) {
                       $url .= '&symb=';
                   } else {
                       $url .= '?symb=';
                   }
                   $url .= &Apache::lonnet::escape($resource->symb());
                   my $title = $resource->compTitle();
                   $r->print('<br /><a href="'.$url.'" target="cat">'.
                        ($title?$title:$url).'</a>&nbsp;&nbsp;-&nbsp;'.$disctype.'<br />');
                   $totaldiscussions++;
               } else {
                   $r->print(' .');
               }
           }
           unless ($totaldiscussions) {
               $r->print('<p>'.&mt('No matches found in postings').'.</p>');
           }
       }
    
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
 =item %hostips  # =============================== This pulls up a resource and its dependencies
   
 matches host name to host ip  sub checkonthis {
       my ($r,$id,$url,$level,$title,$fulltext,$symb,@allwords)=@_;
       $alreadyseen{$id}=1;
       if (&Apache::loncommon::connection_aborted($r)) { return; }
       $r->rflush();
       
       my $result=$title.' ';
       if ($ENV{'request.role.adv'} || !$hash{'encrypted_'.$id}) {
    $result.=&Apache::lonnet::metadata($url,'title').' '.
       &Apache::lonnet::metadata($url,'subject').' '.
       &Apache::lonnet::metadata($url,'abstract').' '.
       &Apache::lonnet::metadata($url,'keywords');
       }
       my ($extension)=($url=~/\.(\w+)$/);
       if (&Apache::loncommon::fileembstyle($extension) eq 'ssi' &&
    ($url) && ($fulltext)) {
    $result.=&Apache::lonnet::ssi_body($url.'?symb='.&Apache::lonnet::escape($symb));
       }
       $result=~s/\s+/ /gs;
       my $applies = 0;
       $applies = &checkwords($result,$applies,@allwords);
   # Does this resource apply?
       if ($applies) {
          $r->print('<br />');
          for (my $i=0;$i<=$level*5;$i++) {
              $r->print('&nbsp;');
          }
          my $href=$url;
          if ($hash{'encrypted_'.$id} && !$ENV{'request.role.adv'}) {
      $href=&Apache::lonenc::encrypted($href)
          .'?symb='.&Apache::lonenc::encrypted($symb);
          } else {
      $href.='?symb='.&Apache::lonnet::escape($symb);
          }
          $r->print('<a href="'.$href.'" 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{$id})) { 
             &checkonthis($r,$id,$_,$level+1,'',$fulltext,undef,@allwords);
          }
       }
   }
   
 =item %hitcount  sub checkwords {
       my ($result,$applies,@allwords) = @_;
       foreach (@allwords) {
           if ($_=~/\w/) {
               if ($result=~/$_/si) {
                   $applies++;
               }
           }
       }
       return $applies;
   }
   
 stores number of hits per host  sub untiehash {
       if (tied(%hash)) {
           untie(%hash);
       }
   }
   
 =item $closebutton  } # End of course search scoping
   
 button that closes the search window  sub search_html_header {
       my $html=&Apache::lonxml::xmlbegin();
       my $Str = <<ENDHEADER;
   $html
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   ENDHEADER
       return $Str;
   }
   
 =item $importbutton  ######################################################################
   ######################################################################
   
 button to take the selecte results and go to group sorting  =pod 
   
 =item $hidden  =item &print_basic_search_form() 
   
 holds 'hidden' html forms  Prints the form for the basic search.  Sorry the name is so cryptic.
   
 =item $scrout  =cut
   
 string that holds portions of the screen output  ######################################################################
   ######################################################################
   sub print_basic_search_form {
       my ($r,$closebutton,$hidden_fields) = @_;
       my $result = ($ENV{'form.catalogmode'} ne 'groupsearch');
       my $bodytag=&Apache::loncommon::bodytag('Search').
           &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Search_Basic',
                                      undef,undef,
                                      $ENV{'form.catalogmode'} ne 'groupsearch');
       my $scrout = &search_html_header().$bodytag;
       if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
           # Define interface components
           my $userelatedwords= '<label>'.
               &mt('[_1] use related words',
                   &Apache::lonhtmlcommon::checkbox
                   ('related',$ENV{'form.related'},'related')).'</label>';
           my $onlysearchdomain='<label>'.
               &mt('[_1] only search domain [_2]',
                   &Apache::lonhtmlcommon::checkbox('domains',
                                                    $ENV{'form.domains'},
                                                    $r->dir_config('lonDefDomain')
                                                    ),
                   $r->dir_config('lonDefDomain')
                   ).'</label>';
           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',
                &HTML::Entities::encode($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" 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)',
            'disc' => 'search discussion postings (resources and bulletin boards)',
      );
           $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>
   $lt{'note'}.
   </p>
   <p>
   <table>
   <tr><td>
   ENDCOURSESEARCH
           $scrout.='&nbsp;'.
               &Apache::lonhtmlcommon::textbox('courseexp',
                                     $ENV{'form.courseexp'},40);
           my $crscheckbox = 
               &Apache::lonhtmlcommon::checkbox('crsfulltext',
                                      $ENV{'form.crsfulltext'});
           my $relcheckbox = 
               &Apache::lonhtmlcommon::checkbox('crsrelated',
      $ENV{'form.crsrelated'});
           my $discheckbox = 
               &Apache::lonhtmlcommon::checkbox('crsdiscuss',
                                      $ENV{'form.crsrelated'});
           $scrout.=(<<ENDENDCOURSE);
   </td></tr>
   <tr><td><label>$relcheckbox $lt{'use'}</label></td><td></td></tr>
   <tr><td><label>$crscheckbox $lt{'full'}</label></td><td></td></tr>
   <tr><td><label>$discheckbox $lt{'disc'}</label></td><td></td></tr>
   </table><p>
   &nbsp;<input type="submit" name="coursesubmit" value='$lt{'srch'}' />
   </p>
   </center>
   </form>
   ENDENDCOURSE
       }
       $scrout.=(<<ENDDOCUMENT);
   </body>
   </html>
   ENDDOCUMENT
       $r->print($scrout);
       return;
   }
   ######################################################################
   ######################################################################
   
 =item $yourself  =pod 
   
 allows for quickly limiting to oneself  =item &advanced_search_form() 
   
 =item %hash     Prints the advanced search form.
   
 The ubiquitous database hash  =cut
   
 =item $basicviewselect and $advancedviewselect  ######################################################################
   ######################################################################
   sub print_advanced_search_form{
       my ($r,$closebutton,$hidden_fields) = @_;
       my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search').
           &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching',
                                               'Search_Advanced',
                                               undef,undef,
                                     $ENV{'form.catalogmode'} ne 'groupsearch');
       my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
          'reset' => 'Reset',
          'help' => 'Help');
       my $advanced_buttons=<<"END";
   <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
   <input type="reset" name="reset" value='$lt{"reset"}' />
   $closebutton
   END
       my $scrout=&search_html_header();
       $scrout .= <<"ENDHEADER";
   $bodytag
   <form method="post" action="/adm/searchcat" name="advsearch">
   <p>
   $advanced_buttons
   ENDHEADER
       $scrout.=('&nbsp;'x2).&viewoptions().'</p>'.$hidden_fields. 
           '<input type="hidden" name="phase" value="adv_search" />';
       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',
                                       $ENV{'form.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',
                                       $ENV{'form.language'},
                                       \&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=>'count',
              description=>'Network-wide number of accesses (hits)',},
            { name=>'stdno',
              description=>
                  'Total number of students who have worked on this problem',},
            { name => 'avetries',
              description=>'Average number of tries till solved',},
            { 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>
   </body>
   </html>
   ENDDOCUMENT
       $r->print($scrout);
       return;
   }
   
 View selection forms.  These are not actually global and will be   ######################################################################
 moved soon.  ######################################################################
   
 =item $diropendb   =pod 
   
 The full path to the (temporary) search database file.  This is set and  =item &titlefield()
 used in &handler() and is also used in &output_results().  
   
 =back   Inputs: title text
   
   Outputs: titletext with font wrapper
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub titlefield {
       my $title=shift;
       return $title;
   }
   
 # -- information holders  ######################################################################
 my %hostdomains; # matches host name to host domain  ######################################################################
 my %hostips;     # matches host name to host ip  
 my %hitcount;    # stores number of hits per host  
   
 # -- dynamically rendered interface components  
 my $closebutton;  # button that closes the search window  
 my $importbutton; # button to take the selected results and go to group sorting  
 my $hidden;       # Holds 'hidden' html forms  
   
 # -- miscellaneous variables  
 my $scrout;   # string that holds portions of the screen output  
 my $yourself; # allows for quickly limiting to oneself  
 my %hash;     # database hash  
   
 # ------------------------------------------ choices for different output views  
 # Detailed Citation View ---> sub detailed_citation_view  
 # Summary View ---> sub summary_view  
 # Fielded Format ---> sub fielded_format_view  
 # XML/SGML ---> sub xml_sgml_view  
 my $basicviewselect=<<END;  
 <select name='basicviewselect'>  
 <option value='Detailed Citation View' selected="true">  
 Detailed Citation View</option>  
 <option value='Summary View'>Summary View</option>  
 <option value='Fielded Format'>Fielded Format</option>  
 <option value='XML/SGML'>XML/SGML</option>  
 </select>  
 END  
 my $advancedviewselect=<<END;  
 <select name='advancedviewselect'>  
 <option value='Detailed Citation View' selected="true">  
 Detailed Citation View</option>  
 <option value='Summary View'>Summary View</option>  
 <option value='Fielded Format'>Fielded Format</option>  
 <option value='XML/SGML'>XML/SGML</option>  
 </select>  
 END  
   
 #------------------------------------------------------------- global variables  
 my $diropendb = "";  
 my $domain = "";  
   
 # ----------------------------------------------------------------------- BEGIN  =pod 
   
 =pod  =item viewoptiontext()
   
 =item BEGIN block  Inputs: codename for view option
   
 Load %hostdomains and %hostips with data from lonnet.pm.  Only library  Outputs: displayed text
 servers are considered.  
   
 =cut  =cut
   
 BEGIN {  ######################################################################
     foreach (keys (%Apache::lonnet::libserv)) {  ######################################################################
         $hostdomains{$_}=$Apache::lonnet::hostdom{$_};  sub viewoptiontext {
         $hostips{$_}=$Apache::lonnet::hostip{$_};      my $code=shift;
     }      my %desc=&Apache::lonlocal::texthash
           ('detailed' => "Detailed Citation View",
            'xml' => 'XML/SGML',
            'compact' => 'Compact View',
            'fielded' => 'Fielded Format',
            'summary' => 'Summary View');
       return $desc{$code};
 }  }
   
 ######################################################################  ######################################################################
Line 220  BEGIN { Line 1084  BEGIN {
   
 =pod   =pod 
   
 =item &handler() - main handler invoked by httpd child  =item viewoptions()
   
   Inputs: none
   
   Outputs: text for box with view options
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 # ----------------------------- Handling routine called via Apache and mod_perl  sub viewoptions {
 sub handler {      my $scrout;
     my $r = shift;      if (! defined($ENV{'form.viewselect'})) { 
     untie %hash;          $ENV{'form.viewselect'}='detailed'; 
       }
     $r->content_type('text/html');      $scrout.=&Apache::lonmeta::selectbox('viewselect',
     $r->send_http_header;   $ENV{'form.viewselect'},
     return OK if $r->header_only;   \&viewoptiontext,
    sort(keys(%Views)));
     my $domain  = $r->dir_config('lonDefDomain');      $scrout.= '&nbsp;&nbsp;';
     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::unescape($domain).      my $countselect = &Apache::lonmeta::selectbox('show',
             "\_".&Apache::lonnet::unescape($ENV{'user.name'})."_searchcat.db";                                                    $ENV{'form.show'},
                                                     undef,
                                                     (10,20,50,100,1000,10000));
       $scrout .= ('&nbsp;'x2).&mt('[_1] Records per Page',$countselect).
           '</nobr>'.$/;
       return $scrout;
   }
   
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},  ######################################################################
              ['catalogmode','launch','acts','mode','form','element']);  ######################################################################
   
     if ($ENV{'form.launch'} eq '1') {  =pod 
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
     &start_fresh_session();  
     untie %hash;  
  }  
  else {  
     $r->print('<html><head></head><body>Unable to tie hash to db '.  
       'file</body></html>');  
     return OK;  
  }  
     }  
   
 # --------------------------- Produce some output, so people know it is working  =item searchhelp()
   
     $r->print("\n");  Inputs: none
     $r->rflush;  
   
 # ----------------------------------- configure dynamic components of interface  Outputs: return little blurb on how to enter searches
   
     if ($ENV{'form.catalogmode'} eq 'interactive') {  =cut
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".  
     "\n";  
         $closebutton="<input type='button' name='close' value='CLOSE' ".  
     "onClick='self.close()'>"."\n";  
     }  
     elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {  
  $hidden=<<END;  
 <input type='hidden' name='catalogmode' value='groupsearch'>  
 END  
         $closebutton=<<END;  
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>  
 END  
         $importbutton=<<END;  
 <input type='button' name='import' value='IMPORT'  
 onClick='javascript:select_group()'>  
 END  
     }  
     $hidden .= <<END;  
 <input type='hidden' name='mode'    value='$ENV{'form.mode'}'>  
 <input type='hidden' name='form'    value='$ENV{'form.form'}'>  
 <input type='hidden' name='element' value='$ENV{'form.element'}'>  
 <input type='hidden' name='date' value='2'>  
 END  
 # ------------------------------------------------------ Determine current user  
     $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'};  
   
 # --- Now, depending on the interface actions, do one of three things here:  ######################################################################
 # --- 1. a basic search  ######################################################################
 # --- 2. an advanced search  sub searchhelp {
 # --- 3. output a search interface      return &mt('Enter words and quoted phrases');
   }
   
 # ----------------------------------- See if a search invocation should be done  ######################################################################
     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {  ######################################################################
  untie %hash; return &basicsearch($r,\%ENV);  
     }  
     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {  
  untie %hash; return &advancedsearch($r,\%ENV);  
     }  
   
 # ----------------------------- Else, begin building search interface to output  =pod 
     $scrout=''; # building a part of screen output  
     $scrout.=&searchphrasefield('Limit by title','title',  
  $ENV{'form.title'});  
   
     $scrout.=&searchphrasefield('Limit by author','author',  =item &get_persistent_form_data()
  $ENV{'form.author'});  
   
     $scrout.=&searchphrasefield('Limit by subject','subject',  Inputs: filename of database
  $ENV{'form.subject'});  
   
     $scrout.=&searchphrasefield('Limit by keywords','keywords',  Outputs: returns undef on database errors.
  $ENV{'form.keywords'});  
   
     $scrout.=&searchphrasefield('Limit by URL','url',  This function is the reverse of &make_persistent() for form data.
  $ENV{'form.url'});  Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If a form value already exists in $ENV, it will not be
   overwritten.  Form values that are array references may have values appended
   to them.
   
 #    $scrout.=&searchphrasefield('Limit by version','version',  =cut
 # $ENV{'form.version'});  
   
     $scrout.=&searchphrasefield('Limit by notes','notes',  ######################################################################
  $ENV{'form.notes'});  ######################################################################
   sub get_persistent_form_data {
       my $filename = shift;
       return 0 if (! -e $filename);
       return undef if (! tie(%persistent_db,'GDBM_File',$filename,
                              &GDBM_READER(),0640));
       #
       # These make sure we do not get array references printed out as 'values'.
       my %arrays_allowed = ('form.domains'=>1);
       #
       # Loop through the keys, looking for 'form.'
       foreach my $name (keys(%persistent_db)) {
           next if ($name !~ /^form./);
           # Kludgification begins!
           if ($name eq 'form.domains' && 
               $ENV{'form.searchmode'} eq 'basic' &&
               $ENV{'form.phase'} ne 'disp_basic') {
               next;
           }
           # End kludge (hopefully)
           next if (exists($ENV{$name}));
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           next if (@values <1);
           if ($arrays_allowed{$name}) {
               $ENV{$name} = [@values];
           } else {
               $ENV{$name} = $values[0] if ($values[0]);
           }
       }
       untie (%persistent_db);
       return 1;
   }
   
     $scrout.=&searchphrasefield('Limit by abstract','abstract',  ######################################################################
  $ENV{'form.abstract'});  ######################################################################
   
     $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});  =pod 
     $scrout.=&selectbox('Limit by MIME type','mime',  
  $ENV{'form.mime'},  
  'any','Any type',  
  \&{Apache::loncommon::filedescriptionex},  
  (&Apache::loncommon::fileextensions));  
   
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});  =item &get_persistent_data()
   
     $scrout.=&selectbox('Limit by language','language',  Inputs: filename of database, ref to array of values to recover.
  $ENV{'form.language'},'any','Any Language',  
  \&{Apache::loncommon::languagedescription},  
  (&Apache::loncommon::languageids),  
  );  
   
 # ------------------------------------------------ Compute date selection boxes  Outputs: array of values.  Returns undef on error.
     $scrout.=<<CREATIONDATESTART;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>  
 </font>  
 <br />  
 between:  
 CREATIONDATESTART  
     $scrout.=&dateboxes('creationdatestart',1,1,1976,  
  $ENV{'form.creationdatestart_month'},  
  $ENV{'form.creationdatestart_day'},  
  $ENV{'form.creationdatestart_year'},  
  );  
     $scrout.=<<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;  This function is the reverse of &make_persistent();
 <p>  Retrieve persistent data from %persistent_db.  Retrieved items will have their
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:  values unescaped.  If the item contains commas (before unescaping), the
 </b></font>  returned value will be an array pointer. 
 <br />between:  
 LASTREVISIONDATESTART  
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,  
  $ENV{'form.lastrevisiondatestart_month'},  
  $ENV{'form.lastrevisiondatestart_day'},  
  $ENV{'form.lastrevisiondatestart_year'},  
  );  
     $scrout.=<<LASTREVISIONDATEEND;  
 and:  
 LASTREVISIONDATEEND  
     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,  
  $ENV{'form.lastrevisiondateend_month'},  
  $ENV{'form.lastrevisiondateend_day'},  
  $ENV{'form.lastrevisiondateend_year'},  
  );  
     $scrout.='</p>';  
   
     $scrout.=&searchphrasefield('Limit by publisher/owner','owner',  
  $ENV{'form.owner'});  
   
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});  
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',  
  $ENV{'form.copyright'},  
  'any','Any copyright/distribution',  
  \&{Apache::loncommon::copyrightdescription},  
  (&Apache::loncommon::copyrightids),  
  );  
   
 # ------------------------------------------- Compute customized metadata field  =cut
     $scrout.=<<CUSTOMMETADATA;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>  
 </font>  
 For resource-specific metadata, enter in an expression in the form of   
 <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />  
 <b>Example:</b> grandmother=75 OR grandfather=85  
 <br />  
 CUSTOMMETADATA  
 $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});  
 $scrout.=' <i>initial users of this system do not need to worry about this option</i>';  
   
     $scrout.=<<CUSTOMSHOW;  ######################################################################
 <p>  ######################################################################
 <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>  sub get_persistent_data {
 </font>      my $filename = shift;
 Enter in a space-separated list of special metadata fields to show      my @Vars = @{shift()};
 in a fielded listing for each record result.      my @Values;   # Return array
 <br />      return undef if (! -e $filename);
 CUSTOMSHOW      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
 $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});                             &GDBM_READER(),0640));
 $scrout.=' <i>initial users of this system do not need to worry about this option</i>';      foreach my $name (@Vars) {
           if (! exists($persistent_db{$name})) {
 # ---------------------------------------------------------------- Print screen              push @Values, undef;
     $r->print(<<ENDDOCUMENT);              next;
 <html>          }
 <head>          my @values = map { 
 <title>The LearningOnline Network with CAPA</title>              &Apache::lonnet::unescape($_);
 <script type="text/javascript">          } split(',',$persistent_db{$name});
     function openhelp(val) {          if (@values <= 1) {
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',              push @Values,$values[0];
      'scrollbars=1,width=600,height=300');          } else {
  openhelpwin.focus();              push @Values,\@values;
           }
     }      }
 </script>      untie (%persistent_db);
 </head>      return @Values;
 <body bgcolor="#FFFFFF">  }
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <h1>Search Catalog</h1>  
 <form method="post" action="/adm/searchcat">  
 $hidden  
 <hr />  
 <h3>Basic Search</h3>  
 <p>  
 Enter terms or phrases separated by search operators  
 such as AND, OR, or NOT then press SEARCH below.  Terms should be specific  
 to the title, author, subject, notes, or abstract information associated  
 with a resource.  
 <br />  
 ENDDOCUMENT  
     $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'}));  
     $r->print(' ');  
     $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'}));  
     $r->print('<font color="#800000">Title only</font> ');  
 #    $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'}));  
 # <font color="#800000">Search historic archives</font>  
     $r->print(<<ENDDOCUMENT);  
 <br />  
 <input type="submit" name="basicsubmit" value='SEARCH' />  
 <input type="reset" name="reset" value='RESET' />  
 $closebutton  
 $basicviewselect  
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  
 <hr />  
 <h3>Advanced Search</h3>  
 $scrout  
 <p>  
 <input type="submit" name="advancedsubmit" value='SEARCH' />  
 <input type="reset" name="reset" value='RESET' />  
 $closebutton  
 $advancedviewselect  
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  
 </form>  
 </body>  
 </html>  
 ENDDOCUMENT  
     return OK;  
 }   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 486  ENDDOCUMENT Line 1239  ENDDOCUMENT
   
 =item &make_persistent()   =item &make_persistent() 
   
 Returns a scalar which holds the current ENV{'form.*'} values in  Inputs: Hash of values to save, filename of persistent database.
 a 'hidden' html input tag.    
   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  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 # ------------------------------------------------------------- make persistent  
   
 sub make_persistent {  sub make_persistent {
     my $persistent='';      my %save = %{shift()};
           my $filename = shift;
     foreach (keys %ENV) {      return undef if (! tie(%persistent_db,'GDBM_File',
  if (/^form\./ && !/submit/) {                             $filename,&GDBM_WRCREAT(),0640));
     my $name=$_;      foreach my $name (keys(%save)) {
     my $key=$name;          my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
     $ENV{$key}=~s/\'//g; # do not mess with html field syntax          # We handle array references, but not recursively.
     $name=~s/^form\.//;          my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
     $persistent.=<<END;          $persistent_db{$name} = $store;
 <input type='hidden' name='$name' value='$ENV{$key}' />  
 END  
         }  
     }      }
     return $persistent;      untie(%persistent_db);
       return 1;
 }  }
   
 # --------------------------------------------------------- Various form fields  ######################################################################
   ######################################################################
   
 sub simpletextfield {  =pod 
     my ($name,$value)=@_;  
     return '<input type=text name=\''.$name.  
    '\' size=20 value=\''.$value.'\' />';  
 }  
   
 sub simplecheckbox {  =item &make_form_data_persistent() 
     my ($name,$value)=@_;  
     my $checked='';  
     $checked="CHECKED" if $value eq 'on';  
     return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';  
 }  
   
 sub searchphrasefield {  Inputs: filename of persistent database.
     my ($title,$name,$value)=@_;  
     my $instruction=<<END;  
 Enter terms or phrases separated by search operators such  
 as AND, OR, or NOT.  
 END  
     my $uctitle=uc($title);  
     return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".  
    "</FONT> $instruction<br />".  
            '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';  
 }  
   
 sub dateboxes {  Store most form variables away to the %persistent_db.
     my ($name,$defaultmonth,$defaultday,$defaultyear,  Values will be escaped.  Values that are array pointers will have their
  $currentmonth,$currentday,$currentyear)=@_;  elements escaped and concatenated in a comma separated string.  
     ($defaultmonth,$defaultday,$defaultyear)=('','','');  
     #  =cut
     # Day  
     my $day=<<END;  ######################################################################
 <select name="${name}_day">  ######################################################################
 <option value='$defaultday'> </option>  sub make_form_data_persistent {
 END      my $r = shift;
     for (my $i = 1; $i<=31; $i++) {      my $filename = shift;
  $day.="<option value=\"$i\">$i</option>\n";      my %save;
     }      foreach (keys(%ENV)) {
     $day.="</select>\n";          next if (!/^form/ || /submit/);
     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);          $save{$_} = $ENV{$_};
     #  
     # Month  
     my $month=<<END;  
 <select name="${name}_month">  
 <option value='$defaultmonth'> </option>  
 END  
     my $i = 1;  
     foreach (qw/January February March April May June   
      July August September October November December /){  
  $month .="<option value=\"$i\">$_</option>\n";  
  $i++;  
     }  
     $month.="</select>\n";  
     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);  
     #  
     # Year (obviously)  
     my $year=<<END;  
 <select name="${name}_year">  
 <option value='$defaultyear'> </option>  
 END  
     my $maxyear = 2051;   
     for (my $i = 1976; $i<=$maxyear; $i++) {  
  $year.="<option value=\"$i\">$i</option>\n";  
     }  
     $year.="</select>\n";  
     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);  
     return "$month$day$year";  
 }  
   
 sub selectbox {  
     my ($title,$name,$value,$anyvalue,$anytag,$functionref,@idlist)=@_;  
     my $uctitle=uc($title);  
     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".  
  "</b></font><br />".'<select name="'.$name.'">';  
     foreach ($anyvalue,@idlist) {  
         $selout.='<option value=\''.$_.'\'';  
         if ($_ eq $value and !/^any$/) {  
     $selout.=' selected>'.&{$functionref}($_).'</option>';  
  }  
  elsif ($_ eq $value and /^$anyvalue$/) {  
     $selout.=' selected>'.$anytag.'</option>';  
  }  
         else {$selout.='>'.&{$functionref}($_).'</option>';}  
     }      }
     return $selout.'</select>';      return &make_persistent(\%save,$filename);
 }  }
   
 # ----------------------------------------------- Performing an advanced search  ######################################################################
 sub advancedsearch {  ######################################################################
     my ($r,$envhash)=@_;  
     my %ENV=%{$envhash};  =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','authorspace',
   #                       'custommetadata','customshow',
                          'modifyinguser','standards','mime');
       my @StatsFields = &statfields();
       my @EvalFields = &evalfields();
     my $fillflag=0;      my $fillflag=0;
       my $pretty_search_string = "";
     # 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/[^\w\/\s\(\)\=\-\"\']//g;  
     }      }
     foreach ('mode','form','element') {      foreach ('mode','form','element') {
  # is this required?  Hmmm.   # is this required?  Hmmm.
  next unless (exists($ENV{"form.$_"}));   next if (! exists($ENV{'form.'.$_}));
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $ENV{'form.'.$_}=&Apache::lonnet::unescape($ENV{'form.'.$_});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $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',      foreach my $field (@BasicFields) {
    'notes','abstract','mime','language','owner',   if (&filled($ENV{'form.'.$field})) {
    'custommetadata') {  
  if (&filled($ENV{"form.$field"})) {  
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      foreach my $field (@StatsFields,@EvalFields) {
  &output_blank_field_error($r);          if (&filled($ENV{'form.'.$field.'_max'})) {
  return OK;              $fillflag++;
           }
           if (&filled($ENV{'form.'.$field.'_min'})) {
               $fillflag++;
           }
     }      }
   
       for my $field ('lowestgradelevel','highestgradelevel') {
           if ( $ENV{'form.'.$field} =~ /^\d+$/ &&
                $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') {   next if (!defined($ENV{'form.'.$field}) || $ENV{'form.'.$field} eq '');
  if ($ENV{'form.'.$field}) {          my ($error,$SQLQuery) = 
     push @queries,&build_SQL_query($field,$ENV{'form.'.$field});              &process_phrase_input($ENV{'form.'.$field},
  }                                    $ENV{'form.'.$field.'_related'},$field);
           if (defined($error)) {
               &output_unparsed_phrase_error($r,$closebutton,'phase=disp_adv',
                                            $hidden_fields,$field);
               return;
           } else {
               $pretty_search_string .= 
                   $font.$field.'</font>: '.$ENV{'form.'.$field};
               if ($ENV{'form.'.$field.'_related'}) {
                   my @Words = 
                       &Apache::loncommon::get_related_words
                       ($ENV{'form.'.$field});
                   if (@Words) {
                       $pretty_search_string.= ' with related words: '.
                           join(', ',@Words[0..4]);
                   } else {
                       $pretty_search_string.= ' with related words.';
                   }
               }
               $pretty_search_string .= '<br />';
               push (@queries,$SQLQuery);
           }
       }
       #
       # 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)) {
           my ($error,$SQLsearch) = &process_phrase_input($searchphrase,0,'mime');
           push @queries,$SQLsearch;
           $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";
     }      }
     # Evaluate date windows      #
     my $datequery=&build_date_queries(      # Statistics
  $ENV{'form.creationdatestart_month'},      foreach my $field (@StatsFields,@EvalFields) {
  $ENV{'form.creationdatestart_day'},          my ($min,$max);
  $ENV{'form.creationdatestart_year'},          if (exists($ENV{'form.'.$field.'_min'}) && 
  $ENV{'form.creationdateend_month'},              $ENV{'form.'.$field.'_min'} ne '') {
  $ENV{'form.creationdateend_day'},              $min = $ENV{'form.'.$field.'_min'};
  $ENV{'form.creationdateend_year'},          }
  $ENV{'form.lastrevisiondatestart_month'},          if (exists($ENV{'form.'.$field.'_max'}) &&
  $ENV{'form.lastrevisiondatestart_day'},              $ENV{'form.'.$field.'_max'} ne '') {
  $ENV{'form.lastrevisiondatestart_year'},              $max = $ENV{'form.'.$field.'_max'};
  $ENV{'form.lastrevisiondateend_month'},          }
  $ENV{'form.lastrevisiondateend_day'},          next if (! defined($max) && ! defined($min));
  $ENV{'form.lastrevisiondateend_year'},          if (defined($min) && defined($max)) {
  );              ($min,$max) = sort {$a <=>$b} ($min,$max);
     # Test to see if date windows are legitimate          }
     if ($datequery=~/^Incorrect/) {          if (defined($min) && $min =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
  &output_date_error($r,$datequery);              push(@queries,'('.$field.'>'.$min.')');
  return OK;              $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 />';
           }
     }      }
     elsif ($datequery) {      #
       # Evaluate date windows
       my $cafter =
           &Apache::lonhtmlcommon::get_date_from_form('creationdate1');
       my $cbefore = 
           &Apache::lonhtmlcommon::get_date_from_form('creationdate2');
       if ($cafter > $cbefore) {
           my $tmp = $cafter;
           $cafter = $cbefore;
           $cbefore = $tmp;
       }
       my $mafter = 
           &Apache::lonhtmlcommon::get_date_from_form('revisiondate1');
       my $mbefore =
           &Apache::lonhtmlcommon::get_date_from_form('revisiondate2');
       if ($mafter > $mbefore) {
           my $tmp = $mafter;
           $mafter = $mbefore;
           $mbefore = $tmp;
       }
       my ($datequery,$error,$prettydate)=&build_date_queries($cafter,$cbefore,
                                                              $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,$domain_sql_restriction) = 
           &parse_domain_restrictions();
       push(@queries,$domain_sql_restriction);
       $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('advanced query = '.$/.$query);
  }      return ($query,$customquery,$customshow,$libraries_to_query,
  else {              $pretty_search_string);
     $reply=&Apache::lonnet::metadata_query($query,  }
    $customquery,$customshow);  
  }  sub parse_domain_restrictions {
  &output_results('Advanced',$r,$envhash,$customquery,$reply);      my $libraries_to_query = undef;
       # $ENV{'form.domains'} can be either a scalar or an array reference.
       # We need an array.
       if (! exists($ENV{'form.domains'}) || $ENV{'form.domains'} eq '') {
           return (undef,'');
       }
       my @allowed_domains;
       if (ref($ENV{'form.domains'})) {
           @allowed_domains =  @{$ENV{'form.domains'}};
       } else {
           @allowed_domains = ($ENV{'form.domains'});
     }      }
     elsif ($customquery) {      #
  my $reply; # reply hash reference      my %domain_hash = ();
  $reply=&Apache::lonnet::metadata_query('',      my $pretty_domains_string;
        $customquery,$customshow);      my $domain_sql_restriction;
  &output_results('Advanced',$r,$envhash,$customquery,$reply);      foreach (@allowed_domains) {
     }          $domain_hash{$_}++;
     # should not get to this point      }
     return 'Error.  Should not have gone to this point.';      if ($domain_hash{'any'}) {
 }          $pretty_domains_string = "In all LON-CAPA domains.";
           $domain_sql_restriction = undef;
 # --------------------------------------------------- Performing a basic search      } else {
 sub basicsearch {          if (@allowed_domains > 1) {
     my ($r,$envhash)=@_;              $pretty_domains_string = "In LON-CAPA domains:";
     my %ENV=%{$envhash};          } else {
               $pretty_domains_string = "In LON-CAPA domain ";
           }
           $domain_sql_restriction = 
               '(domain="'.join('" OR domain="',@allowed_domains).'")';
           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,
               $domain_sql_restriction);
   }
   
   ######################################################################
   ######################################################################
   
   =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') {      foreach ('mode','form','element') {
  # is this required?  Hmmm.   # is this required?  Hmmm.
Line 737  sub basicsearch { Line 1621  sub basicsearch {
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       my ($libraries_to_query,$pretty_domains_string,$domain_sql_restriction) = 
     # Check to see if enough is filled in          &parse_domain_restrictions();
     unless (&filled($ENV{'form.basicexp'})) {      #
  &output_blank_field_error($r);      # Check to see if enough of a query is filled in
       my $search_string = $ENV{'form.basicexp'};
       if (! &filled($search_string)) {
    &output_blank_field_error($r,$closebutton,'phase=disp_basic');
  return OK;   return OK;
     }      }
       my $pretty_search_string=$search_string;
       my @Queries;
       my $searchfield = 'concat_ws(" ",'.join(',',
                                               ('title','author','subject',
                                                'notes','abstract','keywords')
                                               ).')';
       my ($error,$SQLQuery) = &process_phrase_input($search_string,
                                                       $ENV{'form.related'},
                                                       $searchfield);
       if ($error) {
           &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic',
                                         '','basicexp');
           return;
       }
       push(@Queries,$SQLQuery);
       push(@Queries,$domain_sql_restriction);
       #foreach my $q (@Queries) {
       #    &Apache::lonnet::logthis('    '.$q);
       #}
       my $final_query = 'SELECT * FROM metadata WHERE '.join(" AND ",@Queries);
       #
       if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
           $pretty_search_string .= ' '.$pretty_domains_string;
       }
       $pretty_search_string .= "<br />\n";
       $pretty_search_string =~ s:^<br /> and ::;
       &Apache::lonnet::logthis('simple search final query = '.$/.$final_query);
       return ($final_query,$pretty_search_string,
               $libraries_to_query);
   }
   
     # Build SQL query string based on form page  
     my $query='';  
     my $concatarg=join(',"    ",',  
        ('title', 'author', 'subject', 'notes', 'abstract'));  
     $concatarg='title' if $ENV{'form.titleonly'};  
   
     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});  
   
     # Get reply (either a hash reference to filehandles or bad connection)  ###############################################################
     my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);  ###############################################################
   
     # Output search results  my @Phrases;
   
     &output_results('Basic',$r,$envhash,$query,$reply);  sub concat {
       my ($item) = @_;
       my $results = '';
       foreach (@$item) {
           if (ref($_) eq 'ARRAY') {
               $results .= join(' ',@$_);
           }
       }
       return $results;
   }
   
     return OK;  sub process_phrase_input {
       my ($phrase,$related,$field)=@_;
       #&Apache::lonnet::logthis('phrase = :'.$phrase.':');
       my $grammar = <<'ENDGRAMMAR';
       searchphrase:
           expression /^\Z/ {
               # &Apache::lonsearchcat::print_item(\@item,0);
               [@item];
           }
       expression:
           phrase(s)   {
               [@item];
           }
       phrase:
           orword {
               [@item];
           }
         | andword {
               [@item];
           }
         | minusword {
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
         | word {
               unshift(@::Phrases,$item[1]);
               [@item];
           } 
       #
       orword:
           word 'OR' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]);
               [@item];
           }
           | word 'or' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]);
               [@item];
           }    
           | minusword 'OR' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
           | minusword 'or' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }    
       andword:
           word phrase {
               unshift(@::Phrases,'AND');
               unshift(@::Phrases,$item[1]);
               [@item];
           }
           | minusword phrase {
               unshift(@::Phrases,'AND');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
       #
       minusword:
           '-' word {
               [$item[2],'NOT'];
           }
       word:
           "'" term(s) "'" {
             &Apache::lonsearchcat::concat(\@item);
           }
         | '"' term(s) '"' {
             &Apache::lonsearchcat::concat(\@item);
           }
         | term {
               $item[1];
           }
       term:
           /[\w\Q:!@#$%^&*()+_=|{}<>,.;\\\/?\E]+/ {
               $item[1];
           }
   ENDGRAMMAR
       #
       # The end result of parsing the phrase with the grammar is an array
       # @::Phrases.
       # $phrase = "gene splicing" or cat -> "gene splicing","OR","cat"
       # $phrase = "genetic engineering" -dna ->
       #                      "genetic engineering","AND","NOT","dna"
       # $phrase = cat or dog -poodle -> "cat","OR","dog","AND","NOT","poodle"
       undef(@::Phrases);
       my $p = new Parse::RecDescent($grammar);
       if (! defined($p->searchphrase($phrase))) {
           &Apache::lonnet::logthis('lonsearchcat:unable to process:'.$phrase);
           return 'Unable to process phrase '.$phrase;
       }
       #
       # Go through the phrases and make sense of them.  
       # Apply modifiers NOT OR and AND to the phrases.
       my @NewPhrases;
       while(@::Phrases) {
           my $phrase = shift(@::Phrases);
           # &Apache::lonnet::logthis('phrase = '.$phrase);
           my $phrasedata;
           if ($phrase =~ /^(NOT|OR|AND)$/) {
               if ($phrase eq 'OR') {
                   $phrasedata->{'or'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               } elsif ($phrase eq 'AND') {
                   $phrasedata->{'and'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               }
               if ($phrase eq 'NOT') {
                   $phrasedata->{'negate'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               }
           }
           $phrasedata->{'phrase'} = $phrase;
           if ($related) {
               my @NewWords;
               (undef,@NewWords) = &related_version($phrasedata->{'phrase'});
               $phrasedata->{'related_words'} = \@NewWords;
           }
           push(@NewPhrases,$phrasedata);
       }
       #
       # Actually build the sql query from the phrases
       my $SQLQuery;
       foreach my $phrase (@NewPhrases) {
           my $query;
           if ($phrase->{'negate'}) {
               $query .= $field.' NOT LIKE "%'.$phrase->{'phrase'}.'%"';
           } else {
               $query .= $field.' LIKE "%'.$phrase->{'phrase'}.'%"';
           }
           foreach my $related (@{$phrase->{'related_words'}}) {
               if ($phrase->{'negate'}) {
                   $query .= ' AND '.$field.' NOT LIKE "%'.$related.'%"';
               } else {
                   $query .= ' OR '.$field.' LIKE "%'.$related.'%"';
               }
           }
           if ($SQLQuery) {
               if ($phrase->{'or'}) {
                   $SQLQuery .= ' OR ('.$query.')';
               } else {
                   $SQLQuery .= ' AND ('.$query.')';
               }
           } else {
               $SQLQuery = '('.$query.')';
           }
       }
       #
       # &Apache::lonnet::logthis("SQLQuery = $SQLQuery");
       #
       return undef,$SQLQuery;
 }  }
   
 # ------------------------------------------------------------- build_SQL_query  ######################################################################
 sub build_SQL_query {  ######################################################################
     my ($field_name,$logic_statement)=@_;  
     my $q=new Text::Query('abc',  =pod 
   -parse => 'Text::Query::ParseAdvanced',  
   -build => 'Text::Query::Build');  =item &related_version()
     $q->prepare($logic_statement);  
     my $matchexp=${$q}{'matchexp'}; chomp $matchexp;  Modifies an input string to include related words.  Words in the string
     my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);  are replaced with parenthesized lists of 'OR'd words.  For example
     return $sql_query;  "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 ($word) = @_;
       return (undef) if (lc($word) =~ /\b(or|and|not)\b/);
       my @Words = &Apache::loncommon::get_related_words($word);
       # Only use 4 related words
       @Words = ($#Words>4? @Words[0..4] : @Words);
       my $result = join " OR ", ($word,@Words);
       return $result,sort(@Words);
 }  }
   
 # ------------------------------------------------- build custom metadata query  
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &build_custommetadata_query() 
   
   Constructs a custom metadata query using a rather heinous regular
   expression.
   
   =cut
   
   ######################################################################
   ######################################################################
 sub build_custommetadata_query {  sub build_custommetadata_query {
     my ($field_name,$logic_statement)=@_;      my ($field_name,$logic_statement)=@_;
     my $q=new Text::Query('abc',      my $q=new Text::Query('abc',
Line 784  sub build_custommetadata_query { Line 1892  sub build_custommetadata_query {
     my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};      my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
     # quick fix to change literal into xml tag-matching      # quick fix to change literal into xml tag-matching
     # will eventually have to write a separate builder module      # will eventually have to write a separate builder module
     my $oldmatchexp=$matchexp;      # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
     $matchexp=~s/(\w+)\\=([\w\\\+]+)/\\<$1\\>\[\^\\<\]\*$2\[\^\\<\]\*\\<\\\/$1\\>/g;      $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to 
                    /\\<$1\\>?#           \<wordone\>
                      \[\^\\<\]?#        [^\<]         
                      \*$2\[\^\\<\]?#           *wordtwo[^\<]
                      \*\\<\\\/$1\\>?#                        *\<\/wordone\>
                      /g;
     return $matchexp;      return $matchexp;
 }  }
   
 # - Recursively parse a reverse notation expression into a SQL query expression  
 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 ($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);  
 }  
   
 # ------------------------------------------------------------ Build date query  ######################################################################
   ######################################################################
   
   =pod 
   
   =item &build_date_queries() 
   
   Builds a SQL logic query to check time/date entries.
   Also reports errors (check for /^Incorrect/).
   
   =cut
   
   ######################################################################
   ######################################################################
 sub build_date_queries {  sub build_date_queries {
     my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,      my ($cafter,$cbefore,$mafter,$mbefore) = @_;
  $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;      my ($result,$error,$pretty_string);
     my @queries;      #
     if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {      # Verify the input
  unless ($cmonth1 and $cday1 and $cyear1 and      if (! defined($cafter) && ! defined($cbefore) &&
  $cmonth2 and $cday2 and $cyear2) {          ! defined($mafter) && ! defined($mbefore)) {
     return "Incorrect entry for the creation date.  You must specify ".          # This is an okay situation, so return undef for the error
    "a starting month, day, and year and an ending month, ".          return (undef,undef,undef);
    "day, and year.";      }
  }      if ((defined($cafter)  && ! defined($cbefore)) ||
  my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);          (defined($cbefore) && ! defined($cafter))) {
  $cnumeric1+=0;          # This is bad, so let them know
  my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);          $error = &mt('Incorrect entry for the creation date.  '.
  $cnumeric2+=0;                      'You must specify both the beginning and ending dates.');
  if ($cnumeric1>$cnumeric2) {      }
     return "Incorrect entry for the creation date.  The starting ".      if (! defined($error) && 
    "date must occur before the ending date.";          ((defined($mafter)  && ! defined($mbefore)) ||
  }          (defined($mbefore) && ! defined($mafter)))) {
  my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".          # This is also bad, so let them know
            "$cyear2-$cmonth2-$cday2 23:59:59')";          $error = &mt('Incorrect entry for the last revision date.  '.
  push @queries,$cquery;                       'You must specify both the beginning and ending dates.');
     }      }
     if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {      if (! defined($error)) {
  unless ($lmonth1 and $lday1 and $lyear1 and          #
  $lmonth2 and $lday2 and $lyear2) {          # Build the queries
     return "Incorrect entry for the last revision date.  You must ".          my @queries;
    "specify a starting month, day, and year and an ending ".          if (defined($cbefore) && defined($cafter)) {
    "month, day, and year.";              my (undef,undef,undef,$caday,$camon,$cayear) = localtime($cafter);
  }              my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore);
  my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);              # Correct for year being relative to 1900
  $lnumeric1+=0;              $cayear+=1900; $cbyear+=1900;
  my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);              my $cquery=
  $lnumeric2+=0;                  '(creationdate BETWEEN '.
  if ($lnumeric1>$lnumeric2) {                  "'".$cayear.'-'.$camon.'-'.$caday."'".
     return "Incorrect entry for the last revision date.  The ".                  ' AND '.
    "starting date must occur before the ending date.";                  "'".$cbyear.'-'.$cbmon.'-'.$cbday." 23:59:59')";
  }              $pretty_string .= '<br />' if (defined($pretty_string));
  my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".              $pretty_string .= 
            "$lyear2-$lmonth2-$lday2 23:59:59')";                  &mt('created between [_1] and [_2]',
  push @queries,$lquery;                      &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);
           }
     }      }
     if (@queries) {      return ($result,$error,$pretty_string);
  return join(" AND ",@queries);  }
   
   ######################################################################
   ######################################################################
   
   =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 '';      return 1;
 }  }
   
 # ----------------------------- format and output results based on a reply list  ######################################################################
 # There are two windows that this function writes to.  The main search  ######################################################################
 # window ("srch") has a listing of the results.  A secondary window ("popwin")  
 # gives the status of the network search (time elapsed, number of machines  
 # contacted, etc.)  
 sub output_results {  
     my $fnum; # search result counter  
     my ($mode,$r,$envhash,$query,$replyref)=@_;  
     my %ENV=%{$envhash};  
     my %rhash=%{$replyref};  
     my $compiledresult='';  
     my $timeremain=300;  
     my $elapsetime=0;  
     my $resultflag=0;  
     my $tflag=1;  
   
     # make query information persistent to allow for subsequent revision  =pod
     my $persistent=&make_persistent();  
   
     # output beginning of search page  =item &ensure_db_and_table()
  $r->print(<<BEGINNING);  
 <html>  
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 BEGINNING  
   
     # conditional output of script functions dependent on the mode in  Ensure we can get lonmysql to connect to the database and the table we
     # which the search was invoked  need exists.
     if ($ENV{'form.catalogmode'} eq 'interactive'){  
  if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') {  Inputs: $r, table id
             $r->print(<<SCRIPT)   
 <script type="text/javascript">  Returns: undef on error, 1 if the table exists.
     function select_data(title,url) {  
  changeTitle(title);  =cut
  changeURL(url);  
  self.close();  ######################################################################
   ######################################################################
   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;
     }      }
     function changeTitle(val) {      return 1;
  if (opener.inf.document.forms.resinfo.elements.t) {  }
     opener.inf.document.forms.resinfo.elements.t.value=val;  
  }  ######################################################################
   ######################################################################
   
   =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).
           &Apache::lonhtmlcommon::breadcrumbs
           (undef,'Searching','Searching',undef,undef,
            $ENV{'form.catalogmode'} ne 'groupsearch');
   
       ##
       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;
     }      }
     function changeURL(val) {      my $result;
  if (opener.inf.document.forms.resinfo.elements.u) {      my $html=&Apache::lonxml::xmlbegin();
     opener.inf.document.forms.resinfo.elements.u.value=val;      $result.=<<END;
  }  $html
   <head>
   <script>
       function change_sort() {
           var newloc = "/adm/searchcat?phase=results";
           newloc += "&persistent_db_id=$ENV{'form.persistent_db_id'}";
           newloc += "&sortby=";
           newloc += document.forms.statusform.elements.sortby.value;
           parent.resultsframe.location= newloc;
     }      }
 </script>  </script>
 SCRIPT  <title>Results</title>
         } elsif ($ENV{'form.mode'} eq 'edit') {  </head>
             my $form = $ENV{'form.form'};  $bodytag
             my $element = $ENV{'form.element'};  <form name="statusform" action="" method="post">
             $r->print(<<SCRIPT)   <input type="hidden" name="Queue" value="" />
 <script type="text/javascript">  END
 function select_data(title,url) {  
     changeURL(url);  #<h2>Sort Results</h2>
     self.close();  #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
   #    $ENV{'form.sortby'} = 'id' if (! defined($ENV{'form.sortby'}));
   #    foreach (keys(%SortableFields)) {
   #        $result.="<option name=\"$_\"";
   #        if ($_ eq $ENV{'form.sortby'}) {
   #            $result.=" selected ";
   #        }
   #        $result.=" >$SortableFields{$_}</option>\n";
   #    }
   #    $result.="</select>\n";
       my $revise = &revise_button();
       $result.=<<END;
   <p>
   There are $total_results matches to your query. $revise
   </p><p>
   Search:$pretty_query_string
   </p>
   </form>
   </body>
   </html>
   END
       $r->print($result);
       return;
 }  }
 function changeTitle(val) {  
   #####################################################################
   #####################################################################
   
   =pod
   
   =item MySQL Table Description
   
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   #####################################################################
   #####################################################################
   #
   # These should probably be scoped but I don't have time right now...
   #
   my @Datatypes;
   my @Fullindicies;
       
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &create_results_table()
   
   Creates the table of search results by calling lonmysql.  Stores the
   table id in $ENV{'form.table'}
   
   Inputs: none.
   
   Returns: the identifier of the table on success, undef on error.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub set_up_table_structure {
       my ($datatypes,$fullindicies) = 
           &LONCAPA::lonmetadata::describe_metadata_storage();
       # Copy the table description before modifying it...
       @Datatypes = @{$datatypes};
       unshift(@Datatypes,{name => 'id',  
           type => 'MEDIUMINT',
           restrictions => 'UNSIGNED NOT NULL',
           primary_key  => 'yes',
           auto_inc     => 'yes' });
       @Fullindicies = @{$fullindicies};
       return;
   }
   
   sub create_results_table {
       &set_up_table_structure();
       my $table = &Apache::lonmysql::create_table
           ( { columns => \@Datatypes,
               FULLTEXT => [{'columns' => \@Fullindicies},],
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
 }  }
 function changeURL(val) {  
     if (window.opener.document) {  ######################################################################
         window.opener.document.forms["$form"].elements["$element"].value=val;  ######################################################################
     } else {  
  var url = 'forms[\"$form\"].elements[\"$element\"].value';  =pod
         alert("Unable to transfer data to "+url);  
   =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;
 }  }
 </script>  
 SCRIPT  }
         }  
   ######################################################################
   ######################################################################
   
   =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);
       $bodytag.=&Apache::lonhtmlcommon::breadcrumbs
           (undef,'Searching','Searching',undef,undef,
            $ENV{'form.catalogmode'} ne 'groupsearch');
       my $connection = $r->connection;
       #
       # Print run_search header
       #
       my $html=&Apache::lonxml::xmlbegin();
       $r->print(<<END);
   $html
   <head>
   <title>Search Status</title></head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
   END
       # Remove leading and trailing <br />
       $pretty_string =~ s:^\s*<br />::i;
       $pretty_string =~ s:(<br />)*\s*$::im;
       my @Lines = split("<br />",$pretty_string);
       # I keep getting blank items at the end of the list, hence the following:
       while ($Lines[-1] =~ /^\s*$/ && @Lines) {
           pop(@Lines);
     }      }
     $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'groupsearch';      if (@Lines > 2) {
 <script type="text/javascript">          $pretty_string = join '<br />',(@Lines[0..2],'....<br />');
     function select_data(title,url) {  
 // alert('DEBUG: Should be storing '+title+' and '+url);  
     }      }
     function queue(val) {      $r->print(&mt("Search: [_1]",$pretty_string));
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {      $r->rflush();
     document.forms.results.acts.value+='1a'+val+'b';      #
  }      # Determine the servers we need to contact.
  else {      my @Servers_to_contact;
     document.forms.results.acts.value+='0a'+val+'b';      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));
     }      }
     function select_group() {      my %Server_status;
  window.location=      #
     "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+      # Check on the mysql table we will use to store results.
     document.forms.results.acts.value;      my $table =$ENV{'form.table'};
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to determine table id to store search results in.".
                     "The search has been aborted.</body></html>");
           return;
       }
       my $table_status = &Apache::lonmysql::check_table($table);
       if (! defined($table_status)) {
           $r->print("Unable to determine status of table.</body></html>");
           &Apache::lonnet::logthis("Bogus table id of $table for ".
                                    "$ENV{'user.name'} @ $ENV{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           return;
       }
       if (! $table_status) {
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           &Apache::lonnet::logthis("lonmysql debug = ".
                                    &Apache::lonmysql::get_debug());
           &Apache::lonnet::logthis('table status = "'.$table_status.'"');
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
           return;
       }
       ##
       ## Prepare for the big loop.
       my $hitcountsum;
       my $server; 
       my $status;
       my $revise = &revise_button();
       $r->print(<<END);
   <table>
   <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
   <tr>
   <td><input type="text" name="status"  value="" size="30" /></td>
   <td><input type="text" name="count"   value="" size="10" /></td>
   <td><input type="text" name="seconds" value="" size="8" /></td>
   <td>$revise</td>
   </tr>
   </table>
   </form>
   END
       $r->rflush();
       &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.
           foreach my $server (keys(%Server_status)) {
               last if ($connection->aborted());
               &update_seconds($r);
               my $status = $Server_status{$server};
               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);
     }      }
 </script>      &update_status($r,&mt('Search Complete [_1]',$server));
 SCRIPT      &update_seconds($r);
     $r->print(<<SCRIPT);      #
 <script type="text/javascript">      &Apache::lonmysql::disconnect_from_db(); # This is unneccessary
     function displayinfo(val) {      #
  popwin.document.forms.popremain.sdetails.value=val;      # 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 buttons
       my $buttons = '<input type="submit" name="prev" value="'.&mt('Prev').'" ';
       $buttons .= '/>';
       $buttons .= '&nbsp;'x3;
       $buttons .= '<input type="submit" name="reload" '.
           'value="'.&mt('Reload').'" />';
       $buttons .= '&nbsp;'x3;
       $buttons .= '<input type="submit" name="next" value="'.&mt('Next').'" ';
       $buttons .= '/>';
       return $buttons;
   }
   
   ######################################################################
   ######################################################################
   
   =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'}  = 20 if (! exists($ENV{'form.show'}));
       if (exists($ENV{'form.prev'})) {
           $ENV{'form.start'} -= $ENV{'form.show'};
       } elsif (exists($ENV{'form.next'})) {
           $ENV{'form.start'} += $ENV{'form.show'};
       }
       $ENV{'form.start'} = 1 if ($ENV{'form.start'}<1);
       $ENV{'form.start'} = $total_results if ($ENV{'form.start'}>$total_results);
       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);
     }      }
     function openhelp(val) {      ##
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',      ## Output form elements
      'scrollbars=1,width=400,height=300');      $r->print(&hidden_field('table').
  openhelpwin.focus();                &hidden_field('phase').
                 &hidden_field('persistent_db_id').
                 &hidden_field('start')
                 );
       #
       # Build sorting selector
       my @field_order =  ('default',
                           'title',
                           'author',
                           'subject',
                           'url',
                           'keywords',
                           'version',
                           'language',
                           'creationdate'=>,
                           'lastrevisiondate',
                           'owner',
                           'copyright',
                           'authorspace',
                           'lowestgradeleve',
                           'highestgradelevel',
                           'standards',
                           'count',
                           'stdno',
                           'avetries',
                           'difficulty',
                           'disc',
                           'clear',
                           'technical',
                           'correct',
                           'helpful',
                           'depth',
                           );                                              
       my %sort_fields = ('default'     => 'Default',
                          'title'       => 'Title',
                          'author'      => 'Author',
                          'subject'     => 'Subject',
                          'url'         => 'URL',
                          'keywords'    => 'Keywords',
                          'version'     => 'Version',
                          'language'    => 'Language',
                          'creationdate'=> 'Creation Date',
                          'lastrevisiondate' => 'Last Revision Date',
                          'owner'       => 'Owner',
                          'copyright'   => 'Copyright',
                          'authorspace' => 'Authorspace',
                          'lowestgradeleve' => 'Lowest Grade Level',
                          'highestgradelevel' => 'Highest Grade Level',
                          'standards'   => 'Standards',
                          'count'       => 'Number of Accesses',
                          'stdno'       => 'Students Attempting',
                          'avetries'    => 'Average Number of Tries',
                          'difficulty'  => 'Mean Degree of Difficulty',
                          'disc'        => 'Mean Degree of Discrimination',
                          'clear'       => 'Evaluation: Clear',
                          'technical'   => 'Evaluation: Technically Correct',
                          'correct'     => 'Evaluation: Material is Correct',
                          'helpful'     => 'Evaluation: Material is Helpful',
                          'depth'       => 'Evaluation: Material has Depth',
                          'select_form_order' => \@field_order,
                          );
   
       my $sortform = &mt('Sort by [_1]',
                          &Apache::loncommon::select_form($ENV{'form.sortfield'},
                                                         'sortfield',
                                                         %sort_fields));
       ##
       ## Output links (if necessary) for 'prev' and 'next' pages.
       $r->print
           ('<table width="100%"><tr><td width="25%" align="right">'.
            $sortform.
            '</td><td width="25%" align="right">'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results).
            '</td><td align="right">'.
            &viewoptions().'</td></tr></table>'
            );
       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>'.
                     mt('Results [_1] to [_2] out of [_3]',
                        $min,$max,$total_results).
                     "</center>\n");
       }
       ##
       ## Get results from MySQL table
       my $sort_command  = 'id>='.$min.' AND id<='.$max;
       if ($ENV{'form.sortfield'} ne 'default' && 
           exists($sort_fields{$ENV{'form.sortfield'}})) {
           $sort_command = $ENV{'form.sortfield'}.' IS NOT NULL '.
               'ORDER BY '.$ENV{'form.sortfield'}.
               '  LIMIT '.($min-1).','.($max-$min);
       }
       my @Results = &Apache::lonmysql::get_rows($table,$sort_command);
       ##
       ## 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();
     }      }
     function abortsearch(val) {      if (@Results < 1) {
  popwin.close();          $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"
                );
     }      }
 </script>      $r->print("</form></body></html>");
 SCRIPT  
     $r->rflush();      $r->rflush();
       untie %groupsearch_db if (tied(%groupsearch_db));
       return;
   }
   
     # begin showing the cataloged results  ######################################################################
     $r->print(<<CATALOGBEGIN);  ######################################################################
 </head>  
 <body bgcolor="#ffffff">  
 <img align=right src=/adm/lonIcons/lonlogos.gif>  
 <h1>Search Catalog</h1>  
 CATALOGBEGIN  
         $r->print(<<CATALOGCONTROLS);  
 <form name='results' method="post" action="/adm/searchcat">  
 $hidden  
 <input type='hidden' name='acts' value='' />  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $importbutton  
 $closebutton  
 $persistent  
 <hr />  
 <h3>Search Query</h3>  
 CATALOGCONTROLS  
     if ($mode eq 'Basic') {  
  $r->print(<<RESULTS);  
 <p>  
 <b>Basic search:</b> $ENV{'form.basicexp'}  
 </p>  
 RESULTS  
     }  
     elsif ($mode eq 'Advanced') {  
  $r->print(<<RESULTS);  
 <p>  
 <b>Advanced search</b>  
 $query  
 </p>  
 RESULTS  
     }  
     $r->print('<h3>Search Results</h3>');  
     $r->rflush();  
     my $servernum=(keys %rhash)+0;  
   
     # define server grid (shows status of multiple machines)  =pod
     my $hcinit;  
     my $grid="'<br />'+";  
     $grid.="\n";  
     my $sn=1;  
     for my $sk (sort keys %rhash) {  
  # '<a href="  
  $grid.="'<a href=\"";  
  # javascript:displayinfo('+  
  $grid.="javascript:opener.displayinfo('+";  
  # "'"+'key  
  $grid.="\"'\"+'";  
  $grid.=$sk;  
  my $hc;  
  if ($rhash{$sk} eq 'con_lost') {  
     $hc="BAD CONNECTION, CONTACT SYSTEM ADMINISTRATOR ";  
  }  
  else {  
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";  
  }  
  $grid.=" hitcount=".$hc;  
  $grid.=" domain=".$hostdomains{$sk};  
  $grid.=" IP=".$hostips{$sk};  
  # '+"'"+'">'+  
  $grid.="'+\"'\"+')\">'+";  
  $grid.="\n";  
  $grid.="'<img border=\"0\" name=\"img".$sn."\"".  
     " src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk."\" /></a>'+\n";  
  $grid.="'<br />'+\n" unless $sn%10;  
         $sn++;  
     }  
     $r->print(<<ENDPOP);  
 <script type="text/javascript">  
     popwin=open('','popwin','scrollbars=1,width=400,height=220');  
     popwin.focus();  
     popwin.document.writeln('<'+'html>');  
     popwin.document.writeln('<'+'head>');  
     popwin.document.writeln('<'+'script>');  
     popwin.document.writeln('hc=new Array();$hcinit');  
     popwin.document.writeln('<'+'/script>');  
     popwin.document.writeln('<'+'/head>'+  
         '<'+'body bgcolor="#FFFFFF">'+  
  '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+  
  'lonanim.gif" '+  
  'alt="animated logo" />'+  
  '<'+'h3>Search Results Progress<'+'/h3>'+  
         '<'+'form name="popremain">'+  
         '<'+'tt>'+  
  '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+  
  '<'+'br />SCANNING $servernum SERVERS'+  
  '<'+'br clear="all" />Number of record hits found '+  
  '<'+'input type="text" size="10" name="numhits"'+  
  ' value="0" />'+  
  '<'+'br clear="all" />Time elapsed '+  
  '<'+'input type="text" size="10" name="elapsetime"'+  
  ' value="0" />'+  
  '<'+'br />'+  
  'SERVER GRID (click on any cell for details)'+  
         $grid  
         '<'+'br />'+  
  'Server details '+  
  '<'+'input type="text" size="35" name="sdetails"'+  
  ' value="" />'+  
  '<'+'br />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="close this window" '+  
  ' onClick="javascript:opener.abortsearch()" />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="help" onClick="javascript:opener.openhelp()" />'+  
  '<'+'/tt>'+  
         '<'+'/form>'+  
         '<'+'/body><'+'/html>');  
     popwin.document.close();  
 </script>  
 ENDPOP  
     $r->rflush();  
   
     my $servercount=0;  =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
     my $hitcountsum=0;  
     my $bloop=$servernum;  
     my %orkey;  
   BLOOP: while(1) {  
       my $sn=0;  
       last BLOOP unless $bloop;  
       last BLOOP unless $timeremain;  
     RLOOP: foreach my $rkey (sort keys %rhash) {  
  $sn++;  
  next RLOOP if $orkey{$rkey};  
  $servercount++;  
  $tflag=1;  
  $compiledresult='';  
  my $hostname=$rkey;  
  my $reply=$rhash{$rkey};  
  my @results;  
   
  my $replyfile='';  
   
  if ($reply eq 'con_lost') {  
     &popwin_imgupdate($r,$sn,"srvbad.gif");  
     $bloop--;  
     $orkey{$rkey}=1;  
  }  
  else {  
     $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting  
     $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
     $reply=~/(.*?)\_/;  
     {  
  my $temp=0;  
       WLOOP: while (1) {  
   if (-e $replyfile && $tflag) {  
       &popwin_imgupdate($r,$sn,"srvhalf.gif");  
       &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
  '"still transferring..."'.';');  
       $tflag=0;  
   }  
   if (-e "$replyfile.end") {  
       $bloop--;  
       $orkey{$rkey}=1;  
       if (-s $replyfile) {  
   &popwin_imgupdate($r,$sn,"srvgood.gif");  
   my $fh=Apache::File->new($replyfile) or   
       ($r->print('ERROR: file '.  
  $replyfile.' cannot be opened') and  
        return OK);  
   @results=<$fh> if $fh;  
   $hitcount{$rkey}=@results+0;  
   &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
     $hitcount{$rkey}.';');  
   $hitcountsum+=$hitcount{$rkey};  
   &popwin_js($r,'popwin.document.forms.popremain.'.  
     'numhits.value='.$hitcountsum.';');  
       }  
       else {  
   &popwin_imgupdate($r,$sn,"srvempty.gif");  
   &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');  
       }  
       last WLOOP;  
   }  
   if ($temp>1) {  
       sleep 1;  
       $timeremain--;  
       $elapsetime++;  
       last WLOOP;  
   }  
   last WLOOP unless $timeremain;  
   sleep 1;  
   $timeremain--;  
   $elapsetime++;  
   &popwin_js($r,"popwin.document.popremain.".  
        "elapsetime.value=$elapsetime;");  
   $temp++;  
       }  
     }  
     &popwin_js($r,'popwin.document.whirly.'.  
        'src="/adm/lonIcons/lonanimend.gif";');  
  }  
  my $customshow='';  
  my $extrashow='';  
  my @customfields;  
  if ($ENV{'form.customshow'}) {  
     $customshow=$ENV{'form.customshow'};  
     $customshow=~s/[^\w\s]//g;  
     my @fields=map {"<font color=\"#008000\">$_:</font><!-- $_ -->"}   
     split(/\s+/,$customshow);  
     @customfields=split(/\s+/,$customshow);  
     if ($customshow) {  
  $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";  
     }  
  }  
  my $customdata='';  
  my %customhash;  
  foreach my $result (@results) {  
     if ($result=~/^(custom\=.*)$/) { # grab all custom metadata  
  my $tmp=$result;  
  $tmp=~s/^custom\=//;  
  my ($k,$v)=map {&Apache::lonnet::unescape($_);  
     } split(/\,/,$tmp);  
  $customhash{$k}=$v;  
     }  
  }  
  if (keys %hash) {  
     untie %hash;  
  }  
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
     if ($ENV{'form.launch'} eq '1') {  
  &start_fresh_session();  
     }  
     foreach my $result (@results) {  
  next if $result=~/^custom\=/;  
  chomp $result;  
  next unless $result;  
  my @fields=map  
  {&Apache::lonnet::unescape($_)}  
  (split(/\,/,$result));  
  my ($title,$author,$subject,$url,$keywords,$version,  
     $notes,$abstract,$mime,$lang,  
     $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;  
   
                 unless ($title) { $title='<i>Untitled</i>'; }  
  unless ($ENV{'user.adv'}) {  
     $keywords='<i>- not displayed -</i>';  
     $fields[4]=$keywords;  
     $notes='<i>- not displayed -</i>';  
     $fields[6]=$notes;  
     $abstract='<i>- not displayed -</i>';  
     $fields[7]=$abstract;  
     $subject='<i>- not displayed -</i>';  
     $fields[2]=$subject;  
  }  
   
  my $shortabstract=$abstract;  Returns html needed for the various catalog modes.  Gets inputs from
  $shortabstract=substr($abstract,0,200).'...' if length($abstract)>200;  $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
  $fields[7]=$shortabstract;  
  my $shortkeywords=$keywords;  =cut
  $shortkeywords=substr($keywords,0,200).'...' if length($keywords)>200;  
  $fields[4]=$shortkeywords;  
   
  my $extrashow2=$extrashow;  
  if ($extrashow) {  
     foreach my $field (@customfields) {  
  my $value='';  
  if ($customhash{$url}=~/\<${field}[^\>]*\>(.*?)\<\/${field}[^\>]*\>/s) {  
             $value=$1;  
  }  
         $extrashow2=~s/\<\!\-\- $field \-\-\>/ $value/g;  
             }  
                 }  
   
         $compiledresult.=<<END if $compiledresult or $servercount!=$servernum;  
 <hr align='left' width='200' noshade />  
 END  
                 $compiledresult.=<<END;  
 <p>  
 END  
                if ($ENV{'form.catalogmode'} eq 'interactive') {  
    my $titleesc=$title;  
    $titleesc=~s/\'/\\'/; # '  
   
                    $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');  ######################################################################
   ######################################################################
   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('$titleesc','$url')">  onClick="javascript:select_data('$title','$url')">
 </font>  </font>
 <br />  
 END  END
                 }          }
                 if ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
     $fnum+=0;          $groupsearch_db{"pre_${fnum}_link"}=$url;
     $hash{"pre_${fnum}_link"}=$url;          $groupsearch_db{"pre_${fnum}_title"}=$title;
     $hash{"pre_${fnum}_title"}=$title;          $output.=<<END;
     $compiledresult.=<<END;  
 <font size='-1'>  <font size='-1'>
 <input type="checkbox" name="returnvalues" value="SELECT"  <input type="checkbox" name="returnvalues" value="SELECT"
 onClick="javascript:queue($fnum)" />  onClick="javascript:queue($checkbox_num,$fnum)" />
 </font>  </font>
 <br />  
 END  END
 # <input type="hidden" name="title$fnum" value="$title" />      }
 # <input type="hidden" name="url$fnum" value="$url" />      return $output;
                     $fnum++;  }
  }  ######################################################################
         my $httphost=$ENV{'HTTP_HOST'};  ######################################################################
   
         my $viewselect;  =pod
         if ($mode eq 'Basic') {  
     $viewselect=$ENV{'form.basicviewselect'};  
  }  
         elsif ($mode eq 'Advanced') {  
     $viewselect=$ENV{'form.advancedviewselect'};  
  }  
   
         if ($viewselect eq 'Detailed Citation View') {  =item &parse_row()
     $compiledresult.=&detailed_citation_view(@fields,  
  $hostname,$httphost,  
  $extrashow2);  
  }  
                 elsif ($viewselect eq 'Summary View') {  
     $compiledresult.=&summary_view(@fields,$hostname,$httphost,  
        $extrashow2);  
         }  
                 elsif ($viewselect eq 'Fielded Format') {  
     $compiledresult.=&fielded_format_view(@fields,$hostname,  
       $httphost,$extrashow2);  
         }  
                 elsif ($viewselect eq 'XML/SGML') {  
     $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,  
  $extrashow2);  
  }  
       
             }  
   
             untie %hash;  Parse a row returned from the database.
         }  
         else {  
     $r->print('<html><head></head><body>Unable to tie hash to db '.  
   'file</body></html>');  
  }  
  if ($compiledresult) {  
     $resultflag=1;  
  }  
   
  $r->print(<<RESULTS);  =cut
 $compiledresult  
 RESULTS  
         my $percent=sprintf('%3.0f',($servercount/$servernum*100));  
     }  
   }  
     unless ($resultflag) {  
         $r->print("\nThere were no results that matched your query\n");  
     }  
 #    $r->print('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush();   
     $r->print(<<RESULTS);  
 </body>  
 </html>  
 RESULTS  
 }  
   
 # ------------------------------------------------------ Detailed Citation View  ######################################################################
 sub detailed_citation_view {  ######################################################################
     my ($title,$author,$subject,$url,$keywords,$version,  sub parse_row {
  $notes,$shortabstract,$mime,$lang,      my @Row = @_;
  $creationdate,$lastrevisiondate,$owner,$copyright,      my %Fields;
  $hostname,$httphost,$extrashow)=@_;      if (! scalar(@Datatypes)) {
     my $result=<<END;          &set_up_table_structure();
 <i>$owner</i>, last revised $lastrevisiondate      }
 <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>      for (my $i=0;$i<=$#Row;$i++) {
 <h3>$author</h3>          $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
 </p>      }
 <p>      $Fields{'language'} = 
 <b>Subject:</b> $subject<br />          &Apache::loncommon::languagedescription($Fields{'language'});
 <b>Keyword(s):</b> $keywords<br />      $Fields{'copyrighttag'} =
 <b>Notes:</b> $notes<br />          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
 <b>MIME Type:</b>      $Fields{'mimetag'} =
 END          &Apache::loncommon::filedescription($Fields{'mime'});
     $result.=&Apache::loncommon::filedescription($mime);      return \%Fields;
     $result.=<<END;  
 <br />  
 <b>Language:</b>   
 END  
     $result.=&Apache::loncommon::languagedescription($lang);  
     $result.=<<END;  
 <br />  
 <b>Copyright/Distribution:</b>   
 END  
     $result.=&Apache::loncommon::copyrightdescription($copyright);  
     $result.=<<END;  
 <br />  
 </p>  
 $extrashow  
 <p>  
 $shortabstract  
 </p>  
 END  
     return $result;  
 }  }
   
 # ---------------------------------------------------------------- Summary View  ###########################################################
 sub summary_view {  ###########################################################
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost,$extrashow)=@_;  
     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);  
     my $result=<<END;  
 <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />  
 $title<br />  
 $owner -- $lastrevisiondate<br />  
 $cprtag<br />  
 $extrashow  
 </p>  
 END  
     return $result;  
 }  
   
 # -------------------------------------------------------------- Fielded Format  =pod
 sub fielded_format_view {  
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost,$extrashow)=@_;  
     my $mimetag=&Apache::loncommon::filedescription($mime);  
     my $language=&Apache::loncommon::languagedescription($lang);  
     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);  
     my $result=<<END;  
 <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>  
 <br />  
 <b>Title:</b> $title<br />  
 <b>Author(s):</b> $author<br />  
 <b>Subject:</b> $subject<br />  
 <b>Keyword(s):</b> $keywords<br />  
 <b>Notes:</b> $notes<br />  
 <b>MIME Type:</b> $mimetag<br />  
 <b>Language:</b> $language<br />  
 <b>Creation Date:</b> $creationdate<br />  
 <b>Last Revision Date:</b> $lastrevisiondate<br />  
 <b>Publisher/Owner:</b> $owner<br />  
 <b>Copyright/Distribution:</b> $cprtag<br />  
 <b>Repository Location:</b> $hostname<br />  
 <b>Abstract:</b> $shortabstract<br />  
 $extrashow  
 </p>  
 END  
     return $result;  
 }  
   
 # -------------------------------------------------------------------- XML/SGML  =item &parse_raw_result()
 sub xml_sgml_view {  
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost,$extrashow)=@_;  
     my $cprtag=&Apache::loncommon::copyrightdescription($copyright);  
     my $mimetag=&Apache::loncommon::filedescription($mime);  
     my $language=&Apache::loncommon::languagedescription($lang);  
     my $result=<<END;  
 <pre>  
 &lt;LonCapaResource&gt;  
 &lt;url&gt;$url&lt;/url&gt;  
 &lt;title&gt;$title&lt;/title&gt;  
 &lt;author&gt;$author&lt;/author&gt;  
 &lt;subject&gt;$subject&lt;/subject&gt;  
 &lt;keywords&gt;$keywords&lt;/keywords&gt;  
 &lt;notes&gt;$notes&lt;/notes&gt;  
 &lt;mimeInfo&gt;  
 &lt;mime&gt;$mime&lt;/mime&gt;  
 &lt;mimetag&gt;$mimetag&lt;/mimetag&gt;  
 &lt;/mimeInfo&gt;  
 &lt;languageInfo&gt;  
 &lt;language&gt;$lang&lt;/language&gt;  
 &lt;languagetag&gt;$language&lt;/languagetag&gt;  
 &lt;/languageInfo&gt;  
 &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;  
 &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;  
 &lt;owner&gt;$owner&lt;/owner&gt;  
 &lt;copyrightInfo&gt;  
 &lt;copyright&gt;$copyright&lt;/copyright&gt;  
 &lt;copyrighttag&gt;$cprtag&lt;/copyrighttag&gt;  
 &lt;/copyrightInfo&gt;  
 &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;  
 &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;  
 &lt;/LonCapaResource&gt;  
 </pre>  
 $extrashow  
 END  
     return $result;  
 }  
   
 # ---------------------------------------------------- see if a field is filled  Takes a line from the file of results and parse it.  Returns a hash 
 sub filled {  with keys according to column labels
     my ($field)=@_;  
     if ($field=~/\S/ && $field ne 'any') {  
  return 1;  
     }  
     else {  
  return 0;  
     }  
 }  
   
 # ---------------- Message to output when there are not enough fields filled in  In addition, the following tags are set by calling the appropriate 
 sub output_blank_field_error {  lonnet function: 'language', 'copyrighttag', 'mimetag'.
     my ($r)=@_;  
     # make query information persistent to allow for subsequent revision  
     my $persistent=&make_persistent();  
   
     $r->print(<<BEGINNING);  The 'title' field is set to "Untitled" if the title field is blank.
 <html>  
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 BEGINNING  
     $r->print(<<RESULTS);  
 </head>  
 <body bgcolor="#ffffff">  
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <h1>Search Catalog</h1>  
 <form method="post" action="/adm/searchcat">  
 $persistent  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $closebutton  
 <hr />  
 <h3>Helpful Message</h3>  
 <p>  
 Incorrect search query due to blank entry fields.  
 You need to fill in the relevant  
 fields on the search page in order for a query to be  
 processed.  
 </p>  
 </body>  
 </html>  
 RESULTS  
 }  
   
 # ----------------------------------------------------------- Output date error  'abstract' and 'keywords' are truncated to 200 characters.
 sub output_date_error {  
     my ($r,$message)=@_;  
     # make query information persistent to allow for subsequent revision  
     my $persistent=&make_persistent();  
   
     $r->print(<<BEGINNING);  =cut
 <html>  
 <head>  ###########################################################
 <title>The LearningOnline Network with CAPA</title>  ###########################################################
 BEGINNING  sub parse_raw_result {
     $r->print(<<RESULTS);      my ($result,$hostname) = @_;
 </head>      # conclude from self to others regarding fields
 <body bgcolor="#ffffff">      my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />          (map {
 <h1>Search Catalog</h1>              &Apache::lonnet::unescape($_);
 <form method="post" action="/adm/searchcat">          } (split(/\,/,$result)) );
 $persistent      return %Fields;
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $closebutton  
 <hr />  
 <h3>Helpful Message</h3>  
 <p>  
 $message  
 </p>  
 </body>  
 </html>  
 RESULTS  
 }  }
   
 # --------- settings whenever the user causes the search window to be launched  ###########################################################
 sub start_fresh_session {  ###########################################################
     delete $hash{'mode_catalog'};  
     foreach (keys %hash) {  =pod
         if ($_ =~ /^pre_/) {  
             delete $hash{$_};  =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";
         }          }
         if ($_ =~ /^store/) {  
     delete $hash{$_};  
  }  
     }      }
 }      my $customdata='';
       my %customhash;
 # ----------------------------------------------- send javascript to popwin      foreach my $result (@results) {
 sub popwin_js {          if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
     # Print javascript out to popwin, but make sure we dont generate              my $tmp=$result;
     # any javascript errors in doing so.              $tmp=~s/^custom\=//;
     my ($r,$text) = @_;              my ($k,$v)=map {&Apache::lonnet::unescape($_);
     $r->print(<<"END");                          } split(/\,/,$tmp);
 <script type="text/javascript">              $customhash{$k}=$v;
     if (! popwin.closed) {          }
  $text  
     }      }
 </script>      return ($extrashow,\@customfields,\%customhash);
 END  
     $r->rflush();  
 }  }
   
 sub popwin_imgupdate {  ######################################################################
     my ($r,$imgnum,$icon) = @_;  ######################################################################
     &popwin_js($r,'popwin.document.img'.$imgnum.'.'.  
        'src="/adm/lonIcons/'.$icon.'";');  
 }      
   
 1;  =pod
   
 __END__  =item &search_results_header()
   
 =pod  Output the proper html headers and javascript code to deal with different 
   calling modes.
   
 =back   Takes most inputs directly from %ENV, except $mode.  
   
 =over 4  =over 4
   
 =head1 HANDLER SUBROUTINE  =item $mode is either (at this writing) 'Basic' or 'Advanced'
   
 This routine is called by Apache and mod_perl.  =back
   
   The following environment variables are checked:
   
 =over 4  =over 4
   
 =item *  =item 'form.catalogmode' 
   
 configure dynamic components of interface  Checked for 'interactive' and 'groupsearch'.
   
 =item *  =item 'form.mode'
   
 determine current user  Checked for existance & 'edit' mode.
   
 =item *  =item 'form.form'
   
 see if a search invocation should be done  Contains the name of the form that has the input fields to set
   
 =item *  =item 'form.element'
   
 else, begin building search interface to output  the name of the input field to put the URL into
   
 =item *  =item 'form.titleelement'
   
 compute date selection boxes  the name of the input field to put the title into
   
 =item *  =back
   
 compute customized metadata field  =cut
   
 =item *  ######################################################################
   ######################################################################
   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) {
    changeTitle(title);
    changeURL(url);
    parent.close();
       }
       function changeTitle(val) {
    if (parent.opener.inf.document.forms.resinfo.elements.t) {
       parent.opener.inf.document.forms.resinfo.elements.t.value=val;
    }
       }
       function changeURL(val) {
    if (parent.opener.inf.document.forms.resinfo.elements.u) {
       parent.opener.inf.document.forms.resinfo.elements.u.value=val;
    }
       }
   </script>
   SCRIPT
           } elsif ($ENV{'form.mode'} eq 'edit') {
               my $form = $ENV{'form.form'};
               my $element = $ENV{'form.element'};
               my $titleelement = $ENV{'form.titleelement'};
       my $changetitle;
       if (!$titleelement) {
    $changetitle='function changeTitle(val) {}';
       } else {
       $changetitle=<<END;
   function changeTitle(val) {
       if (parent.targetwin.document) {
           parent.targetwin.document.forms["$form"].elements["$titleelement"].value=val;
       } else {
    var url = 'forms[\"$form\"].elements[\"$titleelement\"].value';
           alert("Unable to transfer data to "+url);
       }
   }
   END
               }
   
 print screen              $result.=<<SCRIPT;
   <script type="text/javascript">
   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);
       }
   }
   </script>
   SCRIPT
           }
       }
       $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="/adm/searchcat" >
   <input type="hidden" name="Queue" value="" />
   $importbutton
   END
       return $result;
   }
   
 =back  ######################################################################
   ######################################################################
   sub search_status_header {
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $html=&Apache::lonxml::xmlbegin();
       return <<ENDSTATUS;
   $html
   <head>
   <title>Search Status</title></head>
   $bodytag
   <h3>Search Status</h3>
   Sending search request to LON-CAPA servers.<br />
   ENDSTATUS
   }
   
 =head1 OTHER SUBROUTINES  sub results_link {
       my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
           "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $results_link = $basic_link."&phase=results".
           "&pause=1"."&start=1";
       return $results_link;
   }
   
 =over 4  ######################################################################
   ######################################################################
   sub print_frames_interface {
       my $r = shift;
       my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
           "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $run_search_link = $basic_link."&phase=run_search";
       my $results_link = &results_link();
       my $html=&Apache::lonxml::xmlbegin();
       my $result = <<"ENDFRAMES";
   $html
   <head>
   <script>
   var targetwin = opener;
   var queue = '';
   </script>
   <title>LON-CAPA Digital Library Search Results</title>
   </head>
   <frameset rows="150,*">
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   </frameset>
   </html>
   ENDFRAMES
   
       $r->print($result);
       return;
   }
   
   ######################################################################
   ######################################################################
   
 =item *  sub has_stat_data {
       my ($values) = @_;
       if ( (defined($values->{'count'})      && $values->{'count'}      ne '') ||
            (defined($values->{'stdno'})      && $values->{'stdno'}      ne '') ||
            (defined($values->{'disc'})       && $values->{'disc'}       ne '') ||
            (defined($values->{'avetries'})   && $values->{'avetries'}   ne '') ||
            (defined($values->{'difficulty'}) && $values->{'difficulty'} ne '')) {
           return 1;
       }
       return 0;
   }
   
 get_unprocessed_cgi() : reads in critical name/value pairs that may have not  sub statfields {
 been processed and passed into %ENV by the web server      return ('count','stdno','disc','avetries','difficulty');
   }
   
 =item *  sub has_eval_data {
       my ($values) = @_;
       if ( (defined($values->{'clear'})     && $values->{'clear'}     ne '') ||
            (defined($values->{'technical'}) && $values->{'technical'} ne '') ||
            (defined($values->{'correct'})   && $values->{'correct'}   ne '') ||
            (defined($values->{'helpful'})   && $values->{'helpful'}   ne '') ||
            (defined($values->{'depth'})     && $values->{'depth'}     ne '')) {
           return 1;
       }
       return 0;
   }
   
 make_persistent() : makes a set of hidden HTML fields to make  sub evalfields { 
 SQL search interface information to be persistent      return ('clear','technical','correct','helpful','depth');
   }
   
 =back  ######################################################################
   ######################################################################
   
 WEB INTERFACE COMPONENT FUNCTIONS  =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  =over 4
   
 =item *  =item &detailed_citation_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub detailed_citation_view {
       my ($prefix,%values) = @_;
       my $result;
       $result .= '<b>'.$prefix.
           '<img src="'.&Apache::loncommon::icon($values{'url'}).' " />'.'&nbsp;'.
           '<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=>'url',
              translate => '<b>URL:</b>&nbsp;[_1]',
              special => 'url link',},
            { 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=>'count',
              format => "%d",
              translate => '<b>Access Count:</b>&nbsp;[_1]',},
            { name=>'stdno',
              format => "%d",
              translate => '<b>Number of Students:</b>&nbsp;[_1]',},
            { name=>'avetries',
              format => "%.2f",
              translate => '<b>Average Tries:</b>&nbsp;[_1]',},
            { name=>'disc',
              format => "%.2f",
              translate => '<b>Degree of Discrimination:</b>&nbsp;[_1]',},
            { name=>'difficulty',
              format => "%.2f",
              translate => '<b>Degree of Difficulty:</b>&nbsp;[_1]',},
            { name=>'clear',
              format => "%.2f",
              translate => '<b>Clear:</b>&nbsp;[_1]',},
            { name=>'depth',
              format => "%.2f",
              translate => '<b>Depth:</b>&nbsp;[_1]',},
            { name=>'helpful',
              format => "%.2f",
              translate => '<b>Helpful:</b>&nbsp;[_1]',},
            { name=>'correct',
              format => "%.2f",
              translate => '<b>Correct:</b>&nbsp;[_1]',},
            { name=>'technical',
              format => "%.2f",
              translate => '<b>Technical:</b>&nbsp;[_1]',},
            { name=>'comefrom_list',
              type => 'list',
              translate => 'Resources that lead up to this resource in maps',},
            { name=>'goto_list',
              type => 'list',
              translate => 'Resources that follow this resource in maps',},
            { name=>'sequsage_list',
              type => 'list',
              translate => 'Resources using or importing resource',},
            ) {
           next if (! exists($values{$field->{'name'}}) ||
                    $values{$field->{'name'}} eq '');
           if (exists($field->{'type'}) && $field->{'type'} eq 'list') {
               $result .= '<b>'.&mt($field->{'translate'}).'</b><ul>';
               foreach my $item (split(',',$values{$field->{'name'}})){
                   $result .= '<li>'.
                       '<a target="search_preview" '.
                       'href="/res/'.$item.'">'.$item.'</a></li>';
               }
               $result .= '</ul>';
           } elsif (exists($field->{'format'}) && $field->{'format'} ne ''){
               $result.= &mt($field->{'translate'},
                             sprintf($field->{'format'},
                                     $values{$field->{'name'}}))."<br />\n";
           } else {
               if ($field->{'special'} eq 'url link') {
                   $result.= 
                        &mt($field->{'translate'},
                            '<a href="'.$values{'url'}.'" '.
                            'target="search_preview">'.
                            $values{$field->{'name'}}.
                            '</a>');
               } else {
                   $result.= &mt($field->{'translate'},
                                 $values{$field->{'name'}});
               }
               $result .= "<br />\n";
           }
       }
       $result .= "</p>";
       if (exists($values{'extrashow'}) && $values{'extrashow'} ne '') {
           $result .= '<p>'.$values{'extrashow'}.'</p>';
       }
       if (exists($values{'shortabstract'}) && $values{'shortabstract'} ne '') {
           $result .= '<p>'.$values{'shortabstract'}.'</p>';
       }
       $result .= '<hr align="left" width="200" noshade />'."\n";
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
 simpletextfield(name,value) : returns HTML formatted string for simple text  =item &summary_view() 
 field  
   =cut
   ######################################################################
   ######################################################################
   sub summary_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
       my $result=<<END;
   $prefix<img src="$icon" />&nbsp;
   <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
      target='search_preview'>$values{'author'}</a><br />
   $values{'title'}<br />
   $values{'owner'} -- $values{'lastrevisiondate'}<br />
   $values{'copyrighttag'}<br />
   $values{'extrashow'}
   </p>
   <hr align='left' width='200' noshade />
   END
       return $result;
   }
   
 =item *  ######################################################################
   ######################################################################
   
 simplecheckbox(name,value) : returns HTML formatted string for simple  =pod 
 checkbox  
   
 =item *  =item &compact_view() 
   
 searchphrasefield(title,name,value) : returns HTML formatted string for  =cut
 a search expression phrase field  
   
 =item *  ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $result = 
           $prefix.'<img src="'.&Apache::loncommon::icon($values{'url'}).
           '">&nbsp;<a href="'.$values{'url'}.'" target="search_preview">'.
           $values{'title'}.'</a>'.('&nbsp;'x2).
           '<b>'.$values{'author'}.'</b><br />';
       return $result;
   }
   
 dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML  
 formatted string for a calendar date  
   
 =item *  ######################################################################
   ######################################################################
   
 selectbox(title,name,value,%HASH=options) : returns HTML formatted string for  =pod 
 a selection box field  
   
 =back  =item &fielded_format_view() 
   
 SEARCH FUNCTIONS  =cut
   
 =over 4  ######################################################################
   ######################################################################
   sub fielded_format_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
       my %Translated = &Apache::lonmeta::fieldnames();
       my $result=<<END;
   $prefix <img src="$icon" />
   <dl>
   <dt>URL:</dt>
       <dd><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
            target='search_preview'>$values{'url'}</a></dd>
   END
       foreach my $field ('title','author','domain','subject','keywords','notes',
                          'mimetag','language','creationdate','lastrevisiondate',
                          'owner','copyrighttag','hostname','abstract') {
           $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
               (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
       }
       if (&has_stat_data(\%values)) {
           foreach my $field (&statfields()) {
               $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
                   (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
           }
       }
       if (&has_eval_data(\%values)) {
           foreach my $field (&evalfields()) {
               $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
                   (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
           }
       }
       $result .= "</dl>\n";
       $result .= $values{'extrashow'};
       $result .= '<hr align="left" width="200" noshade />'."\n";
       return $result;
   }
   
 =item *  ######################################################################
   ######################################################################
   
 advancedsearch(server reference, environment reference) : perform a complex  =pod 
 multi-field logical query  
   
 =item *  =item &xml_sgml_view() 
   
 basicsearch(server reference, environment reference) : perform a simple  =back 
 single-field logical query  
   
 =item *  =cut
   
 build_SQL_query(field name, logic) : builds a SQL query string from a  ######################################################################
 logical expression with AND/OR keywords  ######################################################################
   sub xml_sgml_view {
       my ($prefix,%values) = @_;
       my $xml = '<LonCapaResource>'."\n";
       # The usual suspects
       foreach my $field ('url','title','author','subject','keywords','notes','domain') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       #
       $xml .= "<mimeInfo>\n";
       foreach my $field ('mime','mimetag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</mimeInfo>\n";
       #
       $xml .= "<languageInfo>\n";
       foreach my $field ('language','languagetag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</languageInfo>\n";
       #
       foreach my $field ('creationdate','lastrevisiondate','owner') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       #
       $xml .= "<copyrightInfo>\n";
       foreach my $field ('copyright','copyrighttag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</copyrightInfo>\n";
       $xml .= qq{<repositoryLocation>$values{'hostname'}</repositoryLocation>}.
           "\n";
       $xml .= qq{<shortabstract>$values{'shortabstract'}</shortabstract>}."\n";
       #
       if (&has_stat_data(\%values)){
           $xml .= "<problemstatistics>\n";
           foreach my $field (&statfields()) {
               $xml .= qq{<$field>$values{$field}</$field>}."\n";            
           }
           $xml .= "</problemstatistics>\n";
       }
       #
       if (&has_eval_data(\%values)) {
           $xml .= "<evaluation>\n";
           foreach my $field (&evalfields) {
               $xml .= qq{<$field>$values{$field}</$field>}."\n";            
           }
           $xml .= "</evaluation>\n";
       }    
       #
       $xml .= "</LonCapaResource>\n";
       $xml = &HTML::Entities::encode($xml,'<>&');
       my $result=<<END;
   $prefix
   <pre>
   $xml
   </pre>
   $values{'extrashow'}
   <hr align='left' width='200' noshade />
   END
       return $result;
   }
   
 =item *  ######################################################################
   ######################################################################
   
 build_custommetadata_query(field_name, logic_statement) : builds a perl  =pod 
 regular expression from a logical expression with AND/OR keywords  
   
 =item *  =item &filled() see if field is filled.
   
 recursive_SQL_query_build(field name, reverse notation expression) :   =cut
 builds a SQL query string from a reverse notation expression  
 logical expression with AND/OR keywords  
   
 =item *  ######################################################################
   ######################################################################
   sub filled {
       my ($field)=@_;
       if ($field=~/\S/ && $field ne 'any') {
           return 1;
       } else {
           return 0;
       }
   }
   
 build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,  ######################################################################
 lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :  ######################################################################
 Builds a SQL logic query to check time/date entries.  
   
 =back  =pod 
   
 OUTPUTTING RESULTS FUNCTION  =item &output_unparsed_phrase_error()
   
 =over 4  =cut
   
 =item *  ######################################################################
   ######################################################################
   sub output_unparsed_phrase_error {
       my ($r,$closebutton,$parms,$hidden_fields,$field)=@_;
       my $errorstring;
       if ($field eq 'basicexp') {
           $errorstring = &mt('Unable to understand the search phrase <i>[_1]</i>.  Please modify your search.',$ENV{'form.basicexp'});
       } else {
           $errorstring = &mt('Unable to understand the search phrase <b>[_1]</b>:<i>[_2]</i>.',$field,$ENV{'form.'.$field});
       }
       my $bodytag = &Apache::loncommon::bodytag('Search');
       my $heading = &mt('Unparsed Field');
       my $revise  = &mt('Revise search request');
       # make query information persistent to allow for subsequent revision
       my $html=&Apache::lonxml::xmlbegin();
       $r->print(<<ENDPAGE);
   $html
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   $bodytag
   <form method="post" action="/adm/searchcat">
   $hidden_fields
   $closebutton
   <hr />
   <h2>$heading</h2>
   <p>
   $errorstring
   </p>
   <p>
   <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}">$revise</a>
   </p>
   </body>
   </html>
   ENDPAGE
   }
   
 output_results(output mode, server reference, environment reference,  ######################################################################
 reply list reference) : outputs results from search  ######################################################################
   
 =back  =pod 
   
 DIFFERENT WAYS TO VIEW METADATA RECORDS  =item &output_blank_field_error()
   
 =over 4  Output a complete page that indicates the user has not filled in enough
   information to do a search.
   
 =item *  Inputs: $r (Apache request handle), $closebutton, $parms.
   
 detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :  Returns: nothing
 see metadata viewing notes below   
   
 =item *  $parms is extra information to include in the 'Revise search request' link.
   
 summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :  =cut
 see metadata viewing notes below   
   ######################################################################
   ######################################################################
   sub output_blank_field_error {
       my ($r,$closebutton,$parms,$hidden_fields)=@_;
       my $bodytag=&Apache::loncommon::bodytag('Search');
       my $errormsg = &mt('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.');
       my $revise = &mt('Revise Search Request');
       my $heading = &mt('Unactionable Search Queary');
       my $html=&Apache::lonxml::xmlbegin();
       $r->print(<<ENDPAGE);
   $html
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   $bodytag
   <form method="post" action="/adm/searchcat">
   $hidden_fields
   $closebutton
   <hr />
   <h2>$heading</h2>
   <p>
   $errormsg
   </p>
   <p>
   <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}">$revise</a>&nbsp;
   </p>
   </body>
   </html>
   ENDPAGE
       return;
   }
   
 =item *  ######################################################################
   ######################################################################
   
 fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :  =pod 
 see metadata viewing notes below   
   
 =item *  =item &output_date_error()
   
 xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :  Output a full html page with an error message.
 see metadata viewing notes below   
   
 =back  Inputs: 
   
   _____________________________________________________________________      $r, the request pointer.
  | * Metadata viewing notes                                            |      $message, the error message for the user.
  | Output is a HTML-ified string.                                      |      $closebutton, the specialized close button needed for groupsearch.
  | Input arguments are title, author, subject, url, keywords, version, |  
  | notes, short abstract, mime, language, creation date,               |  
  | last revision date, owner, copyright, hostname, httphost, and       |  
  | extra custom metadata to show.                                      |  
   ---------------------------------------------------------------------  
   
 TEST CONDITIONAL FUNCTIONS  =cut
   
 =over 4  ######################################################################
   ######################################################################
   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);
       my $html=&Apache::lonxml::xmlbegin();
       $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'
   onClick='this.form.submit();' />
   $closebutton
   <hr />
   <h3>Error</h3>
   <p>
   $message
   </p>
   </body>
   </html>
   RESULTS
   }
   
 =item *  ######################################################################
   ######################################################################
   
 filled(field) : determines whether a given field has been filled  =pod 
   
 =back  =item &start_fresh_session()
   
 ERROR FUNCTIONS  Cleans the global %groupsearch_db by removing all fields which begin with
   'pre_' or 'store'.
   
 =over 4  =cut
   
 =item *  ######################################################################
   ######################################################################
   sub start_fresh_session {
       delete $groupsearch_db{'mode_catalog'};
       foreach (keys %groupsearch_db) {
           if ($_ =~ /^pre_/) {
               delete $groupsearch_db{$_};
           }
           if ($_ =~ /^store/) {
       delete $groupsearch_db{$_};
    }
       }
   }
   
 output_blank_field_error(server reference) : outputs a message saying that  1;
 more fields need to be filled in  
   
 =item *  sub cleanup {
       if (tied(%groupsearch_db)) {
           unless (untie(%groupsearch_db)) {
     &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
           }
       }
       &untiehash();
       &Apache::lonmysql::disconnect_from_db();
   }
   
 output_date_error(server reference, error message) : outputs  __END__
 an error message specific to bad date format.  
   
 =back  =pod
   
   =back 
   
 =cut  =cut
Removed from v.1.121  
changed lines
  Added in v.1.239

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