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

Diff for /loncom/interface/lonsearchcat.pm between versions 1.130 and 1.176

version 1.130, 2002/06/26 16:04:13 version 1.176, 2003/06/06 02:24:49
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # YEAR=2001  
 # 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison  
 # 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison  
 # 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison  
 # YEAR=2002  
 # 1/17 Scott Harrison  
 # 6/17 Matthew Hall  
 #  
 ###############################################################################  ###############################################################################
 ###############################################################################  ###############################################################################
   
Line 40 Line 32
   
 =head1 NAME  =head1 NAME
   
 lonsearchcat  lonsearchcat - LONCAPA Search Interface
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
Line 82  package Apache::lonsearchcat; Line 74  package Apache::lonsearchcat;
   
 # ------------------------------------------------- modules used by this module  # ------------------------------------------------- modules used by this module
 use strict;  use strict;
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common :http);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::File();  use Apache::File();
 use CGI qw(:standard);  use CGI qw(:standard);
 use Text::Query;  use Text::Query;
 use GDBM_File;  use GDBM_File;
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::lonmysql();
   
 # ---------------------------------------- variables used throughout the module  # ---------------------------------------- variables used throughout the module
   
Line 101  use Apache::loncommon(); Line 94  use Apache::loncommon();
   
 =over 4  =over 4
   
 =item $closebutton  
   
 button that closes the search window  
   
 =item $importbutton  =item $importbutton
   
 button to take the selecte 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.
   
   =item $bodytag
   
   LON-CAPA standard body tag, gotten from &Apache::lonnet::bodytag.
   No title, no table, just a <body> tag.
   
 =back   =back 
   
 =cut  =cut
Line 126  used in &handler() and is also used in & Line 127  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,
                "Compact View"           => \&compact_view);
   my %persistent_db;
   my $hidden_fields;
   my $bodytag;
   
   #
   # For course search
   #
   my %alreadyseen;
   my $hashtied;
   my %hash;
   my $totalfound;
    
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 160  string that holds portions of the screen Line 177  string that holds portions of the screen
 ######################################################################  ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
     untie %hash;      #
   
       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
   
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
     $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;
       ##
       ## Prevent caching of the search interface window.  Hopefully this means
       ## we will get the launch=1 passed in a little more.
       &Apache::loncommon::no_cache($r);
       ## 
       ## Pick up form fields passed in the links.
       ##
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element','pause',
                 'phase','persistent_db_id','table','start','show',
                 'cleargroupsort']);
       ##
       ## The following is a trick - we wait a few seconds if asked to so
       ##     the daemon running the search can get ahead of the daemon
       ##     printing the results.  We only need (theoretically) to do
       ##     this once, so the pause indicator is deleted
       ##
       if (exists($ENV{'form.pause'})) {
           sleep(3);
           delete($ENV{'form.pause'});
       }
       ##
       ## Initialize global variables
       ##
     my $domain  = $r->dir_config('lonDefDomain');      my $domain  = $r->dir_config('lonDefDomain');
     $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).      $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";              "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
       #
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      # set the name of the persistent database
              ['catalogmode','launch','acts','mode','form','element',      #          $ENV{'form.persistent_db_id'} can only have digits in it.
               'reqinterface']);      if (! exists($ENV{'form.persistent_db_id'}) ||
           ($ENV{'form.persistent_db_id'} =~ /\D/) ||
           ($ENV{'form.launch'} eq '1')) {
           $ENV{'form.persistent_db_id'} = time;
       }
       $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $persistent_db_file = "/home/httpd/perl/tmp/".
           &Apache::lonnet::escape($domain).
               '_'.&Apache::lonnet::escape($ENV{'user.name'}).
                   '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
     ##      ##
     ## Clear out old values from database      if (! &get_persistent_form_data($persistent_db_file)) {
           if ($ENV{'form.phase'} =~ /(run_search|results)/) {
               &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ".
                                        "from $persistent_db_file");
               $r->print(<<END);
   <html>
   <head><title>LON-CAPA Search Error</title></head>
   $bodytag
   We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
   END
               return OK;
           }
       }
     ##      ##
     if ($ENV{'form.launch'} eq '1') {      ## Clear out old values from groupsearch database
  if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {      ##
       untie %groupsearch_db if (tied(%groupsearch_db));
       if (($ENV{'form.cleargroupsort'} eq '1') || 
           (($ENV{'form.launch'} eq '1') && 
            ($ENV{'form.catalogmode'} eq 'groupsearch'))) {
    if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
     &start_fresh_session();      &start_fresh_session();
     untie %hash;      untie %groupsearch_db;
               delete($ENV{'form.cleargroupsort'});
  } else {   } else {
     $r->print('<html><head></head><body>Unable to tie hash to db '.              # This is a stupid error to give to the user.  
       'file</body></html>');              # It really tells them nothing.
       $r->print('<html><head></head>'.$bodytag.
                         'Unable to tie hash to db file</body></html>');
     return OK;      return OK;
  }   }
     }      }
     ##      ##
     ## Produce some output, so people know it is working      ## Configure hidden fields
     ##      ##
     $r->print("\n");      $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
     $r->rflush;          $ENV{'form.persistent_db_id'}.'" />'."\n";
       if (exists($ENV{'form.catalogmode'})) {
           $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
                   $ENV{'form.catalogmode'}.'" />'."\n";
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= '<input type="hidden" name="form" value="'.
                   $ENV{'form.form'}.'" />'."\n";
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= '<input type="hidden" name="element" value="'.
                   $ENV{'form.element'}.'" />'."\n";
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= '<input type="hidden" name="mode" value="'.
                   $ENV{'form.mode'}.'" />'."\n";
       }
     ##      ##
     ## Configure dynamic components of interface      ## Configure dynamic components of interface
     ##      ##
     my $hidden;       # Holds 'hidden' html forms  
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".          $closebutton="<input type='button' name='close' value='CLOSE' ";
     "\n";          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
         $closebutton="<input type='button' name='close' value='CLOSE' ".      $closebutton .="onClick='parent.close()'";
     "onClick='self.close()'>"."\n";          } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .=">\n";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
  $hidden=<<END;          $closebutton="<input type='button' name='close' value='CLOSE' ";
 <input type='hidden' name='catalogmode' value='groupsearch'>          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
 END      $closebutton .="onClick='parent.close()'";
         $closebutton=<<END;          } else {
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>              $closebutton .="onClick='self.close()'";
 END          }
           $closebutton .= ">";
         $importbutton=<<END;          $importbutton=<<END;
 <input type='button' name='import' value='IMPORT'  <input type='button' name='import' value='IMPORT'
 onClick='javascript:select_group()'>  onClick='javascript:select_group()'>
 END  END
       } else {
           $closebutton = '';
           $importbutton = '';
     }      }
     $hidden .= <<END;      ##
 <input type='hidden' name='mode'    value='$ENV{'form.mode'}'>      ## Sanity checks on form elements
 <input type='hidden' name='form'    value='$ENV{'form.form'}'>      ##
 <input type='hidden' name='element' value='$ENV{'form.element'}'>      if (!defined($ENV{'form.viewselect'})) {
 <input type='hidden' name='date' value='2'>          if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
 END              ($ENV{'form.catalogmode'} eq 'interactive')) {
     ##              $ENV{'form.viewselect'} ="Compact View";
     ##  What are we doing?          } else {
     ##              $ENV{'form.viewselect'} ="Detailed Citation View";
     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {          }
         # Perform basic search and give results      }
  return &basicsearch($r,$hidden);      $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
     } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {      $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
         # Perform advanced search and give results      ##
  return &advancedsearch($r,$hidden);      ## Switch on the phase
     } elsif ($ENV{'form.reqinterface'} eq 'advanced') {      ##
         # Output the advanced interface      if ($ENV{'form.phase'} eq 'disp_basic') {
         $r->print(&advanced_search_form($closebutton,$hidden));          &print_basic_search_form($r,$closebutton);
         return OK;      } elsif ($ENV{'form.phase'} eq 'disp_adv') {
     } else {           &print_advanced_search_form($r,$closebutton);
         # Output normal search interface      } elsif ($ENV{'form.phase'} eq 'results') {
         $r->print(&basic_search_form($closebutton,$hidden));          &display_results($r,$importbutton,$closebutton);
       } elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) {
           my ($query,$customquery,$customshow,$libraries,$pretty_string) =
               &get_persistent_data($persistent_db_file,
                    ['query','customquery','customshow',
                     'libraries','pretty_string']);
           if ($ENV{'form.phase'} eq 'sort') {
               &print_sort_form($r,$pretty_string);
           } elsif ($ENV{'form.phase'} eq 'run_search') {
               &run_search($r,$query,$customquery,$customshow,
                           $libraries,$pretty_string);
           }
       } elsif ($ENV{'form.phase'} eq 'course_search') {
           &course_search($r);
       } elsif(($ENV{'form.phase'} eq 'basic_search') ||
               ($ENV{'form.phase'} eq 'adv_search')) {
           $ENV{'form.searchmode'} = 'basic';
           if ($ENV{'form.phase'} eq 'adv_search') {
               $ENV{'form.searchmode'} = 'advanced';
           }
           # Set up table
           if (! defined(&create_results_table())) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to create table in which to store search results.  
   The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           #
           # We are running a search
           my ($query,$customquery,$customshow,$libraries) = 
               (undef,undef,undef,undef);
           my $pretty_string;
           if ($ENV{'form.phase'} eq 'basic_search') {
               ($query,$pretty_string) = &parse_basic_search($r,$closebutton);
           } else {                      # Advanced search
               ($query,$customquery,$customshow,$libraries,$pretty_string) 
                   = &parse_advanced_search($r,$closebutton);
               return OK if (! defined($query));
           }
           &make_persistent({ query => $query,
                              customquery => $customquery,
                              customshow => $customshow,
                              libraries => $libraries,
                              pretty_string => $pretty_string },
                            $persistent_db_file);
           ##
           ## Print out the frames interface
           ##
           &print_frames_interface($r);
     }      }
     return OK;      return OK;
 }   } 
