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

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

version 1.136, 2002/07/05 18:56:52 version 1.146, 2002/07/29 21:53:57
Line 40 Line 40
   
 =head1 NAME  =head1 NAME
   
 lonsearchcat  lonsearchcat - LONCAPA Search Interface
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
Line 87  use Apache::lonnet(); Line 87  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 103  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 
   
 The full path to the (temporary) search database file.  This is set and  The full path to the (temporary) search database file.  This is set and
 used in &handler() and is also used in &output_results().  used in &handler() and is also used in &output_results().
   
   =item %Views
   
   Hash which associates an output view description with the function
   that produces it.  Adding a new view type should be as easy as
   adding a line to the definition of this hash and making sure the function
   takes the proper parameters.
   
 =back   =back 
   
 =cut  =cut
Line 126  used in &handler() and is also used in & Line 131  used in &handler() and is also used in &
 ######################################################################  ######################################################################
   
 # -- 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
   my %Views = ("Detailed Citation View" => \&detailed_citation_view,
                "Summary View"           => \&summary_view,
                "Fielded Format"         => \&fielded_format_view,
                "XML/SGML"               => \&xml_sgml_view );
   my %persistent_db;
   my $hidden_fields;
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 160  string that holds portions of the screen Line 170  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(5);
           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.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';
       ##
       &get_persistent_form_data($r,$persistent_db_file);
     ##      ##
     ## Clear out old values from database      ## Clear out old values from groupsearch database
     ##      ##
       untie %groupsearch_db if (tied(%groupsearch_db));
     if ($ENV{'form.launch'} eq '1') {      if ($ENV{'form.launch'} eq '1') {
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {   if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
     &start_fresh_session();      &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 187  sub handler { Line 228  sub handler {
  }   }
     }      }
     ##      ##
     ## Produce some output, so people know it is working  
     ##  
     $r->print("\n");  
     $r->rflush;  
     ##  
     ## Configure dynamic components of interface      ## Configure dynamic components of interface
     ##      ##
     my $hidden;       # Holds 'hidden' html forms      $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
           $ENV{'form.persistent_db_id'}.'" />';
       ##
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".  
     "\n";  
         $closebutton="<input type='button' name='close' value='CLOSE' ".          $closebutton="<input type='button' name='close' value='CLOSE' ".
     "onClick='self.close()'>"."\n";      "onClick='self.close()'>"."\n";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
  $hidden=<<END;  
 <input type='hidden' name='catalogmode' value='groupsearch'>  
 END  
         $closebutton=<<END;          $closebutton=<<END;
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>  <input type='button' name='close' value='CLOSE' onClick='self.close()'>
 END  END
Line 211  END Line 244  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'})) {
     ##          $ENV{'form.viewselect'} ="Detailed Citation View";
     ##  What are we doing?      }
     ##      $ENV{'form.phase'} = 'displaybasic' if (! exists($ENV{'form.phase'}));
     my $searchtype;      ##
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');      ## Switch on the phase
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');      ##
     if ($searchtype) {      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']);
           &write_status($r,"query         = $query");
           &write_status($r,"customquery   = $customquery");
           &write_status($r,"customshow    = $customshow");
           &write_status($r,"libraries     = $libraries");
           &write_status($r,"pretty_string = $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())) {
               # Unable to make table to store results in.  
               # Definately abort search.
           }
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               # Unable to store persistent data.
               # Probably should bail out.
           }
           #
           # 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           &write_status($r,"query         = $query");
         # either the SQL database or a recursive scheme of 'grep'-like           &write_status($r,"customquery   = $customquery");
         # actions (for custom metadata).          &write_status($r,"customshow    = $customshow");
         $r->rflush();          &write_status($r,"libraries     = $libraries");
         my $reply=&Apache::lonnet::metadata_query($query,$customquery,          &write_status($r,"pretty_string = $pretty_string");
                                                $customshow,$libraries);          &make_persistent($r,
         &output_results($searchtype,$r,$reply,$hidden);                           { query => $query,
     } elsif ($ENV{'form.reqinterface'} eq 'advanced') {                             customquery => $customquery,
         # Output the advanced interface                             customshow => $customshow,
         $r->print(&advanced_search_form($closebutton,$hidden));                             libraries => $libraries,
     } else {                              pretty_string => $pretty_string },
         # Output normal search interface                           $persistent_db_file);
         $r->print(&basic_search_form($closebutton,$hidden));          ##
           ## Print out the frames interface
           ##
           &print_frames_interface($r);
     }      }
     return OK;      return OK;
 }   } 
