Diff for /loncom/interface/lonsearchcat.pm between versions 1.136 and 1.204

version 1.136, 2002/07/05 18:56:52 version 1.204, 2004/03/03 17:25:23
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 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. Variables used throughout the module                                   ##  
 ## 3. handler subroutine called via Apache and mod_perl                      ##  
 ## 4. 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();
 # ---------------------------------------- variables used throughout the module  use Apache::lonmeta;
   use Apache::lonhtmlcommon;
   use Apache::lonlocal;
   use LONCAPA::lonmetadata();
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
 =pod   ## Global variables
   ##
 =item Global variables  
   
 =over 4  
   
 =item $closebutton  
   
 button that closes the search window  
   
 =item $importbutton  
   
 button to take the select results and go to group sorting  
   
 =item %hash     
   
 The ubiquitous database hash  
   
 =item $diropendb   
   
 The full path to the (temporary) search database file.  This is set and  
 used in &handler() and is also used in &output_results().  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   my %groupsearch_db;  # Database hash used to save values for the 
                        # groupsearch RAT interface.
   my %persistent_db;   # gdbm hash which holds data which is supposed to
                        # persist across calls to lonsearchcat.pm
   
 # -- dynamically rendered interface components  # The different view modes and associated functions
 my $closebutton;  # button that closes the search window  
 my $importbutton; # button to take the selected results and go to group sorting  
   
 # -- miscellaneous variables  my %Views = ("detailed" => \&detailed_citation_view,
 my %hash;     # database hash       "summary"  => \&summary_view,
 my $diropendb = "";    # db file       "fielded"  => \&fielded_format_view,
        "xml"      => \&xml_sgml_view,
 ######################################################################       "compact"  => \&compact_view);
 ######################################################################  
   
 =pod   
   
 =item &handler() - main handler invoked by httpd child  
   
 =item Variables  
   
 =over 4  
   
 =item $hidden  
   
 holds 'hidden' html forms  
   
 =item $scrout  
   
 string that holds portions of the screen output  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
     untie %hash;  #    &set_defaults();
       #
     $r->content_type('text/html');      # set form defaults
       #
       my $hidden_fields;# Hold all the hidden fields used to keep track
                         # of the search system state
       my $importbutton; # button to take the selected results and go to group 
                         # sorting
       my $diropendb;    # The full path to the (temporary) search database file.
                         # This is set and used in &handler() and is also used in 
                         # &output_results().
       my $bodytag;  # LON-CAPA standard body tag, gotten from 
                     # &Apache::lonnet::bodytag. 
                     # No title, no table, just a <body> tag.
   
       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
   
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
       &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
       ##
     my $domain  = $r->dir_config('lonDefDomain');      ## Prevent caching of the search interface window.  Hopefully this means
     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).      ## we will get the launch=1 passed in a little more.
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";      &Apache::loncommon::no_cache($r);
       ## 
       ## Pick up form fields passed in the links.
       ##
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
              ['catalogmode','launch','acts','mode','form','element',               ['catalogmode','launch','acts','mode','form','element','pause',
               'reqinterface']);                'phase','persistent_db_id','table','start','show',
                 'cleargroupsort','titleelement']);
       ##
       ## 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';
       ##
       if (! &get_persistent_form_data($persistent_db_file)) {
           if ($ENV{'form.phase'} =~ /(run_search|results)/) {
               &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ".
                                        "from $persistent_db_file");
               $r->print(<<END);
   <html>
   <head><title>LON-CAPA Search Error</title></head>
   $bodytag
   We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
   END
               return OK;
           }
       }
     ##      ##
     ## Clear out old values from database      ## Clear out old values from groupsearch database
     ##      ##
     if ($ENV{'form.launch'} eq '1') {      untie %groupsearch_db if (tied(%groupsearch_db));
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {      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();      &start_fresh_session();
     untie %hash;      untie %groupsearch_db;
               delete($ENV{'form.cleargroupsort'});
  } else {   } else {
     $r->print('<html><head></head><body>Unable to tie hash to db '.              # This is a stupid error to give to the user.  
       'file</body></html>');              # It really tells them nothing.
       $r->print('<html><head></head>'.$bodytag.
                         'Unable to tie hash to db file</body></html>');
     return OK;      return OK;
  }   }
     }      }
     ##      ##
     ## Produce some output, so people know it is working      ## Configure hidden fields
     ##      ##
     $r->print("\n");      $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
     $r->rflush;          $ENV{'form.persistent_db_id'}.'" />'."\n";
       if (exists($ENV{'form.catalogmode'})) {
           $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
                   $ENV{'form.catalogmode'}.'" />'."\n";
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= '<input type="hidden" name="form" value="'.
                   $ENV{'form.form'}.'" />'."\n";
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= '<input type="hidden" name="element" value="'.
                   $ENV{'form.element'}.'" />'."\n";
       }
       if (exists($ENV{'form.titleelement'})) {
           $hidden_fields .= '<input type="hidden" name="titleelement" value="'.
                   $ENV{'form.titleelement'}.'" />'."\n";
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= '<input type="hidden" name="mode" value="'.
                   $ENV{'form.mode'}.'" />'."\n";
       }
     ##      ##
     ## Configure dynamic components of interface      ## Configure dynamic components of interface
     ##      ##
     my $hidden;       # Holds 'hidden' html forms  
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".          $closebutton="<input type='button' name='close' value='CLOSE' ";
     "\n";          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
         $closebutton="<input type='button' name='close' value='CLOSE' ".      $closebutton .="onClick='parent.close()'";
     "onClick='self.close()'>"."\n";          } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .=">\n";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
  $hidden=<<END;          $closebutton="<input type='button' name='close' value='CLOSE' ";
 <input type='hidden' name='catalogmode' value='groupsearch'>          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
 END      $closebutton .="onClick='parent.close()'";
         $closebutton=<<END;          } else {
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>              $closebutton .="onClick='self.close()'";
 END          }
           $closebutton .= ">";
         $importbutton=<<END;          $importbutton=<<END;
 <input type='button' name='import' value='IMPORT'  <input type='button' name='import' value='IMPORT'
 onClick='javascript:select_group()'>  onClick='javascript:select_group()'>
 END  END
       } else {
           $closebutton = '';
           $importbutton = '';
       }
       ##
       ## Sanity checks on form elements
       ##
       if (!defined($ENV{'form.viewselect'})) {
           if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
               ($ENV{'form.catalogmode'} eq 'interactive')) {
               $ENV{'form.viewselect'} ="Compact View";
           } else {
               $ENV{'form.viewselect'} ="Detailed Citation View";
           }
     }      }
     $hidden .= &make_persistent({ "form.mode"    => $ENV{'form.mode'},      $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
                                   "form.form"    => $ENV{'form.form'},      $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
                                   "form.element" => $ENV{'form.element'},      ##
                                   "form.date"    => 2 });      ## Switch on the phase
     ##      ##
     ##  What are we doing?      if ($ENV{'form.phase'} eq 'disp_basic') {
     ##          &print_basic_search_form($r,$closebutton,$hidden_fields);
     my $searchtype;      } elsif ($ENV{'form.phase'} eq 'disp_adv') {
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');          &print_advanced_search_form($r,$closebutton,$hidden_fields);
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');      } elsif ($ENV{'form.phase'} eq 'results') {
     if ($searchtype) {          &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')) {
           $ENV{'form.searchmode'} = 'basic';
           if ($ENV{'form.phase'} eq 'adv_search') {
               $ENV{'form.searchmode'} = 'advanced';
           }
           # Set up table
           if (! defined(&create_results_table())) {
       my $errorstring=&Apache::lonmysql::get_error();
               $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.
   <br />$errorstring
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           #
           # We are running a search
         my ($query,$customquery,$customshow,$libraries) =           my ($query,$customquery,$customshow,$libraries) = 
             (undef,undef,undef,undef);              (undef,undef,undef,undef);
         if ($searchtype eq 'Basic') {          my $pretty_string;
             $query = &parse_basic_search($r);          if ($ENV{'form.phase'} eq 'basic_search') {
         } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {              ($query,$pretty_string,$libraries) = 
             ($query,$customquery,$customshow,$libraries)                   &parse_basic_search($r,$closebutton,$hidden_fields);
                 = &parse_advanced_search($r);          } else {                      # Advanced search
               ($query,$customquery,$customshow,$libraries,$pretty_string) 
                   = &parse_advanced_search($r,$closebutton,$hidden_fields);
             return OK if (! defined($query));              return OK if (! defined($query));
         }          }
         # Send query statements over the network to be processed by           &make_persistent({ query => $query,
         # either the SQL database or a recursive scheme of 'grep'-like                              customquery => $customquery,
         # actions (for custom metadata).                             customshow => $customshow,
         $r->rflush();                             libraries => $libraries,
         my $reply=&Apache::lonnet::metadata_query($query,$customquery,                             pretty_string => $pretty_string },
                                                $customshow,$libraries);                           $persistent_db_file);
         &output_results($searchtype,$r,$reply,$hidden);          ##
     } elsif ($ENV{'form.reqinterface'} eq 'advanced') {          ## Print out the frames interface
         # Output the advanced interface          ##
         $r->print(&advanced_search_form($closebutton,$hidden));          &print_frames_interface($r);
     } else {   
         # Output normal search interface  
         $r->print(&basic_search_form($closebutton,$hidden));  
     }      }
     return OK;      return OK;
 }   } 
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
   ##   Course Search
   ##
   ######################################################################
   ######################################################################
   {   # Scope the course search to avoid global variables
   #
   # Variables For course search
   my %alreadyseen;
   my %hash;
   my $totalfound;
   
   sub course_search {
       my $r=shift;
       my $bodytag=&Apache::loncommon::bodytag('Course Search').
    &Apache::loncommon::help_open_bug('Searching');
       my $pretty_search_string = '<b>'.$ENV{'form.courseexp'}.'</b>';
       my $search_string = $ENV{'form.courseexp'};
       my @New_Words;
       if ($ENV{'form.crsrelated'}) {
           ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
           if (@New_Words) {
               $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= ' '.&mt('with no related words').".";
           }
       }
       my $fulltext=$ENV{'form.crsfulltext'};
       my @allwords=($search_string,@New_Words);
       $totalfound=0;
       $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
         $bodytag.'<hr /><center><font size="+2" face="arial">'.$pretty_search_string.'</font></center><hr />');
       $r->rflush();
   # ======================================================= Go through the course
       undef %alreadyseen;
       %alreadyseen=();
       my $c=$r->connection;
       if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
           foreach (keys %hash) {
               if ($c->aborted()) { last; }
               if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
                   &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
                                @allwords);
               }
           }
           untie(%hash);
       }
       unless ($totalfound) {
    $r->print('<p>'.&mt('No resources found').'.</p>');
       }
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
   # =============================== This pulls up a resource and its dependencies
   
   sub checkonthis {
       my ($r,$url,$level,$title,$fulltext,@allwords)=@_;
       $alreadyseen{$url}=1;
       $r->rflush();
       my $result=&Apache::lonnet::metadata($url,'title').' '.
                  &Apache::lonnet::metadata($url,'subject').' '.
                  &Apache::lonnet::metadata($url,'abstract').' '.
                  &Apache::lonnet::metadata($url,'keywords');
       if (($url) && ($fulltext)) {
    $result.=&Apache::lonnet::ssi_body($url);
       }
       $result=~s/\s+/ /gs;
       my $applies=0;
       foreach (@allwords) {
           if ($_=~/\w/) {
      if ($result=~/$_/si) {
         $applies++;
              }
          }
       }
   # Does this resource apply?
       if ($applies) {
          $r->print('<br />');
          for (my $i=0;$i<=$level*5;$i++) {
              $r->print('&nbsp;');
          }
          $r->print('<a href="'.$url.'" target="cat">'.
    ($title?$title:$url).'</a><br />');
          $totalfound++;
       } elsif ($fulltext) {
          $r->print(' .');
       }
       $r->rflush();
   # Check also the dependencies of this one
       my $dependencies=
                   &Apache::lonnet::metadata($url,'dependencies');
       foreach (split(/\,/,$dependencies)) {
          if (($_=~/^\/res\//) && (!$alreadyseen{$_})) {
             &checkonthis($r,$_,$level+1,'',$fulltext,@allwords);
          }
       }
   }
   
   sub untiehash {
       if (tied(%hash)) {
           untie(%hash);
       }
   }
   
   } # End of course search scoping
   
   ######################################################################
   ######################################################################
   
 =pod   =pod 
   
 =item &basic_search_form()   =item &print_basic_search_form() 
   
 Returns a scalar which holds html for the basic search form.  Prints the form for the basic search.  Sorry the name is so cryptic.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub print_basic_search_form {
 sub basic_search_form{      my ($r,$closebutton,$hidden_fields) = @_;
     my ($closebutton,$hidden) = @_;      my $bodytag=&Apache::loncommon::bodytag('Search').
    &Apache::loncommon::help_open_topic('Finding_Resources').
    &Apache::loncommon::help_open_bug('Searching');
     my $scrout=<<"ENDDOCUMENT";      my $scrout=<<"ENDDOCUMENT";
 <html>  <html>
 <head>  <head>
Line 277  sub basic_search_form{ Line 484  sub basic_search_form{
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  ENDDOCUMENT
 <h1>Search Catalog</h1>  if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
 <form method="post" action="/adm/searchcat">      my $CatalogSearch=&mt('Catalog Search');
 $hidden      my $Statement=&searchhelp();
 <h3>Basic Search</h3>      $scrout.=(<<ENDDOCUMENT);
   <h1>$CatalogSearch</h1>
   <form name="loncapa_search" method="post" action="/adm/searchcat">
   <input type="hidden" name="phase" value="basic_search" />
   $hidden_fields
 <p>  <p>
 Enter terms or phrases separated by AND, OR, or NOT   $Statement.
 then press SEARCH below.  
 </p>  </p>
 <p>  <p>
 <table>  <table>
 <tr><td>  <tr><td>
 ENDDOCUMENT  ENDDOCUMENT
     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).      $scrout.='&nbsp;'.&Apache::lonhtmlcommon::textbox('basicexp',
                                               $ENV{'form.basicexp'},40).
         '&nbsp;';          '&nbsp;';
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});      my $relatedcheckbox = &Apache::lonhtmlcommon::checkbox('related',
 #    $scrout.='<font color="#800000">Search historic archives</font>';   $ENV{'form.related'});
     $scrout.=<<ENDDOCUMENT;      my $domain = $r->dir_config('lonDefDomain');
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>      my $domaincheckbox = &Apache::lonhtmlcommon::checkbox('domains',
    $ENV{'form.domains'});
       my $srch=&mt('Search');
       my $header=&mt('Advanced Search');
       my $userelatedwords=&mt('use related words');
       my $onlysearchdomain=&mt('only search domain');
       my $view=&viewoptions();
       $scrout.=<<END;
   </td><td><a
   href="/adm/searchcat?phase=disp_adv&catalogmode=$ENV{'form.catalogmode'}&launch=$ENV{'form.launch'}&mode=$ENV{'form.mode'}"
   >$header</a></td></tr>
   <tr><td>$relatedcheckbox $userelatedwords</td>
       <td>$domaincheckbox $onlysearchdomain <b>$domain</b></td></tr>
   </table>
 </p>  </p>
   $view
 <p>  <p>
 &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;  &nbsp;<input type="submit" name="basicsubmit" value='$srch' />&nbsp;
 $closebutton  $closebutton
 <!-- view selection -->  END
 <select name="viewselect">      $scrout.=<<ENDDOCUMENT;
 <option value="Detailed Citation View" selected="true" >Detailed Citation View</option>  
 <option value="Summary View"  >Summary View</option>  
 <option value="Fielded Format">Fielded Format</option>  
 <option value="XML/SGML"      >XML/SGML</option>  
 </select>  
 <!-- end of view selection -->  
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  </p>
 </form>  </form>
   ENDDOCUMENT
       }
       if ($ENV{'request.course.id'}) {
    my %lt=&Apache::lonlocal::texthash(
      'srch' => 'Search',
                                              'header' => 'Course Search',
    'note' => 'Enter terms or phrases, then press "Search" below',
    'use' => 'use related words',
    'full' =>'fulltext search (time consuming)'
      );
           $scrout.=(<<ENDCOURSESEARCH);
   <hr />
   <h1>$lt{'header'}</h1>    
   <form name="course_search" method="post" action="/adm/searchcat">
   <input type="hidden" name="phase" value="course_search" />
   $hidden_fields
   <p>
   $lt{'note'}.
   </p>
   <p>
   <table>
   <tr><td>
   ENDCOURSESEARCH
           $scrout.='&nbsp;'.
               &Apache::lonhtmlcommon::textbox('courseexp',
                                     $ENV{'form.courseexp'},40);
           my $crscheckbox = 
               &Apache::lonhtmlcommon::checkbox('crsfulltext',
                                      $ENV{'form.crsfulltext'});
           my $relcheckbox = 
               &Apache::lonhtmlcommon::checkbox('crsrelated',
      $ENV{'form.crsrelated'});
           $scrout.=(<<ENDENDCOURSE);
   </td></tr>
   <tr><td>$relcheckbox $lt{'use'}</td><td></td></tr>
   <tr><td>$crscheckbox $lt{'full'}</td><td></td></tr>
   </table><p>
   &nbsp;<input type="submit" name="coursesubmit" value='$lt{'srch'}' />
   </p>
   ENDENDCOURSE
       }
       $scrout.=(<<ENDDOCUMENT);
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 324  ENDDOCUMENT Line 585  ENDDOCUMENT
   
 =item &advanced_search_form()   =item &advanced_search_form() 
   
 Returns a scalar which holds html for the advanced search form.  Prints the advanced search form.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub print_advanced_search_form{
 sub advanced_search_form{      my ($r,$closebutton,$hidden_fields) = @_;
     my ($closebutton,$hidden) = @_;      my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
          'reset' => 'Reset',
          'help' => 'Help');
     my $advanced_buttons = <<"END";      my $advanced_buttons = <<"END";
 <p>  <p>
 <input type="submit" name="advancedsubmit" value='SEARCH' />  <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
 <input type="reset" name="reset" value='RESET' />  <input type="reset" name="reset" value='$lt{"reset"}' />
 $closebutton  $closebutton
 <input type="button" value="HELP" onClick="openhelp()" />  <input type="button" value="$lt{'help'}" onClick="openhelp()" />
 </p>  </p>
 END  END
       my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search');
       my $searchhelp=&searchhelp();
     my $scrout=<<"ENDHEADER";      my $scrout=<<"ENDHEADER";
 <html>  <html>
 <head>  <head>
Line 353  END Line 618  END
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  $searchhelp
 <h1>Advanced Catalog Search</h1>  <form method="post" action="/adm/searchcat" name="advsearch">
 <hr />  
 Enter terms or phrases separated by search operators   
 such as AND, OR, or NOT.<br />  
 <form method="post" action="/adm/searchcat">  
 $advanced_buttons  $advanced_buttons
 $hidden  $hidden_fields
 <table>  <input type="hidden" name="phase" value="adv_search" />
 <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>  
 <td>  
 <!-- view selection -->  
 <select name="viewselect" size ="1">  
     <option value="Detailed Citation View" selected="true">Detailed Citation View</option>  
     <option value="Summary View">Summary View</option>  
     <option value="Fielded Format">Fielded Format</option>  
     <option value="XML/SGML">XML/SGML</option>  
 </select>  
 <!-- end of view selection -->  
 </td></tr>  
 ENDHEADER  ENDHEADER
     $scrout.=&searchphrasefield('title',   'title'   ,$ENV{'form.title'});      $scrout.=&viewoptions();
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});      my %fields=&Apache::lonmeta::fieldnames();
     $scrout.=&searchphrasefield('subject', 'subject' ,$ENV{'form.subject'});  
     $scrout.=&searchphrasefield('keywords','keywords',$ENV{'form.keywords'});      $scrout.='<table>';
     $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});      $scrout.="<tr><th>".&mt('Field').'</th><th>'.&mt('Value').'</th><th>'
     $scrout.=&searchphrasefield('notes',   'notes'   ,$ENV{'form.notes'});   .&mt('Related').'<br />'.&mt('Words')."</td></tr>\n";
     $scrout.=&searchphrasefield('abstract','abstract',$ENV{'form.abstract'});      foreach ('title','author','owner','authorspace','modifyinguser',
     # Hack - an empty table row.       'keywords','notes','abstract','standards',
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";       'lowestgradelevel','highestgradelevel','mime') {
     $scrout.=&searchphrasefield('file<br />extension','mime',   $scrout.='<tr bgcolor="#FFFFBB"><td>'.&titlefield($fields{$_}).'</td><td>'.
                         $ENV{'form.mime'});      &Apache::lonmeta::prettyinput($_,$ENV{'form.'.$_},$_,'advsearch',
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";    1,'</td><td>',$ENV{'form.'.$_.'_related'}).
     $scrout.=&searchphrasefield('publisher<br />owner','owner',      '</td></tr>';
  $ENV{'form.owner'});      }
     $scrout.="</table>\n";      $scrout.='<tr bgcolor="#FFFFBB"><td>'.
     $ENV{'form.category'}='any' unless length($ENV{'form.category'});   &titlefield(&mt('MIME Type Category')).'</td><td>'. 
     $scrout.=&selectbox('File Category','category',      &Apache::loncommon::filecategoryselect('category',
  $ENV{'form.category'},     $ENV{'form.category'}).
  'any','Any category',      '</td><td>&nbsp;</td></td></tr>';
  undef,      $scrout.='<tr bgcolor="#FFFFBB"><td>'.
  (&Apache::loncommon::filecategories()));   &titlefield(&mt('Limit Search to Domains')).'</td><td>'. 
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});      &Apache::loncommon::domain_select('domains',
     #----------------------------------------------------------------     $ENV{'form.domains'},1).
     # Allow restriction to multiple domains.      '</td><td>&nbsp;</td></td></tr>';
     #   I make the crazy assumption that there will never be a domain 'any'.      my %dates=&Apache::lonlocal::texthash
     #          ('creationdatestart'     => 'Creation Date After',
     $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));           'creationdateend'       => 'Creation Date Before',
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}            'lastrevisiondatestart' => 'Last Revision Date After',
                            :  ($ENV{'form.domains'}) );           'lastrevisiondateend'   => 'Last Revision Date Before');
     my %domain_hash = ();      foreach (sort keys %dates) {
     foreach (@allowed_domains) {   $scrout.='<tr bgcolor="#FFFFBB">'.
         $domain_hash{$_}++;              '<td>'.&titlefield($dates{$_}).'</td><td>'. 
       &Apache::lonhtmlcommon::date_setter('advsearch',$_,0,'',1).
       '</td><td>&nbsp;</td></td>'.
               '</tr>';
     }      }
     my @domains =&Apache::loncommon::get_domains();  
     # adjust the size of the select box      $scrout.="</table>\n";
     my $size = 4;  
     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);  
     # standalone machines do not get to choose a domain to search.  
     if ((scalar @domains) == 1) {  
         $scrout .='<input type="hidden" name="domains" value="any" />'."\n";  
     } else {  
         $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.  
             'DOMAINS</b></font><br />'.  
                 '<select name="domains" size="'.$size.'" multiple>'."\n".  
                     '<option name="any" value="any" '.  
                         ($domain_hash{'any'}? 'selected ' :'').  
                         '>all domains</option>'."\n";  
         foreach my $dom (sort @domains) {  
             $scrout.="<option name=\"$dom\" ".  
                 ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";  
         }  
         $scrout.="</select>\n";  
     }  
     #----------------------------------------------------------------  
     $scrout.=&selectbox('Limit by language','language',  
  $ENV{'form.language'},'any','Any Language',  
  \&{Apache::loncommon::languagedescription},  
  (&Apache::loncommon::languageids),  
  );  
 # ------------------------------------------------ Compute date selection boxes  
     $scrout.=<<CREATIONDATESTART;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>  
 </font>  
 <br />  
 between:  
 CREATIONDATESTART  
     $scrout.=&dateboxes('creationdatestart',1,1,1976,  
  $ENV{'form.creationdatestart_month'},  
  $ENV{'form.creationdatestart_day'},  
  $ENV{'form.creationdatestart_year'},  
  );  
     $scrout.="and:\n";  
     $scrout.=&dateboxes('creationdateend',12,31,2051,  
  $ENV{'form.creationdateend_month'},  
  $ENV{'form.creationdateend_day'},  
  $ENV{'form.creationdateend_year'},  
  );  
     $scrout.="</p>";  
     $scrout.=<<LASTREVISIONDATESTART;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:  
 </b></font>  
 <br />between:  
 LASTREVISIONDATESTART  
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,  
  $ENV{'form.lastrevisiondatestart_month'},  
  $ENV{'form.lastrevisiondatestart_day'},  
  $ENV{'form.lastrevisiondatestart_year'},  
  );  
     $scrout.=<<LASTREVISIONDATEEND;  
 and:  
 LASTREVISIONDATEEND  
     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,  
  $ENV{'form.lastrevisiondateend_month'},  
  $ENV{'form.lastrevisiondateend_day'},  
  $ENV{'form.lastrevisiondateend_year'},  
  );  
     $scrout.='</p>';  
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});  
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',  
  $ENV{'form.copyright'},  
  'any','Any copyright/distribution',  
  \&{Apache::loncommon::copyrightdescription},  
  (&Apache::loncommon::copyrightids),  
  );  
 # ------------------------------------------- Compute customized metadata field  
     $scrout.=<<CUSTOMMETADATA;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>  
 </font>  
 For resource-specific metadata, enter in an expression in the form of   
 <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />  
 <b>Example:</b> grandmother=75 OR grandfather=85  
 <br />  
 CUSTOMMETADATA  
     $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});  
     $scrout.=<<CUSTOMSHOW;  
 <p>  
 <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>  
 </font>  
 Enter in a space-separated list of special metadata fields to show  
 in a fielded listing for each record result.  
 <br />  
 CUSTOMSHOW  
     $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});  
     $scrout.=<<ENDDOCUMENT;      $scrout.=<<ENDDOCUMENT;
 $advanced_buttons  $advanced_buttons
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 515  ENDDOCUMENT Line 678  ENDDOCUMENT
   
 =pod   =pod 
   
 =item &make_persistent()   =item &titlefield()
   
   Inputs: title text
   
 Returns a scalar which holds the current ENV{'form.*'} values in  Outputs: titletext with font wrapper
 a 'hidden' html input tag.  This allows search interface information  
 to be somewhat persistent.  
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub titlefield {
 sub make_persistent {      my $title=shift;
     my %save = %{shift()};      return '<font face="arial" color="#800000">'.$title.'</font>';
     my $persistent='';  
     foreach (keys %save) {  
  if (/^form\./ && !/submit/) {  
     my $name=$_;  
             my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));  
     $name=~s/^form\.//;  
             foreach (@values) {  
                 s/\"/\'/g; # do not mess with html field syntax  
                 $persistent.=<<END;  
 <input type="hidden" name="$name" value="$_" />  
 END  
             }  
         }  
     }  
     return $persistent;  
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item HTML form building functions  =item viewoptiontext()
   
 =over 4  Inputs: codename for view option
   
 =item &simpletextfield()   Outputs: displayed text
   
 Inputs: $name,$value,$size  =cut
   
 Returns a text input field with the given name, value, and size.    ######################################################################
 If size is not specified, a value of 20 is used.  ######################################################################
   sub viewoptiontext {
       my $code=shift;
       my %desc=&Apache::lonlocal::texthash
           ('detailed' => "Detailed Citation View",
            'xml' => 'XML/SGML',
            'compact' => 'Compact View',
            'fielded' => 'Fielded Format',
            'summary' => 'Summary View');
       return $desc{$code};
   }
   
 =item &simplecheckbox()  ######################################################################
   ######################################################################
   
 Inputs: $name,$value  =pod 
   
 Returns a simple check box with the given $name.  =item viewoptions()
 If $value eq 'on' the box is checked.  
   
 =item &searchphrasefield()  Inputs: none
   
 Inputs: $title,$name,$value  Outputs: text for box with view options
   
 Returns html for a title line and an input field for entering search terms.  =cut
 the instructions "Enter terms or phrases separated by search operators such   
 as AND, OR, or NOT." are given following the title.  The entry field (which  
 is where the $name and $value are used) is an 80 column simpletextfield.  
   
 =item &dateboxes()  ######################################################################
   ######################################################################
   sub viewoptions {
       my $scrout="\n\n".'<table bgcolor="#FFFFBB">'.
           '<tr><th>'.&mt('View Options').'</th><th>'.
    &mt('Records per Page').'</th></tr><tr><td>';
       unless ($ENV{'form.viewselect'}) { $ENV{'form.viewselect'}='detailed'; }
       $scrout.=&Apache::lonmeta::selectbox('viewselect',
    $ENV{'form.viewselect'},
    \&viewoptiontext,
    sort(keys(%Views)));
       $scrout.='</td><td>';
       $scrout.=&Apache::lonmeta::selectbox('show',
    $ENV{'form.show'},
    undef,
    (10,20,50,100,1000,10000));
       $scrout.="</td></tr></table>\n\n";
       return $scrout;
   }
   
 Returns html selection form elements for the specification of   ######################################################################
 the day, month, and year.  ######################################################################
   
 =item &selectbox()  =pod 
   
 Returns a scalar containing an html <select> form.    =item searchhelp()
   
 Inputs:   Inputs: none
   
 =over 4  Outputs: return little blurb on how to enter searches
   
 =item $title   =cut
   
 Printed above the select box, in uppercase.  ######################################################################
   ######################################################################
   sub searchhelp {
       return &mt('Enter terms or phrases separated by AND, OR, or NOT');
   }
   
 =item $name   ######################################################################
   ######################################################################
   
 The name element of the <select> tag.  =pod 
   
 =item $default   =item &get_persistent_form_data()
   
 The default value of the form.  Can be $anyvalue or in @idlist.  Inputs: filename of database
   
 =item $anyvalue   Outputs: returns undef on database errors.
   
 The <option value="..."> used to indicate a default of   This function is the reverse of &make_persistent() for form data.
 none of the values.  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.
   
 =item $anytag   =cut
   
 The text associate with $anyvalue above.  ######################################################################
   ######################################################################
   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;
   }
   
 =item $functionref   ######################################################################
   ######################################################################
   
 Each element in @idlist will be passed as a parameter   =pod 
 to the function referenced here.  The return value of the function should  
 be a scalar description of the items.  If this value is undefined the   
 description of each item in @idlist will be the item name.  
   
 =item @idlist   =item &get_persistent_data()
   
 The items to be selected from.  One of these or $anyvalue will be the   Inputs: filename of database, ref to array of values to recover.
 value returned by the form element, $ENV{form.$name}.  
   
 =back  Outputs: array of values.  Returns undef on error.
   
 =back   This function is the reverse of &make_persistent();
   Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If the item contains commas (before unescaping), the
   returned value will be an array pointer. 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub get_persistent_data {
       my $filename = shift;
       my @Vars = @{shift()};
       my @Values;   # Return array
       return undef if (! -e $filename);
       return undef if (! tie(%persistent_db,'GDBM_File',$filename,
                              &GDBM_READER(),0640));
       foreach my $name (@Vars) {
           if (! exists($persistent_db{$name})) {
               push @Values, undef;
               next;
           }
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           if (@values <= 1) {
               push @Values,$values[0];
           } else {
               push @Values,\@values;
           }
       }
       untie (%persistent_db);
       return @Values;
   }
   
   ######################################################################
   ######################################################################
   
 sub simpletextfield {  =pod 
     my ($name,$value,$size)=@_;  
     $size = 20 if (! defined($size));  =item &make_persistent() 
     return '<input type="text" name="'.$name.  
         '" size="'.$size.'" value="'.$value.'" />';  Inputs: Hash of values to save, filename of persistent database.
 }  
   Store variables away to the %persistent_db.
 sub simplecheckbox {  Values will be escaped.  Values that are array pointers will have their
     my ($name,$value)=@_;  elements escaped and concatenated in a comma seperated string.  
     my $checked='';  
     $checked="checked" if $value eq 'on';  =cut
     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';  
 }  ######################################################################
   ######################################################################
 sub searchphrasefield {  sub make_persistent {
     my ($title,$name,$value)=@_;      my %save = %{shift()};
     my $uctitle=uc($title);      my $filename = shift;
     return '<tr><td><font color="#800000" face="helvetica">'.      return undef if (! tie(%persistent_db,'GDBM_File',
         '<b>'.$uctitle.':&nbsp;</b></font></td><td>'.                             $filename,&GDBM_WRCREAT(),0640));
                 &simpletextfield($name,$value,50)."</td></tr>\n";      foreach my $name (keys(%save)) {
 }          my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
           # We handle array references, but not recursively.
 sub dateboxes {          my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
     my ($name,$defaultmonth,$defaultday,$defaultyear,          $persistent_db{$name} = $store;
  $currentmonth,$currentday,$currentyear)=@_;  
     ($defaultmonth,$defaultday,$defaultyear)=('','','');  
     #  
     # Day  
     my $day=<<END;  
 <select name="${name}_day">  
 <option value='$defaultday'> </option>  
 END  
     for (my $i = 1; $i<=31; $i++) {  
  $day.="<option value=\"$i\">$i</option>\n";  
     }      }
     $day.="</select>\n";      untie(%persistent_db);
     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);      return 1;
     #  }
     # Month  
     my $month=<<END;  ######################################################################
 <select name="${name}_month">  ######################################################################
 <option value='$defaultmonth'> </option>  
 END  =pod 
     my $i = 1;  
     foreach (qw/January February March April May June   =item &make_form_data_persistent() 
      July August September October November December /){  
  $month .="<option value=\"$i\">$_</option>\n";  Inputs: filename of persistent database.
  $i++;  
     }  Store most form variables away to the %persistent_db.
     $month.="</select>\n";  Values will be escaped.  Values that are array pointers will have their
     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);  elements escaped and concatenated in a comma seperated string.  
     #  
     # Year (obviously)  =cut
     my $year=<<END;  
 <select name="${name}_year">  ######################################################################
 <option value='$defaultyear'> </option>  ######################################################################
 END  sub make_form_data_persistent {
     my $maxyear = 2051;       my $r = shift;
     for (my $i = 1976; $i<=$maxyear; $i++) {      my $filename = shift;
  $year.="<option value=\"$i\">$i</option>\n";      my %save;
     }      foreach (keys(%ENV)) {
     $year.="</select>\n";          next if (!/^form/ || /submit/);
     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);          $save{$_} = $ENV{$_};
     return "$month$day$year";  
 }  
   
 sub selectbox {  
     my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;  
     if (! defined($functionref)) { $functionref = sub { $_[0]}; }  
     my $uctitle=uc($title);  
     my $selout="\n".'<p><font color="#800000" face="helvetica">'.  
         '<b>'.$uctitle.': </b></font><select name="'.$name.'">';  
     foreach ($anyvalue,@idlist) {  
         $selout.='<option value="'.$_.'"';  
         if ($_ eq $default and !/^any$/) {  
     $selout.=' selected >'.&{$functionref}($_).'</option>';  
  }  
  elsif ($_ eq $default and /^$anyvalue$/) {  
     $selout.=' selected >'.$anytag.'</option>';  
  }  
         else {$selout.='>'.&{$functionref}($_).'</option>';}  
     }      }
     return $selout.'</select></p>';      return &make_persistent(\%save,$filename);
 }  }
   
 ######################################################################  ######################################################################