Line 241  END Line 406  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
   sub course_search {
       my $r=shift;
       my $bodytag=&Apache::loncommon::bodytag('Course Search');
       my $pretty_search_string = '<b>'.$ENV{'form.courseexp'}.'</b>';
       my $search_string = $ENV{'form.courseexp'};
       my @New_Words;
       if ($ENV{'form.crsrelated'}) {
           ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
           if (@New_Words) {
               $pretty_search_string .= " with related words: <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= " with no related words.";
           }
       }
       my $fulltext=$ENV{'form.crsfulltext'};
       my @allwords=($search_string,@New_Words);
       $totalfound=0;
       $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
         $bodytag.$pretty_search_string);
       $r->rflush();
   # ======================================================= Go through the course
      $hashtied=0;
      undef %alreadyseen;
      %alreadyseen=();
       my $c=$r->connection;
      &tiehash();
      foreach (keys %hash) {
          if ($c->aborted()) { last; }
          if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
              &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,@allwords);
          }
      }
      &untiehash();
       unless ($totalfound) {
    $r->print('<p>No resources found.</p>');
       }
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
   # ---------------------------------------------------------------- tie the hash
   
   sub tiehash {
       $hashtied=0;
       if ($ENV{'request.course.fn'}) {
           if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
                   $hashtied=1;
           }
       }    
   }
   
   sub untiehash {
       if ($hashtied) { untie %hash; }
       $hashtied=0;
   }
   
   # =============================== This pulls up a resource and its dependencies
   
   sub checkonthis {
       my ($r,$url,$level,$title,$fulltext,@allwords)=@_;
       $alreadyseen{$url}=1;
       $r->rflush();
       my $result=&Apache::lonnet::metadata($url,'title').' '.
                  &Apache::lonnet::metadata($url,'subject').' '.
                  &Apache::lonnet::metadata($url,'abstract').' '.
                  &Apache::lonnet::metadata($url,'keywords');
       if (($url) && ($fulltext)) {
    $result.=&Apache::lonnet::ssi_body($url);
       }
       $result=~s/\s+/ /gs;
       my $applies=0;
       foreach (@allwords) {
           if ($_=~/\w/) {
      if ($result=~/$_/si) {
         $applies++;
              }
          }
       }
   # Does this resource apply?
       if ($applies) {
          $r->print('<br />');
          for (my $i=0;$i<=$level*5;$i++) {
              $r->print('&nbsp;');
          }
          $r->print('<a href="'.$url.'" target="cat">'.
    ($title?$title:$url).'</a><br />');
          $totalfound++;
       } elsif ($fulltext) {
          $r->print(' .');
       }
       $r->rflush();
   # Check also the dependencies of this one
       my $dependencies=
                   &Apache::lonnet::metadata($url,'dependencies');
       foreach (split(/\,/,$dependencies)) {
          if (($_=~/^\/res\//) && (!$alreadyseen{$_})) {
             &checkonthis($r,$_,$level+1,'',$fulltext,@allwords);
          }
       }
   }
   
   ######################################################################
   ######################################################################
   
 =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 252  Returns a scalar which holds html for th Line 522  Returns a scalar which holds html for th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub basic_search_form{  sub print_basic_search_form{
     my ($closebutton,$hidden) = @_;      my ($r,$closebutton) = @_;
       my $bodytag=&Apache::loncommon::bodytag('Search');
     my $scrout=<<"ENDDOCUMENT";      my $scrout=<<"ENDDOCUMENT";
 <html>  <html>
 <head>  <head>
Line 266  sub basic_search_form{ Line 537  sub basic_search_form{
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  ENDDOCUMENT
 <h1>Search Catalog</h1>  if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
       $scrout.=(<<ENDDOCUMENT);
   <h1>Catalog Search</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $hidden  <input type="hidden" name="phase" value="basic_search" />
 <h3>Basic Search</h3>  $hidden_fields
 <p>  <p>
 Enter terms or quoted phrases separated by AND, OR, or NOT   Enter terms or phrases separated by AND, OR, or NOT 
 then press SEARCH below.  then press SEARCH below.
 </p>  </p>
 <p>  <p>
Line 282  then press SEARCH below. Line 555  then press SEARCH below.
 ENDDOCUMENT  ENDDOCUMENT
     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).      $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).
         '&nbsp;';          '&nbsp;';
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});      my $checkbox = &simplecheckbox('related',$ENV{'form.related'});
 #    $scrout.='<font color="#800000">Search historic archives</font>';      $scrout.=<<END;
     $scrout.=<<ENDDOCUMENT;  </td><td><a
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>  href="/adm/searchcat?phase=disp_adv&catalogmode=$ENV{'form.catalogmode'}&launch=$ENV{'form.launch'}"
   >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.=&selectbox(undef,'show',
 </select>   $ENV{'form.show'},
 <!-- end of view selection -->   undef,undef,undef,
 <input type="button" value="HELP" onClick="openhelp()" />   (10,20,50,100));
       $scrout.=<<ENDDOCUMENT;
   per page.
 </p>  </p>
 </form>  </form>
   ENDDOCUMENT
       if ($ENV{'request.course.id'}) { $scrout.='<hr />'; }
   }
   if ($ENV{'request.course.id'}) {
       $scrout.=(<<ENDCOURSESEARCH);
   <h1>Course Search</h1>    
   <form method="post" action="/adm/searchcat">
   <input type="hidden" name="phase" value="course_search" />
   $hidden_fields
   <p>
   Enter terms or phrases, then press SEARCH below.
   </p>
   <p>
   <table>
   <tr><td>
   ENDCOURSESEARCH
       $scrout.='&nbsp;'.&simpletextfield('courseexp',$ENV{'form.courseexp'},40);
       my $crscheckbox = &simplecheckbox('crsfulltext',$ENV{'form.crsfulltext'});
       my $relcheckbox = &simplecheckbox('crsrelated',$ENV{'form.crsrelated'});
   $scrout.=(<<ENDENDCOURSE);
   </td></tr>
   <tr><td>$relcheckbox use related words</td><td></td></tr>
   <tr><td>$crscheckbox fulltext search (time consuming)</td><td></td></tr>
   </table><p>
   &nbsp;<input type="submit" name="coursesubmit" value='SEARCH' />
   </p>
   ENDENDCOURSE
   }
       $scrout.=(<<ENDDOCUMENT);
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 320  Returns a scalar which holds html for th Line 628  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 330  $closebutton Line 638  $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 $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search');
     my $scrout=<<"ENDHEADER";      my $scrout=<<"ENDHEADER";
 <html>  <html>
 <head>  <head>
Line 342  END Line 654  END
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  Enter terms or phrases separated by search operators 
 <h1>Advanced Catalog Search</h1>  
 <hr />  
 Enter terms or quoted phrases separated by search operators   
 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',      $scrout.=&selectbox(undef,'viewselect',
  $ENV{'form.title'});   $ENV{'form.viewselect'},
     $scrout.=&searchphrasefield('author','author',   undef,undef,undef,
  $ENV{'form.author'});   sort(keys(%Views)));
     $scrout.=&searchphrasefield('subject','subject',      $scrout.='&nbsp;';
  $ENV{'form.subject'});      $scrout.=&selectbox(undef,'show',
     $scrout.=&searchphrasefield('keywords','keywords',   $ENV{'form.show'},
  $ENV{'form.keywords'});   undef,undef,undef,
     $scrout.=&searchphrasefield('URL','url',   (10,20,50,100));
  $ENV{'form.url'});      $scrout.='&nbsp;'.
 #    $scrout.=&searchphrasefield('Limit by version','version',          '<font color="#800000" face="helvetica">Per Page</font>';
 # $ENV{'form.version'});      $scrout.="</td><td>Related<br />Words</td></tr>\n";
     $scrout.=&searchphrasefield('notes','notes',      $scrout.=&searchphrasefield_with_related('title',   'title'   ,
  $ENV{'form.notes'});                                               $ENV{'form.title'});
     $scrout.=&searchphrasefield('abstract','abstract',      $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});
  $ENV{'form.abstract'});      $scrout.=&searchphrasefield_with_related('subject', 'subject' ,
                                                $ENV{'form.subject'});
       $scrout.=&searchphrasefield_with_related('keywords','keywords',
                                                $ENV{'form.keywords'});
       $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});
       $scrout.=&searchphrasefield_with_related('notes',   'notes'   ,
                                                $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','extension',
                         $ENV{'form.mime'});                          $ENV{'form.extension'});
     $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";
 #    $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});      $ENV{'form.category'}='any' if (! defined($ENV{'form.category'}));
 #    $scrout.=&selectbox('Limit by MIME type','mime',      $scrout.=&selectbox('File Category','category',
 # $ENV{'form.mime'},   $ENV{'form.category'},
 # 'any','Any type',   'any','Any category',
 # \&{Apache::loncommon::filedescriptionex},   undef,
 # (&Apache::loncommon::fileextensions));   (&Apache::loncommon::filecategories()));
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});      $ENV{'form.language'}='any' unless length($ENV{'form.language'});
       #----------------------------------------------------------------
       # Allow restriction to multiple domains.
       #   I make the crazy assumption that there will never be a domain 'any'.
       #
       $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));
       my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
                              :  ($ENV{'form.domains'}) );
       my %domain_hash = ();
       foreach (@allowed_domains) {
           $domain_hash{$_}++;
       }
       my @domains =&Apache::loncommon::get_domains();
       # adjust the size of the select box
       my $size = 4;
       $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
       $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
           'DOMAINS TO BE SEARCHED</b></font><br />'.
               '<select name="domains" size="'.$size.'" multiple>'."\n".
                   '<option name="any" value="any" '.
                       ($domain_hash{'any'}? 'selected ' :'').
                           '>all domains</option>'."\n";
       foreach my $dom (sort @domains) {
           $scrout.="<option name=\"$dom\" ".
               ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";
       }
       $scrout.="</select>\n";
       #----------------------------------------------------------------
     $scrout.=&selectbox('Limit by language','language',      $scrout.=&selectbox('Limit by language','language',
  $ENV{'form.language'},'any','Any Language',   $ENV{'form.language'},'any','Any Language',
  \&{Apache::loncommon::languagedescription},   \&Apache::loncommon::languagedescription,
  (&Apache::loncommon::languageids),   (&Apache::loncommon::languageids),
  );   );
 # ------------------------------------------------ Compute date selection boxes  # ------------------------------------------------ Compute date selection boxes