Line 254  END Line 324  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 263  Returns a scalar which holds html for th Line 333  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 281  sub basic_search_form{ Line 351  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 295  ENDDOCUMENT Line 366  ENDDOCUMENT
         '&nbsp;';          '&nbsp;';
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});  #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});
 #    $scrout.='<font color="#800000">Search historic archives</font>';  #    $scrout.='<font color="#800000">Search historic archives</font>';
     $scrout.=<<ENDDOCUMENT;      my $checkbox = &simplecheckbox('related',$ENV{'form.related'});
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>      $scrout.=<<END;
   </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;
 $closebutton  $closebutton
 <!-- view selection -->  END
 <select name="viewselect">      $scrout.=&selectbox(undef,'viewselect',
 <option value="Detailed Citation View" selected="true" >Detailed Citation View</option>   $ENV{'form.viewselect'},
 <option value="Summary View"  >Summary View</option>   undef,undef,undef,
 <option value="Fielded Format">Fielded Format</option>   sort(keys(%Views)));
 <option value="XML/SGML"      >XML/SGML</option>      $scrout.=<<ENDDOCUMENT;
 </select>  
 <!-- end of view selection -->  
 <input type="button" value="HELP" onClick="openhelp()" />  <input type="button" value="HELP" onClick="openhelp()" />
 </p>  </p>
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 331  Returns a scalar which holds html for th Line 404  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 341  $closebutton Line 414  $closebutton
 <input type="button" value="HELP" onClick="openhelp()" />  <input type="button" value="HELP" onClick="openhelp()" />
 </p>  </p>
 END  END
       if (!defined($ENV{'form.viewselect'})) {
           $ENV{'form.viewselect'} ="Detailed Citation View";
       }
     my $scrout=<<"ENDHEADER";      my $scrout=<<"ENDHEADER";
 <html>  <html>
 <head>  <head>
Line 361  Enter terms or phrases separated by sear Line 437  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>
 <!-- view selection -->  
 <select name="viewselect" size ="1">  
     <option value="Detailed Citation View" selected="true">Detailed Citation View</option>  
     <option value="Summary View">Summary View</option>  
     <option value="Fielded Format">Fielded Format</option>  
     <option value="XML/SGML">XML/SGML</option>  
 </select>  
 <!-- end of view selection -->  
 </td></tr>  
 ENDHEADER  ENDHEADER
     $scrout.=&searchphrasefield('title',   'title'   ,$ENV{'form.title'});      $scrout.=&selectbox(undef,'viewselect',
    $ENV{'form.viewselect'},
    undef,undef,undef,
    sort(keys(%Views)));
       $scrout.="</td><td>Related<br />Words</td></tr>\n";
       $scrout.=&searchphrasefield_with_related('title',   'title'   ,
                                                $ENV{'form.title'});
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});      $scrout.=&searchphrasefield('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 412  ENDHEADER Line 490  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 507  $advanced_buttons Line 580  $advanced_buttons
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 515  ENDDOCUMENT Line 589  ENDDOCUMENT
   
 =pod   =pod 
   
 =item &make_persistent()   =item &get_persistent_form_data
   
 Returns a scalar which holds the current ENV{'form.*'} values in  Inputs: filename of database
 a 'hidden' html input tag.  This allows search interface information  
 to be somewhat persistent.  Outputs: returns undef on database errors.
   
   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 undef 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]);
             }              }
         }          }
           &write_status($r,"Reconstructed $name = $ENV{$name}");
     }      }
     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;
           &write_status($r,"Stored $name = $store");
       }
       untie(%persistent_db);
       return 1;
   }
   
 =over 4  ######################################################################
   ######################################################################
   
 =item $title   =pod 
   
 Printed above the select box, in uppercase.  =item &make_form_data_persistent() 
   
 =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.  
   
 =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 640  sub simpletextfield { Line 787  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 647  sub simplecheckbox { Line 811  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 699  END Line 944  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]}; }
     my $uctitle=uc($title);      my $selout='';
     my $selout="\n".'<p><font color="#800000" face="helvetica">'.      if (defined($title)) {
         '<b>'.$uctitle.': </b></font><select name="'.$name.'">';          my $uctitle=uc($title);
     foreach ($anyvalue,@idlist) {          $selout="\n".'<p><font color="#800000" face="helvetica">'.
               '<b>'.$uctitle.': </b></font>';
       }
       $selout .= '<select name="'.$name.'">';
       unshift @idlist,$anyvalue if (defined($anyvalue));
       foreach (@idlist) {
         $selout.='<option value="'.$_.'"';          $selout.='<option value="'.$_.'"';
         if ($_ eq $default and !/^any$/) {          if ($_ eq $default and !/^any$/) {
     $selout.=' selected >'.&{$functionref}($_).'</option>';      $selout.=' selected >'.&{$functionref}($_).'</option>';
Line 715  sub selectbox { Line 1018  sub selectbox {
  }   }
         else {$selout.='>'.&{$functionref}($_).'</option>';}          else {$selout.='>'.&{$functionref}($_).'</option>';}
     }      }
     return $selout.'</select></p>';      return $selout.'</select>'.(defined($title)?'</p>':' ');
 }  }
   
 ######################################################################  ######################################################################
   #                End of HTML form building functions                 #  
   ######################################################################
   
   =pod
   
   =back 
   
   =cut
   
   
   ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
