Diff for /loncom/interface/lonsearchcat.pm between versions 1.140 and 1.150

version 1.140, 2002/07/09 17:27:11 version 1.150, 2002/08/01 14:11:57
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 87  use Apache::lonnet(); Line 79  use Apache::lonnet();
 use Apache::File();  use Apache::File();
 use CGI qw(:standard);  use CGI qw(:standard);
 use Text::Query;  use Text::Query;
   use DBI;
 use GDBM_File;  use GDBM_File;
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::lonmysql();
   
 # ---------------------------------------- variables used throughout the module  # ---------------------------------------- variables used throughout the module
   
Line 101  use Apache::loncommon(); Line 95  use Apache::loncommon();
   
 =over 4  =over 4
   
 =item $closebutton  
   
 button that closes the search window  
   
 =item $importbutton  =item $importbutton
   
 button to take the select results and go to group sorting  button to take the select results and go to group sorting
   
 =item %hash     =item %groupsearch_db   
   
 The ubiquitous database hash  Database hash used to save values for the groupsearch RAT interface.
   
 =item $diropendb   =item $diropendb 
   
Line 133  takes the proper parameters. Line 123  takes the proper parameters.
 ######################################################################  ######################################################################
   
 # -- dynamically rendered interface components  # -- dynamically rendered interface components
 my $closebutton;  # button that closes the search window  
 my $importbutton; # button to take the selected results and go to group sorting  my $importbutton; # button to take the selected results and go to group sorting
   
 # -- miscellaneous variables  # -- miscellaneous variables
 my %hash;     # database hash  my %groupsearch_db;     # database hash
 my $diropendb = "";    # db file  my $diropendb = "";    # db file
   
 #             View Description           Function Pointer  #             View Description           Function Pointer
 my %Views = ("Detailed Citation View" => \&detailed_citation_view,  my %Views = ("Detailed Citation View" => \&detailed_citation_view,
              "Summary View"           => \&summary_view,               "Summary View"           => \&summary_view,
              "Fielded Format"         => \&fielded_format_view,               "Fielded Format"         => \&fielded_format_view,
              "XML/SGML"               => \&xml_sgml_view );               "XML/SGML"               => \&xml_sgml_view,
                "Compact View"           => \&compact_view);
   my %persistent_db;
   my $hidden_fields;
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 173  string that holds portions of the screen Line 163  string that holds portions of the screen
 ######################################################################  ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
     untie %hash;      #
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
     $r->content_type('text/html');      $r->content_type('text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
       ## 
       ## Pick up form fields passed in the links.
       ##
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element','pause',
                 'phase','persistent_db_id','table','start','show']);
       ##
       ## 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(3);
           delete($ENV{'form.pause'});
       }
       ##
       ## Initialize global variables
       ##
     my $domain  = $r->dir_config('lonDefDomain');      my $domain  = $r->dir_config('lonDefDomain');
     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).      $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";              "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
       #
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      # set the name of the persistent database
              ['catalogmode','launch','acts','mode','form','element',      #          $ENV{'form.persistent_db_id'} can only have digits in it.
               'reqinterface']);      if (! exists($ENV{'form.persistent_db_id'}) ||
           ($ENV{'form.persistent_db_id'} =~ /\D/) ||
           ($ENV{'form.launch'} eq '1')) {
           $ENV{'form.persistent_db_id'} = time;
       }
       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';
     ##      ##
     ## Clear out old values from database      if (! &get_persistent_form_data($r,$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>
   <body>
   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;
           }
       }
     ##      ##
     if ($ENV{'form.launch'} eq '1') {      ## Clear out old values from groupsearch database
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {      ##
       untie %groupsearch_db if (tied(%groupsearch_db));
       if ($ENV{'form.launch'} eq '1' && 
           ($ENV{'form.catalogmode'} eq 'groupsearch') && 
           ($ENV{'form.phase'} eq 'results')) {
    if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
     &start_fresh_session();      &start_fresh_session();
     untie %hash;      untie %groupsearch_db;
  } else {   } else {
     $r->print('<html><head></head><body>Unable to tie hash to db '.      $r->print('<html><head></head><body>Unable to tie hash to db '.
       'file</body></html>');        'file</body></html>');
Line 200  sub handler { Line 239  sub handler {
  }   }
     }      }
     ##      ##
     ## 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.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 = '';
     }      }
     $hidden .= &make_persistent({ "form.mode"    => $ENV{'form.mode'},      ##
                                   "form.form"    => $ENV{'form.form'},      ## Sanity checks on form elements
                                   "form.element" => $ENV{'form.element'},      ##
                                   "form.date"    => 2 });      if (!defined($ENV{'form.viewselect'})) {
     ##          if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
     ##  What are we doing?              ($ENV{'form.catalogmode'} eq 'interactive')) {
     ##              $ENV{'form.viewselect'} ="Compact View";
     my $searchtype;          } else {
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');              $ENV{'form.viewselect'} ="Detailed Citation View";
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');          }
     if ($searchtype) {      }
       $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
       ##
       ## Switch on the phase
       ##
       if ($ENV{'form.phase'} eq 'disp_basic') {
           &print_basic_search_form($r,$closebutton);
       } elsif ($ENV{'form.phase'} eq 'disp_adv') {
           &print_advanced_search_form($r,$closebutton);
       } elsif ($ENV{'form.phase'} eq 'results') {
           &display_results($r,$importbutton,$closebutton);
       } elsif($ENV{'form.phase'} eq 'run_search') {
           my ($query,$customquery,$customshow,$libraries,$pretty_string) =
               &get_persistent_data($persistent_db_file,
                    ['query','customquery','customshow',
                     'libraries','pretty_string']);
           &run_search($r,$query,$customquery,$customshow,
                       $libraries,$pretty_string);
       } elsif(($ENV{'form.phase'} eq 'basic_search') ||
               ($ENV{'form.phase'} eq 'adv_search')) {
           # Set up table
           if (! defined(&create_results_table())) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   <body>
   Unable to create table in which to store search results.  
   The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   <body>
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           #
         # We are running a search          # 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) = &parse_basic_search($r,$closebutton);
             ($query,$customquery,$customshow,$libraries)           } else {                      # Advanced search
                 = &parse_advanced_search($r);              ($query,$customquery,$customshow,$libraries,$pretty_string) 
                   = &parse_advanced_search($r,$closebutton);
             return OK if (! defined($query));              return OK if (! defined($query));
         }          }
         # Send query statements over the network to be processed by           &make_persistent($r,
         # either the SQL database or a recursive scheme of 'grep'-like                            { query => $query,
         # actions (for custom metadata).                             customquery => $customquery,
         $r->rflush();                             customshow => $customshow,
         my $reply=&Apache::lonnet::metadata_query($query,$customquery,                             libraries => $libraries,
                                                $customshow,$libraries);                             pretty_string => $pretty_string },
         &output_results($searchtype,$r,$reply,$hidden);                           $persistent_db_file);
     } else {          ##
         #          ## Print out the frames interface
         # We need to get information to search on          ##
         #          &print_frames_interface($r);
         # Set the default view if it is not already set.  
         if (!defined($ENV{'form.viewselect'})) {  
             $ENV{'form.viewselect'} ="Detailed Citation View";  
         }  
         # Output the advanced interface  
         if ($ENV{'form.reqinterface'} eq 'advanced') {  
             $r->print(&advanced_search_form($closebutton,$hidden));  
         } else {   
             # Output normal search interface  
             $r->print(&basic_search_form($closebutton,$hidden));  
         }  
     }      }
     return OK;      return OK;
 }   } 