Line 444  LASTREVISIONDATEEND Line 780  LASTREVISIONDATEEND
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',      $scrout.=&selectbox('Limit by copyright/distribution','copyright',
  $ENV{'form.copyright'},   $ENV{'form.copyright'},
  'any','Any copyright/distribution',   'any','Any copyright/distribution',
  \&{Apache::loncommon::copyrightdescription},   \&Apache::loncommon::copyrightdescription,
  (&Apache::loncommon::copyrightids),   (&Apache::loncommon::copyrightids),
  );   );
 # ------------------------------------------- Compute customized metadata field  # ------------------------------------------- Compute customized metadata field
     $scrout.=<<CUSTOMMETADATA;  #    $scrout.=<<CUSTOMMETADATA;
 <p>  #<p>
 <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>  #<font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>
 </font>  #</font>
 For resource-specific metadata, enter in an expression in the form of   #For resource-specific metadata, enter in an expression in the form of 
 <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />  #<i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />
 <b>Example:</b> grandmother=75 OR grandfather=85  #<b>Example:</b> grandmother=75 OR grandfather=85
 <br />  #<br />
 CUSTOMMETADATA  #CUSTOMMETADATA
     $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});  #    $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
     $scrout.=<<CUSTOMSHOW;  #    $scrout.=<<CUSTOMSHOW;
 <p>  #<p>
 <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>  #<font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
 </font>  #</font>
 Enter in a space-separated list of special metadata fields to show  #Enter in a space-separated list of special metadata fields to show
 in a fielded listing for each record result.  #in a fielded listing for each record result.
 <br />  #<br />
 CUSTOMSHOW  #CUSTOMSHOW
     $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});  #    $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
     $scrout.=<<ENDDOCUMENT;      $scrout.=<<ENDDOCUMENT;
 $advanced_buttons  $advanced_buttons
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 481  ENDDOCUMENT Line 818  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 $filename = shift;
     my $persistent='';      return 0 if (! -e $filename);
     foreach (keys %ENV) {      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
  if (/^form\./ && !/submit/) {                             &GDBM_READER(),0640));
     my $name=$_;      #
     my $key=$name;      # These make sure we do not get array references printed out as 'values'.
     $ENV{$key}=~s/\'//g; # do not mess with html field syntax      my %arrays_allowed = ('form.domains'=>1);
     $name=~s/^form\.//;      #
     $persistent.=<<END;      # Loop through the keys, looking for 'form.'
 <input type="hidden" name="$name" value="$ENV{$key}" />      foreach my $name (keys(%persistent_db)) {
 END          next if ($name !~ /^form./);
           next if (exists($ENV{$name}));
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           next if (@values <1);
           if ($arrays_allowed{$name}) {
               $ENV{$name} = [@values];
           } else {
               $ENV{$name} = $values[0] if ($values[0]);
         }          }
     }      }
     return $persistent;      untie (%persistent_db);
       return 1;
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item HTML form building functions  =item &get_persistent_data
   
 =over 4  
   
 =item &simpletextfield()   
   
 Inputs: $name,$value,$size  
   
 Returns a text input field with the given name, value, and size.    Inputs: filename of database, ref to array of values to recover.
 If size is not specified, a value of 20 is used.  
   
 =item &simplecheckbox()  Outputs: array of values.  Returns undef on error.
   
 Inputs: $name,$value  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 simple check box with the given $name.  =cut
 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 %save = %{shift()};
       my $filename = shift;
       return undef if (! tie(%persistent_db,'GDBM_File',
                              $filename,&GDBM_WRCREAT(),0640));
       foreach my $name (keys(%save)) {
           my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
           # We handle array references, but not recursively.
           my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
           $persistent_db{$name} = $store;
       }
       untie(%persistent_db);
       return 1;
   }
   
 =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(\%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 603  sub simpletextfield { Line 1001  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 610  sub simplecheckbox { Line 1025  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 662  END Line 1158  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><br /><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 678  sub selectbox { Line 1232  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 
   
 =item &advancedsearch()  =item &parse_advanced_search()
   
   Parse advanced search form and return the following:
   
   =over 4
   
   =item $query Scalar containing an SQL query.
   
   =item $customquery Scalar containing a custom query.
   
   =item $customshow Scalar containing commands to show custom metadata.
   
 Parse advanced search results.  =item $libraries_to_query Reference to array of domains to search.
   
   =back
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub advancedsearch {  sub parse_advanced_search {
     my ($r,$hidden)=@_;      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 705  sub advancedsearch { Line 1283  sub advancedsearch {
    'lastrevisiondatestart_month','lastrevisiondatestart_day',     'lastrevisiondatestart_month','lastrevisiondatestart_day',
    'lastrevisiondatestart_year','lastrevisiondateend_month',     'lastrevisiondatestart_year','lastrevisiondateend_month',
    'lastrevisiondateend_day','lastrevisiondateend_year',     'lastrevisiondateend_day','lastrevisiondateend_year',
    'notes','abstract','mime','language','owner',     'notes','abstract','extension','language','owner',
    'custommetadata','customshow') {     'custommetadata','customshow','category') {
  $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
     foreach ('mode','form','element') {      foreach ('mode','form','element') {
Line 715  sub advancedsearch { Line 1293  sub advancedsearch {
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       # Preprocess the category form element.
       $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) ||
                                         ref($ENV{'form.category'}));
       #
     # Check to see if enough information was filled in      # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
    'notes','abstract','mime','language','owner',     'notes','abstract','category','extension','language',
    'custommetadata') {                     'owner','custommetadata') {
  if (&filled($ENV{"form.$field"})) {   if (&filled($ENV{"form.$field"})) {
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton,'phase=disp_adv');
  return OK;   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') {
  if ($ENV{'form.'.$field}) {   if ($ENV{'form.'.$field}) {
     push @queries,&build_SQL_query($field,$ENV{'form.'.$field});              my $searchphrase = $ENV{'form.'.$field};
  }              $pretty_search_string .= $font."$field</font> contains <b>".
                   $searchphrase."</b>";
               if ($ENV{'form.'.$field.'_related'}) {
                   my @New_Words;
                   ($searchphrase,@New_Words) = &related_version($searchphrase);
                   if (@New_Words) {
                       $pretty_search_string .= " with related words: ".
                           "<b>@New_Words</b>.";
                   } else {
                       $pretty_search_string .= " with no related words.";
                   }
               }
               $pretty_search_string .= "<br />\n";
       push @queries,&build_SQL_query($field,$searchphrase);
           }
       }
       #
       # Make the 'mime' from 'form.category' and 'form.extension'
       #
       my $searchphrase;
       if (exists($ENV{'form.category'})    && 
           $ENV{'form.category'} !~ /^\s*$/ &&
           $ENV{'form.category'} ne 'any')     {
           my @extensions = &Apache::loncommon::filecategorytypes
                                                      ($ENV{'form.category'});
           if (scalar(@extensions) > 0) {
               $searchphrase = join(' OR ',@extensions);
           }
       }
       if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) {
           $searchphrase .= ' OR ' if (defined($searchphrase));
           my @extensions = split(/,/,$ENV{'form.extension'});
           $searchphrase .= join(' OR ',@extensions);
       }
       if (defined($searchphrase)) {
           push @queries,&build_SQL_query('mime',$searchphrase);
           $pretty_search_string .=$font.'mime</font> contains <b>'.
               $searchphrase.'</b><br />';
     }      }
       #####
     # Evaluate option lists      # Evaluate option lists
     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  push @queries,"(language like \"$ENV{'form.language'}\")";   push @queries,"(language like \"$ENV{'form.language'}\")";
           $pretty_search_string.=$font."language</font>= ".
               &Apache::loncommon::languagedescription($ENV{'form.language'}).
                   "<br />\n";
     }      }
 #    if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {  
 # push @queries,"(mime like \"$ENV{'form.mime'}\")";  
 #    }  
     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 764  sub advancedsearch { Line 1389  sub advancedsearch {
  );   );
     # 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 OK;   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='';      my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {  #    if ($ENV{'form.custommetadata'}) {
  $customquery=&build_custommetadata_query('custommetadata',  #        $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
       $ENV{'form.custommetadata'});  #            $ENV{'form.custommetadata'}."</b><br />\n";
   # $customquery=&build_custommetadata_query('custommetadata',
   #      $ENV{'form.custommetadata'});
   #    }
       my $customshow=undef;
   #    if ($ENV{'form.customshow'}) {
   #        $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
   #            $ENV{'form.customshow'}."</b><br />\n";
   # $customshow=$ENV{'form.customshow'};
   # $customshow=~s/[^\w\s]//g;
   # my @fields=split(/\s+/,$customshow);
   # $customshow=join(" ",@fields);
   #    }
       ## ---------------------------------------------------------------
       ## Deal with restrictions to given domains
       ## 
       my $libraries_to_query = undef;
       # $ENV{'form.domains'} can be either a scalar or an array reference.
       # We need an array.
       my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
                              :  ($ENV{'form.domains'}) );
       my %domain_hash = ();
       my $pretty_domains_string;
       foreach (@allowed_domains) {
           $domain_hash{$_}++;
     }      }
     my $customshow='';      if ($domain_hash{'any'}) {
     if ($ENV{'form.customshow'}) {          $pretty_domains_string = "In all LON-CAPA domains.";
  $customshow=$ENV{'form.customshow'};      } else {
  $customshow=~s/[^\w\s]//g;          if (@allowed_domains > 1) {
  my @fields=split(/\s+/,$customshow);              $pretty_domains_string = "In LON-CAPA domains:";
  $customshow=join(" ",@fields);          } else {
     }              $pretty_domains_string = "In LON-CAPA domain ";
     # Send query statements over the network to be processed by either the SQL          }
     # database or a recursive scheme of 'grep'-like actions (for custom          foreach (sort @allowed_domains) {
     # metadata).              $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);
  $query="select * from metadata where $query";   $query="select * from metadata where $query";
  my $reply; # reply hash reference  
  unless ($customquery or $customshow) {  
     $reply=&Apache::lonnet::metadata_query($query);  
  }  
  else {  
     $reply=&Apache::lonnet::metadata_query($query,  
    $customquery,$customshow);  
  }  
  &output_results('Advanced',$r,$customquery,$reply,$hidden);  
         return OK;  
     } elsif ($customquery) {      } elsif ($customquery) {
  my $reply; # reply hash reference          $query = '';
  $reply=&Apache::lonnet::metadata_query('',  
        $customquery,$customshow);  
  &output_results('Advanced',$r,$customquery,$reply,$hidden);  
         return OK;  
     }      }
     # should not get to this point      return ($query,$customquery,$customshow,$libraries_to_query,
     return 'Error.  Should not have gone to this point.';              $pretty_search_string);
 }  }
   
 ######################################################################  ######################################################################