Line 744  Parse advanced search form and return th Line 1058  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 779  sub parse_advanced_search { Line 1094  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 799  sub parse_advanced_search { Line 1129  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 820  sub parse_advanced_search { Line 1157  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 848  sub parse_advanced_search { Line 1190  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 ";
         }          }
         if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {          foreach (sort @allowed_domains) {
             push @$libraries_to_query,$_;              $pretty_domains_string .= "<b>$_</b> ";
           }
           foreach (keys(%Apache::lonnet::libserv)) {
               if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
                   push @$libraries_to_query,$_;
               }
         }          }
     }      }
       $pretty_search_string .= $pretty_domains_string."<br />\n";
     #      #
     if (@queries) {      if (@queries) {
  $query=join(" AND ",@queries);   $query=join(" AND ",@queries);
Line 867  sub parse_advanced_search { Line 1219  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 884  Parse the basic search form and return a Line 1237  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 898  sub parse_basic_search { Line 1251  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 919  sub parse_basic_search { Line 1282  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 1083  sub build_date_queries { Line 1479  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 = undef;  
     if ($ENV{'form.viewselect'} eq 'Detailed Citation View') {  
         $viewfunction = \&detailed_citation_view;  
     } elsif ($ENV{'form.viewselect'} eq 'Summary View') {  
         $viewfunction = \&summary_view;  
     } elsif ($ENV{'form.viewselect'} eq 'Fielded Format') {  
         $viewfunction = \&fielded_format_view;  
     } elsif ($ENV{'form.viewselect'} eq 'XML/SGML') {  
         $viewfunction = \&xml_sgml_view;  
     }      }
     if (!defined($viewfunction)) {      # Check for domain
         $r->print("Internal Error - Bad view selected.\n");      if (($Metadata->{'copyright'} eq 'domain') &&
         $r->rflush();          ($ENV{'user.domain'} ne $resdom)) {
         return;          return 0;
     }      }
       return 1;
   }
   
   #####################################################################
   #####################################################################
   
   =pod
   
   =item MySQL Table Description
   
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   ##
   ## Restrictions:
   ##    columns of type 'text' and 'blob' cannot have defaults.
   ##    columns of type 'enum' cannot be used for FULLTEXT.
   ##
   my @DataOrder = qw/id title author subject url keywords version notes
       abstract mime lang owner copyright creationdate lastrevisiondate hostname
       idx_title idx_author idx_subject idx_abstract idx_mime idx_language 
       idx_owner idx_copyright/;
   
   my %Datatypes = 
       ( id        =>{ type         => 'INT',
                       restrictions => 'NOT NULL',
                       primary_key  => 'yes',
                       auto_inc     => 'yes'
                       },
         title     =>{ type=>'TEXT'},
         author    =>{ type=>'TEXT'},
         subject   =>{ type=>'TEXT'},
         url       =>{ type=>'TEXT',
                       restrictions => 'NOT NULL' },
         keywords  =>{ type=>'TEXT'},
         version   =>{ type=>'TEXT'},
         notes     =>{ type=>'TEXT'},
         abstract  =>{ type=>'TEXT'},
         mime      =>{ type=>'TEXT'},
         lang      =>{ type=>'TEXT'},
         owner     =>{ type=>'TEXT'},
         copyright =>{ type=>'TEXT'},
         hostname  =>{ type=>'TEXT'},
         #--------------------------------------------------
         creationdate     =>{ type=>'DATETIME'},
         lastrevisiondate =>{ type=>'DATETIME'},
         #--------------------------------------------------
         idx_title     =>{ type=>'FULLTEXT', target=>'title'},
         idx_author    =>{ type=>'FULLTEXT', target=>'author'},
         idx_subject   =>{ type=>'FULLTEXT', target=>'subject'},
         idx_abstract  =>{ type=>'FULLTEXT', target=>'abstract'},
         idx_mime      =>{ type=>'FULLTEXT', target=>'mime'},
         idx_language  =>{ type=>'FULLTEXT', target=>'lang'},
         idx_owner     =>{ type=>'FULLTEXT', target=>'owner'},
         idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},
         );
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &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,
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
   }
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &write_status()
   
   =cut
   
   ######################################################################
   ######################################################################
   sub write_status {
       my ($r,$string) = @_;
       $string =~ s/(\')/\$1/g;
       $string =~ s/\n//sg;
   #    $r->print("<script>alert('$string');</script>\n");
   #    $r->rflush();
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &run_search 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub run_search {
       my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
     #      #
     # 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."<br />\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)) {
           # What do I do now?  Print out an error page.
           &Apache::lonnet::logthis("lonmysql attempted to create a table ".
                                    "and this was the result:".
                                    &Apache::lonmysql::get_error());
           $r->print("An internal error occured with the database.<br />".
                     "The error has been logged, but you should probably alert".
                     " your system administrator.");
           return;
       }
     ##      ##
     ## 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;      while ((time - $starttime < $max_time) && 
     ##             ((@Servers_to_contact) || keys(%Server_status))) {
     ## Run until we run out of time or we run out of servers          # Send out a search request if it needs to be done.
     ##          if (@Servers_to_contact) {
     while($serversleft && $timeremain) {              # Contact one server
       ##              my $server = shift(@Servers_to_contact);
       ## %rhash has servers deleted from it as results come in               my $reply=&Apache::lonnet::metadata_query($query,$customquery,
       ## (within the foreach loop below).                                                        $customshow,[$server]);
       ##              ($server) = keys(%$reply);
       foreach my $rkey (sort keys %rhash) {              $Server_status{$server} = $reply->{$server};
 #        &Apache::lonnet::logthis("Server $rkey:".time);              # $r->print("Contacted:$server:reply:$Server_status{$server}");
  $servercount++;              if ($max_time - (time - $starttime) < 20) {
  $compiledresult='';                  # If there are less than 20 seconds to go in the search,
  my $reply=$rhash{$rkey};                  # give the newly contacted servers 20 more seconds to 
  my @results;                  # respond....
  if ($reply eq 'con_lost') {                  $max_time += 20;
     &popwin_imgupdate($r,$rkey,"srvbad.gif");              }
     $serversleft--;  
             delete $rhash{$rkey};  
  } else {  
             # must do since 'use strict' checks for tainting  
     $reply=~/^([\.\w]+)$/;   
     my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
     $reply=~/(.*?)\_/;  
             for (my $counter=0;$counter<2;$counter++) {  
                 if (-e $replyfile && ! -e "$replyfile.end") {  
                     &popwin_imgupdate($r,$rkey,"srvhalf.gif");  
                     &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
                                '"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') {              sleep(1); # wait a sec. to give time for files to be written
  &start_fresh_session();          }
     }          while (my ($server,$status) = each(%Server_status)) {
     foreach my $result (@results) {              if ($status eq 'con_lost') {
  next if $result=~/^custom\=/;                  delete ($Server_status{$server});
  chomp $result;                  # $r->print("server $server is not responding.");
  next unless $result;                  next;
                 %Fields = &parse_raw_result($result,$rkey);              }
  $Fields{'extrashow'}=$extrashow;              $status=~/^([\.\w]+)$/; 
  if ($extrashow) {             my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
     foreach my $field (@customfields) {              if (-e $datafile && ! -e "$datafile.end") {
  my $value='';                  # Let the user know we are receiving data from the server
  $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);                  # $r->print("$server:Receiving file");
                         $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;                  next;
                     }              }
               if (-e "$datafile.end") {
                   if (-z "$datafile") {
                       delete($Server_status{$server});
                       next;
                   }
                   my $fh;
                   if (!($fh=Apache::File->new($datafile))) { 
                       # Error opening file...
                       # Tell the user and exit...?
                       # Should I give up on opening it?
                       $r->print("Unable to open search results file for ".
                                     "server $server.  Omitting from search");
                       next;
                 }                  }
                 $compiledresult.="\n<p>\n";                  # Read in the whole file.
                 if ($ENV{'form.catalogmode'} eq 'interactive') {                  while (my $result = <$fh>) {
                     my $titleesc=$Fields{'title'};                      # handle custom fields?  Someday we will!
                     $titleesc=~s/\'/\\'/; # '                      chomp($result);
                     $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');                      next unless $result;
                       # Parse the result.
                       my %Fields = &parse_raw_result($result,$server);
                       $Fields{'hostname'} = $server;
                       next if (! &copyright_check(\%Fields));
                       # Store the result in the mysql database
                       my $result = &Apache::lonmysql::store_row($table,\%Fields);
                       if (! defined($result)) {
                           $r->print(&Apache::lonmysql::get_error());
                       }
                       # $r->print(&Apache::lonmysql::get_debug());
                       $hitcountsum ++;
                   } # End of foreach (@results)
                   $fh->close();
                   # $server is only deleted if the results file has been 
                   # found and (successfully) opened.  This may be a bad idea.
                   delete($Server_status{$server});
                   # $r->print("Received $new_count more results from ".
                   #              $server.".");
               }
           }
           # Finished looping through the servers
       }
       &Apache::lonmysql::disconnect_from_db();
       # Let the user know
       #
       # We have run out of time or run out of servers to talk to and
       # results to get.  
       $r->print("<h1>Search completed.</h1>");
       if ($hitcountsum) {
           $r->print($hitcountsum." successful matches to your query.<br />");
       } else {
           $r->print("There were no successful matches to your query.<br />");
       }
       $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,$mode,$importbutton,$closebutton) = @_;
       $r->print(&search_results_header());
       ##
       ## 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";
       ##
       ##
       ##
       if ($ENV{'form.catalogmode'} eq 'groupsearch') {
           if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                     &GDBM_WRCREAT,0640)) {
               $r->print('Unable to tie hash to db file</body></html>');
               $r->rflush();
               return;
           } 
       }
       ##
       ## Prepare the table for querying
       ##
       my $table = $ENV{'form.table'};
       my $connection_result = &Apache::lonmysql::connect_to_db();
       if (!defined($connection_result)) {
           $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.</body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the status".
                                    " of table ".$table);
           return;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return;
       }
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           &Apache::lonnet::logthis(&Apache::lonmysql::get_debug());
           return;
       }
       if ($total_results == 0) {
           $r->print("There were no results matching your query.\n".
                     "</form></body></html>");
           return;
       }
       ##
       ## Determine how many results we need to get
       ##
       $ENV{'form.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>Results $min to $max out of $total_results</center>\n");
       $r->print
           ('<br /><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><br />\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) {
           my %Fields = %{&parse_row(@$row)};
           my $output="<p>\n";
           $output.=&catalogmode_output($Fields{'title'},$Fields{'url'});
           # Render the result into html
           $output.= &$viewfunction(%Fields);
           $output.="</p>\n<hr align='left' width='200' noshade />";
           # Print them out as they come in.
           $r->print($output);
           $r->rflush();
       }
       if (@Results < 1) {
           $r->print("There were no results matching your query");
       }
       $r->print("</body></html>");
       $r->rflush();
       untie %groupsearch_db;
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &catalogmode_output($title,$url)
   
   Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db and $fnum 
   (local variable).
   
   =cut
   
   ######################################################################
   ######################################################################
   { 
   my $fnum;
   
   sub catalogmode_output {
       my $output = '';
       my ($title,$url) = @_;
       if ($ENV{'form.catalogmode'} eq 'interactive') {
           $title=~ s/\'/\\'/g; # ' Escape single quotes.
           if ($ENV{'form.catalogmode'} eq 'interactive') {
               $output.=<<END 
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  <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') {      }
     $fnum+=0;      if ($ENV{'form.catalogmode'} eq 'groupsearch') {
     $hash{"pre_${fnum}_link"}=$Fields{'url'};          $fnum+=0;
     $hash{"pre_${fnum}_title"}=$Fields{'title'};          $groupsearch_db{"pre_${fnum}_link"}=$url;
     $compiledresult.=<<END;          $groupsearch_db{"pre_${fnum}_title"}=$title;
           $output.=<<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 1374  sub parse_raw_result { Line 2071  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 1472  Checked for existance & 'edit' mode. Line 2170  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode) = @_;  
     $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 1553  SCRIPT Line 2238  SCRIPT
     }      }
 </script>  </script>
 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  
     $result.=<<END;      $result.=<<END;
 </head>  </head>
 <body bgcolor="#ffffff">  
 <img align=right src=/adm/lonIcons/lonlogos.gif>  
 <h1>$title</h1>  
 END  END
     return $result;      return $result;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub search_status_header {
 =pod      return <<ENDSTATUS;
   <html><head><title>Search Status</title></head>
 =item &make_popwin()  <body>
   <h3>Search Status</h3>
 Returns html with javascript in it to open up the status window.  Sending search request to LON-CAPA servers.<br />
   ENDSTATUS
 =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 = $basic_link."&phase=results".
     # rows of 10 each.  No longer used to index images.          "&pause=10"."&start=0"."&show=20";
     my $sn=1;      my $result = <<"ENDFRAMES";
     foreach my $sk (sort keys %rhash) {  <html>
  $grid.="'<a href=\"";  <head>
  $grid.="javascript:opener.displayinfo('+";  <title>LON-CAPA Digital Library Search Results</title>
  $grid.="\"'\"+'";  </head>
  $grid.=$sk;  <frameset rows="150,*">
  my $hc;      <frame name="statusframe"  src="$run_search_link">
  if ($rhash{$sk} eq 'con_lost') {      <frame name="resultsframe" src="$results_link">
     $hc="BAD CONNECTION ";  </frameset>
  }  </html>
  else {  ENDFRAMES
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";      $r->print($result);
  }      return;
  $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>  
 ENDPOP  
     return $result;  
 }  }
   
 ######################################################################  ######################################################################
Line 1722  END Line 2332  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
Line 1856  sub filled { Line 2465  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 1871  BEGINNING Line 2478  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 1897  RESULTS Line 2504  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 1915  sub output_date_error { Line 2526  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 1936  RESULTS Line 2547  RESULTS
   
 =item &start_fresh_session()  =item &start_fresh_session()
   
 Cleans the global %hash by removing all fields which begin with  Cleans the global %groupsearch_db by removing all fields which begin with
 'pre_' or 'store'.  'pre_' or 'store'.
   
 =cut  =cut
Line 1944  Cleans the global %hash by removing all Line 2555  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.136  
changed lines
  Added in v.1.146

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