Line 744  Parse advanced search form and return th Line 957  Parse advanced search form and return th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_advanced_search {  sub parse_advanced_search {
     my ($r)=@_;      my ($r,$closebutton,$hidden_fields)=@_;
     my $fillflag=0;      my $fillflag=0;
       my $pretty_search_string = "<br />\n";
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
    'creationdatestart_month','creationdatestart_day',     'creationdatestart_month','creationdatestart_day',
Line 754  sub parse_advanced_search { Line 968  sub parse_advanced_search {
    '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',     'notes','abstract','extension','language','owner',
    'custommetadata','customshow','category') {     'custommetadata','customshow','category') {
  $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
Line 765  sub parse_advanced_search { Line 979  sub parse_advanced_search {
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
     # Preprocess the category form element.      # Preprocess the category form element.
     if ($ENV{'form.category'} ne 'any') {      $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) ||
         my @extensions = &Apache::loncommon::filecategorytypes                                        ref($ENV{'form.category'}));
             ($ENV{'form.category'});      #
         $ENV{'form.mime'} = join ' OR ',@extensions;  
     }  
     # Check to see if enough information was filled in      # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
    'notes','abstract','mime','language','owner',     'notes','abstract','category','extension','language',
    'custommetadata') {                     'owner','custommetadata') {
  if (&filled($ENV{"form.$field"})) {   if (&filled($ENV{"form.$field"})) {
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton,
                                     'phase=disp_adv',$hidden_fields);
  return ;   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 ('title','author','subject','notes','abstract','url',
        'keywords','version','owner','mime') {         'keywords','version','owner','standards') {
  if ($ENV{'form.'.$field}) {   if ($ENV{'form.'.$field}) {
     push @queries,&build_SQL_query($field,$ENV{'form.'.$field});              my $searchphrase = $ENV{'form.'.$field};
               $pretty_search_string .= $font."$field</font> contains <b>".
                   $searchphrase."</b>";
               if ($ENV{'form.'.$field.'_related'}) {
                   my @New_Words;
                   ($searchphrase,@New_Words) = &related_version($searchphrase);
                   if (@New_Words) {
                       $pretty_search_string .= " with related words: ".
                           "<b>@New_Words</b>.";
                   } else {
                       $pretty_search_string .= " with no related words.";
                   }
               }
               $pretty_search_string .= "<br />\n";
       push @queries,&build_SQL_query($field,$searchphrase);
         }          }
     }      }
     # I dislike the hack below.      #
     if ($ENV{'form.category'}) {      # Make the 'mime' from 'form.category' and 'form.extension'
         $ENV{'form.mime'}='';      #
       my $searchphrase;
       if (exists($ENV{'form.category'})    && 
           $ENV{'form.category'} !~ /^\s*$/ &&
           $ENV{'form.category'} ne 'any')     {
           my @extensions = &Apache::loncommon::filecategorytypes
                                                      ($ENV{'form.category'});
           if (scalar(@extensions) > 0) {
               $searchphrase = join(' OR ',@extensions);
           }
       }
       if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) {
           $searchphrase .= ' OR ' if (defined($searchphrase));
           my @extensions = split(/,/,$ENV{'form.extension'});
           $searchphrase .= join(' OR ',@extensions);
       }
       if (defined($searchphrase)) {
           push @queries,&build_SQL_query('mime',$searchphrase);
           $pretty_search_string .=$font.'mime</font> contains <b>'.
               $searchphrase.'</b><br />';
     }      }
       #
     # Evaluate option lists      # Evaluate option lists
     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>= ".
               &Apache::loncommon::languagedescription($ENV{'form.language'}).
                   "<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      # Evaluate date windows
     my $datequery=&build_date_queries(      my $datequery=&build_date_queries(
  $ENV{'form.creationdatestart_month'},   $ENV{'form.creationdatestart_month'},
Line 820  sub parse_advanced_search { Line 1075  sub parse_advanced_search {
  );   );
     # Test to see if date windows are legitimate      # Test to see if date windows are legitimate
     if ($datequery=~/^Incorrect/) {      if ($datequery=~/^Incorrect/) {
  &output_date_error($r,$datequery);   &output_date_error($r,$datequery,$closebutton,$hidden_fields);
  return ;   return ;
     }      } elsif ($datequery) {
     elsif ($datequery) {          # Here is where you would set up pretty_search_string to output
           # date query information.
  push @queries,$datequery;   push @queries,$datequery;
     }      }
       #
     # Process form information for custom metadata querying      # Process form information for custom metadata querying
     my $customquery=undef;      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
       ##
       # if ($ENV{'form.custommetadata'}) {
       #    $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
       #    $ENV{'form.custommetadata'}."</b><br />\n";
       #    $customquery=&build_custommetadata_query('custommetadata',
       #                                             $ENV{'form.custommetadata'});
       # }
     my $customshow=undef;      my $customshow=undef;
     if ($ENV{'form.customshow'}) {      # if ($ENV{'form.customshow'}) {
  $customshow=$ENV{'form.customshow'};      # $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
  $customshow=~s/[^\w\s]//g;      #                         $ENV{'form.customshow'}."</b><br />\n";
  my @fields=split(/\s+/,$customshow);      #    $customshow=$ENV{'form.customshow'};
  $customshow=join(" ",@fields);      #    $customshow=~s/[^\w\s]//g;
     }      #    my @fields=split(/\s+/,$customshow);
     ## ---------------------------------------------------------------      #    $customshow=join(" ",@fields);
       # }
       ##
     ## Deal with restrictions to given domains      ## Deal with restrictions to given domains
     ##       ## 
       my ($libraries_to_query,$pretty_domains_string) = 
           &parse_domain_restrictions();
       $pretty_search_string .= $pretty_domains_string."<br />\n";
       #
       if (@queries) {
    $query=join(" AND ",@queries);
    $query="select * from metadata where $query";
       } elsif ($customquery) {
           $query = '';
       }
       return ($query,$customquery,$customshow,$libraries_to_query,
               $pretty_search_string);
   }
   
   sub parse_domain_restrictions {
     my $libraries_to_query = undef;      my $libraries_to_query = undef;
     # $ENV{'form.domains'} can be either a scalar or an array reference.      # $ENV{'form.domains'} can be either a scalar or an array reference.
     # We need an array.      # We need an array.
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}       if (! exists($ENV{'form.domains'})) {
                            :  ($ENV{'form.domains'}) );          return (undef,'');
       }
       my @allowed_domains;
       if (ref($ENV{'form.domains'})) {
           @allowed_domains =  @{$ENV{'form.domains'}};
       } else {
           @allowed_domains = ($ENV{'form.domains'});
       }
       #
     my %domain_hash = ();      my %domain_hash = ();
       my $pretty_domains_string;
     foreach (@allowed_domains) {      foreach (@allowed_domains) {
         $domain_hash{$_}++;          $domain_hash{$_}++;
     }      }
     foreach (keys(%Apache::lonnet::libserv)) {      if ($domain_hash{'any'}) {
         if ($_ eq 'any') {          $pretty_domains_string = "In all LON-CAPA domains.";
             $libraries_to_query = undef;      } else {
             last;          if (@allowed_domains > 1) {
               $pretty_domains_string = "In LON-CAPA domains:";
           } else {
               $pretty_domains_string = "In LON-CAPA domain ";
         }          }
         if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {          foreach (sort @allowed_domains) {
             push @$libraries_to_query,$_;              $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);
     if (@queries) {  
  $query=join(" AND ",@queries);  
  $query="select * from metadata where $query";  
     } elsif ($customquery) {  
         $query = '';  
     }  
     return ($query,$customquery,$customshow,$libraries_to_query);  
 }  }
   
 ######################################################################  ######################################################################
Line 884  Parse the basic search form and return a Line 1175  Parse the basic search form and return a
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_basic_search {  sub parse_basic_search {
     my ($r)=@_;      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;
Line 895  sub parse_basic_search { Line 1187  sub parse_basic_search {
  $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) = 
     # Check to see if enough is filled in          &parse_domain_restrictions();
       #
       # Check to see if enough of a query is filled in
     unless (&filled($ENV{'form.basicexp'})) {      unless (&filled($ENV{'form.basicexp'})) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton,'phase=disp_basic');
  return OK;   return OK;
     }      }
       my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
       my $search_string = $ENV{'form.basicexp'};
       if ($ENV{'form.related'}) {
           my @New_Words;
           ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'});
           if (@New_Words) {
               $pretty_search_string .= " with related words: <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= " with no related words.";
           }
       }
       #
     # Build SQL query string based on form page      # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',',
        ('title', 'author', 'subject', 'notes', 'abstract',         ('title', 'author', 'subject', 'notes', 'abstract',
                         'keywords'));                          'keywords'));
     $concatarg='title' if $ENV{'form.titleonly'};      $concatarg='title' if $ENV{'form.titleonly'};
       $query=&build_SQL_query('concat_ws(" ",'.$concatarg.')',$search_string);
     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});      if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
     return 'select * from metadata where '.$query;          $pretty_search_string .= ' '.$pretty_domains_string;
       }
       $pretty_search_string .= "<br />\n";
       my $final_query = 'SELECT * FROM metadata WHERE '.$query;
       # &Apache::lonnet::logthis($final_query);
       return ($final_query,$pretty_search_string,
               $libraries_to_query);
 }  }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &related_version()
   
   Modifies an input string to include related words.  Words in the string
   are replaced with parenthesized lists of 'OR'd words.  For example
   "torque" is replaced with "(torque OR word1 OR word2 OR ...)".  
   
   Note: Using this twice on a string is probably silly.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub related_version {
       my $search_string = shift;
       my $result = $search_string;
       my %New_Words = ();
       while ($search_string =~ /(\w+)/cg) {
           my $word = $1;
           next if (lc($word) =~ /\b(or|and|not)\b/);
           my @Words = &Apache::loncommon::get_related_words($word);
           @Words = ($#Words>4? @Words[0..4] : @Words);
           foreach (@Words) { $New_Words{$_}++;}
           my $replacement = join " OR ", ($word,@Words);
           $result =~ s/(\b)$word(\b)/$1($replacement)$2/g;
       }
       return $result,sort(keys(%New_Words));
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 990  sub recursive_SQL_query_build { Line 1333  sub recursive_SQL_query_build {
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
     return $pattern unless @matches;      return $pattern unless @matches;
     foreach my $match (@matches) {      foreach my $match (@matches) {
  $match=~/\[ (\w+)\s(.*) \]/;          $match=~/\[ (\w+)\s(.*) \]/;
  my ($key,$value)=($1,$2);          my ($key,$value)=($1,$2);
  my $replacement='';          my $replacement='';
  if ($key eq 'literal') {          if ($key eq 'literal') {
     $replacement="($dkey like \"\%$value\%\")";              $replacement="($dkey LIKE \"\%$value\%\")";
  }          } elsif (lc($key) eq 'not') {
  elsif ($key eq 'not') {              $value=~s/LIKE/NOT LIKE/;
     $value=~s/like/not like/;  #          $replacement="($dkey not like $value)";
 #    $replacement="($dkey not like $value)";              $replacement="$value";
     $replacement="$value";          } elsif ($key eq 'and') {
  }              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  elsif ($key eq 'and') {              $replacement="($1 AND $2)";
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;   } elsif ($key eq 'or') {
     $replacement="($1 AND $2)";              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  }              $replacement="($1 OR $2)";
  elsif ($key eq 'or') {  
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  
     $replacement="($1 OR $2)";  
  }   }
  substr($pattern,   substr($pattern,
        index($pattern,$match),                 index($pattern,$match),
        length($match),                 length($match),
        $replacement                 $replacement);
        );  
     }      }
     &recursive_SQL_query_build($dkey,$pattern);      &recursive_SQL_query_build($dkey,$pattern);
 }  }
Line 1083  sub build_date_queries { Line 1422  sub build_date_queries {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod
   
   =item &copyright_check()
   
   Inputs: $Metadata, a hash pointer of metadata for a resource.
   
   Returns: 1 if the resource is available to the user making the query, 
            0 otherwise.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub copyright_check {
       my $Metadata = shift;
       # Check copyright tags and skip results the user cannot use
       my (undef,undef,$resdom,$resname) = split('/',
                                                 $Metadata->{'url'});
       # Check for priv
       if (($Metadata->{'copyright'} eq 'priv') && 
           (($ENV{'user.name'} ne $resname) &&
            ($ENV{'user.domain'} ne $resdom))) {
           return 0;
       }
       # Check for domain
       if (($Metadata->{'copyright'} eq 'domain') &&
           ($ENV{'user.domain'} ne $resdom)) {
           return 0;
       }
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
 =item &output_results()   =item &ensure_db_and_table()
   
 Format and output results based on a reply list.  Ensure we can get lonmysql to connect to the database and the table we
 There are two windows that this function writes to.  The main search  need exists.
 window ("srch") has a listing of the results.  A secondary window ("popwin")  
 gives the status of the network search (time elapsed, number of machines  Inputs: $r, table id
 contacted, etc.)  
   Returns: undef on error, 1 if the table exists.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_results {  sub ensure_db_and_table {
 #    &Apache::lonnet::logthis("output_results:".time);      my ($r,$table) = @_;
     my $fnum; # search result counter  
     my ($mode,$r,$replyref,$hidden)=@_;  
     my %rhash=%{$replyref};  
     my $compiledresult='';  
     my $timeremain=300; # (seconds)  
     my $elapsetime=0;  
     my $resultflag=0;  
     my $tflag=1;  
     ##      ##
     ## Set viewing function      ## Sanity check the table id.
     ##      ##
     my $viewfunction = undef;      if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
     if ($ENV{'form.viewselect'} eq 'Detailed Citation View') {          $r->print("Unable to retrieve search results.  ".
         $viewfunction = \&detailed_citation_view;                    "Unable to determine the table results were stored in.  ".
     } elsif ($ENV{'form.viewselect'} eq 'Summary View') {                    "</body></html>");
         $viewfunction = \&summary_view;          return undef;
     } elsif ($ENV{'form.viewselect'} eq 'Fielded Format') {  
         $viewfunction = \&fielded_format_view;  
     } elsif ($ENV{'form.viewselect'} eq 'XML/SGML') {  
         $viewfunction = \&xml_sgml_view;  
     }      }
     if (!defined($viewfunction)) {      ##
         $r->print("Internal Error - Bad view selected.\n");      ## Make sure we can connect and the table exists.
         $r->rflush();      ##
       my $connection_result = &Apache::lonmysql::connect_to_db();
       if (!defined($connection_result)) {
           $r->print("Unable to connect to the MySQL database where your results".
                     " are stored. </body></html>");
           &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to".
                                    " connect to database.");
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return undef;
       }
       my $table_check = &Apache::lonmysql::check_table($table);
       if (! defined($table_check)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the status".
                                    " of table ".$table);
           return undef;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return undef;
       }
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &print_sort_form()
   
   The sort feature is not implemented at this time.  This form just prints 
   a link to change the search query.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_sort_form {
       my ($r,$pretty_query_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       ##
       my %SortableFields=&Apache::lonlocal::texthash( 
            id        => 'Default',
            title     => 'Title',
            author    => 'Author',
            subject   => 'Subject',
            url       => 'URL',
            version   => 'Version Number',
            mime      => 'Mime type',
            lang      => 'Language',
            owner     => 'Owner/Publisher',
            copyright => 'Copyright',
            hostname  => 'Host',
            creationdate     => 'Creation Date',
            lastrevisiondate => 'Revision Date'
        );
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
         return;          return;
     }      }
       my $result;
       $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>
   <title>Results</title>
   </head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
   END
   
   #<h2>Sort Results</h2>
   #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
   #    $ENV{'form.sortby'} = 'id' if (! defined($ENV{'form.sortby'}));
   #    foreach (keys(%SortableFields)) {
   #        $result.="<option name=\"$_\"";
   #        if ($_ eq $ENV{'form.sortby'}) {
   #            $result.=" selected ";
   #        }
   #        $result.=" >$SortableFields{$_}</option>\n";
   #    }
   #    $result.="</select>\n";
       my $revise = &revise_button();
       $result.=<<END;
   <p>
   There are $total_results matches to your query. $revise
   </p><p>
   Search:$pretty_query_string
   </p>
   </form>
   </body>
   </html>
   END
       $r->print($result);
       return;
   }
   
   #####################################################################
   #####################################################################
   
   =pod
   
   =item MySQL Table Description
   
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   #####################################################################
   #####################################################################
   #
   # These should probably be scoped but I don't have time right now...
   #
   my @Datatypes;
   my @Fullindicies;
       
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &create_results_table()
   
   Creates the table of search results by calling lonmysql.  Stores the
   table id in $ENV{'form.table'}
   
   Inputs: none.
   
   Returns: the identifier of the table on success, undef on error.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub set_up_table_structure {
       my ($datatypes,$fullindicies) = 
           &LONCAPA::lonmetadata::describe_metadata_storage();
       unshift(@$datatypes,{name => 'id', 
           type => 'MEDIUMINT',
           restrictions => 'UNSIGNED NOT NULL',
           primary_key  => 'yes',
           auto_inc     => 'yes' });
       @Datatypes = @{$datatypes};
       @Fullindicies = @{$fullindicies};
       return;
   }
   
   sub create_results_table {
       &set_up_table_structure();
       my $table = &Apache::lonmysql::create_table
           ( { columns => \@Datatypes,
               FULLTEXT => [{'columns' => \@Fullindicies},],
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item Search Status update functions
   
   Each of the following functions changes the values of one of the
   input fields used to display the search status to the user.  The names
   should be explanatory.
   
   Inputs: Apache request handler ($r), text to display.
   
   Returns: Nothing.
   
   =over 4
   
   =item &update_count_status()
   
   =item &update_status()
   
   =item &update_seconds()
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub update_count_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.count.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   sub update_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.status.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   sub update_seconds {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.seconds.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &revise_button()
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revise_phase = 'disp_basic';
       $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
       my $newloc = '/adm/searchcat'.
           '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
               '&cleargroupsort=1'.
               '&phase='.$revise_phase;
       my $result = qq{<input type="button" value="Revise search" name="revise"} .
           qq{ onClick="parent.location='$newloc';" /> };
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &run_search()
   
   Executes a search query by sending it the the other servers and putting the
   results into MySQL.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub run_search {
       my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $connection = $r->connection;
     #      #
     # make query information persistent to allow for subsequent revision      # Timing variables
     my $persistent=&make_persistent(\%ENV);  
     #      #
     # Begin producing output      my $starttime = time;
     $r->print(&search_results_header($mode));      my $max_time  = 30;  # seconds for the search to complete
     $r->rflush();  
     #      #
     # begin showing the cataloged results      # Print run_search header
     my $action = "/adm/searchcat";  
     if ($mode eq 'Basic') {   
         $action .= "?reqinterface=basic";  
     } elsif ($mode eq 'Advanced') {  
         $action .= "?reqinterface=advanced";  
     }  
     $r->print(<<CATALOGCONTROLS);  
 <form name='results' method="post" action="$action">  
 $hidden  
 <input type='hidden' name='acts' value='' />  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $importbutton  
 $closebutton  
 $persistent  
 <hr />  
 CATALOGCONTROLS  
     #      #
     # make the pop-up window for status      $r->print(<<END);
     $r->print(&make_popwin(%rhash));  <html>
   <head><title>Search Status</title></head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
   END
       # Check to see if $pretty_string has more than one carriage return.
       # Assume \n s are following <br /> s and truncate the value.
       # (there is probably a better way)...
       my @Lines = split /<br \/>/,$pretty_string;
       if (@Lines > 2) {
           $pretty_string = join '<br \>',(@Lines[0..2],'....<br />');
       }
       $r->print(&mt("Search").": ".$pretty_string);
     $r->rflush();      $r->rflush();
       #
       # Determine the servers we need to contact.
       my @Servers_to_contact;
       if (defined($serverlist)) {
           if (ref($serverlist) eq 'ARRAY') {
               @Servers_to_contact = @$serverlist;
           } else {
               @Servers_to_contact = ($serverlist);
           }
       } else {
           @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
       }
       my %Server_status;
       my $table =$ENV{'form.table'};
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to determine table id to store search results in.".
                     "The search has been aborted.</body></html>");
           return;
       }
       my $table_status = &Apache::lonmysql::check_table($table);
       if (! defined($table_status)) {
           $r->print("Unable to determine status of table.</body></html>");
           &Apache::lonnet::logthis("Bogus table id of $table for ".
                                    "$ENV{'user.name'} @ $ENV{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           return;
       }
       if (! $table_status) {
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           &Apache::lonnet::logthis("lonmysql debug = ".
                                    &Apache::lonmysql::get_debug());
           &Apache::lonnet::logthis('table status = "'.$table_status.'"');
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
           return;
       }
     ##      ##
     ## Prepare for the main loop below      ## Prepare for the big loop.
     ##      my $hitcountsum;
     my $servercount=0;      my $server; 
     my $hitcountsum=0;      my $status;
     my $servernum=(keys %rhash);      my $revise = &revise_button();
     my $serversleft=$servernum;      $r->print(<<END);
     ##  <table>
     ## Run until we run out of time or we run out of servers  <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
     ##  <tr>
     while($serversleft && $timeremain) {  <td><input type="text" name="status"  value="" size="30" /></td>
       ##  <td><input type="text" name="count"   value="" size="10" /></td>
       ## %rhash has servers deleted from it as results come in   <td><input type="text" name="seconds" value="" size="8" /></td>
       ## (within the foreach loop below).  <td>$revise</td>
       ##  </tr>
       foreach my $rkey (sort keys %rhash) {  </table>
 #        &Apache::lonnet::logthis("Server $rkey:".time);  </form>
  $servercount++;  END
  $compiledresult='';      $r->rflush();
  my $reply=$rhash{$rkey};      my $time_remaining = $max_time - (time - $starttime) ;
  my @results;      my $last_time = $time_remaining;
  if ($reply eq 'con_lost') {      &update_seconds($r,$time_remaining);
     &popwin_imgupdate($r,$rkey,"srvbad.gif");      &update_status($r,'contacting '.$Servers_to_contact[0]);
     $serversleft--;      while (($time_remaining > 0) &&
             delete $rhash{$rkey};             ((@Servers_to_contact) || keys(%Server_status))) {
  } else {          # Send out a search request if it needs to be done.
             # must do since 'use strict' checks for tainting          if (@Servers_to_contact) {
     $reply=~/^([\.\w]+)$/;               # Contact one server
     my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;              my $server = shift(@Servers_to_contact);
     $reply=~/(.*?)\_/;              &update_status($r,&mt('contacting').' '.$server);
             for (my $counter=0;$counter<2;$counter++) {              my $reply=&Apache::lonnet::metadata_query($query,$customquery,
                 if (-e $replyfile && ! -e "$replyfile.end") {                                                        $customshow,[$server]);
                     &popwin_imgupdate($r,$rkey,"srvhalf.gif");              ($server) = keys(%$reply);
                     &popwin_js($r,'popwin.hc["'.$rkey.'"]='.              $Server_status{$server} = $reply->{$server};
                                '"still transferring..."'.';');          } else {
               # wait a sec. to give time for files to be written
               # This sleep statement is here instead of outside the else 
               # block because we do not want to pause if we have servers
               # left to contact.  
               if (scalar (keys(%Server_status))) {
                   &update_status($r,
                          &mt('waiting on').' '.(join(' ',keys(%Server_status))));
               }
               sleep(1)
           }
           #
           # Loop through the servers we have contacted but do not
           # have results from yet, looking for results.
           while (my ($server,$status) = each(%Server_status)) {
               last if ($connection->aborted());
               if ($status eq 'con_lost') {
                   delete ($Server_status{$server});
                   next;
               }
               $status=~/^([\.\w]+)$/; 
              my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
               if (-e $datafile && ! -e "$datafile.end") {
                   &update_status($r,&mt('Receiving results from').' '.$server);
                   next;
               }
               last if ($connection->aborted());
               if (-e "$datafile.end") {
                   &update_status($r,&mt('Reading results from').' '.$server);
                   if (-z "$datafile") {
                       delete($Server_status{$server});
                       next;
                   }
                   my $fh;
                   if (!($fh=Apache::File->new($datafile))) { 
                       $r->print("Unable to open search results file for ".
                                     "server $server.  Omitting from search");
                       delete($Server_status{$server}); 
                      next;
                 }                  }
                 # Are we finished transferring data?                  # Read in the whole file.
                 if (-e "$replyfile.end") {                  while (my $result = <$fh>) {
                     $serversleft--;                      last if ($connection->aborted());
                     delete $rhash{$rkey};                      # handle custom fields?  Someday we will!
                     if (-s $replyfile) {                      chomp($result);
                         &popwin_imgupdate($r,$rkey,"srvgood.gif");                      next unless $result;
                         my $fh;                      # Parse the result.
                         unless ($fh=Apache::File->new($replyfile)){                       my %Fields = &parse_raw_result($result,$server);
                             # Is it really appropriate to die on this error?                      $Fields{'hostname'} = $server;
                             $r->print('ERROR: file '.                      next if (! &copyright_check(\%Fields));
                                       $replyfile.' cannot be opened');                      # Store the result in the mysql database
                             return OK;                      my $result = &Apache::lonmysql::store_row($table,\%Fields);
                         }                      if (! defined($result)) {
                         @results=<$fh> if $fh;                          $r->print(&Apache::lonmysql::get_error());
                         my $hits =@results;  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
                                    $hits.';');  
                         $hitcountsum+=$hits;  
                         &popwin_js($r,'popwin.document.forms.popremain.'.  
                                    'numhits.value='.$hitcountsum.';');  
                     } else {  
                         &popwin_imgupdate($r,$rkey,"srvempty.gif");  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');  
                     }                      }
                     last;                      # $r->print(&Apache::lonmysql::get_debug());
                 } # end of if ( -e "$replyfile.end")                      $hitcountsum ++;
                 last unless $timeremain;                      $time_remaining = $max_time - (time - $starttime) ;
                 sleep 1;    # wait for daemons to write files?                      if ($last_time - $time_remaining > 0) {
                 $timeremain--;                          &update_seconds($r,$time_remaining);
                 $elapsetime++;                          $last_time = $time_remaining;
                 &popwin_js($r,"popwin.document.popremain.".  
                            "elapsetime.value=$elapsetime;");  
     }  
     &popwin_js($r,'popwin.document.whirly.'.  
        'src="/adm/lonIcons/lonanimend.gif";');  
  } # end of if ($reply eq 'con_lost') else statement  
         my %Fields = undef;     # Holds the data to be sent to the various   
                                 # *_view routines.  
         my ($extrashow,$customfields,$customhash) =   
                                     &handle_custom_fields(\@results);  
         my @customfields = @$customfields;  
         my %customhash   = %$customhash;  
  untie %hash if (keys %hash);  
         #  
  if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
     $r->print('<html><head></head><body>Unable to tie hash to db '.  
                       'file</body></html>');  
         } else {  
     if ($ENV{'form.launch'} eq '1') {  
  &start_fresh_session();  
     }  
     foreach my $result (@results) {  
  next if $result=~/^custom\=/;  
  chomp $result;  
  next unless $result;  
                 %Fields = &parse_raw_result($result,$rkey);  
  $Fields{'extrashow'}=$extrashow;  
  if ($extrashow) {  
     foreach my $field (@customfields) {  
  my $value='';  
  $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);  
                         $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;  
                     }                      }
                 }                      if ($hitcountsum % 50 == 0) {
                 $compiledresult.="\n<p>\n";                          &update_count_status($r,$hitcountsum);
                 if ($ENV{'form.catalogmode'} eq 'interactive') {                      }
                     my $titleesc=$Fields{'title'};                  } # End of foreach (@results)
                     $titleesc=~s/\'/\\'/; # '                  $fh->close();
                     $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');                  # $server is only deleted if the results file has been 
                   # found and (successfully) opened.  This may be a bad idea.
                   delete($Server_status{$server});
               }
               last if ($connection->aborted());
               &update_count_status($r,$hitcountsum);
           }
           last if ($connection->aborted());
           # Finished looping through the servers
           $starttime = time if (@Servers_to_contact);
           $time_remaining = $max_time - (time - $starttime) ;
           if ($last_time - $time_remaining > 0) {
               $last_time = $time_remaining;
               &update_seconds($r,$time_remaining);
           }
       }
       &update_status($r,&mt('Search Complete').$server);
       &update_seconds($r,0);
       #
       &Apache::lonmysql::disconnect_from_db();
       #
       # We have run out of time or run out of servers to talk to and
       # results to get.  
       $r->print("</body></html>");
       if ($ENV{'form.catalogmode'} ne 'groupsearch') {
           $r->print("<script>".
                         "window.location='/adm/searchcat?".
                         "phase=sort&".
                         "persistent_db_id=$ENV{'form.persistent_db_id'}';".
                     "</script>");
       }
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &prev_next_buttons()
   
   Returns html for the previous and next buttons on the search results page.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub prev_next_buttons {
       my ($current_min,$show,$total,$parms) = @_;
       return '' if ($show eq 'all'); # No links if you get them all at once.
       my $links;
       ##
       ## Prev
       my $prev_min = $current_min - $show;
       $prev_min = 1 if $prev_min < 1;
       if ($prev_min < $current_min) {
           $links .= 
               qq{<a href="/adm/searchcat?$parms&start=$prev_min&show=$show">}.
               &mt('prev').'</a>';
       } else {
           $links .= &mt('prev');
       }
       ##
       ## Pages.... Someday.
       ##
       $links .= 
           qq{&nbsp;
              <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">}.
                   &mt('reload').'</a>';
       ##
       ## Next
       my $next_min = $current_min + $show;
       $next_min = $current_min if ($next_min > $total);
       if ($next_min != $current_min) {
           $links .= 
               qq{&nbsp;
                  <a href="/adm/searchcat?$parms&start=$next_min&show=$show">}.
                       &mt('next').'</a>';
       } else {
           $links .= '&nbsp;'.&mt('next');
       }
       return $links;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &display_results()
   
   Prints the results out for selection and perusal.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub display_results {
       my ($r,$importbutton,$closebutton,$diropendb) = @_;
       my $connection = $r->connection;
       $r->print(&search_results_header($importbutton,$closebutton));
       ##
       ## Set viewing function
       ##
       my $viewfunction = $Views{$ENV{'form.viewselect'}};
       if (!defined($viewfunction)) {
           $r->print("Internal Error - Bad view selected.\n");
           $r->rflush();
           return;
       }
       ##
       ## $checkbox_num is a count of the number of checkboxes output on the 
       ## page this is used only during catalogmode=groupsearch.
       my $checkbox_num = 0;
       ##
       ## Get the catalog controls setup
       ##
       my $action = "/adm/searchcat?phase=results";
       ##
       ## Deal with groupsearch by opening the groupsearch db file.
       if ($ENV{'form.catalogmode'} eq 'groupsearch') {
           if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                     &GDBM_WRCREAT(),0640)) {
               $r->print('Unable to store import results.</form></body></html>');
               $r->rflush();
               return;
           } 
       }
       ##
       ## Prepare the table for querying
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       ##
       ## Determine how many results we need to get
       $ENV{'form.start'} = 1      if (! exists($ENV{'form.start'}));
       $ENV{'form.show'}  = 'all'  if (! exists($ENV{'form.show'}));
       my $min = $ENV{'form.start'};
       my $max;
       if ($ENV{'form.show'} eq 'all') {
           $max = $total_results ;
       } else {
           $max = $min + $ENV{'form.show'} - 1;
           $max = $total_results if ($max > $total_results);
       }
       ##
       ## Output links (if necessary) for 'prev' and 'next' pages.
       $r->print
           ('<center>'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                               "table=".$ENV{'form.table'}.
                               "&phase=results".
                               "&persistent_db_id=".$ENV{'form.persistent_db_id'})
            ."</center>\n"
            );
       if ($total_results == 0) {
           $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="1">'.
                     '<h3>'.&mt('There are currently no results').'.</h3>'.
                     "</form></body></html>");
           return;
       } else {
           $r->print
               ("<center>Results $min to $max out of $total_results</center>\n");
       }
       ##
       ## Get results from MySQL table
       my @Results = &Apache::lonmysql::get_rows($table,
                                                 'id>='.$min.' AND id<='.$max);
       ##
       ## Loop through the results and output them.
       foreach my $row (@Results) {
           if ($connection->aborted()) {
               &cleanup();
               return;
           }
           my %Fields = %{&parse_row(@$row)};
           my $output="<p>\n";
           my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'},
                                          $Fields{'id'},$checkbox_num++);
           # Render the result into html
           $output.= &$viewfunction($prefix,%Fields);
           # Print them out as they come in.
           $r->print($output);
           $r->rflush();
       }
       if (@Results < 1) {
           $r->print(&mt("There were no results matching your query"));
       } else {
           $r->print
               ('<center>'.
                &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                                   "table=".$ENV{'form.table'}.
                                   "&phase=results".
                                   "&persistent_db_id=".
                                   $ENV{'form.persistent_db_id'})
                ."</center>\n"
                );
       }
       $r->print("</form></body></html>");
       $r->rflush();
       untie %groupsearch_db if (tied(%groupsearch_db));
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
   
   Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub catalogmode_output {
       my $output = '';
       my ($title,$url,$fnum,$checkbox_num) = @_;
       if ($ENV{'form.catalogmode'} eq 'interactive') {
           $title=~ s/\'/\\\'/g;
           if ($ENV{'form.catalogmode'} eq 'interactive') {
               $output.=<<END 
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
 onClick="javascript:select_data('$titleesc','$Fields{'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"}=$Fields{'url'};          $groupsearch_db{"pre_${fnum}_title"}=$title;
     $hash{"pre_${fnum}_title"}=$Fields{'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++;  }
  }  ######################################################################
                 # Render the result into html  ######################################################################
                 $compiledresult.= &$viewfunction(%Fields, hostname => $rkey );  
                 if ($compiledresult or $servercount!=$servernum) {  =pod
                     $compiledresult.="<hr align='left' width='200' noshade />";  
                 }  =item &parse_row()
             }  
             untie %hash;  Parse a row returned from the database.
         }  
  if ($compiledresult) {  =cut
     $resultflag=1;  
             $r->print($compiledresult);  ######################################################################
  }  ######################################################################
       } # End of foreach loop over servers remaining  sub parse_row {
     }   # End of big loop - while($serversleft && $timeremain)      my @Row = @_;
     unless ($resultflag) {      my %Fields;
         $r->print("\nThere were no results that matched your query\n");      if (! scalar(@Datatypes)) {
     }          &set_up_table_structure();
     $r->print('<script type="text/javascript">'.'popwin.close()</script>'.      }
               "\n");       for (my $i=0;$i<=$#Row;$i++) {
     $r->print("</body>\n</html>\n");          $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
     $r->rflush();       }
     return;      $Fields{'language'} = 
           &Apache::loncommon::languagedescription($Fields{'language'});
       $Fields{'copyrighttag'} =
           &Apache::loncommon::copyrightdescription($Fields{'copyright'});
       $Fields{'mimetag'} =
           &Apache::loncommon::filedescription($Fields{'mime'});
       return \%Fields;
 }  }
   
 ###########################################################  ###########################################################
Line 1313  END Line 2220  END
 =item &parse_raw_result()  =item &parse_raw_result()
   
 Takes a line from the file of results and parse it.  Returns a hash   Takes a line from the file of results and parse it.  Returns a hash 
 with keys for the following fields:  with keys according to column labels
 'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes',   
 'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate',   
 'lastrevisiondate'.  
   
 In addition, the following tags are set by calling the appropriate   In addition, the following tags are set by calling the appropriate 
 lonnet function: 'language', 'cprtag', 'mimetag'.  lonnet function: 'language', 'copyrighttag', 'mimetag'.
   
 The 'title' field is set to "Untitled" if the title field is blank.  The 'title' field is set to "Untitled" if the title field is blank.
   
Line 1331  The 'title' field is set to "Untitled" i Line 2235  The 'title' field is set to "Untitled" i
 ###########################################################  ###########################################################
 sub parse_raw_result {  sub parse_raw_result {
     my ($result,$hostname) = @_;      my ($result,$hostname) = @_;
     # Check for a comma - if it is there then we do not need to unescape the      # conclude from self to others regarding fields
     # string.  There seems to be some kind of problem with some items in      my %Fields=&Apache::lonmeta::metadata_col_to_hash(
     # the database - the entire string gets sent out unescaped...?   map {
     unless ($result =~ /,/) {   &Apache::lonnet::unescape($_);
         $result = &Apache::lonnet::unescape($result);   } (split(/\,/,$result))
     }        );
     my @fields=map {  
         &Apache::lonnet::unescape($_);  
     } (split(/\,/,$result));  
     my ($title,$author,$subject,$url,$keywords,$version,  
         $notes,$abstract,$mime,$lang,  
         $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;  
     my %Fields =   
         ( title     => &Apache::lonnet::unescape($title),  
           author    => &Apache::lonnet::unescape($author),  
           subject   => &Apache::lonnet::unescape($subject),  
           url       => &Apache::lonnet::unescape($url),  
           keywords  => &Apache::lonnet::unescape($keywords),  
           version   => &Apache::lonnet::unescape($version),  
           notes     => &Apache::lonnet::unescape($notes),  
           abstract  => &Apache::lonnet::unescape($abstract),  
           mime      => &Apache::lonnet::unescape($mime),  
           lang      => &Apache::lonnet::unescape($lang),  
           owner     => &Apache::lonnet::unescape($owner),  
           copyright => &Apache::lonnet::unescape($copyright),  
           creationdate     => &Apache::lonnet::unescape($creationdate),  
           lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate)  
         );  
     $Fields{'language'} =   
         &Apache::loncommon::languagedescription($Fields{'lang'});  
     $Fields{'copyrighttag'} =  
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});  
     $Fields{'mimetag'} =  
         &Apache::loncommon::filedescription($Fields{'mime'});  
     if ($Fields{'author'}=~/^(\s*|error)$/) {  
         $Fields{'author'}="Unknown Author";  
     }  
     # Put spaces in the keyword list, if needed.  
     $Fields{'keywords'}=~ s/,([A-z])/, $1/g;   
     if ($Fields{'title'}=~ /^\s*$/ ) {   
         $Fields{'title'}='Untitled';   
     }  
     unless ($ENV{'user.adv'}) {  
         $Fields{'keywords'} = '- not displayed -';  
         $Fields{'notes'}    = '- not displayed -';  
         $Fields{'abstract'} = '- not displayed -';  
         $Fields{'subject'}  = '- not displayed -';  
     }  
     if (length($Fields{'abstract'})>200) {  
         $Fields{'abstract'} =   
             substr($Fields{'abstract'},0,200).'...';  
     }  
     if (length($Fields{'keywords'})>200) {  
         $Fields{'keywords'} =  
             substr($Fields{'keywords'},0,200).'...';  
     }  
     return %Fields;      return %Fields;
 }  }
   