Line 815  sub advancedsearch { Line 1460  sub advancedsearch {
   
 =pod   =pod 
   
 =item &basicsearch()   =item &parse_basic_search() 
   
 Parse basic search form.  Parse the basic search form and return a scalar containing an sql query.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub basicsearch {  sub parse_basic_search {
     my ($r,$hidden)=@_;      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 838  sub basicsearch { Line 1483  sub basicsearch {
   
     # 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,'phase=disp_basic');
  return OK;   return OK;
     }      }
       my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
       my $search_string = $ENV{'form.basicexp'};
       if ($ENV{'form.related'}) {
           my @New_Words;
           ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'});
           if (@New_Words) {
               $pretty_search_string .= " with related words: <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= " with no related words.";
           }
       }
     # Build SQL query string based on form page      # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',"    ",',
        ('title', 'author', 'subject', 'notes', 'abstract',         ('title', 'author', 'subject', 'notes', 'abstract',
                         'keywords'));                          'keywords'));
     $concatarg='title' if $ENV{'form.titleonly'};      $concatarg='title' if $ENV{'form.titleonly'};
       $query=&build_SQL_query('concat('.$concatarg.')',$search_string);
       $pretty_search_string .= "<br />\n";
       return 'select * from metadata where '.$query,$pretty_search_string;
   }
   
     $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});  
   
     # Get reply (either a hash reference to filehandles or bad connection)  ######################################################################
 #    &Apache::lonnet::logthis("metadata query started:".time);  ######################################################################
     my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);  
 #    &Apache::lonnet::logthis("metadata query finished:".time);  
     # Output search results  
   
     &output_results('Basic',$r,$query,$reply,$hidden);  =pod 
   
     return OK;  =item &related_version
 }  
   
   Modifies an input string to include related words.  Words in the string
   are replaced with parenthesized lists of 'OR'd words.  For example
   "torque" is replaced with "(torque OR word1 OR word2 OR ...)".  
   
   Note: Using this twice on a string is probably silly.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub related_version {
       my $search_string = shift;
       my $result = $search_string;
       my %New_Words = ();
       while ($search_string =~ /(\w+)/cg) {
           my $word = $1;
           next if (lc($word) =~ /\b(or|and|not)\b/);
           my @Words = &Apache::loncommon::get_related_words($word);
           @Words = ($#Words>4? @Words[0..4] : @Words);
           foreach (@Words) { $New_Words{$_}++;}
           my $replacement = join " OR ", ($word,@Words);
           $result =~ s/(\b)$word(\b)/$1($replacement)$2/g;
       }
       return $result,sort(keys(%New_Words));
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 939  sub recursive_SQL_query_build { Line 1618  sub recursive_SQL_query_build {
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
     return $pattern unless @matches;      return $pattern unless @matches;
     foreach my $match (@matches) {      foreach my $match (@matches) {
  $match=~/\[ (\w+)\s(.*) \]/;          $match=~/\[ (\w+)\s(.*) \]/;
  my ($key,$value)=($1,$2);          my ($key,$value)=($1,$2);
  my $replacement='';          my $replacement='';
  if ($key eq 'literal') {          if ($key eq 'literal') {
     $replacement="($dkey like \"\%$value\%\")";              $replacement="($dkey like \"\%$value\%\")";
  }          } elsif ($key eq 'not') {
  elsif ($key eq 'not') {              $value=~s/like/not like/;
     $value=~s/like/not like/;  #          $replacement="($dkey not like $value)";
 #    $replacement="($dkey not like $value)";              $replacement="$value";
     $replacement="$value";          } elsif ($key eq 'and') {
  }              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  elsif ($key eq 'and') {              $replacement="($1 AND $2)";
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;   } elsif ($key eq 'or') {
     $replacement="($1 AND $2)";              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  }              $replacement="($1 OR $2)";
  elsif ($key eq 'or') {  
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  
     $replacement="($1 OR $2)";  
  }   }
  substr($pattern,   substr($pattern,
        index($pattern,$match),                 index($pattern,$match),
        length($match),                 length($match),
        $replacement                 $replacement);
        );  
     }      }
     &recursive_SQL_query_build($dkey,$pattern);      &recursive_SQL_query_build($dkey,$pattern);
 }  }
Line 1032  sub build_date_queries { Line 1707  sub build_date_queries {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod
   
 =item &output_results()   =item &copyright_check()
   
 Format and output results based on a reply list.  =cut
 There are two windows that this function writes to.  The main search  
 window ("srch") has a listing of the results.  A secondary window ("popwin")  ######################################################################
 gives the status of the network search (time elapsed, number of machines  ######################################################################
 contacted, etc.)  sub copyright_check {
       my $Metadata = shift;
       # Check copyright tags and skip results the user cannot use
       my (undef,undef,$resdom,$resname) = split('/',
                                                 $Metadata->{'url'});
       # Check for priv
       if (($Metadata->{'copyright'} eq 'priv') && 
           (($ENV{'user.name'} ne $resname) &&
            ($ENV{'user.domain'} ne $resdom))) {
           return 0;
       }
       # Check for domain
       if (($Metadata->{'copyright'} eq 'domain') &&
           ($ENV{'user.domain'} ne $resdom)) {
           return 0;
       }
       return 1;
   }
   
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &ensure_db_and_table
   
   Ensure we can get lonmysql to connect to the database and the table we
   need exists.
   
   Inputs: $r, table id
   
   Returns: undef on error, 1 if the table exists.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_results {  sub ensure_db_and_table {
 #    &Apache::lonnet::logthis("output_results:".time);      my ($r,$table) = @_;
     my $fnum; # search result counter      ##
     my ($mode,$r,$query,$replyref,$hidden)=@_;      ## Sanity check the table id.
     my %rhash=%{$replyref};      ##
     my $compiledresult='';      if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
     my $timeremain=300; # (seconds)          $r->print("Unable to retrieve search results.  ".
     my $elapsetime=0;                    "Unable to determine the table results were stored in.  ".
     my $resultflag=0;                    "</body></html>");
     my $tflag=1;          return undef;
     my $viewselect=$ENV{'form.viewselect'};      }
     #      ##
     # make query information persistent to allow for subsequent revision      ## Make sure we can connect and the table exists.
     my $persistent=&make_persistent();      ##
     # spit out the results header      my $connection_result = &Apache::lonmysql::connect_to_db();
     $r->print(&search_results_header($mode));      if (!defined($connection_result)) {
           $r->print("Unable to connect to the MySQL database where your results".
                     " are stored. </body></html>");
           &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to".
                                    " connect to database.");
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return undef;
       }
       my $table_check = &Apache::lonmysql::check_table($table);
       if (! defined($table_check)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the status".
                                    " of table ".$table);
           return undef;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return undef;
       }
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &print_sort_form
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_sort_form {
       my ($r,$pretty_query_string) = @_;
       ##
       my %SortableFields = 
           (id        => 'Default',
            title     => 'Title',
            author    => 'Author',
            subject   => 'Subject',
            url       => 'URL',
            version   => 'Version Number',
            mime      => 'Mime type',
            lang      => 'Language',
            owner     => 'Owner/Publisher',
            copyright => 'Copyright',
            hostname  => 'Host',
            creationdate     => 'Creation Date',
            lastrevisiondate => 'Revision Date',
        );
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       my $result;
       $result.=<<END;
   <html>
   <head>
   <script>
       function change_sort() {
           var newloc = "/adm/searchcat?phase=results";
           newloc += "&persistent_db_id=$ENV{'form.persistent_db_id'}";
           newloc += "&sortby=";
           newloc += document.forms.statusform.elements.sortby.value;
           parent.resultsframe.location= newloc;
       }
   </script>
   <title>Results</title>
   </head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
   END
   
   #<h2>Sort Results</h2>
   #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
   #    $ENV{'form.sortby'} = 'id' if (! defined($ENV{'form.sortby'}));
   #    foreach (keys(%SortableFields)) {
   #        $result.="<option name=\"$_\"";
   #        if ($_ eq $ENV{'form.sortby'}) {
   #            $result.=" selected ";
   #        }
   #        $result.=" >$SortableFields{$_}</option>\n";
   #    }
   #    $result.="</select>\n";
       my $revise = &revise_button();
       $result.=<<END;
   <p>
   There are $total_results matches to your query. $revise
   </p><p>
   Search:$pretty_query_string
   </p>
   </form>
   </body>
   </html>
   END
       $r->print($result);
       return;
   }
   
   #####################################################################
   #####################################################################
   
   =pod
   
   =item MySQL Table Description
   
   MySQL table creation requires a precise description of the data to be
   stored.  The use of the correct types to hold data is vital to efficient
   storage and quick retrieval of records.  The columns must be described in
   the following format:
   
   =cut
   
   #####################################################################
   #####################################################################
   
   my @Datatypes = 
       ( { name => 'id', 
           type => 'MEDIUMINT',
           restrictions => 'UNSIGNED NOT NULL',
           primary_key  => 'yes',
           auto_inc     => 'yes' },
         { name => 'title',     type=>'TEXT'},
         { name => 'author',    type=>'TEXT'},
         { name => 'subject',   type=>'TEXT'},
         { name => 'url',       type=>'TEXT', restrictions => 'NOT NULL' },
         { name => 'keywords',  type=>'TEXT'},
         { name => 'version',   type=>'TEXT'},
         { name => 'notes',     type=>'TEXT'},
         { name => 'abstract',  type=>'TEXT'},
         { name => 'mime',      type=>'TEXT'},
         { name => 'lang',      type=>'TEXT'},
         { name => 'owner',     type=>'TEXT'},
         { name => 'copyright', type=>'TEXT'},
         { name => 'hostname',  type=>'TEXT'},
         #--------------------------------------------------
         { name => 'creationdate',     type=>'DATETIME'},
         { name => 'lastrevisiondate', type=>'DATETIME'},
         #--------------------------------------------------
         );
   
   my @Fullindicies = 
       qw/title/;
   #    qw/title author subject abstract mime language owner copyright/;
       
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &create_results_table()
   
   Creates the table of search results by calling lonmysql.  Stores the
   table id in $ENV{'form.table'}
   
   Inputs: none.
   
   Returns: the identifier of the table on success, undef on error.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub create_results_table {
       my $table = &Apache::lonmysql::create_table
           ( { columns => \@Datatypes,
               FULLTEXT => [{'columns' => \@Fullindicies},],
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item Search Status update functions
   
   Each of the following functions changes the values of one of the
   input fields used to display the search status to the user.  The names
   should be explanatory.
   
   Inputs: Apache request handler ($r), text to display.
   
   Returns: Nothing.
   
   =over 4
   
   =item &update_count_status()
   
   =item &update_status()
   
   =item &update_seconds()
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub update_count_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.count.value = ' $text'</script>\n");
     $r->rflush();      $r->rflush();
     # begin showing the cataloged results  }
     my $action = "/adm/searchcat";  
     if ($mode eq 'Basic') {   sub update_status {
         $action .= "?reqinterface=basic";      my ($r,$text) = @_;
     } elsif ($mode eq 'Advanced') {      $text =~ s/\'/\\\'/g;
         $action .= "?reqinterface=advanced";      $r->print
     }          ("<script>document.statusform.status.value = ' $text'</script>\n");
     $r->print(<<CATALOGCONTROLS);      $r->rflush();
 <form name='results' method="post" action="$action">  }
 $hidden  
 <input type='hidden' name='acts' value='' />  sub update_seconds {
 <input type='button' value='Revise search request'      my ($r,$text) = @_;
 onClick='this.form.submit();' />      $text =~ s/\'/\\\'/g;
 $importbutton      $r->print
 $closebutton          ("<script>document.statusform.seconds.value = ' $text'</script>\n");
 $persistent      $r->rflush();
 <hr />  }
 CATALOGCONTROLS  
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &revise_button
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revise_phase = 'disp_basic';
       $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
       my $newloc = '/adm/searchcat'.
           '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
               '&cleargroupsort=1'.
               '&phase='.$revise_phase;
       my $result = qq{<input type="button" value="Revise search" name="revise"} .
           qq{ onClick="parent.location='$newloc';" /> };
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &run_search 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub run_search {
       my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
       my $connection = $r->connection;
       #
       # Timing variables
       #
       my $starttime = time;
       my $max_time  = 30;  # seconds for the search to complete
     #      #
     # make the pop-up window for status      # Print run_search header
     #      #
     $r->print(&make_popwin(%rhash));      $r->print(<<END);
   <html>
   <head><title>Search Status</title></head>
   $bodytag
   <form name="statusform" action="" method="post">
   <input type="hidden" name="Queue" value="" />
   END
       # Check to see if $pretty_string has more than one carriage return.
       # Assume \n s are following <br /> s and truncate the value.
       # (there is probably a better way)...
       my @Lines = split /<br \/>/,$pretty_string;
       if (@Lines > 2) {
           $pretty_string = join '<br \>',(@Lines[0..2],'....<br />');
       }
       $r->print("Search: ".$pretty_string);
     $r->rflush();      $r->rflush();
       #
       # Determine the servers we need to contact.
       #
       my @Servers_to_contact;
       if (defined($serverlist)) {
           if (ref($serverlist) eq 'ARRAY') {
               @Servers_to_contact = @$serverlist;
           } else {
               @Servers_to_contact = ($serverlist);
           }
       } else {
           @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
       }
       my %Server_status;
       my $table =$ENV{'form.table'};
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to determine table id to store search results in.".
                     "The search has been aborted.</body></html>");
           return;
       }
       my $table_status = &Apache::lonmysql::check_table($table);
       if (! defined($table_status)) {
           $r->print("Unable to determine status of table.</body></html>");
           &Apache::lonnet::logthis("Bogus table id of $table for ".
                                    "$ENV{'user.name'} @ $ENV{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                    &Apache::lonmysql::get_error());
           return;
       }
       if (! $table_status) {
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
           return;
       }
     ##      ##
     ## Prepare for the main loop below      ## Prepare for the big loop.
     ##      ##
     my $servercount=0;      my $hitcountsum;
     my $hitcountsum=0;      my $server; 
     my $servernum=(keys %rhash);      my $status;
     my $serversleft=$servernum;      my $revise = &revise_button();
     ##      $r->print(<<END);
     ## Run until we run out of time or we run out of servers  <table>
     ##  <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
     while($serversleft && $timeremain) {  <tr>
       ##  <td><input type="text" name="status"  value="" size="30" /></td>
       ## %rhash has servers deleted from it as results come in   <td><input type="text" name="count"   value="" size="10" /></td>
       ## (within the foreach loop below).  <td><input type="text" name="seconds" value="" size="8" /></td>
       ##  <td>$revise</td>
       foreach my $rkey (sort keys %rhash) {  </tr>
 #        &Apache::lonnet::logthis("Server $rkey:".time);  </table>
  $servercount++;  </form>
  $compiledresult='';  END
  my $reply=$rhash{$rkey};      $r->rflush();
  my @results;      my $time_remaining = $max_time - (time - $starttime) ;
  if ($reply eq 'con_lost') {      my $last_time = $time_remaining;
     &popwin_imgupdate($r,$rkey,"srvbad.gif");      &update_seconds($r,$time_remaining);
     $serversleft--;      while (($time_remaining > 0) &&
             delete $rhash{$rkey};             ((@Servers_to_contact) || keys(%Server_status))) {
  } else {          # Send out a search request if it needs to be done.
             # must do since 'use strict' checks for tainting          if (@Servers_to_contact) {
     $reply=~/^([\.\w]+)$/;               # Contact one server
     my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;              my $server = shift(@Servers_to_contact);
     $reply=~/(.*?)\_/;              my $reply=&Apache::lonnet::metadata_query($query,$customquery,
             for (my $counter=0;$counter<2;$counter++) {                                                        $customshow,[$server]);
                 if (-e $replyfile && ! -e "$replyfile.end") {              ($server) = keys(%$reply);
                     &popwin_imgupdate($r,$rkey,"srvhalf.gif");              $Server_status{$server} = $reply->{$server};
                     &popwin_js($r,'popwin.hc["'.$rkey.'"]='.              &update_status($r,'contacting '.$server);
                                '"still transferring..."'.';');          } else {
               # wait a sec. to give time for files to be written
               # This sleep statement is here instead of outside the else 
               # block because we do not want to pause if we have servers
               # left to contact.  
               sleep(1); 
           }
           #
           if (scalar (keys(%Server_status))) {
               &update_status($r,'waiting on '.(join(' ',keys(%Server_status))));
           }
           #
           # Loop through the servers we have contacted but do not
           # have results from yet, looking for results.
           while (my ($server,$status) = each(%Server_status)) {
               last if ($connection->aborted());
               if ($status eq 'con_lost') {
                   delete ($Server_status{$server});
                   next;
               }
               $status=~/^([\.\w]+)$/; 
              my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
               if (-e $datafile && ! -e "$datafile.end") {
                   &update_status($r,'Receiving results from '.$server);
                   next;
               }
               last if ($connection->aborted());
               if (-e "$datafile.end") {
                   &update_status($r,'Reading results from '.$server);
                   if (-z "$datafile") {
                       delete($Server_status{$server});
                       next;
                   }
                   my $fh;
                   if (!($fh=Apache::File->new($datafile))) { 
                       $r->print("Unable to open search results file for ".
                                     "server $server.  Omitting from search");
                       delete($Server_status{$server}); 
                      next;
                 }                  }
                 # Are we finished transferring data?                  # Read in the whole file.
                 if (-e "$replyfile.end") {                  while (my $result = <$fh>) {
                     $serversleft--;                      last if ($connection->aborted());
                     delete $rhash{$rkey};                      # handle custom fields?  Someday we will!
                     if (-s $replyfile) {                      chomp($result);
                         &popwin_imgupdate($r,$rkey,"srvgood.gif");                      next unless $result;
                         my $fh;                      # Parse the result.
                         unless ($fh=Apache::File->new($replyfile)){                       my %Fields = &parse_raw_result($result,$server);
                             # Is it really appropriate to die on this error?                      $Fields{'hostname'} = $server;
                             $r->print('ERROR: file '.                      next if (! &copyright_check(\%Fields));
                                       $replyfile.' cannot be opened');                      # Store the result in the mysql database
                             return OK;                      my $result = &Apache::lonmysql::store_row($table,\%Fields);
                         }                      if (! defined($result)) {
                         @results=<$fh> if $fh;                          $r->print(&Apache::lonmysql::get_error());
                         my $hits =@results;  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
                                    $hits.';');  
                         $hitcountsum+=$hits;  
                         &popwin_js($r,'popwin.document.forms.popremain.'.  
                                    'numhits.value='.$hitcountsum.';');  
                     } else {  
                         &popwin_imgupdate($r,$rkey,"srvempty.gif");  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');  
                     }                      }
                     last;                      # $r->print(&Apache::lonmysql::get_debug());
                 } # end of if ( -e "$replyfile.end")                      $hitcountsum ++;
                 last unless $timeremain;                      $time_remaining = $max_time - (time - $starttime) ;
                 sleep 1;    # wait for daemons to write files?                      if ($last_time - $time_remaining > 0) {
                 $timeremain--;                          &update_seconds($r,$time_remaining);
                 $elapsetime++;                          $last_time = $time_remaining;
                 &popwin_js($r,"popwin.document.popremain.".  
                            "elapsetime.value=$elapsetime;");  
     }  
     &popwin_js($r,'popwin.document.whirly.'.  
        'src="/adm/lonIcons/lonanimend.gif";');  
  } # end of if ($reply eq 'con_lost') else statement  
         my %Fields = undef;     # Holds the data to be sent to the various   
                                 # *_view routines.  
         my ($extrashow,$customfields,$customhash) = &handle_custom_fields(\@results);  
         my @customfields = @$customfields;  
         my %customhash   = %$customhash;  
  untie %hash if (keys %hash);  
         #  
  if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
     $r->print('<html><head></head><body>Unable to tie hash to db '.  
                       'file</body></html>');  
         } else {  
     if ($ENV{'form.launch'} eq '1') {  
  &start_fresh_session();  
     }  
     foreach my $result (@results) {  
  next if $result=~/^custom\=/;  
  chomp $result;  
  next unless $result;  
                 %Fields = &parse_raw_result($result,$rkey);  
  $Fields{'extrashow'}=$extrashow;  
  if ($extrashow) {  
     foreach my $field (@customfields) {  
  my $value='';  
  $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);  
                         $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;  
                     }                      }
                 }                      if ($hitcountsum % 50 == 0) {
                 $compiledresult.="\n<p>\n";                          &update_count_status($r,$hitcountsum);
                 if ($ENV{'form.catalogmode'} eq 'interactive') {                      }
                     my $titleesc=$Fields{'title'};                  } # End of foreach (@results)
                     $titleesc=~s/\'/\\'/; # '                  $fh->close();
                     $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');                  # $server is only deleted if the results file has been 
                   # found and (successfully) opened.  This may be a bad idea.
                   delete($Server_status{$server});
               }
               last if ($connection->aborted());
               &update_count_status($r,$hitcountsum);
           }
           last if ($connection->aborted());
           # Finished looping through the servers
           $starttime = time if (@Servers_to_contact);
           $time_remaining = $max_time - (time - $starttime) ;
           if ($last_time - $time_remaining > 0) {
               $last_time = $time_remaining;
               &update_seconds($r,$time_remaining);
           }
       }
       &update_status($r,'Search Complete'.$server);
       &update_seconds($r,0);
       &Apache::lonmysql::disconnect_from_db();
       # We have run out of time or run out of servers to talk to and
       # results to get.  
       $r->print("</body></html>");
       if ($ENV{'form.catalogmode'} ne 'groupsearch') {
           $r->print("<script>".
                         "window.location='/adm/searchcat?".
                         "phase=sort&".
                         "persistent_db_id=$ENV{'form.persistent_db_id'}';".
                     "</script>");
       }
       return;
   }
   
   ######################################################################
   ######################################################################
   =pod
   
   =item &prev_next_buttons
   
   =cut
   
   ######################################################################
   ######################################################################
   sub prev_next_buttons {
       my ($current_min,$show,$total,$parms) = @_;
       return '' if ($show eq 'all'); # No links if you get them all at once.
       my $links;
       ##
       ## Prev
       my $prev_min = $current_min - $show;
       $prev_min = 1 if $prev_min < 1;
       if ($prev_min < $current_min) {
           $links .= qq{
   <a href="/adm/searchcat?$parms&start=$prev_min&show=$show">prev</a>
   };    
       } else {
           $links .= 'prev';
       }
       ##
       ## Pages.... Someday.
       ##
       $links .= qq{ &nbsp;
   <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">reload</a>
   };
       ##
       ## Next
       my $next_min = $current_min + $show;
       $next_min = $current_min if ($next_min > $total);
       if ($next_min != $current_min) {
           $links .= qq{ &nbsp;
   <a href="/adm/searchcat?$parms&start=$next_min&show=$show">next</a>
   };    
       } else {
           $links .= '&nbsp;next';
       }
       return $links;
   }
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &display_results
   
   =cut
   
   ######################################################################
   ######################################################################
   sub display_results {
       my ($r,$importbutton,$closebutton) = @_;
       my $connection = $r->connection;
       $r->print(&search_results_header($importbutton,$closebutton));
       ##
       ## Set viewing function
       ##
       my $viewfunction = $Views{$ENV{'form.viewselect'}};
       if (!defined($viewfunction)) {
           $r->print("Internal Error - Bad view selected.\n");
           $r->rflush();
           return;
       }
       ##
       ## $checkbox_num is a count of the number of checkboxes output on the 
       ## page this is used only during catalogmode=groupsearch.
       my $checkbox_num = 0;
       ##
       ## Get the catalog controls setup
       ##
       my $action = "/adm/searchcat?phase=results";
       ##
       ## Deal with groupsearch
       ##
       if ($ENV{'form.catalogmode'} eq 'groupsearch') {
           if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                     &GDBM_WRCREAT(),0640)) {
               $r->print('Unable to store import results.</form></body></html>');
               $r->rflush();
               return;
           } 
       }
       ##
       ## Prepare the table for querying
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       ##
       ## Determine how many results we need to get
       ##
       $ENV{'form.start'} = 1      if (! exists($ENV{'form.start'}));
       $ENV{'form.show'}  = 'all'  if (! exists($ENV{'form.show'}));
       my $min = $ENV{'form.start'};
       my $max;
       if ($ENV{'form.show'} eq 'all') {
           $max = $total_results ;
       } else {
           $max = $min + $ENV{'form.show'} - 1;
           $max = $total_results if ($max > $total_results);
       }
       ##
       ## Output links (if necessary) for 'prev' and 'next' pages.
       ##
       $r->print
           ('<center>'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                               "table=".$ENV{'form.table'}.
                               "&phase=results".
                               "&persistent_db_id=".$ENV{'form.persistent_db_id'})
            ."</center>\n"
            );
       if ($total_results == 0) {
           $r->print("There are currently no results.\n".
                     "</form></body></html>");
           return;
       } else {
           $r->print
               ("<center>Results $min to $max out of $total_results</center>\n");
       }
       ##
       ## Get results from MySQL table
       ##
       my @Results = &Apache::lonmysql::get_rows($table,
                                                 'id>='.$min.' AND id<='.$max);
       ##
       ## Loop through the results and output them.
       ##
       foreach my $row (@Results) {
           if ($connection->aborted()) {
               &cleanup();
               return;
           }
           my %Fields = %{&parse_row(@$row)};
           my $output="<p>\n";
           my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'},
                                          $Fields{'id'},$checkbox_num++);
           # Render the result into html
           $output.= &$viewfunction($prefix,%Fields);
           # Print them out as they come in.
           $r->print($output);
           $r->rflush();
       }
       if (@Results < 1) {
           $r->print("There were no results matching your query");
       } else {
           $r->print
               ('<center>'.
                &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                                   "table=".$ENV{'form.table'}.
                                   "&phase=results".
                                   "&persistent_db_id=".
                                   $ENV{'form.persistent_db_id'})
                ."</center>\n"
                );
       }
       $r->print("</form></body></html>");
       $r->rflush();
       untie %groupsearch_db if (tied(%groupsearch_db));
       return;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
   
   Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub catalogmode_output {
       my $output = '';
       my ($title,$url,$fnum,$checkbox_num) = @_;
       if ($ENV{'form.catalogmode'} eq 'interactive') {
           $title=~ s/\'/\\\'/g;
           if ($ENV{'form.catalogmode'} eq 'interactive') {
               $output.=<<END 
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
 onClick="javascript:select_data('$titleesc','$Fields{'url'}')">  onClick="javascript:select_data('$title','$url')">
 </font>  </font>
 <br />  
 END  END
                 }          }
                 if ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
     $fnum+=0;          $groupsearch_db{"pre_${fnum}_link"}=$url;
     $hash{"pre_${fnum}_link"}=$Fields{'url'};          $groupsearch_db{"pre_${fnum}_title"}=$title;
     $hash{"pre_${fnum}_title"}=$Fields{'title'};          $output.=<<END;
     $compiledresult.=<<END;  
 <font size='-1'>  <font size='-1'>
 <input type="checkbox" name="returnvalues" value="SELECT"  <input type="checkbox" name="returnvalues" value="SELECT"
 onClick="javascript:queue($fnum)" />  onClick="javascript:queue($checkbox_num,$fnum)" />
 </font>  </font>
 <br />  
 END  END
 # <input type="hidden" name="title$fnum" value="$title" />  
 # <input type="hidden" name="url$fnum" value="$url" />  
                     $fnum++;  
  }  
         if ($viewselect eq 'Detailed Citation View') {  
     $compiledresult.=&detailed_citation_view  
                         (%Fields, hostname => $rkey );  
  }  
                 elsif ($viewselect eq 'Summary View') {  
     $compiledresult.=&summary_view  
                         (%Fields, hostname => $rkey );  
         }  
                 elsif ($viewselect eq 'Fielded Format') {  
     $compiledresult.=&fielded_format_view  
                         (%Fields, hostname => $rkey );  
         }  
                 elsif ($viewselect eq 'XML/SGML') {  
     $compiledresult.=&xml_sgml_view  
                         (%Fields, hostname => $rkey );  
  }  
                 if ($compiledresult or $servercount!=$servernum) {  
                     $compiledresult.="<hr align='left' width='200' noshade />";  
                 }  
             }  
             untie %hash;  
         }  
  if ($compiledresult) {  
     $resultflag=1;  
             $r->print($compiledresult);  
  }  
         my $percent=sprintf('%3.0f',($servercount/$servernum*100));  
       } # 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");  
     }      }
 #    $r->print('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush();       return $output;
     $r->print("</body>\n</html>\n");  }
     return;  ######################################################################
   ######################################################################
   
   =pod
   
   =item &parse_row
   
   Parse a row returned from the database.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub parse_row {
       my @Row = @_;
       my %Fields;
       for (my $i=0;$i<=$#Row;$i++) {
           $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
       }
       $Fields{'language'} = 
           &Apache::loncommon::languagedescription($Fields{'lang'});
       $Fields{'copyrighttag'} =
           &Apache::loncommon::copyrightdescription($Fields{'copyright'});
       $Fields{'mimetag'} =
           &Apache::loncommon::filedescription($Fields{'mime'});
       return \%Fields;
 }  }
   
 ###########################################################  ###########################################################