Line 277  END Line 371  END
   
 =pod   =pod 
   
 =item &basic_search_form()   =item &print_basic_search_form() 
   
 Returns a scalar which holds html for the basic search form.  Returns a scalar which holds html for the basic search form.
   
Line 286  Returns a scalar which holds html for th Line 380  Returns a scalar which holds html for th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub basic_search_form{  sub print_basic_search_form{
     my ($closebutton,$hidden) = @_;      my ($r,$closebutton) = @_;
     my $scrout=<<"ENDDOCUMENT";      my $scrout=<<"ENDDOCUMENT";
 <html>  <html>
 <head>  <head>
Line 304  sub basic_search_form{ Line 398  sub basic_search_form{
 <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">
 $hidden  <input type="hidden" name="phase" value="basic_search" />
   $hidden_fields
 <h3>Basic Search</h3>  <h3>Basic Search</h3>
 <p>  <p>
 Enter terms or phrases separated by AND, OR, or NOT   Enter terms or phrases separated by AND, OR, or NOT 
Line 316  then press SEARCH below. Line 411  then press SEARCH below.
 ENDDOCUMENT  ENDDOCUMENT
     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).      $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).
         '&nbsp;';          '&nbsp;';
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});      my $checkbox = &simplecheckbox('related',$ENV{'form.related'});
 #    $scrout.='<font color="#800000">Search historic archives</font>';  
     $scrout.=<<END;      $scrout.=<<END;
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>  </td><td><a href="/adm/searchcat?phase=disp_adv">Advanced Search</a></td></tr>
   <tr><td>$checkbox use related words</td><td></td></tr>
   </table>
 </p>  </p>
 <p>  <p>
 &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;  &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;
Line 336  END Line 432  END
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 352  Returns a scalar which holds html for th Line 449  Returns a scalar which holds html for th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub advanced_search_form{  sub print_advanced_search_form{
     my ($closebutton,$hidden) = @_;      my ($r,$closebutton) = @_;
     my $advanced_buttons = <<"END";      my $advanced_buttons = <<"END";
 <p>  <p>
 <input type="submit" name="advancedsubmit" value='SEARCH' />  <input type="submit" name="advancedsubmit" value='SEARCH' />
Line 385  Enter terms or phrases separated by sear Line 482  Enter terms or phrases separated by sear
 such as AND, OR, or NOT.<br />  such as AND, OR, or NOT.<br />
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $advanced_buttons  $advanced_buttons
 $hidden  $hidden_fields
   <input type="hidden" name="phase" value="adv_search" />
 <table>  <table>
 <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>  <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>
 <td>  <td>
Line 394  ENDHEADER Line 492  ENDHEADER
  $ENV{'form.viewselect'},   $ENV{'form.viewselect'},
  undef,undef,undef,   undef,undef,undef,
  sort(keys(%Views)));   sort(keys(%Views)));
     $scrout.="</td></tr>\n";      $scrout.="</td><td>Related<br />Words</td></tr>\n";
     $scrout.=&searchphrasefield('title',   'title'   ,$ENV{'form.title'});      $scrout.=&searchphrasefield_with_related('title',   'title'   ,
                                                $ENV{'form.title'});
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});      $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});
     $scrout.=&searchphrasefield('subject', 'subject' ,$ENV{'form.subject'});      $scrout.=&searchphrasefield_with_related('subject', 'subject' ,
     $scrout.=&searchphrasefield('keywords','keywords',$ENV{'form.keywords'});                                               $ENV{'form.subject'});
       $scrout.=&searchphrasefield_with_related('keywords','keywords',
                                                $ENV{'form.keywords'});
     $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});      $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});
     $scrout.=&searchphrasefield('notes',   'notes'   ,$ENV{'form.notes'});      $scrout.=&searchphrasefield_with_related('notes',   'notes'   ,
     $scrout.=&searchphrasefield('abstract','abstract',$ENV{'form.abstract'});                                               $ENV{'form.notes'});
       $scrout.=&searchphrasefield_with_related('abstract','abstract',
                                                $ENV{'form.abstract'});
     # Hack - an empty table row.      # Hack - an empty table row.
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";      $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
     $scrout.=&searchphrasefield('file<br />extension','mime',      $scrout.=&searchphrasefield('file<br />extension','mime',
                         $ENV{'form.mime'});                          $ENV{'form.mime'});
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";      $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
     $scrout.=&searchphrasefield('publisher<br />owner','owner',      $scrout.=&searchphrasefield('publisher<br />owner','owner',
  $ENV{'form.owner'});   $ENV{'form.owner'});
     $scrout.="</table>\n";      $scrout.="</table>\n";