Line 1436  sub handle_custom_fields { Line 2290  sub handle_custom_fields {
   
 =pod  =pod
   
 =item &search_results_header  =item &search_results_header()
   
 Output the proper html headers and javascript code to deal with different   Output the proper html headers and javascript code to deal with different 
 calling modes.  calling modes.
Line 1463  Checked for existance & 'edit' mode. Line 2317  Checked for existance & 'edit' mode.
   
 =item 'form.form'  =item 'form.form'
   
   Contains the name of the form that has the input fields to set
   
 =item 'form.element'  =item 'form.element'
   
   the name of the input field to put the URL into
   
   =item 'form.titleelement'
   
   the name of the input field to put the title into
   
 =back  =back
   
 =cut  =cut
Line 1472  Checked for existance & 'edit' mode. Line 2334  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode) = @_;      my ($importbutton,$closebutton) = @_;
     $mode = lc($mode);      my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     my $title;  
     if ($mode eq 'advanced') {  
         $title = "Advanced Search Results";  
     } elsif ($mode eq 'basic') {  
         $title = "Basic Search Results";  
     }  
     my $result = '';      my $result = '';
     # output beginning of search page      # output beginning of search page
     $result.=<<BEGINNING;  
 <html>  
 <head>  
 <title>$title</title>  
 BEGINNING  
     # conditional output of script functions dependent on the mode in      # conditional output of script functions dependent on the mode in
     # which the search was invoked      # which the search was invoked
     if ($ENV{'form.catalogmode'} eq 'interactive'){      if ($ENV{'form.catalogmode'} eq 'interactive'){
Line 1496  BEGINNING Line 2347  BEGINNING
     function select_data(title,url) {      function select_data(title,url) {
  changeTitle(title);   changeTitle(title);
  changeURL(url);   changeURL(url);
  self.close();   parent.close();
     }      }
     function changeTitle(val) {      function changeTitle(val) {
  if (opener.inf.document.forms.resinfo.elements.t) {   if (parent.opener.inf.document.forms.resinfo.elements.t) {
     opener.inf.document.forms.resinfo.elements.t.value=val;      parent.opener.inf.document.forms.resinfo.elements.t.value=val;
  }   }
     }      }
     function changeURL(val) {      function changeURL(val) {
  if (opener.inf.document.forms.resinfo.elements.u) {   if (parent.opener.inf.document.forms.resinfo.elements.u) {
     opener.inf.document.forms.resinfo.elements.u.value=val;      parent.opener.inf.document.forms.resinfo.elements.u.value=val;
  }   }
     }      }
 </script>  </script>
Line 1513  SCRIPT Line 2364  SCRIPT
         } elsif ($ENV{'form.mode'} eq 'edit') {          } elsif ($ENV{'form.mode'} eq 'edit') {
             my $form = $ENV{'form.form'};              my $form = $ENV{'form.form'};
             my $element = $ENV{'form.element'};              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
               }
   
             $result.=<<SCRIPT;              $result.=<<SCRIPT;
 <script type="text/javascript">  <script type="text/javascript">
 function select_data(title,url) {  function select_data(title,url) {
     changeURL(url);      changeURL(url);
     self.close();      changeTitle(title);
 }      parent.close();
 function changeTitle(val) {  
 }  }
   $changetitle
 function changeURL(val) {  function changeURL(val) {
     if (window.opener.document) {      if (parent.targetwin.document) {
         window.opener.document.forms["$form"].elements["$element"].value=val;          parent.targetwin.document.forms["$form"].elements["$element"].value=val;
     } else {      } else {
  var url = 'forms[\"$form\"].elements[\"$element\"].value';   var url = 'forms[\"$form\"].elements[\"$element\"].value';
         alert("Unable to transfer data to "+url);          alert("Unable to transfer data to "+url);
Line 1535  SCRIPT Line 2403  SCRIPT
     }      }
     $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';      $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
 <script type="text/javascript">  <script type="text/javascript">
     function select_data(title,url) {      function queue(checkbox_num,val) {
 // alert('DEBUG: Should be storing '+title+' and '+url);          if (document.forms.results.returnvalues.length != "undefined" &&
     }              typeof(document.forms.results.returnvalues.length) == "number") {
     function queue(val) {              if (document.forms.results.returnvalues[checkbox_num].checked) {
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {                  parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
     document.forms.results.acts.value+='1a'+val+'b';              } else {
  }                  parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
  else {              }
     document.forms.results.acts.value+='0a'+val+'b';          } else {
  }              if (document.forms.results.returnvalues.checked) {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
               } else {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
               }
           }
     }      }
     function select_group() {      function select_group() {
  window.location=   parent.window.location=
     "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+      "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
     document.forms.results.acts.value;      parent.statusframe.document.forms.statusform.elements.Queue.value;
     }  
 </script>  
 SCRIPT  
     $result.=<<SCRIPT;  
 <script type="text/javascript">  
     function displayinfo(val) {  
  popwin.document.forms.popremain.sdetails.value=val;  
     }  
     function openhelp(val) {  
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',  
      'scrollbars=1,width=400,height=300');  
  openhelpwin.focus();  
     }  
     function abortsearch(val) {  
  popwin.close();  
     }      }
 </script>  </script>
 SCRIPT  SCRIPT
     $result.=<<END;      $result.=<<END;
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <form name="results" method="post" action="" >
 <h1>$title</h1>  <input type="hidden" name="Queue" value="" />
   $importbutton
 END  END
     return $result;      return $result;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub search_status_header {
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       return <<ENDSTATUS;
   <html><head><title>Search Status</title></head>
   $bodytag
   <h3>Search Status</h3>
   Sending search request to LON-CAPA servers.<br />
   ENDSTATUS
   }
   
 =pod  sub results_link {
       my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
 =item &make_popwin()          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $results_link = $basic_link."&phase=results".
 Returns html with javascript in it to open up the status window.          "&pause=1"."&start=1";
       return $results_link;
 =cut  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub make_popwin {  sub print_frames_interface {
     my %rhash = @_;      my $r = shift;
     my $servernum=(keys %rhash);      my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
     my $hcinit;          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
     my $grid="'<br />'+\n";      my $run_search_link = $basic_link."&phase=run_search";
     # $sn is the server number, used ONLY to make sure we have      my $results_link = &results_link();
     # rows of 10 each.  No longer used to index images.      my $result = <<"ENDFRAMES";
     my $sn=1;  <html>
     foreach my $sk (sort keys %rhash) {  <head>
  $grid.="'<a href=\"";  <script>
  $grid.="javascript:opener.displayinfo('+";  var targetwin = opener;
  $grid.="\"'\"+'";  var queue = '';
  $grid.=$sk;  
  my $hc;  
  if ($rhash{$sk} eq 'con_lost') {  
     $hc="BAD CONNECTION ";  
  }  
  else {  
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";  
  }  
  $grid.=" hitcount=".$hc;  
  $grid.=" domain=".$Apache::lonnet::hostdom{$sk};  
  $grid.=" IP=".$Apache::lonnet::hostip{$sk};  
  # '+"'"+'">'+  
  $grid.="'+\"'\"+')\">'+";  
  $grid.="\n";  
  $grid.="'<img border=\"0\" name=\"img_".$Apache::lonnet::hostdom{$sk}.  
             '_'.$sk."\" src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk.  
                 "\" /></a>'+\n";  
  $grid.="'<br />'+\n" unless $sn%10;  
         $sn++;  
     }  
     my $result.=<<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>  </script>
 ENDPOP  <title>LON-CAPA Digital Library Search Results</title>
     return $result;  </head>
   <frameset rows="150,*">
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   </frameset>
   </html>
   ENDFRAMES
   
       $r->print($result);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 1678  ENDPOP Line 2492  ENDPOP
 =item Metadata Viewing Functions  =item Metadata Viewing Functions
   
 Output is a HTML-ified string.  Output is a HTML-ified string.
   
 Input arguments are title, author, subject, url, keywords, version,  Input arguments are title, author, subject, url, keywords, version,
 notes, short abstract, mime, language, creation date,  notes, short abstract, mime, language, creation date,
 last revision date, owner, copyright, hostname, and  last revision date, owner, copyright, hostname, and
Line 1692  extra custom metadata to show. Line 2507  extra custom metadata to show.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>$prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
     target='search_preview'>$values{'title'}</a></h3>      target='search_preview'>$values{'title'}</a></b>
 <p>  <p>
 <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />  <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />
   
Line 1704  sub detailed_citation_view { Line 2520  sub detailed_citation_view {
 <b>Notes:         </b> $values{'notes'}<br />  <b>Notes:         </b> $values{'notes'}<br />
 <b>MIME Type:     </b> $values{'mimetag'}<br />  <b>MIME Type:     </b> $values{'mimetag'}<br />
 <b>Language:      </b> $values{'language'}<br />  <b>Language:      </b> $values{'language'}<br />
 <b>Copyright/Distribution:</b> $values{'cprtag'}<br />  <b>Copyright/Distribution:</b> $values{'copyrighttag'}<br />
 </p>  </p>
 $values{'extrashow'}  $values{'extrashow'}
 <p>  <p>
 $values{'shortabstract'}  $values{'shortabstract'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1722  END Line 2539  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   $prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
    target='search_preview'>$values{'author'}</a><br />     target='search_preview'>$values{'author'}</a><br />
 $values{'title'}<br />  $values{'title'}<br />
 $values{'owner'} -- $values{'lastrevisiondate'}<br />  $values{'owner'} -- $values{'lastrevisiondate'}<br />
 $values{'copyrighttag'}<br />  $values{'copyrighttag'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  </p>
   <hr align='left' width='200' noshade />
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &compact_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
       my $result=<<END;
   $prefix <img src="$icon" /> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"  target='search_preview'>
   $values{'title'}</a>
   <b>$values{'author'}</b><br />
 END  END
     return $result;      return $result;
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 1751  END Line 2592  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
   $prefix <img src="$icon" />
 <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
               target='search_preview'>$values{'url'}</a>                target='search_preview'>$values{'url'}</a>
 <br />  <br />
Line 1771  sub fielded_format_view { Line 2614  sub fielded_format_view {
 <b>Abstract:</b> $values{'shortabstract'}<br />  <b>Abstract:</b> $values{'shortabstract'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1789  END Line 2633  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub xml_sgml_view {  sub xml_sgml_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
   $prefix
 <pre>  <pre>
 &lt;LonCapaResource&gt;  &lt;LonCapaResource&gt;
 &lt;url&gt;$values{'url'}&lt;/url&gt;  &lt;url&gt;$values{'url'}&lt;/url&gt;
Line 1804  sub xml_sgml_view { Line 2649  sub xml_sgml_view {
 &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;  &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;
 &lt;/mimeInfo&gt;  &lt;/mimeInfo&gt;
 &lt;languageInfo&gt;  &lt;languageInfo&gt;
 &lt;language&gt;$values{'lang'}&lt;/language&gt;  &lt;language&gt;$values{'language'}&lt;/language&gt;
 &lt;languagetag&gt;$values{'language'}&lt;/languagetag&gt;  &lt;languagetag&gt;$values{'languagetag'}&lt;/languagetag&gt;
 &lt;/languageInfo&gt;  &lt;/languageInfo&gt;
 &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;  &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;
 &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;  &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;
Line 1819  sub xml_sgml_view { Line 2664  sub xml_sgml_view {
 &lt;/LonCapaResource&gt;  &lt;/LonCapaResource&gt;
 </pre>  </pre>
 $values{'extrashow'}  $values{'extrashow'}
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1837  END Line 2683  END
 sub filled {  sub filled {
     my ($field)=@_;      my ($field)=@_;
     if ($field=~/\S/ && $field ne 'any') {      if ($field=~/\S/ && $field ne 'any') {
  return 1;          return 1;
     }      } else {
     else {          return 0;
  return 0;  
     }      }
 }  }
   
Line 1851  sub filled { Line 2696  sub filled {
   
 =item &output_blank_field_error()  =item &output_blank_field_error()
   
   Output a complete page that indicates the user has not filled in enough
   information to do a search.
   
   Inputs: $r (Apache request handle), $closebutton, $parms.
   
   Returns: nothing
   
   $parms is extra information to include in the 'Revise search request' link.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_blank_field_error {  sub output_blank_field_error {
     my ($r)=@_;      my ($r,$closebutton,$parms,$hidden_fields)=@_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent(\%ENV);  
   
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
 <head>  <head>
Line 1867  sub output_blank_field_error { Line 2720  sub output_blank_field_error {
 BEGINNING  BEGINNING
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}"
 onClick='this.form.submit();' />  >Revise search request</a>&nbsp;
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Unactionable search query.</h3>
 <p>  <p>
 Incorrect search query due to blank entry fields.  You did not fill in enough information for the search to be started.
 You need to fill in the relevant  You need to fill in relevant fields on the search page in order 
 fields on the search page in order for a query to be  for a query to be processed.
 processed.  
 </p>  </p>
 </body>  </body>
 </html>  </html>
Line 1897  RESULTS Line 2749  RESULTS
   
 Output a full html page with an error message.  Output a full html page with an error message.
   
   Inputs: 
   
       $r, the request pointer.
       $message, the error message for the user.
       $closebutton, the specialized close button needed for groupsearch.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_date_error {  sub output_date_error {
     my ($r,$message)=@_;      my ($r,$message,$closebutton,$hidden_fields)=@_;
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent(\%ENV);      my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
   
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>The LearningOnline Network with CAPA</title>
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <input type='button' value='Revise search request'
 onClick='this.form.submit();' />  onClick='this.form.submit();' />
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Error</h3>
 <p>  <p>
 $message  $message
 </p>  </p>
Line 1936  RESULTS Line 2793  RESULTS
   
 =item &start_fresh_session()  =item &start_fresh_session()
   
 Cleans the global %hash by removing all fields which begin with  Cleans the global %groupsearch_db by removing all fields which begin with
 'pre_' or 'store'.  'pre_' or 'store'.
   
 =cut  =cut
Line 1944  Cleans the global %hash by removing all Line 2801  Cleans the global %hash by removing all
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub start_fresh_session {  sub start_fresh_session {
     delete $hash{'mode_catalog'};      delete $groupsearch_db{'mode_catalog'};
     foreach (keys %hash) {      foreach (keys %groupsearch_db) {
         if ($_ =~ /^pre_/) {          if ($_ =~ /^pre_/) {
             delete $hash{$_};              delete $groupsearch_db{$_};
         }          }
         if ($_ =~ /^store/) {          if ($_ =~ /^store/) {
     delete $hash{$_};      delete $groupsearch_db{$_};
  }   }
     }      }
 }  }
   
 ######################################################################  1;
 ######################################################################  
   
 =pod   
   
 =item &popwin_js() send javascript to popwin  
   
 =cut  
   
 ######################################################################  sub cleanup {
 ######################################################################      if (tied(%groupsearch_db)) {
 sub popwin_js {          unless (untie(%groupsearch_db)) {
     # Print javascript out to popwin, but make sure we dont generate    &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
     # any javascript errors in doing so.          }
     my ($r,$text) = @_;  
     $r->print(<<"END");  
 <script type="text/javascript">  
     if (! popwin.closed) {  
  $text  
     }      }
 </script>      &untiehash();
 END      &Apache::lonmysql::disconnect_from_db();
     $r->rflush();  
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &popwin_imgupdate()  
   
 Send a given image (and its location) out to the browser.  Takes as   
 input $r, loncapa server id, and an icon URL.  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub popwin_imgupdate {  
     my ($r,$server,$icon) = @_;  
     &popwin_js($r,'popwin.document.img_'.$Apache::lonnet::hostdom{$server}.  
                '_'.$server.'.'.'src="/adm/lonIcons/'.$icon.'";');  
 }      
   
 1;  
   
 __END__  __END__
   
 =pod  =pod

Removed from v.1.136  
changed lines
  Added in v.1.204


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