Line 1308  sub parse_raw_result { Line 2544  sub parse_raw_result {
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
     $Fields{'mimetag'} =      $Fields{'mimetag'} =
         &Apache::loncommon::filedescription($Fields{'mime'});          &Apache::loncommon::filedescription($Fields{'mime'});
       if ($Fields{'author'}=~/^(\s*|error)$/) {
           $Fields{'author'}="Unknown Author";
       }
     # Put spaces in the keyword list, if needed.      # Put spaces in the keyword list, if needed.
     $Fields{'keywords'}=~ s/,([A-z])/, $1/g;       $Fields{'keywords'}=~ s/,([A-z])/, $1/g; 
     if ($Fields{'title'}=~ /^\s*$/ ) {       if ($Fields{'title'}=~ /^\s*$/ ) { 
         $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 1412  Checked for existance & 'edit' mode. Line 2652  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode) = @_;      my ($importbutton,$closebutton) = @_;
     $mode = lc($mode);  
     my $title;  
     if ($mode eq 'advanced') {  
         $title = "Advanced Search Results";  
     } elsif ($mode eq 'basic') {  
         $title = "Basic Search Results";  
     }  
     my $result = '';      my $result = '';
     # output beginning of search page      # output beginning of search page
     $result.=<<BEGINNING;  
 <html>  
 <head>  
 <title>$title</title>  
 BEGINNING  
     # conditional output of script functions dependent on the mode in      # conditional output of script functions dependent on the mode in
     # which the search was invoked      # which the search was invoked
     if ($ENV{'form.catalogmode'} eq 'interactive'){      if ($ENV{'form.catalogmode'} eq 'interactive'){
Line 1436  BEGINNING Line 2664  BEGINNING
     function select_data(title,url) {      function select_data(title,url) {
  changeTitle(title);   changeTitle(title);
  changeURL(url);   changeURL(url);
  self.close();   parent.close();
     }      }
     function changeTitle(val) {      function changeTitle(val) {
  if (opener.inf.document.forms.resinfo.elements.t) {   if (parent.opener.inf.document.forms.resinfo.elements.t) {
     opener.inf.document.forms.resinfo.elements.t.value=val;      parent.opener.inf.document.forms.resinfo.elements.t.value=val;
  }   }
     }      }
     function changeURL(val) {      function changeURL(val) {
  if (opener.inf.document.forms.resinfo.elements.u) {   if (parent.opener.inf.document.forms.resinfo.elements.u) {
     opener.inf.document.forms.resinfo.elements.u.value=val;      parent.opener.inf.document.forms.resinfo.elements.u.value=val;
  }   }
     }      }
 </script>  </script>
Line 1457  SCRIPT Line 2685  SCRIPT
 <script type="text/javascript">  <script type="text/javascript">
 function select_data(title,url) {  function select_data(title,url) {
     changeURL(url);      changeURL(url);
     self.close();      parent.close();
 }  }
 function changeTitle(val) {  function changeTitle(val) {
 }  }
 function changeURL(val) {  function changeURL(val) {
     if (window.opener.document) {      if (parent.targetwin.document) {
         window.opener.document.forms["$form"].elements["$element"].value=val;          parent.targetwin.document.forms["$form"].elements["$element"].value=val;
     } else {      } else {
  var url = 'forms[\"$form\"].elements[\"$element\"].value';   var url = 'forms[\"$form\"].elements[\"$element\"].value';
         alert("Unable to transfer data to "+url);          alert("Unable to transfer data to "+url);
Line 1475  SCRIPT Line 2703  SCRIPT
     }      }
     $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';      $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
 <script type="text/javascript">  <script type="text/javascript">
     function select_data(title,url) {      function queue(checkbox_num,val) {
 // alert('DEBUG: Should be storing '+title+' and '+url);          if (document.forms.results.returnvalues[checkbox_num].checked) {
     }              parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
     function queue(val) {          } else {
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {              parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
     document.forms.results.acts.value+='1a'+val+'b';          }
  }  
  else {  
     document.forms.results.acts.value+='0a'+val+'b';  
  }  
     }      }
     function select_group() {      function select_group() {
  window.location=   parent.window.location=
     "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+      "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
     document.forms.results.acts.value;      parent.statusframe.document.forms.statusform.elements.Queue.value;
     }  
 </script>  
 SCRIPT  
     $result.=<<SCRIPT;  
 <script type="text/javascript">  
     function displayinfo(val) {  
  popwin.document.forms.popremain.sdetails.value=val;  
     }  
     function openhelp(val) {  
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',  
      'scrollbars=1,width=400,height=300');  
  openhelpwin.focus();  
     }  
     function abortsearch(val) {  
  popwin.close();  
     }      }
 </script>  </script>
 SCRIPT  SCRIPT
     $result.=<<END;      $result.=<<END;
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <form name="results" method="post" action="" >
 <h1>$title</h1>  <input type="hidden" name="Queue" value="" />
   $importbutton
 END  END
     return $result;      return $result;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub search_status_header {
       return <<ENDSTATUS;
   <html><head><title>Search Status</title></head>
   $bodytag
   <h3>Search Status</h3>
   Sending search request to LON-CAPA servers.<br />
   ENDSTATUS
   }
   
 =pod  sub results_link {
       my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
 =item &make_popwin()          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $results_link = $basic_link."&phase=results".
 Returns html with javascript in it to open up the status window.          "&pause=1"."&start=1";
       return $results_link;
 =cut  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub make_popwin {  sub print_frames_interface {
     my %rhash = @_;      my $r = shift;
     my $servernum=(keys %rhash);      my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
     my $hcinit;          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
     my $grid="'<br />'+\n";      my $run_search_link = $basic_link."&phase=run_search";
     # $sn is the server number, used ONLY to make sure we have      my $results_link = &results_link();
     # rows of 10 each.  No longer used to index images.      my $result = <<"ENDFRAMES";
     my $sn=1;  <html>
     foreach my $sk (sort keys %rhash) {  <head>
  # '<a href="  <script>
  $grid.="'<a href=\"";  var targetwin = opener;
  # javascript:displayinfo('+  var queue = '';
  $grid.="javascript:opener.displayinfo('+";  
  # "'"+'key  
  $grid.="\"'\"+'";  
  $grid.=$sk;  
  my $hc;  
  if ($rhash{$sk} eq 'con_lost') {  
     $hc="BAD CONNECTION, CONTACT SYSTEM ADMINISTRATOR ";  
  }  
  else {  
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";  
  }  
  $grid.=" hitcount=".$hc;  
  $grid.=" domain=".$Apache::lonnet::hostdom{$sk};  
  $grid.=" IP=".$Apache::lonnet::hostip{$sk};  
  # '+"'"+'">'+  
  $grid.="'+\"'\"+')\">'+";  
  $grid.="\n";  
  $grid.="'<img border=\"0\" name=\"img_".$Apache::lonnet::hostdom{$sk}.  
             '_'.$sk."\" src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk.  
                 "\" /></a>'+\n";  
  $grid.="'<br />'+\n" unless $sn%10;  
         $sn++;  
     }  
     my $result.=<<ENDPOP;  
 <script type="text/javascript">  
     popwin=open('','popwin','scrollbars=1,width=400,height=220');  
     popwin.focus();  
     popwin.document.writeln('<'+'html>');  
     popwin.document.writeln('<'+'head>');  
     popwin.document.writeln('<'+'script>');  
     popwin.document.writeln('hc=new Array();$hcinit');  
     popwin.document.writeln('<'+'/script>');  
     popwin.document.writeln('<'+'/head>'+  
         '<'+'body bgcolor="#FFFFFF">'+  
  '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+  
  'lonanim.gif" '+  
  'alt="animated logo" />'+  
  '<'+'h3>Search Results Progress<'+'/h3>'+  
         '<'+'form name="popremain">'+  
         '<'+'tt>'+  
  '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+  
  '<'+'br />SCANNING $servernum SERVERS'+  
  '<'+'br clear="all" />Number of record hits found '+  
  '<'+'input type="text" size="10" name="numhits"'+  
  ' value="0" />'+  
  '<'+'br clear="all" />Time elapsed '+  
  '<'+'input type="text" size="10" name="elapsetime"'+  
  ' value="0" />'+  
  '<'+'br />'+  
  'SERVER GRID (click on any cell for details)'+  
         $grid  
         '<'+'br />'+  
  'Server details '+  
  '<'+'input type="text" size="35" name="sdetails"'+  
  ' value="" />'+  
  '<'+'br />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="close this window" '+  
  ' onClick="javascript:opener.abortsearch()" />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="help" onClick="javascript:opener.openhelp()" />'+  
  '<'+'/tt>'+  
         '<'+'/form>'+  
         '<'+'/body><'+'/html>');  
     popwin.document.close();  
 </script>  </script>
 ENDPOP  <title>LON-CAPA Digital Library Search Results</title>
     return $result;  </head>
   <frameset rows="150,*">
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   </frameset>
   </html>
   ENDFRAMES
   
       $r->print($result);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 1635  extra custom metadata to show. Line 2796  extra custom metadata to show.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
 <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>$prefix<a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
     target='search_preview'>$values{'title'}</a></h3>      target='search_preview'>$values{'title'}</a></b>
 <p>  <p>
 <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />  <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />
   
Line 1653  $values{'extrashow'} Line 2814  $values{'extrashow'}
 <p>  <p>
 $values{'shortabstract'}  $values{'shortabstract'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1665  END Line 2827  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
 <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   $prefix<a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
    target='search_preview'>$values{'author'}</a><br />     target='search_preview'>$values{'author'}</a><br />
 $values{'title'}<br />  $values{'title'}<br />
 $values{'owner'} -- $values{'lastrevisiondate'}<br />  $values{'owner'} -- $values{'lastrevisiondate'}<br />
 $values{'copyrighttag'}<br />  $values{'copyrighttag'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  </p>
   <hr align='left' width='200' noshade />
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &compact_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $result=<<END;
   $prefix <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"  target='search_preview'>
   $values{'title'}</a>
   <b>$values{'author'}</b><br />
 END  END
     return $result;      return $result;
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 1694  END Line 2878  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
   $prefix
 <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
               target='search_preview'>$values{'url'}</a>                target='search_preview'>$values{'url'}</a>
 <br />  <br />
Line 1714  sub fielded_format_view { Line 2899  sub fielded_format_view {
 <b>Abstract:</b> $values{'shortabstract'}<br />  <b>Abstract:</b> $values{'shortabstract'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1732  END Line 2918  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub xml_sgml_view {  sub xml_sgml_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result=<<END;
   $prefix
 <pre>  <pre>
 &lt;LonCapaResource&gt;  &lt;LonCapaResource&gt;
 &lt;url&gt;$values{'url'}&lt;/url&gt;  &lt;url&gt;$values{'url'}&lt;/url&gt;
Line 1762  sub xml_sgml_view { Line 2949  sub xml_sgml_view {
 &lt;/LonCapaResource&gt;  &lt;/LonCapaResource&gt;
 </pre>  </pre>
 $values{'extrashow'}  $values{'extrashow'}
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 1794  sub filled { Line 2982  sub filled {
   
 =item &output_blank_field_error()  =item &output_blank_field_error()
   
   Output a complete page that indicates the user has not filled in enough
   information to do a search.
   
   Inputs: $r (Apache request handle), $closebutton, $parms.
   
   Returns: nothing
   
   $parms is extra information to include in the 'Revise search request' link.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_blank_field_error {  sub output_blank_field_error {
     my ($r)=@_;      my ($r,$closebutton,$parms)=@_;
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent();  
   
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
 <head>  <head>
Line 1810  sub output_blank_field_error { Line 3005  sub output_blank_field_error {
 BEGINNING  BEGINNING
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}"
 onClick='this.form.submit();' />  >Revise search request</a>&nbsp;
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Unactionable search query.</h3>
 <p>  <p>
 Incorrect search query due to blank entry fields.  You did not fill in enough information for the search to be started.
 You need to fill in the relevant  You need to fill in relevant fields on the search page in order 
 fields on the search page in order for a query to be  for a query to be processed.
 processed.  
 </p>  </p>
 </body>  </body>
 </html>  </html>
Line 1840  RESULTS Line 3034  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();  
   
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>The LearningOnline Network with CAPA</title>
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <input type='button' value='Revise search request'
 onClick='this.form.submit();' />  onClick='this.form.submit();' />
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Error</h3>
 <p>  <p>
 $message  $message
 </p>  </p>
Line 1879  RESULTS Line 3077  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 1887  Cleans the global %hash by removing all Line 3085  Cleans the global %hash by removing all
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub start_fresh_session {  sub start_fresh_session {
     delete $hash{'mode_catalog'};      delete $groupsearch_db{'mode_catalog'};
     foreach (keys %hash) {      foreach (keys %groupsearch_db) {
         if ($_ =~ /^pre_/) {          if ($_ =~ /^pre_/) {
             delete $hash{$_};              delete $groupsearch_db{$_};
         }          }
         if ($_ =~ /^store/) {          if ($_ =~ /^store/) {
     delete $hash{$_};      delete $groupsearch_db{$_};
  }   }
     }      }
 }  }
   
 ######################################################################  1;
 ######################################################################  
   
 =pod   
   
 =item &popwin_js() send javascript to popwin  
   
 =cut  
   
 ######################################################################  sub cleanup {
 ######################################################################      if (tied(%groupsearch_db)) {
 sub popwin_js {   &Apache::lonnet::logthis('Cleanup searchcat: groupsearch_db');
     # Print javascript out to popwin, but make sure we dont generate          unless (untie(%groupsearch_db)) {
     # any javascript errors in doing so.    &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
     my ($r,$text) = @_;          }
     $r->print(<<"END");  
 <script type="text/javascript">  
     if (! popwin.closed) {  
  $text  
     }      }
 </script>      &untiehash();
 END      &Apache::lonmysql::disconnect_from_db();
     $r->rflush();  
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &popwin_imgupdate()  
   
 Send a given image (and its location) out to the browser.  Takes as   
 input $r, loncapa server id, and an icon URL.  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub popwin_imgupdate {  
     my ($r,$server,$icon) = @_;  
     &popwin_js($r,'popwin.document.img_'.$Apache::lonnet::hostdom{$server}.  
                '_'.$server.'.'.'src="/adm/lonIcons/'.$icon.'";');  
 }      
   
 1;  
   
 __END__  __END__
   
 =pod  =pod
Removed from v.1.130  
changed lines
  Added in v.1.176

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