Line 432  ENDHEADER Line 535  ENDHEADER
     # adjust the size of the select box      # adjust the size of the select box
     my $size = 4;      my $size = 4;
     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);      my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
     # standalone machines do not get to choose a domain to search.      $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
     if ((scalar @domains) == 1) {          'DOMAINS</b></font><br />'.
         $scrout .='<input type="hidden" name="domains" value="any" />'."\n";              '<select name="domains" size="'.$size.'" multiple>'."\n".
     } else {                  '<option name="any" value="any" '.
         $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.                      ($domain_hash{'any'}? 'selected ' :'').
             'DOMAINS</b></font><br />'.  
                 '<select name="domains" size="'.$size.'" multiple>'."\n".  
                     '<option name="any" value="any" '.  
                         ($domain_hash{'any'}? 'selected ' :'').  
                         '>all domains</option>'."\n";                          '>all domains</option>'."\n";
         foreach my $dom (sort @domains) {      foreach my $dom (sort @domains) {
             $scrout.="<option name=\"$dom\" ".          $scrout.="<option name=\"$dom\" ".
                 ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";              ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";
         }  
         $scrout.="</select>\n";  
     }      }
       $scrout.="</select>\n";
     #----------------------------------------------------------------      #----------------------------------------------------------------
     $scrout.=&selectbox('Limit by language','language',      $scrout.=&selectbox('Limit by language','language',
  $ENV{'form.language'},'any','Any Language',   $ENV{'form.language'},'any','Any Language',
Line 527  $advanced_buttons Line 625  $advanced_buttons
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 535  ENDDOCUMENT Line 634  ENDDOCUMENT
   
 =pod   =pod 
   
 =item &make_persistent()   =item &get_persistent_form_data
   
   Inputs: filename of database
   
 Returns a scalar which holds the current ENV{'form.*'} values in  Outputs: returns undef on database errors.
 a 'hidden' html input tag.  This allows search interface information  
 to be somewhat persistent.  This function is the reverse of &make_persistent() for form data.
   Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If a form value already exists in $ENV, it will not be
   overwritten.  Form values that are array references may have values appended
   to them.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub get_persistent_form_data {
 sub make_persistent {      my $r = shift;
     my %save = %{shift()};      my $filename = shift;
     my $persistent='';      return 0 if (! -e $filename);
     foreach (keys %save) {      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
  if (/^form\./ && !/submit/) {                             &GDBM_READER(),0640));
     my $name=$_;      #
             my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));      # These make sure we do not get array references printed out as 'values'.
     $name=~s/^form\.//;      my %arrays_allowed = ('form.category'=>1,'form.domains'=>1);
             foreach (@values) {      #
                 s/\"/\'/g; # do not mess with html field syntax      # Loop through the keys, looking for 'form.'
                 $persistent.=<<END;      foreach my $name (keys(%persistent_db)) {
 <input type="hidden" name="$name" value="$_" />          next if ($name !~ /^form./);
 END          my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           next if (@values <1);
           if (exists($ENV{$name})) {
               if (ref($ENV{$name}) eq 'ARRAY') {
                   # If it is an array, tack @values on the end of it.
                   $ENV{$name} = [@$ENV{$name},@values];
               } elsif (! ref($ENV{$name}) && $arrays_allowed{$name}) {
                   # if arrays are allowed, turn it into one and add @values
                   $ENV{$name} = [$ENV{$name},@values];
               } # otherwise, assume the value in $ENV{$name} is better than ours.
           } else {
               if ($arrays_allowed{$name}) {
                   $ENV{$name} = [@values];
               } else {
                   $ENV{$name} = $values[0] if ($values[0]);
             }              }
         }          }
     }      }
     return $persistent;      untie (%persistent_db);
       return 1;
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item HTML form building functions  =item &get_persistent_data
   
 =over 4  Inputs: filename of database, ref to array of values to recover.
   
 =item &simpletextfield()   Outputs: array of values.  Returns undef on error.
   
 Inputs: $name,$value,$size  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. 
   
 Returns a text input field with the given name, value, and size.    =cut
 If size is not specified, a value of 20 is used.  
   
 =item &simplecheckbox()  
   
 Inputs: $name,$value  
   
 Returns a simple check box with the given $name.  
 If $value eq 'on' the box is checked.  
   
 =item &searchphrasefield()  ######################################################################
   ######################################################################
   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;
   }
   
 Inputs: $title,$name,$value  ######################################################################
   ######################################################################
   
 Returns html for a title line and an input field for entering search terms.  =pod 
 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()  =item &make_persistent() 
   
 Returns html selection form elements for the specification of   Inputs: Hash of values to save, filename of persistent database.
 the day, month, and year.  
   
 =item &selectbox()  Store variables away to the %persistent_db.
   Values will be escaped.  Values that are array pointers will have their
   elements escaped and concatenated in a comma seperated string.  
   
 Returns a scalar containing an html <select> form.    =cut
   
 Inputs:   ######################################################################
   ######################################################################
   sub make_persistent {
       my $r = shift;
       my %save = %{shift()};
       my $filename = shift;
       return undef if (! tie(%persistent_db,'GDBM_File',
                              $filename,&GDBM_WRCREAT(),0640));
       foreach my $name (keys(%save)) {
           next if (! exists($save{$name}));
           next if (! defined($save{$name}) || $save{$name} eq '');
           my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
           # We handle array references, but not recursively.
           my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
           $persistent_db{$name} = $store;
       }
       untie(%persistent_db);
       return 1;
   }
   
 =over 4  ######################################################################
   ######################################################################
   
 =item $title   =pod 
   
 Printed above the select box, in uppercase.  If undefined, only a select  =item &make_form_data_persistent() 
 box will be returned, with no additional html.  
   
 =item $name   Inputs: filename of persistent database.
   
 The name element of the <select> tag.  Store most form variables away to the %persistent_db.
   Values will be escaped.  Values that are array pointers will have their
   elements escaped and concatenated in a comma seperated string.  
   
 =item $default   =cut
   
 The default value of the form.  Can be $anyvalue, or in @idlist.  ######################################################################
   ######################################################################
   sub make_form_data_persistent {
       my $r = shift;
       my $filename = shift;
       my %save;
       foreach (keys(%ENV)) {
           next if (!/^form/ || /submit/);
           $save{$_} = $ENV{$_};
       }
       return &make_persistent($r,\%save,$filename);
   }
   
 =item $anyvalue   ######################################################################
   #                HTML form building functions                        #  
   ######################################################################
   
 The <option value="..."> used to indicate a default of   =pod 
 none of the values.  Can be undef.  
   
 =item $anytag   =item HTML form building functions
   
 The text associate with $anyvalue above.  =over 4
   
 =item $functionref   =cut
   
 Each element in @idlist will be passed as a parameter   ###############################################
 to the function referenced here.  The return value of the function should  ###############################################
 be a scalar description of the items.  If this value is undefined the   
 description of each item in @idlist will be the item name.  
   
 =item @idlist   =pod
   
 The items to be selected from.  One of these or $anyvalue will be the   =item &simpletextfield() 
 value returned by the form element, $ENV{form.$name}.  
   
 =back  Inputs: $name,$value,$size
   
 =back   Returns a text input field with the given name, value, and size.  
   If size is not specified, a value of 20 is used.
   
 =cut  =cut
   
 ######################################################################  ###############################################
 ######################################################################  ###############################################
   
 sub simpletextfield {  sub simpletextfield {
     my ($name,$value,$size)=@_;      my ($name,$value,$size)=@_;
Line 661  sub simpletextfield { Line 830  sub simpletextfield {
         '" size="'.$size.'" value="'.$value.'" />';          '" size="'.$size.'" value="'.$value.'" />';
 }  }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &simplecheckbox()
   
   Inputs: $name,$value
   
   Returns a simple check box with the given $name.
   If $value eq 'on' the box is checked.
   
   =cut
   
   ###############################################
   ###############################################
   
 sub simplecheckbox {  sub simplecheckbox {
     my ($name,$value)=@_;      my ($name,$value)=@_;
     my $checked='';      my $checked='';
Line 668  sub simplecheckbox { Line 854  sub simplecheckbox {
     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';      return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';
 }  }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &fieldtitle()
   
   Input: $title
   
   Returns a scalar with html which will display $title as a search
   field heading.
   
   =cut
   
   ###############################################
   ###############################################
   
   sub fieldtitle {
       my $title = uc(shift());
       return '<font color="#800000" face="helvetica"><b>'.$title.
           ':&nbsp;</b></font>';
   }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &searchphrasefield()
   
   Inputs: $title,$name,$value
   
   Returns html for a title line and an input field for entering search terms.
   The entry field (which is where the $name and $value are used) is a 50 column 
   simpletextfield.  The html returned is for a row in a three column table.
   
   =cut
   
   ###############################################
   ###############################################
       
 sub searchphrasefield {  sub searchphrasefield {
     my ($title,$name,$value)=@_;      my ($title,$name,$value)=@_;
     my $uctitle=uc($title);      return '<tr><td>'.&fieldtitle($title).'</td><td>'.
     return '<tr><td><font color="#800000" face="helvetica">'.          &simpletextfield($name,$value,50)."</td><td>&nbsp;</td></tr>\n";
         '<b>'.$uctitle.':&nbsp;</b></font></td><td>'.  
                 &simpletextfield($name,$value,50)."</td></tr>\n";  
 }  }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &searchphrasefield_with_related()
   
   Inputs: $title,$name,$value
   
   Returns html for a title line and an input field for entering search terms
   and a check box for 'related words'.  The entry field (which is where the 
   $name and $value are used) is a 50 column simpletextfield.  The name of
   the related words checkbox is "$name_related".
   
   =cut
   
   ###############################################
   ###############################################
       
   sub searchphrasefield_with_related {
       my ($title,$name,$value)=@_;
       return '<tr><td>'.&fieldtitle($title).'</td><td>'.
           &simpletextfield($name,$value,50).'</td><td align="center">&nbsp;'.
               &simplecheckbox($name.'_related',$ENV{'form.'.$name.'_related'}).
                   "&nbsp;</td></tr>\n";
   }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &dateboxes()
   
   Returns html selection form elements for the specification of 
   the day, month, and year.
   
   =cut
   
   ###############################################
   ###############################################
   
 sub dateboxes {  sub dateboxes {
     my ($name,$defaultmonth,$defaultday,$defaultyear,      my ($name,$defaultmonth,$defaultday,$defaultyear,
  $currentmonth,$currentday,$currentyear)=@_;   $currentmonth,$currentday,$currentyear)=@_;
Line 720  END Line 987  END
     return "$month$day$year";      return "$month$day$year";
 }  }
   
   ###############################################
   ###############################################
   
   =pod
   
   =item &selectbox()
   
   Returns a scalar containing an html <select> form.  
   
   Inputs: 
   
   =over 4
   
   =item $title 
   
   Printed above the select box, in uppercase.  If undefined, only a select
   box will be returned, with no additional html.
   
   =item $name 
   
   The name element of the <select> tag.
   
   =item $default 
   
   The default value of the form.  Can be $anyvalue, or in @idlist.
   
   =item $anyvalue 
   
   The <option value="..."> used to indicate a default of 
   none of the values.  Can be undef.
   
   =item $anytag 
   
   The text associate with $anyvalue above.
   
   =item $functionref 
   
   Each element in @idlist will be passed as a parameter 
   to the function referenced here.  The return value of the function should
   be a scalar description of the items.  If this value is undefined the 
   description of each item in @idlist will be the item name.
   
   =item @idlist 
   
   The items to be selected from.  One of these or $anyvalue will be the 
   value returned by the form element, $ENV{form.$name}.
   
   =back
   
   =cut
   
   ###############################################
   
 sub selectbox {  sub selectbox {
     my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;      my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;
     if (! defined($functionref)) { $functionref = sub { $_[0]}; }      if (! defined($functionref)) { $functionref = sub { $_[0]}; }
Line 745  sub selectbox { Line 1065  sub selectbox {
 }  }
   
 ######################################################################  ######################################################################
   #                End of HTML form building functions                 #  
   ######################################################################
   
   =pod
   
   =back 
   
   =cut
   
   
   ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
Line 770  Parse advanced search form and return th Line 1101  Parse advanced search form and return th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_advanced_search {  sub parse_advanced_search {
     my ($r)=@_;      my ($r,$closebutton)=@_;
     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 805  sub parse_advanced_search { Line 1137  sub parse_advanced_search {
  }   }
     }      }
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton);
  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','mime') {
  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.      # I dislike the hack below.
Line 825  sub parse_advanced_search { Line 1172  sub parse_advanced_search {
     # 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 846  sub parse_advanced_search { Line 1200  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);
  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'}) {      if ($ENV{'form.custommetadata'}) {
           $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
               $ENV{'form.custommetadata'}."</b><br />\n";
  $customquery=&build_custommetadata_query('custommetadata',   $customquery=&build_custommetadata_query('custommetadata',
       $ENV{'form.custommetadata'});        $ENV{'form.custommetadata'});
     }      }
     my $customshow=undef;      my $customshow=undef;
     if ($ENV{'form.customshow'}) {      if ($ENV{'form.customshow'}) {
           $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
               $ENV{'form.customshow'}."</b><br />\n";
  $customshow=$ENV{'form.customshow'};   $customshow=$ENV{'form.customshow'};
  $customshow=~s/[^\w\s]//g;   $customshow=~s/[^\w\s]//g;
  my @fields=split(/\s+/,$customshow);   my @fields=split(/\s+/,$customshow);
Line 874  sub parse_advanced_search { Line 1233  sub parse_advanced_search {
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}       my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
                            :  ($ENV{'form.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 = "Searching all domains.";
             $libraries_to_query = undef;      } else {
             last;          if (@allowed_domains > 1) {
               $pretty_domains_string = "Searching domains:";
           } else {
               $pretty_domains_string = "Searching domain ";
           }
           foreach (sort @allowed_domains) {
               $pretty_domains_string .= "<b>$_</b> ";
         }          }
         if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {          foreach (keys(%Apache::lonnet::libserv)) {
             push @$libraries_to_query,$_;              if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
                   push @$libraries_to_query,$_;
               }
         }          }
     }      }
       $pretty_search_string .= $pretty_domains_string."<br />\n";
     #      #
     if (@queries) {      if (@queries) {
  $query=join(" AND ",@queries);   $query=join(" AND ",@queries);
Line 893  sub parse_advanced_search { Line 1262  sub parse_advanced_search {
     } elsif ($customquery) {      } elsif ($customquery) {
         $query = '';          $query = '';
     }      }
     return ($query,$customquery,$customshow,$libraries_to_query);      return ($query,$customquery,$customshow,$libraries_to_query,
               $pretty_search_string);
 }  }
   
 ######################################################################  ######################################################################
Line 910  Parse the basic search form and return a Line 1280  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 924  sub parse_basic_search { Line 1294  sub parse_basic_search {
   
     # Check to see if enough is filled in      # Check to see if enough is filled in
     unless (&filled($ENV{'form.basicexp'})) {      unless (&filled($ENV{'form.basicexp'})) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton);
  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('.$concatarg.')',$search_string);
     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});      $pretty_search_string .= "<br />\n";
     return 'select * from metadata where '.$query;      return 'select * from metadata where '.$query,$pretty_search_string;
 }  }
   
   
Line 945  sub parse_basic_search { Line 1325  sub parse_basic_search {
   
 =pod   =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));
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
 =item &build_SQL_query()   =item &build_SQL_query() 
   
 Builds a SQL query string from a logical expression with AND/OR keywords  Builds a SQL query string from a logical expression with AND/OR keywords
Line 1109  sub build_date_queries { Line 1522  sub build_date_queries {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod
   
 =item &output_results()   
   
 Format and output results based on a reply list.  =item &copyright_check()
 There are two windows that this function writes to.  The main search  
 window ("srch") has a listing of the results.  A secondary window ("popwin")  
 gives the status of the network search (time elapsed, number of machines  
 contacted, etc.)  
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_results {  
 #    &Apache::lonnet::logthis("output_results:".time);  sub copyright_check {
     my $fnum; # search result counter      my $Metadata = shift;
     my ($mode,$r,$replyref,$hidden)=@_;      # Check copyright tags and skip results the user cannot use
     my %rhash=%{$replyref};      my (undef,undef,$resdom,$resname) = split('/',
     my $compiledresult='';                                                $Metadata->{'url'});
     my $timeremain=300; # (seconds)      # Check for priv
     my $elapsetime=0;      if (($Metadata->{'copyright'} eq 'priv') && 
     my $resultflag=0;          (($ENV{'user.name'} ne $resname) &&
     my $tflag=1;           ($ENV{'user.domain'} ne $resdom))) {
     ##          return 0;
     ## Set viewing function  
     ##  
     my $viewfunction = $Views{$ENV{'form.viewselect'}};  
     if (!defined($viewfunction)) {  
         $r->print("Internal Error - Bad view selected.\n");  
         $r->rflush();  
         return;  
     }      }
       # Check for domain
       if (($Metadata->{'copyright'} eq 'domain') &&
           ($ENV{'user.domain'} ne $resdom)) {
           return 0;
       }
       return 1;
   }
   
   #####################################################################
   #####################################################################
   
   =pod
   
   =item MySQL Table Description
   
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   ##
   ## Restrictions:
   ##    columns of type 'text' and 'blob' cannot have defaults.
   ##    columns of type 'enum' cannot be used for FULLTEXT.
   ##
   my @DataOrder = qw/id title author subject url keywords version notes
       abstract mime lang owner copyright creationdate lastrevisiondate hostname/;
   
   my %Datatypes = 
       ( id        =>{ type         => 'INT',
                       restrictions => 'NOT NULL',
                       primary_key  => 'yes',
                       auto_inc     => 'yes'
                       },
         title     =>{ type=>'TEXT'},
         author    =>{ type=>'TEXT'},
         subject   =>{ type=>'TEXT'},
         url       =>{ type=>'TEXT',
                       restrictions => 'NOT NULL' },
         keywords  =>{ type=>'TEXT'},
         version   =>{ type=>'TEXT'},
         notes     =>{ type=>'TEXT'},
         abstract  =>{ type=>'TEXT'},
         mime      =>{ type=>'TEXT'},
         lang      =>{ type=>'TEXT'},
         owner     =>{ type=>'TEXT'},
         copyright =>{ type=>'TEXT'},
         hostname  =>{ type=>'TEXT'},
         #--------------------------------------------------
         creationdate     =>{ type=>'DATETIME'},
         lastrevisiondate =>{ type=>'DATETIME'},
         #--------------------------------------------------
         );
   
   my @Fullindicies = 
       qw/title author subject abstract mime language owner copyright/;
       
   ######################################################################
   ######################################################################
   
   =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 create_results_table {
       my $table = &Apache::lonmysql::create_table
           ( { columns => \%Datatypes,
               column_order => \@DataOrder,
               fullindex => \@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 &run_search 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub run_search {
       my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
       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  = 120;  # 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("<html><head><title>Search Status</title></head><body>");
     $r->print(&make_popwin(%rhash));      $r->print("Search: ".$pretty_string."\n");
     $r->rflush();      $r->rflush();
       #
       # Determine the servers we need to contact.
       #
       my @Servers_to_contact;
       if (defined($serverlist)) {
           @Servers_to_contact = @$serverlist;
       } else {
           @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
       }
       my %Server_status;
       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) {
           $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 $servercount=0;      my $hitcountsum;
     my $hitcountsum=0;      my $server; 
     my $servernum=(keys %rhash);      my $status;
     my $serversleft=$servernum;      $r->print(<<END);
     ##  <form name="statusform" action="" method="post">
     ## Run until we run out of time or we run out of servers  <input type="hidden" name="Queue" value="" />
     ##  <table>
     while($serversleft && $timeremain) {  <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th></tr>
       ##  <tr>
       ## %rhash has servers deleted from it as results come in   <td><input type="text" name="status"  value="" size="30" /></td>
       ## (within the foreach loop below).  <td><input type="text" name="count"   value="" size="10" /></td>
       ##  <td><input type="text" name="seconds" value="" size="8" /></td>
       foreach my $rkey (sort keys %rhash) {  </tr>
 #        &Apache::lonnet::logthis("Server $rkey:".time);  </table>
  $servercount++;  </form>
  $compiledresult='';  END
  my $reply=$rhash{$rkey};      $r->rflush();
  my @results;      my $time_remaining = $max_time - (time - $starttime) ;
  if ($reply eq 'con_lost') {      my $last_time = $time_remaining;
     &popwin_imgupdate($r,$rkey,"srvbad.gif");      &update_seconds($r,$time_remaining);
     $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=~/(.*?)\_/;              my $reply=&Apache::lonnet::metadata_query($query,$customquery,
             for (my $counter=0;$counter<2;$counter++) {                                                        $customshow,[$server]);
                 if (-e $replyfile && ! -e "$replyfile.end") {              ($server) = keys(%$reply);
                     &popwin_imgupdate($r,$rkey,"srvhalf.gif");              $Server_status{$server} = $reply->{$server};
                     &popwin_js($r,'popwin.hc["'.$rkey.'"]='.              &update_status($r,'contacting '.$server);
                                '"still transferring..."'.';');  
                 }  
                 # Are we finished transferring data?  
                 if (-e "$replyfile.end") {  
                     $serversleft--;  
                     delete $rhash{$rkey};  
                     if (-s $replyfile) {  
                         &popwin_imgupdate($r,$rkey,"srvgood.gif");  
                         my $fh;  
                         unless ($fh=Apache::File->new($replyfile)){   
                             # Is it really appropriate to die on this error?  
                             $r->print('ERROR: file '.  
                                       $replyfile.' cannot be opened');  
                             return OK;  
                         }  
                         @results=<$fh> if $fh;  
                         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;  
                 } # end of if ( -e "$replyfile.end")  
                 last unless $timeremain;  
                 sleep 1;    # wait for daemons to write files?  
                 $timeremain--;  
                 $elapsetime++;  
                 &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 {          } else {
     if ($ENV{'form.launch'} eq '1') {              # wait a sec. to give time for files to be written
  &start_fresh_session();              # This sleep statement is here instead of outside the else 
     }              # block because we do not want to pause if we have servers
     foreach my $result (@results) {              # left to contact.  
  next if $result=~/^custom\=/;              sleep(1)
  chomp $result;          }
  next unless $result;          &update_status($r,'waiting on '.(join(' ',keys(%Server_status))));
                 %Fields = &parse_raw_result($result,$rkey);          while (my ($server,$status) = each(%Server_status)) {
                 #              last if ($connection->aborted());
                 # Check copyright tags and skip results the user cannot use              if ($status eq 'con_lost') {
                 my (undef,undef,$resdom,$resname) = split('/',$Fields{'url'});                  delete ($Server_status{$server});
                 # Check for priv                  next;
                 if (($Fields{'copyright'} eq 'priv') &&               }
                     (($ENV{'user.name'} ne $resname) &&              $status=~/^([\.\w]+)$/; 
                      ($ENV{'user.domain'} ne $resdom))) {             my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
               if (-e $datafile && ! -e "$datafile.end") {
                   &update_status($r,'Receiving results from '.$server);
                   next;
               }
               last if ($connection->aborted());
               if (-e "$datafile.end") {
                   &update_status($r,'Reading results from '.$server);
                   if (-z "$datafile") {
                       delete($Server_status{$server});
                     next;                      next;
                 }                  }
                 # Check for domain                  my $fh;
                 if (($Fields{'copyright'} eq 'domain') &&                  if (!($fh=Apache::File->new($datafile))) { 
                     ($ENV{'user.domain'} ne $resdom)) {                      $r->print("Unable to open search results file for ".
                     next;                                    "server $server.  Omitting from search");
                       delete($Server_status{$server}); 
                      next;
                 }                  }
                 #                  # Read in the whole file.
  $Fields{'extrashow'}=$extrashow;                  while (my $result = <$fh>) {
  if ($extrashow) {                      last if ($connection->aborted());
     foreach my $field (@customfields) {                      # handle custom fields?  Someday we will!
  my $value='';                      chomp($result);
  $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);                      next unless $result;
                         $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;                      # Parse the result.
                       my %Fields = &parse_raw_result($result,$server);
                       $Fields{'hostname'} = $server;
                       next if (! &copyright_check(\%Fields));
                       # Store the result in the mysql database
                       my $result = &Apache::lonmysql::store_row($table,\%Fields);
                       if (! defined($result)) {
                           $r->print(&Apache::lonmysql::get_error());
                     }                      }
                 }                      # $r->print(&Apache::lonmysql::get_debug());
                 $compiledresult.="\n<p>\n";                      $hitcountsum ++;
                 if ($ENV{'form.catalogmode'} eq 'interactive') {                      $time_remaining = $max_time - (time - $starttime) ;
                     my $titleesc=$Fields{'title'};                      if ($last_time - $time_remaining > 0) {
                     $titleesc=~s/\'/\\'/; # '                          &update_seconds($r,$time_remaining);
                     $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');                          $last_time = $time_remaining;
                       }
                       if ($hitcountsum % 50 == 0) {
                           &update_count_status($r,$hitcountsum);
                       }
                   } # End of foreach (@results)
                   $fh->close();
                   # $server is only deleted if the results file has been 
                   # found and (successfully) opened.  This may be a bad idea.
                   delete($Server_status{$server});
               }
               last if ($connection->aborted());
               &update_count_status($r,$hitcountsum);
           }
           last if ($connection->aborted());
           # Finished looping through the servers
           $time_remaining = $max_time - (time - $starttime) ;
           if ($last_time - $time_remaining > 0) {
               $last_time = $time_remaining;
               &update_seconds($r,$time_remaining);
           }
       }
       &update_status($r,'Search Complete'.$server);
       &Apache::lonmysql::disconnect_from_db();
       # Let the user know
       #
       # We have run out of time or run out of servers to talk to and
       # results to get.  
       $r->print("<b>Search Completed.</b>&nbsp;&nbsp;");
       if ($hitcountsum) {
           $r->print($hitcountsum." matches were found.");
       } else {
           $r->print("There were no successful matches to your query.");
       }
       $r->print("</body></html>");
       return;
   }
   
   ######################################################################
   ######################################################################
   =pod
   
   =item &prev_next_buttons
   
   =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 = 0 if $prev_min < 0;
       if ($prev_min < $current_min) {
           $links .= qq{
   <a href="/adm/searchcat?$parms&start=$prev_min&show=$show">prev</a>
   };    
       } else {
           $links .= 'prev';
       }
       ##
       ## Pages.... Someday.
       ##
       $links .= qq{ &nbsp;
   <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">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">next</a>
   };    
       } else {
           $links .= '&nbsp;next';
       }
       return $links;
   }
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &display_results
   
   =cut
   
   ######################################################################
   ######################################################################
   sub display_results {
       my ($r,$importbutton,$closebutton) = @_;
       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;
       }
       ##
       ## Get the catalog controls setup
       ##
       my $action = "/adm/searchcat?phase=results";
       ##
       ## Deal with groupsearch
       ##
       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'};
       my $connection_result = &Apache::lonmysql::connect_to_db();
       if (!defined($connection_result)) {
           $r->print(&Apache::lonmysql::get_error());
       }
       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;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return;
       }
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</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());
           &Apache::lonnet::logthis(&Apache::lonmysql::get_debug());
           return;
       }
       ##
       ## Determine how many results we need to get
       ##
       $ENV{'form.show'} = 20;
       $ENV{'form.start'} = 0      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'};
           $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("There are currently no results.\n".
                     "</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()) {
               untie %groupsearch_db if (tied(%groupsearch_db));
               &Apache::lonmysql::disconnect_from_db();
               return;
           }
           my %Fields = %{&parse_row(@$row)};
           my $output="<p>\n";
           my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'});
           # 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("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)
   
   Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db and $fnum 
   (local variable).
   
   =cut
   
   ######################################################################
   ######################################################################
   { 
   my $fnum = 0;
   
   sub catalogmode_output {
       my $output = '';
       my ($title,$url) = @_;
       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($fnum)" />
 </font>  </font>
 <br />  
 END  END
 # <input type="hidden" name="title$fnum" value="$title" />          $fnum++;
 # <input type="hidden" name="url$fnum" value="$url" />      }
                     $fnum++;      return $output;
  }  }
                 # Render the result into html  
                 $compiledresult.= &$viewfunction(%Fields, hostname => $rkey );  }
                 if ($compiledresult or $servercount!=$servernum) {  ######################################################################
                     $compiledresult.="<hr align='left' width='200' noshade />";  ######################################################################
                 }  
             }  =pod
             untie %hash;  
         }  =item &parse_row
  if ($compiledresult) {  
     $resultflag=1;  Parse a row returned from the database.
             $r->print($compiledresult);  
  }  =cut
       } # End of foreach loop over servers remaining  
     }   # End of big loop - while($serversleft && $timeremain)  ######################################################################
     unless ($resultflag) {  ######################################################################
         $r->print("\nThere were no results that matched your query\n");  sub parse_row {
     }      my @Row = @_;
     $r->print('<script type="text/javascript">'.'popwin.close()</script>'.      my %Fields;
               "\n");       for (my $i=0;$i<=$#Row;$i++) {
     $r->print("</body>\n</html>\n");          $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]);
     $r->rflush();       }
     return;      $Fields{'language'} = 
           &Apache::loncommon::languagedescription($Fields{'lang'});
       $Fields{'copyrighttag'} =
           &Apache::loncommon::copyrightdescription($Fields{'copyright'});
       $Fields{'mimetag'} =
           &Apache::loncommon::filedescription($Fields{'mime'});
       return \%Fields;
 }  }
   
 ###########################################################  ###########################################################
Line 1406  sub parse_raw_result { Line 2198  sub parse_raw_result {
         $Fields{'title'}='Untitled';           $Fields{'title'}='Untitled'; 
     }      }
     unless ($ENV{'user.adv'}) {      unless ($ENV{'user.adv'}) {
           # What is this anyway?
         $Fields{'keywords'} = '- not displayed -';          $Fields{'keywords'} = '- not displayed -';
         $Fields{'notes'}    = '- not displayed -';          $Fields{'notes'}    = '- not displayed -';
         $Fields{'abstract'} = '- not displayed -';          $Fields{'abstract'} = '- not displayed -';
Line 1504  Checked for existance & 'edit' mode. Line 2297  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode) = @_;      my ($importbutton,$closebutton) = @_;
     $mode = lc($mode);  
     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 1528  BEGINNING Line 2309  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 (opener.inf.document.forms.resinfo.elements.t) {
Line 1549  SCRIPT Line 2330  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();      parent.close();
 }  }
 function changeTitle(val) {  function changeTitle(val) {
 }  }
 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 1567  SCRIPT Line 2348  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) {  
 // alert('DEBUG: Should be storing '+title+' and '+url);  
     }  
     function queue(val) {      function queue(val) {
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {          if (document.forms.results.returnvalues[val].checked) {
     document.forms.results.acts.value+='1a'+val+'b';              parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
  }          } else {
  else {              parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
     document.forms.results.acts.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">  <form name="results" method="post" action="" >
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <input type="hidden" name="Queue" value="" />
 <h1>$title</h1>  $importbutton
 END  END
     return $result;      return $result;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub search_status_header {
       return <<ENDSTATUS;
   <html><head><title>Search Status</title></head>
   <body>
   <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=10"."&start=0"."&show=20";
       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.="\"'\"+'";  
  $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 1724  extra custom metadata to show. Line 2439  extra custom metadata to show.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
 <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>$prefix<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 1742  $values{'extrashow'} Line 2457  $values{'extrashow'}
 <p>  <p>
 $values{'shortabstract'}  $values{'shortabstract'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1754  END Line 2470  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
 <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   $prefix<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 $result=<<END;
   $prefix <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 1783  END Line 2521  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
   $prefix
 <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 1803  sub fielded_format_view { Line 2542  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 1821  END Line 2561  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 1851  sub xml_sgml_view { Line 2592  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 1888  sub filled { Line 2630  sub filled {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_blank_field_error {  sub output_blank_field_error {
     my ($r)=@_;      my ($r,$closebutton)=@_;
     # 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 1903  BEGINNING Line 2643  BEGINNING
 <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?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>Helpful Message</h3>
Line 1929  RESULTS Line 2669  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)=@_;
     # 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(<<RESULTS);      $r->print(<<RESULTS);
 <html>  <html>
 <head>  <head>
Line 1947  sub output_date_error { Line 2691  sub output_date_error {
 <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
Line 1968  RESULTS Line 2712  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 1976  Cleans the global %hash by removing all Line 2720  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{$_};
  }   }
     }      }
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &popwin_js() send javascript to popwin  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub popwin_js {  
     # Print javascript out to popwin, but make sure we dont generate  
     # any javascript errors in doing so.  
     my ($r,$text) = @_;  
     $r->print(<<"END");  
 <script type="text/javascript">  
     if (! popwin.closed) {  
  $text  
     }  
 </script>  
 END  
     $r->rflush();  
 }  
   
 ######################################################################  
 ######################################################################  
   
 =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;  1;
   
 __END__  __END__

Removed from v.1.140  
changed lines
  Added in v.1.150


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