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

Diff for /loncom/interface/lonsearchcat.pm between versions 1.145 and 1.199

version 1.145, 2002/07/28 20:02:14 version 1.199, 2003/12/28 20:12:59
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 67  search (on a server basis) is displayed Line 59  search (on a server basis) is displayed
 ###############################################################################  ###############################################################################
 ###############################################################################  ###############################################################################
   
 ###############################################################################  
 ##                                                                           ##  
 ## ORGANIZATION OF THIS PERL MODULE                                          ##  
 ##                                                                           ##  
 ## 1. Modules used by this module                                            ##  
 ## 2. Variables used throughout the module                                   ##  
 ## 3. handler subroutine called via Apache and mod_perl                      ##  
 ## 4. Other subroutines                                                      ##  
 ##                                                                           ##  
 ###############################################################################  
   
 package Apache::lonsearchcat;  package Apache::lonsearchcat;
   
 # ------------------------------------------------- modules used by this module  
 use strict;  use strict;
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common :http);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::File();  use Apache::File();
 use CGI qw(:standard);  use CGI qw(:standard);
 use Text::Query;  use Text::Query;
 use DBI;  
 use GDBM_File;  use GDBM_File;
 use Apache::loncommon();  use Apache::loncommon();
 use Apache::lonmysql();  use Apache::lonmysql();
   use Apache::lonlocal;
 # ---------------------------------------- variables used throughout the module  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
 =pod   ## Global variables
   ##
 =item Global variables  
   
 =over 4  
   
 =item $importbutton  
   
 button to take the select results and go to group sorting  
   
 =item %groupsearch_db     
   
 Database hash used to save values for the groupsearch RAT interface.  
   
 =item $diropendb   
   
 The full path to the (temporary) search database file.  This is set and  
 used in &handler() and is also used in &output_results().  
   
 =item %Views  
   
 Hash which associates an output view description with the function  
 that produces it.  Adding a new view type should be as easy as  
 adding a line to the definition of this hash and making sure the function  
 takes the proper parameters.  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   my %groupsearch_db;  # Database hash used to save values for the 
 # -- dynamically rendered interface components                       # groupsearch RAT interface.
 my $importbutton; # button to take the selected results and go to group sorting  my %persistent_db;   # gdbm hash which holds data which is supposed to
                        # persist across calls to lonsearchcat.pm
 # -- miscellaneous variables  ## %Views:
 my %groupsearch_db;     # database hash  ## Hash which associates an output view description with the function
 my $diropendb = "";    # db file  ## that produces it.
 #             View Description           Function Pointer  #             View Description/Name      Function Pointer
 my %Views = ("Detailed Citation View" => \&detailed_citation_view,  my %Views = ("Detailed Citation View" => \&detailed_citation_view,
              "Summary View"           => \&summary_view,               "Summary View"           => \&summary_view,
              "Fielded Format"         => \&fielded_format_view,               "Fielded Format"         => \&fielded_format_view,
              "XML/SGML"               => \&xml_sgml_view );               "XML/SGML"               => \&xml_sgml_view,
 my $persistent_db_file;               "Compact View"           => \&compact_view);
 my %persistent_db;  
 my $hidden_fields;  
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &handler() - main handler invoked by httpd child  
   
 =item Variables  
   
 =over 4  
   
 =item $hidden  
   
 holds 'hidden' html forms  
   
 =item $scrout  
   
 string that holds portions of the screen output  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
   #    &set_defaults();
     #      #
     untie %groupsearch_db if (tied(%groupsearch_db));      # set form defaults
     #      #
       my $hidden_fields;# Hold all the hidden fields used to keep track
                         # of the search system state
       my $importbutton; # button to take the selected results and go to group 
                         # sorting
       my $diropendb;    # The full path to the (temporary) search database file.
                         # This is set and used in &handler() and is also used in 
                         # &output_results().
       my $bodytag;  # LON-CAPA standard body tag, gotten from 
                     # &Apache::lonnet::bodytag. 
                     # No title, no table, just a <body> tag.
   
       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
   
     my $closebutton;  # button that closes the search window       my $closebutton;  # button that closes the search window 
                       # This button is different for the RAT compared to                        # This button is different for the RAT compared to
                       # normal invocation.                        # normal invocation.
     #      #
     $r->content_type('text/html');      &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
       ##
       ## 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.      ## Pick up form fields passed in the links.
     ##      ##
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
              ['catalogmode','launch','acts','mode','form','element',               ['catalogmode','launch','acts','mode','form','element','pause',
               'reqinterface','persistent_db_id','table']);                'phase','persistent_db_id','table','start','show',
                 'cleargroupsort','titleelement']);
       ##
       ## The following is a trick - we wait a few seconds if asked to so
       ##     the daemon running the search can get ahead of the daemon
       ##     printing the results.  We only need (theoretically) to do
       ##     this once, so the pause indicator is deleted
       ##
       if (exists($ENV{'form.pause'})) {
           sleep(1);
           delete($ENV{'form.pause'});
       }
     ##      ##
     ## Initialize global variables      ## 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/$ENV{'user.domain'}_$ENV{'user.name'}_searchcat.db";
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";  
     #      #
     # set the name of the persistent database      # set the name of the persistent database
     # $ENV{'form.persistent_db_id'} can only have digits in it.      #          $ENV{'form.persistent_db_id'} can only have digits in it.
     if (! exists($ENV{'form.persistent_db_id'}) ||      if (! exists($ENV{'form.persistent_db_id'}) ||
             $ENV{'form.persistent_db_id'} =~ /\D/ ) {          ($ENV{'form.persistent_db_id'} =~ /\D/) ||
           ($ENV{'form.launch'} eq '1')) {
         $ENV{'form.persistent_db_id'} = time;          $ENV{'form.persistent_db_id'} = time;
     }      }
     $persistent_db_file = "/home/httpd/perl/tmp/".      $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $persistent_db_file = "/home/httpd/perl/tmp/".
         &Apache::lonnet::escape($domain).          &Apache::lonnet::escape($domain).
             '_'.&Apache::lonnet::escape($ENV{'user.name'}).              '_'.&Apache::lonnet::escape($ENV{'user.name'}).
                 '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';                  '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
     #      ##
     # Read in the database.  It should (hopefully) not be catastrophic to      if (! &get_persistent_form_data($persistent_db_file)) {
     #    fail in this exercise.           if ($ENV{'form.phase'} =~ /(run_search|results)/) {
     if (-e $persistent_db_file) {              &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ".
         # Read in the previous values, if we can.                                       "from $persistent_db_file");
  if (tie(%persistent_db,'GDBM_File',$persistent_db_file,              $r->print(<<END);
                 &GDBM_READER,0640)) {  <html>
             &reconstruct_persistent_form_data($r);  <head><title>LON-CAPA Search Error</title></head>
             untie (%persistent_db);  $bodytag
  }  We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
   END
               return OK;
           }
     }      }
     ##      ##
     ## Clear out old values from groupsearch database      ## Clear out old values from groupsearch database
     ##      ##
     if ($ENV{'form.launch'} eq '1') {      untie %groupsearch_db if (tied(%groupsearch_db));
  if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {      if (($ENV{'form.cleargroupsort'} eq '1') || 
           (($ENV{'form.launch'} eq '1') && 
            ($ENV{'form.catalogmode'} eq 'groupsearch'))) {
    if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
     &start_fresh_session();      &start_fresh_session();
     untie %groupsearch_db;      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;
  }   }
     }      }
     ##      ##
     ## Configure dynamic components of interface      ## Configure hidden fields
     ##      ##
     $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.      $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
         $ENV{'form.persistent_db_id'}.'" />';          $ENV{'form.persistent_db_id'}.'" />'."\n";
       if (exists($ENV{'form.catalogmode'})) {
           $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
                   $ENV{'form.catalogmode'}.'" />'."\n";
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= '<input type="hidden" name="form" value="'.
                   $ENV{'form.form'}.'" />'."\n";
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= '<input type="hidden" name="element" value="'.
                   $ENV{'form.element'}.'" />'."\n";
       }
       if (exists($ENV{'form.titleelement'})) {
           $hidden_fields .= '<input type="hidden" name="titleelement" value="'.
                   $ENV{'form.titleelement'}.'" />'."\n";
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= '<input type="hidden" name="mode" value="'.
                   $ENV{'form.mode'}.'" />'."\n";
       }
       ##
       ## Configure dynamic components of interface
       ##
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
         $closebutton="<input type='button' name='close' value='CLOSE' ".          $closebutton="<input type='button' name='close' value='CLOSE' ";
     "onClick='self.close()'>"."\n";          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
       $closebutton .="onClick='parent.close()'";
           } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .=">\n";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
         $closebutton=<<END;          $closebutton="<input type='button' name='close' value='CLOSE' ";
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
 END      $closebutton .="onClick='parent.close()'";
           } else {
               $closebutton .="onClick='self.close()'";
           }
           $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 = '';
     }      }
     ##      ##
     ##  Do a search, if needed.      ## Sanity checks on form elements
     ##      ##
     my $searchtype;      if (!defined($ENV{'form.viewselect'})) {
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');          if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');              ($ENV{'form.catalogmode'} eq 'interactive')) {
     if ($searchtype) {              $ENV{'form.viewselect'} ="Compact View";
         ##          } else {
         ## make query information persistent to allow for subsequent revision              $ENV{'form.viewselect'} ="Detailed Citation View";
         ##          }
         tie(%persistent_db,'GDBM_File',$persistent_db_file,&GDBM_WRCREAT,0640);      }
         &make_persistent(\%ENV);      $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
         untie(%persistent_db);      $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
       ##
       ## Switch on the phase
       ##
       if ($ENV{'form.phase'} eq 'disp_basic') {
           &print_basic_search_form($r,$closebutton,$hidden_fields);
       } elsif ($ENV{'form.phase'} eq 'disp_adv') {
           &print_advanced_search_form($r,$closebutton,$hidden_fields);
       } elsif ($ENV{'form.phase'} eq 'results') {
           &display_results($r,$importbutton,$closebutton,$diropendb);
       } elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) {
           my ($query,$customquery,$customshow,$libraries,$pretty_string) =
               &get_persistent_data($persistent_db_file,
                    ['query','customquery','customshow',
                     'libraries','pretty_string']);
           if ($ENV{'form.phase'} eq 'sort') {
               &print_sort_form($r,$pretty_string);
           } elsif ($ENV{'form.phase'} eq 'run_search') {
               &run_search($r,$query,$customquery,$customshow,
                           $libraries,$pretty_string);
           }
       } elsif ($ENV{'form.phase'} eq 'course_search') {
           &course_search($r);
       } elsif(($ENV{'form.phase'} eq 'basic_search') ||
               ($ENV{'form.phase'} eq 'adv_search')) {
           $ENV{'form.searchmode'} = 'basic';
           if ($ENV{'form.phase'} eq 'adv_search') {
               $ENV{'form.searchmode'} = 'advanced';
           }
           # Set up table
           if (! defined(&create_results_table())) {
       my $errorstring=&Apache::lonmysql::get_error();
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to create table in which to store search results.  
   The search has been aborted.
   <br />$errorstring
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
         #          #
         # We are running a search          # We are running a search
         my ($query,$customquery,$customshow,$libraries) =           my ($query,$customquery,$customshow,$libraries) = 
             (undef,undef,undef,undef);              (undef,undef,undef,undef);
         my $pretty_string;          my $pretty_string;
         if ($searchtype eq 'Basic') {          if ($ENV{'form.phase'} eq 'basic_search') {
             ($query,$pretty_string) = &parse_basic_search($r,$closebutton);              ($query,$pretty_string,$libraries) = 
         } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {                  &parse_basic_search($r,$closebutton,$hidden_fields);
           } else {                      # Advanced search
             ($query,$customquery,$customshow,$libraries,$pretty_string)               ($query,$customquery,$customshow,$libraries,$pretty_string) 
                 = &parse_advanced_search($r,$closebutton);                  = &parse_advanced_search($r,$closebutton,$hidden_fields);
             return OK if (! defined($query));              return OK if (! defined($query));
         }          }
         # Output some information to the user.          &make_persistent({ query => $query,
         $r->print(&search_results_header($searchtype,$pretty_string));                             customquery => $customquery,
         $r->print("Sending search request to LON-CAPA servers.<br />\n");                             customshow => $customshow,
         $r->rflush();                             libraries => $libraries,
         &run_search($r,$query,$customquery,$customshow,$libraries);                             pretty_string => $pretty_string },
                            $persistent_db_file);
         ##          ##
         ## Display the results          ## Print out the frames interface
         ##          ##
         &display_results($r,$searchtype,$importbutton,$closebutton);          &print_frames_interface($r);
         $r->rflush();      }
     } else {      return OK;
         #  } 
         # Set the default view if it is not already set.  
         if (!defined($ENV{'form.viewselect'})) {  ######################################################################
             $ENV{'form.viewselect'} ="Detailed Citation View";  ######################################################################
         }  ##
         #   ##   Course Search
         # remove the requested interface from the environment.  ##
         my $interface;  ######################################################################
         if ($ENV{'form.reqinterface'}) {  ######################################################################
             $interface = lc($ENV{'form.reqinterface'});  {   # Scope the course search to avoid global variables
   #
   # Variables For course search
   my %alreadyseen;
   my %hash;
   my $totalfound;
   
   sub course_search {
       my $r=shift;
       my $bodytag=&Apache::loncommon::bodytag('Course Search');
       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 {          } else {
             $interface = 'basic';              $pretty_search_string .= " with no related words.";
         }          }
         ##      }
         ## Determine course of action      my $fulltext=$ENV{'form.crsfulltext'};
         ##      my @allwords=($search_string,@New_Words);
         if ($interface eq 'display') {      $totalfound=0;
             # &display_results($closebutton));      $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
         } elsif ($interface eq 'advanced') {        $bodytag.$pretty_search_string);
             $r->print(&advanced_search_form($closebutton));      $r->rflush();
         } elsif ($interface eq 'basic') {   # ======================================================= Go through the course
             # Output normal search interface      undef %alreadyseen;
             $r->print(&basic_search_form($closebutton));      %alreadyseen=();
       my $c=$r->connection;
       if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
           foreach (keys %hash) {
               if ($c->aborted()) { last; }
               if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
                   &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
                                @allwords);
               }
         }          }
           untie(%hash);
     }      }
     untie (%persistent_db);      unless ($totalfound) {
     return OK;   $r->print('<p>'.&mt('No resources found').'.</p>');
 }       }
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
   # =============================== This pulls up a resource and its dependencies
   
   sub checkonthis {
       my ($r,$url,$level,$title,$fulltext,@allwords)=@_;
       $alreadyseen{$url}=1;
       $r->rflush();
       my $result=&Apache::lonnet::metadata($url,'title').' '.
                  &Apache::lonnet::metadata($url,'subject').' '.
                  &Apache::lonnet::metadata($url,'abstract').' '.
                  &Apache::lonnet::metadata($url,'keywords');
       if (($url) && ($fulltext)) {
    $result.=&Apache::lonnet::ssi_body($url);
       }
       $result=~s/\s+/ /gs;
       my $applies=0;
       foreach (@allwords) {
           if ($_=~/\w/) {
      if ($result=~/$_/si) {
         $applies++;
              }
          }
       }
   # Does this resource apply?
       if ($applies) {
          $r->print('<br />');
          for (my $i=0;$i<=$level*5;$i++) {
              $r->print('&nbsp;');
          }
          $r->print('<a href="'.$url.'" target="cat">'.
    ($title?$title:$url).'</a><br />');
          $totalfound++;
       } elsif ($fulltext) {
          $r->print(' .');
       }
       $r->rflush();
   # Check also the dependencies of this one
       my $dependencies=
                   &Apache::lonnet::metadata($url,'dependencies');
       foreach (split(/\,/,$dependencies)) {
          if (($_=~/^\/res\//) && (!$alreadyseen{$_})) {
             &checkonthis($r,$_,$level+1,'',$fulltext,@allwords);
          }
       }
   }
   
   sub untiehash {
       if (tied(%hash)) {
           untie(%hash);
       }
   }
   
   } # End of course search scoping
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item &basic_search_form()   =item &print_basic_search_form() 
   
 Returns a scalar which holds html for the basic search form.  Returns a scalar which holds html for the basic search form.
   
Line 324  Returns a scalar which holds html for th Line 466  Returns a scalar which holds html for th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub basic_search_form{  sub print_basic_search_form{
     my ($closebutton) = @_;      my ($r,$closebutton,$hidden_fields) = @_;
       my $bodytag=&Apache::loncommon::bodytag('Search');
     my $scrout=<<"ENDDOCUMENT";      my $scrout=<<"ENDDOCUMENT";
 <html>  <html>
 <head>  <head>
Line 338  sub basic_search_form{ Line 481  sub basic_search_form{
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  ENDDOCUMENT
 <h1>Search Catalog</h1>  if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
 <form method="post" action="/adm/searchcat">      my $CatalogSearch=&mt('Catalog Search');
       my $Statement=&mt('Enter terms or phrases separated by AND, OR, or NOT then press SEARCH below');
       $scrout.=(<<ENDDOCUMENT);
   <h1>$CatalogSearch</h1>
   <form name="loncapa_search" method="post" action="/adm/searchcat">
   <input type="hidden" name="phase" value="basic_search" />
 $hidden_fields  $hidden_fields
 <h3>Basic Search</h3>  
 <p>  <p>
 Enter terms or phrases separated by AND, OR, or NOT   $Statement.
 then press SEARCH below.  
 </p>  </p>
 <p>  <p>
 <table>  <table>
Line 354  then press SEARCH below. Line 500  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 $relatedcheckbox = &simplecheckbox('related','related',$ENV{'form.related'});
 #    $scrout.='<font color="#800000">Search historic archives</font>';      my $domain = $r->dir_config('lonDefDomain');
     my $checkbox = &simplecheckbox('related',$ENV{'form.related'});      my $domaincheckbox = &simplecheckbox('domains',$domain);
       my $srch=&mt('Search');
       my $header=&mt('Advanced Search');
       my $userelatedwords=&mt('use related words');
       my $onlysearchdomain=&mt('only search domain');
     $scrout.=<<END;      $scrout.=<<END;
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr>  </td><td><a
 <tr><td>$checkbox use related words</td><td></td></tr>  href="/adm/searchcat?phase=disp_adv&catalogmode=$ENV{'form.catalogmode'}&launch=$ENV{'form.launch'}&mode=$ENV{'form.mode'}"
   >$header</a></td></tr>
   <tr><td>$relatedcheckbox $userelatedwords</td>
       <td>$domaincheckbox $onlysearchdomain <b>$domain</b></td></tr>
 </table>  </table>
 </p>  </p>
 <p>  <p>
 &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;  &nbsp;<input type="submit" name="basicsubmit" value='$srch' />&nbsp;
 $closebutton  $closebutton
 END  END
     $scrout.=&selectbox(undef,'viewselect',      $scrout.=&selectbox('View','viewselect',
  $ENV{'form.viewselect'},   $ENV{'form.viewselect'},
  undef,undef,undef,   undef,undef,undef,
  sort(keys(%Views)));   sort(keys(%Views)));
       $scrout.=&selectbox('Per Page','show',
    $ENV{'form.show'},
    undef,undef,undef,
    (10,20,50,100));
     $scrout.=<<ENDDOCUMENT;      $scrout.=<<ENDDOCUMENT;
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  </p>
 </form>  </form>
   ENDDOCUMENT
       }
       if ($ENV{'request.course.id'}) {
    my %lt=&Apache::lonlocal::texthash(
      'srch' => 'Search',
                                              'header' => 'Course Search',
    'note' => 'Enter terms or phrases, then press "Search" below',
      );
           $scrout.=(<<ENDCOURSESEARCH);
   <hr />
   <h1>$lt{'header'}</h1>    
   <form name="course_search" method="post" action="/adm/searchcat">
   <input type="hidden" name="phase" value="course_search" />
   $hidden_fields
   <p>
   $lt{'note'}.
   </p>
   <p>
   <table>
   <tr><td>
   ENDCOURSESEARCH
           $scrout.='&nbsp;'.
               &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='$lt{'srch'}' />
   </p>
   ENDENDCOURSE
       }
       $scrout.=(<<ENDDOCUMENT);
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 393  Returns a scalar which holds html for th Line 587  Returns a scalar which holds html for th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub advanced_search_form{  sub print_advanced_search_form{
     my ($closebutton) = @_;      my ($r,$closebutton,$hidden_fields) = @_;
     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 406  END Line 600  END
     if (!defined($ENV{'form.viewselect'})) {      if (!defined($ENV{'form.viewselect'})) {
         $ENV{'form.viewselect'} ="Detailed Citation View";          $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 418  END Line 613  END
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <h1>Advanced Catalog Search</h1>  
 <hr />  
 Enter terms or phrases separated by search operators   Enter terms or 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_fields  $hidden_fields
   <input type="hidden" name="phase" value="adv_search" />
 <table>  <table>
 <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>  <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>
 <td>  <td>
Line 435  ENDHEADER Line 628  ENDHEADER
  $ENV{'form.viewselect'},   $ENV{'form.viewselect'},
  undef,undef,undef,   undef,undef,undef,
  sort(keys(%Views)));   sort(keys(%Views)));
     $scrout.="</td><td>Related<br />Words</td></tr>\n";      $scrout.='&nbsp;';
       $scrout.=&selectbox(undef,'show',
    $ENV{'form.show'},
    undef,undef,undef,
    (10,20,50,100));
       $scrout.='&nbsp;'.
           '<font color="#800000" face="helvetica">'.&mt('Per Page').'</font>';
       $scrout.="</td><td>".&mt('Related').'<br />'.&mt('Words')."</td></tr>\n";
     $scrout.=&searchphrasefield_with_related('title',   'title'   ,      $scrout.=&searchphrasefield_with_related('title',   'title'   ,
                                              $ENV{'form.title'});                                               $ENV{'form.title'});
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});      $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});
Line 448  ENDHEADER Line 648  ENDHEADER
                                              $ENV{'form.notes'});                                               $ENV{'form.notes'});
     $scrout.=&searchphrasefield_with_related('abstract','abstract',      $scrout.=&searchphrasefield_with_related('abstract','abstract',
                                              $ENV{'form.abstract'});                                               $ENV{'form.abstract'});
       $scrout.=&searchphrasefield('Standards','standards',$ENV{'form.standards'});
     # Hack - an empty table row.      # Hack - an empty table row.
     $scrout.="<tr><td>&nbsp;</td><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><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.category'}='any' unless length($ENV{'form.category'});      $ENV{'form.category'}='any' if (! defined($ENV{'form.category'}));
     $scrout.=&selectbox('File Category','category',      $scrout.=&selectbox('File Category','category',
  $ENV{'form.category'},   $ENV{'form.category'},
  'any','Any category',   'any','Any category',
Line 477  ENDHEADER Line 678  ENDHEADER
     my @domains =&Apache::loncommon::get_domains();      my @domains =&Apache::loncommon::get_domains();
     # adjust the size of the select box      # adjust the size of the select box
     my $size = 4;      my $size = 4;
     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);      $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
     $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.      $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
         'DOMAINS</b></font><br />'.          'DOMAINS TO BE SEARCHED</b></font><br />'.
             '<select name="domains" size="'.$size.'" multiple>'."\n".              '<select name="domains" size="'.$size.'" multiple>'."\n".
                 '<option name="any" value="any" '.                  '<option name="any" value="any" '.
                     ($domain_hash{'any'}? 'selected ' :'').                      ($domain_hash{'any'}? 'selected ' :'').
Line 492  ENDHEADER Line 693  ENDHEADER
     #----------------------------------------------------------------      #----------------------------------------------------------------
     $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 539  LASTREVISIONDATEEND Line 740  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;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &get_persistent_form_data
   
   Inputs: filename of database
   
   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
   
   ######################################################################
   ######################################################################
   sub get_persistent_form_data {
       my $filename = shift;
       return 0 if (! -e $filename);
       return undef if (! tie(%persistent_db,'GDBM_File',$filename,
                              &GDBM_READER(),0640));
       #
       # These make sure we do not get array references printed out as 'values'.
       my %arrays_allowed = ('form.domains'=>1);
       #
       # Loop through the keys, looking for 'form.'
       foreach my $name (keys(%persistent_db)) {
           next if ($name !~ /^form./);
           # Kludgification begins!
           if ($name eq 'form.domains' && 
               $ENV{'form.searchmode'} eq 'basic' &&
               $ENV{'form.phase'} ne 'disp_basic') {
               next;
           }
           # End kludge (hopefully)
           next if (exists($ENV{$name}));
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           next if (@values <1);
           if ($arrays_allowed{$name}) {
               $ENV{$name} = [@values];
           } else {
               $ENV{$name} = $values[0] if ($values[0]);
           }
       }
       untie (%persistent_db);
       return 1;
 }  }
   
 ######################################################################  ######################################################################
Line 576  ENDDOCUMENT Line 833  ENDDOCUMENT
   
 =pod   =pod 
   
 =item &reconstruct_persistent_form_data  =item &get_persistent_data
   
   Inputs: filename of database, ref to array of values to recover.
   
   Outputs: array of values.  Returns undef on error.
   
 This function is the reverse of &make_persistent();  This function is the reverse of &make_persistent();
 Retrieve persistent data from %persistent_db.  Retrieved items will have their  Retrieve persistent data from %persistent_db.  Retrieved items will have their
 values unescaped.  If the item contains commas (before unescaping), the  values unescaped.  If the item contains commas (before unescaping), the
 returned value will be an array pointer.  Items will be returned in the  returned value will be an array pointer. 
 environment in $ENV{"form.$name"}.  
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub reconstruct_persistent_form_data {  sub get_persistent_data {
     foreach my $name (keys %persistent_db) {      my $filename = shift;
         # &Apache::lonnet::logthis("Reconstructing $name = $persistent_db{$name}");      my @Vars = @{shift()};
         my @Values = split(',',$persistent_db{$name});      my @Values;   # Return array
         my @value = map { &Apache::lonnet::unescape($_) } @Values;      return undef if (! -e $filename);
         $name = 'form.'.$name;      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
         if (exists($ENV{$name})) {                             &GDBM_READER(),0640));
             if (ref($ENV{$name})) {      foreach my $name (@Vars) {
                 # Assume it is an array reference          if (! exists($persistent_db{$name})) {
                 $ENV{$name} = [@{$ENV{$name}},@value];              push @Values, undef;
             } else {              next;
                 $ENV{$name} = [$ENV{$name},@value];          }
             }          my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           if (@values <= 1) {
               push @Values,$values[0];
         } else {          } else {
             if (@value > 1) {              push @Values,\@values;
                 $ENV{$name} = [@value];  
             } else {  
                 $ENV{$name} = $value[0];  
             }  
         }          }
     }      }
     return;      untie (%persistent_db);
       return @Values;
 }  }
   
 ######################################################################  ######################################################################
Line 619  sub reconstruct_persistent_form_data { Line 880  sub reconstruct_persistent_form_data {
   
 =item &make_persistent()   =item &make_persistent() 
   
 Store (environment) variables away to the %persistent_db.    Inputs: Hash of values to save, filename of persistent database.
   
   Store variables away to the %persistent_db.
 Values will be escaped.  Values that are array pointers will have their  Values will be escaped.  Values that are array pointers will have their
 elements escaped and concatenated in a comma seperated string.    elements escaped and concatenated in a comma seperated string.  
   
Line 629  elements escaped and concatenated in a c Line 892  elements escaped and concatenated in a c
 ######################################################################  ######################################################################
 sub make_persistent {  sub make_persistent {
     my %save = %{shift()};      my %save = %{shift()};
     foreach my $name (keys %save) {      my $filename = shift;
         next if ($name !~ /^form\./ || $name =~ /submit/);      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}));          my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
         # We handle array references, but not recursively.          # We handle array references, but not recursively.
         my $store = join(',', map { &Apache::lonnet::escape($_); } @values );          my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
         $name=~s/^form\.//;  
         $persistent_db{$name} = $store;          $persistent_db{$name} = $store;
     }      }
     return '';      untie(%persistent_db);
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &make_form_data_persistent() 
   
   Inputs: filename of persistent database.
   
   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.  
   
   =cut
   
   ######################################################################
   ######################################################################
   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);
 }  }
   
 ######################################################################  ######################################################################
Line 683  sub simpletextfield { Line 976  sub simpletextfield {
   
 =item &simplecheckbox()  =item &simplecheckbox()
   
 Inputs: $name,$value  Inputs: $name,$value,$checked
   
 Returns a simple check box with the given $name.  Returns a simple check box with the given $name.
 If $value eq 'on' the box is checked.  If $value eq 'on' the box is checked.
Line 693  If $value eq 'on' the box is checked. Line 986  If $value eq 'on' the box is checked.
 ###############################################  ###############################################
 ###############################################  ###############################################
   
 sub simplecheckbox {  sub simplecheckbox{
     my ($name,$value)=@_;      my ($name,$value,$checked)=@_;
     my $checked='';      $checked="checked" if ($value eq $checked || $value eq 'on');
     $checked="checked" if $value eq 'on';      return '<input type="checkbox" name="'.$name.'" value="'.$value.'" '.
     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';          $checked.' />';
 }  }
   
 ###############################################  ###############################################
Line 718  field heading. Line 1011  field heading.
 ###############################################  ###############################################
   
 sub fieldtitle {  sub fieldtitle {
     my $title = uc(shift());      my $title = uc(&mt(shift()));
     return '<font color="#800000" face="helvetica"><b>'.$title.      return '<font color="#800000" face="helvetica"><b>'.$title.
         ':&nbsp;</b></font>';          ':&nbsp;</b></font>';
 }  }
Line 813  END Line 1106  END
     my $i = 1;      my $i = 1;
     foreach (qw/January February March April May June       foreach (qw/January February March April May June 
      July August September October November December /){       July August September October November December /){
  $month .="<option value=\"$i\">$_</option>\n";   $month .="<option value=\"$i\">".&mt($_)."</option>\n";
  $i++;   $i++;
     }      }
     $month.="</select>\n";      $month.="</select>\n";
Line 890  sub selectbox { Line 1183  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 $selout='';      my $selout='';
       $title=&mt($title);
     if (defined($title)) {      if (defined($title)) {
         my $uctitle=uc($title);          my $uctitle=uc($title);
         $selout="\n".'<p><font color="#800000" face="helvetica">'.          $selout="\n".'<p><font color="#800000" face="helvetica">'.
Line 900  sub selectbox { Line 1194  sub selectbox {
     foreach (@idlist) {      foreach (@idlist) {
         $selout.='<option value="'.$_.'"';          $selout.='<option value="'.$_.'"';
         if ($_ eq $default and !/^any$/) {          if ($_ eq $default and !/^any$/) {
     $selout.=' selected >'.&{$functionref}($_).'</option>';      $selout.=' selected >'.&mt(&{$functionref}($_)).'</option>';
  }   }
  elsif ($_ eq $default and /^$anyvalue$/) {   elsif ($_ eq $default and /^$anyvalue$/) {
     $selout.=' selected >'.$anytag.'</option>';      $selout.=' selected >'.&mt($anytag).'</option>';
  }   }
         else {$selout.='>'.&{$functionref}($_).'</option>';}          else {$selout.='>'.&mt(&{$functionref}($_)).'</option>';}
     }      }
     return $selout.'</select>'.(defined($title)?'</p>':' ');      return $selout.'</select>'.(defined($title)?'</p>':' ');
 }  }
Line 947  Parse advanced search form and return th Line 1241  Parse advanced search form and return th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_advanced_search {  sub parse_advanced_search {
     my ($r,$closebutton)=@_;      my ($r,$closebutton,$hidden_fields)=@_;
     my $fillflag=0;      my $fillflag=0;
     my $pretty_search_string = "<br />\n";      my $pretty_search_string = "<br />\n";
     # Clean up fields for safety      # Clean up fields for safety
Line 958  sub parse_advanced_search { Line 1252  sub parse_advanced_search {
    'lastrevisiondatestart_month','lastrevisiondatestart_day',     'lastrevisiondatestart_month','lastrevisiondatestart_day',
    'lastrevisiondatestart_year','lastrevisiondateend_month',     'lastrevisiondatestart_year','lastrevisiondateend_month',
    'lastrevisiondateend_day','lastrevisiondateend_year',     'lastrevisiondateend_day','lastrevisiondateend_year',
    'notes','abstract','mime','language','owner',     'notes','abstract','extension','language','owner',
    'custommetadata','customshow','category') {     'custommetadata','customshow','category') {
  $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
Line 969  sub parse_advanced_search { Line 1263  sub parse_advanced_search {
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
     # Preprocess the category form element.      # Preprocess the category form element.
     if ($ENV{'form.category'} ne 'any') {      $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) ||
         my @extensions = &Apache::loncommon::filecategorytypes                                        ref($ENV{'form.category'}));
             ($ENV{'form.category'});      #
         $ENV{'form.mime'} = join ' OR ',@extensions;  
     }  
     # Check to see if enough information was filled in      # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
    'notes','abstract','mime','language','owner',     'notes','abstract','category','extension','language',
    'custommetadata') {                     'owner','custommetadata') {
  if (&filled($ENV{"form.$field"})) {   if (&filled($ENV{"form.$field"})) {
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r,$closebutton);   &output_blank_field_error($r,$closebutton,'phase=disp_adv',$hidden_fields);
  return ;   return ;
     }      }
     # Turn the form input into a SQL-based query      # Turn the form input into a SQL-based query
Line 992  sub parse_advanced_search { Line 1284  sub parse_advanced_search {
     my $font = '<font color="#800000" face="helvetica">';      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}) {
             my $searchphrase = $ENV{'form.'.$field};              my $searchphrase = $ENV{'form.'.$field};
             $pretty_search_string .= $font."$field</font> contains <b>".              $pretty_search_string .= $font."$field</font> contains <b>".
Line 1011  sub parse_advanced_search { Line 1303  sub parse_advanced_search {
     push @queries,&build_SQL_query($field,$searchphrase);      push @queries,&build_SQL_query($field,$searchphrase);
         }          }
     }      }
     # I dislike the hack below.      #
     if ($ENV{'form.category'}) {      # Make the 'mime' from 'form.category' and 'form.extension'
         $ENV{'form.mime'}='';      #
       my $searchphrase;
       if (exists($ENV{'form.category'})    && 
           $ENV{'form.category'} !~ /^\s*$/ &&
           $ENV{'form.category'} ne 'any')     {
           my @extensions = &Apache::loncommon::filecategorytypes
                                                      ($ENV{'form.category'});
           if (scalar(@extensions) > 0) {
               $searchphrase = join(' OR ',@extensions);
           }
     }      }
       if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) {
           $searchphrase .= ' OR ' if (defined($searchphrase));
           my @extensions = split(/,/,$ENV{'form.extension'});
           $searchphrase .= join(' OR ',@extensions);
       }
       if (defined($searchphrase)) {
           push @queries,&build_SQL_query('mime',$searchphrase);
           $pretty_search_string .=$font.'mime</font> contains <b>'.
               $searchphrase.'</b><br />';
       }
       #####
     # Evaluate option lists      # Evaluate option lists
     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  push @queries,"(language like \"$ENV{'form.language'}\")";   push @queries,"(language like \"$ENV{'form.language'}\")";
Line 1046  sub parse_advanced_search { Line 1358  sub parse_advanced_search {
  );   );
     # Test to see if date windows are legitimate      # Test to see if date windows are legitimate
     if ($datequery=~/^Incorrect/) {      if ($datequery=~/^Incorrect/) {
  &output_date_error($r,$datequery,$closebutton);   &output_date_error($r,$datequery,$closebutton,$hidden_fields);
  return ;   return ;
     } elsif ($datequery) {      } elsif ($datequery) {
         # Here is where you would set up pretty_search_string to output          # Here is where you would set up pretty_search_string to output
Line 1055  sub parse_advanced_search { Line 1367  sub parse_advanced_search {
     }      }
     # Process form information for custom metadata querying      # Process form information for custom metadata querying
     my $customquery=undef;      my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {  #    if ($ENV{'form.custommetadata'}) {
         $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".  #        $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
             $ENV{'form.custommetadata'}."</b><br />\n";  #            $ENV{'form.custommetadata'}."</b><br />\n";
  $customquery=&build_custommetadata_query('custommetadata',  # $customquery=&build_custommetadata_query('custommetadata',
       $ENV{'form.custommetadata'});  #      $ENV{'form.custommetadata'});
     }  #    }
     my $customshow=undef;      my $customshow=undef;
     if ($ENV{'form.customshow'}) {  #    if ($ENV{'form.customshow'}) {
         $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".  #        $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
             $ENV{'form.customshow'}."</b><br />\n";  #            $ENV{'form.customshow'}."</b><br />\n";
  $customshow=$ENV{'form.customshow'};  # $customshow=$ENV{'form.customshow'};
  $customshow=~s/[^\w\s]//g;  # $customshow=~s/[^\w\s]//g;
  my @fields=split(/\s+/,$customshow);  # my @fields=split(/\s+/,$customshow);
  $customshow=join(" ",@fields);  # $customshow=join(" ",@fields);
     }  #    }
     ## ---------------------------------------------------------------      ## ---------------------------------------------------------------
     ## Deal with restrictions to given domains      ## Deal with restrictions to given domains
     ##       ## 
       my ($libraries_to_query,$pretty_domains_string) = 
           &parse_domain_restrictions();
       $pretty_search_string .= $pretty_domains_string."<br />\n";
       #
       if (@queries) {
    $query=join(" AND ",@queries);
    $query="select * from metadata where $query";
       } elsif ($customquery) {
           $query = '';
       }
       return ($query,$customquery,$customshow,$libraries_to_query,
               $pretty_search_string);
   }
   
   sub parse_domain_restrictions {
     my $libraries_to_query = undef;      my $libraries_to_query = undef;
     # $ENV{'form.domains'} can be either a scalar or an array reference.      # $ENV{'form.domains'} can be either a scalar or an array reference.
     # We need an array.      # We need an array.
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}       if (! exists($ENV{'form.domains'})) {
                            :  ($ENV{'form.domains'}) );          return (undef,'');
       }
       my @allowed_domains;
       if (ref($ENV{'form.domains'})) {
           @allowed_domains =  @{$ENV{'form.domains'}};
       } else {
           @allowed_domains = ($ENV{'form.domains'});
       }
     my %domain_hash = ();      my %domain_hash = ();
     my $pretty_domains_string;      my $pretty_domains_string;
     foreach (@allowed_domains) {      foreach (@allowed_domains) {
         $domain_hash{$_}++;          $domain_hash{$_}++;
     }      }
     if ($domain_hash{'any'}) {      if ($domain_hash{'any'}) {
         $pretty_domains_string = "Searching all domains.";          $pretty_domains_string = "In all LON-CAPA domains.";
     } else {      } else {
         if (@allowed_domains > 1) {          if (@allowed_domains > 1) {
             $pretty_domains_string = "Searching domains:";              $pretty_domains_string = "In LON-CAPA domains:";
         } else {          } else {
             $pretty_domains_string = "Searching domain ";              $pretty_domains_string = "In LON-CAPA domain ";
         }          }
         foreach (sort @allowed_domains) {          foreach (sort @allowed_domains) {
             $pretty_domains_string .= "<b>$_</b> ";              $pretty_domains_string .= "<b>".$_."</b> ";
         }          }
         foreach (keys(%Apache::lonnet::libserv)) {          foreach (keys(%Apache::lonnet::libserv)) {
             if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {              if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
Line 1100  sub parse_advanced_search { Line 1434  sub parse_advanced_search {
             }              }
         }          }
     }      }
     $pretty_search_string .= $pretty_domains_string."<br />\n";      return ($libraries_to_query,$pretty_domains_string);
     #  
     if (@queries) {  
  $query=join(" AND ",@queries);  
  $query="select * from metadata where $query";  
     } elsif ($customquery) {  
         $query = '';  
     }  
     return ($query,$customquery,$customshow,$libraries_to_query,  
             $pretty_search_string);  
 }  }
   
 ######################################################################  ######################################################################
Line 1137  sub parse_basic_search { Line 1462  sub parse_basic_search {
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       my ($libraries_to_query,$pretty_domains_string) = 
           &parse_domain_restrictions();
     # 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,$closebutton);   &output_blank_field_error($r,$closebutton,'phase=disp_basic');
  return OK;   return OK;
     }      }
     my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';      my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
Line 1156  sub parse_basic_search { Line 1482  sub parse_basic_search {
     }      }
     # Build SQL query string based on form page      # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',',
        ('title', 'author', 'subject', 'notes', 'abstract',         ('title', 'author', 'subject', 'notes', 'abstract',
                         'keywords'));                          'keywords'));
     $concatarg='title' if $ENV{'form.titleonly'};      $concatarg='title' if $ENV{'form.titleonly'};
     $query=&build_SQL_query('concat('.$concatarg.')',$search_string);      $query=&build_SQL_query('concat_ws(" ",'.$concatarg.')',$search_string);
       if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
           $pretty_search_string .= ' '.$pretty_domains_string;
       }
     $pretty_search_string .= "<br />\n";      $pretty_search_string .= "<br />\n";
     return 'select * from metadata where '.$query,$pretty_search_string;      my $final_query = 'SELECT * FROM metadata WHERE '.$query;
   #    &Apache::lonnet::logthis($final_query);
       return ($final_query,$pretty_search_string,
               $libraries_to_query);
 }  }
   
   
Line 1275  sub recursive_SQL_query_build { Line 1607  sub recursive_SQL_query_build {
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
     return $pattern unless @matches;      return $pattern unless @matches;
     foreach my $match (@matches) {      foreach my $match (@matches) {
  $match=~/\[ (\w+)\s(.*) \]/;          $match=~/\[ (\w+)\s(.*) \]/;
  my ($key,$value)=($1,$2);          my ($key,$value)=($1,$2);
  my $replacement='';          my $replacement='';
  if ($key eq 'literal') {          if ($key eq 'literal') {
     $replacement="($dkey like \"\%$value\%\")";              $replacement="($dkey LIKE \"\%$value\%\")";
  }          } elsif (lc($key) eq 'not') {
  elsif ($key eq 'not') {              $value=~s/LIKE/NOT LIKE/;
     $value=~s/like/not like/;  #          $replacement="($dkey not like $value)";
 #    $replacement="($dkey not like $value)";              $replacement="$value";
     $replacement="$value";          } elsif ($key eq 'and') {
  }              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  elsif ($key eq 'and') {              $replacement="($1 AND $2)";
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;   } elsif ($key eq 'or') {
     $replacement="($1 AND $2)";              $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  }              $replacement="($1 OR $2)";
  elsif ($key eq 'or') {  
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  
     $replacement="($1 OR $2)";  
  }   }
  substr($pattern,   substr($pattern,
        index($pattern,$match),                 index($pattern,$match),
        length($match),                 length($match),
        $replacement                 $replacement);
        );  
     }      }
     &recursive_SQL_query_build($dkey,$pattern);      &recursive_SQL_query_build($dkey,$pattern);
 }  }
Line 1376  sub build_date_queries { Line 1704  sub build_date_queries {
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 sub copyright_check {  sub copyright_check {
     my $Metadata = shift;      my $Metadata = shift;
     # Check copyright tags and skip results the user cannot use      # Check copyright tags and skip results the user cannot use
Line 1396  sub copyright_check { Line 1723  sub copyright_check {
     return 1;      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
   
   ######################################################################
   ######################################################################
   sub ensure_db_and_table {
       my ($r,$table) = @_;
       ##
       ## Sanity check the table id.
       ##
       if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
           $r->print("Unable to retrieve search results.  ".
                     "Unable to determine the table results were stored in.  ".
                     "</body></html>");
           return undef;
       }
       ##
       ## Make sure we can connect and the table exists.
       ##
       my $connection_result = &Apache::lonmysql::connect_to_db();
       if (!defined($connection_result)) {
           $r->print("Unable to connect to the MySQL database where your results".
                     " are stored. </body></html>");
           &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to".
                                    " connect to database.");
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return undef;
       }
       my $table_check = &Apache::lonmysql::check_table($table);
       if (! defined($table_check)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the status".
                                    " of table ".$table);
           return undef;
       } elsif (! $table_check) {
           $r->print("The table of results could not be found.");
           &Apache::lonnet::logthis("The user requested a table, ".$table.
                                    ", that could not be found.");
           return undef;
       }
       return 1;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &print_sort_form
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_sort_form {
       my ($r,$pretty_query_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       ##
       my %SortableFields=&Apache::lonlocal::texthash( 
            id        => 'Default',
            title     => 'Title',
            author    => 'Author',
            subject   => 'Subject',
            url       => 'URL',
            version   => 'Version Number',
            mime      => 'Mime type',
            lang      => 'Language',
            owner     => 'Owner/Publisher',
            copyright => 'Copyright',
            hostname  => 'Host',
            creationdate     => 'Creation Date',
            lastrevisiondate => 'Revision Date'
        );
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       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;
   }
   
 #####################################################################  #####################################################################
 #####################################################################  #####################################################################
   
Line 1410  the following format: Line 1884  the following format:
   
 =cut  =cut
   
 ##  #####################################################################
 ## Restrictions:  #####################################################################
 ##    columns of type 'text' and 'blob' cannot have defaults.  
 ##    columns of type 'enum' cannot be used for FULLTEXT.  my @Datatypes = 
 ##      ( { name => 'id', 
 my @DataOrder = qw/id title author subject url keywords version notes          type => 'MEDIUMINT',
     abstract mime lang owner copyright creationdate lastrevisiondate hostname          restrictions => 'UNSIGNED NOT NULL',
     idx_title idx_author idx_subject idx_abstract idx_mime idx_language           primary_key  => 'yes',
     idx_owner idx_copyright/;          auto_inc     => 'yes' },
         { name => 'title',     type=>'TEXT'},
 my %Datatypes =         { name => 'author',    type=>'TEXT'},
     ( id        =>{ type         => 'INT',        { name => 'subject',   type=>'TEXT'},
                     restrictions => 'NOT NULL',        { name => 'url',       type=>'TEXT', restrictions => 'NOT NULL' },
                     primary_key  => 'yes',        { name => 'keywords',  type=>'TEXT'},
                     auto_inc     => 'yes'        { name => 'version',   type=>'TEXT'},
                     },        { name => 'notes',     type=>'TEXT'},
       title     =>{ type=>'TEXT'},        { name => 'abstract',  type=>'TEXT'},
       author    =>{ type=>'TEXT'},        { name => 'mime',      type=>'TEXT'},
       subject   =>{ type=>'TEXT'},        { name => 'language',  type=>'TEXT'},
       url       =>{ type=>'TEXT',        { name => 'owner',     type=>'TEXT'},
                     restrictions => 'NOT NULL' },        { name => 'copyright', type=>'TEXT'},
       keywords  =>{ type=>'TEXT'},        { name => 'dependencies',     type=>'TEXT'},
       version   =>{ type=>'TEXT'},        { name => 'modifyinguser', type=>'TEXT'},
       notes     =>{ type=>'TEXT'},        { name => 'authorspace', type=>'TEXT'},
       abstract  =>{ type=>'TEXT'},        { name => 'lowestgradelevel',  type=>'INT'},
       mime      =>{ type=>'TEXT'},        { name => 'highestgradelevel', type=>'INT'},
       lang      =>{ type=>'TEXT'},        { name => 'standards', type=>'TEXT'},
       owner     =>{ type=>'TEXT'},        { name => 'count',     type=>'INT'},
       copyright =>{ type=>'TEXT'},        { name => 'course', type=>'INT'},
       hostname  =>{ type=>'TEXT'},        { name => 'course_list',  type=>'TEXT'},
         { name => 'goto', type=>'INT'},
         { name => 'goto_list',  type=>'TEXT'},
         { name => 'comefrom', type=>'INT'},
         { name => 'comefrom_list',  type=>'TEXT'},
         { name => 'sequsage', type=>'INT'},
         { name => 'sequsage_list',  type=>'TEXT'},
         { name => 'stdno', type=>'INT'},
         { name => 'stdno_list',  type=>'TEXT'},
         { name => 'avetries', type=>'FLOAT'},
         { name => 'avetries_list',  type=>'TEXT'},
         { name => 'difficulty', type=>'FLOAT'},
         { name => 'difficulty_list',  type=>'TEXT'},
         { name => 'clear',  type=>'FLOAT'},
         { name => 'technical',  type=>'FLOAT'},
         { name => 'correct',  type=>'FLOAT'},
         { name => 'helpful',  type=>'FLOAT'},
         { name => 'depth',  type=>'FLOAT'},
         { name => 'hostname', type=> 'TEXT'},
       #--------------------------------------------------        #--------------------------------------------------
       creationdate     =>{ type=>'DATETIME'},        { name => 'creationdate',     type=>'DATETIME'},
       lastrevisiondate =>{ type=>'DATETIME'},        { name => 'lastrevisiondate', type=>'DATETIME'},
       #--------------------------------------------------        #--------------------------------------------------
       idx_title     =>{ type=>'FULLTEXT', target=>'title'},  
       idx_author    =>{ type=>'FULLTEXT', target=>'author'},  
       idx_subject   =>{ type=>'FULLTEXT', target=>'subject'},  
       idx_abstract  =>{ type=>'FULLTEXT', target=>'abstract'},  
       idx_mime      =>{ type=>'FULLTEXT', target=>'mime'},  
       idx_language  =>{ type=>'FULLTEXT', target=>'lang'},  
       idx_owner     =>{ type=>'FULLTEXT', target=>'owner'},  
       idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},  
       );        );
   
   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  =pod
   
 =item &write_status()  =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  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub write_status {  sub update_count_status {
     my ($r,$string) = @_;      my ($r,$text) = @_;
     $r->print("<pre>".$string."</pre>\n");      $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.count.value = ' $text'</script>\n");
     $r->rflush();      $r->rflush();
     return;  }
   
   sub update_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.status.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   sub update_seconds {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print
           ("<script>document.statusform.seconds.value = ' $text'</script>\n");
       $r->rflush();
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &revise_button
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revise_phase = 'disp_basic';
       $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
       my $newloc = '/adm/searchcat'.
           '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
               '&cleargroupsort=1'.
               '&phase='.$revise_phase;
       my $result = qq{<input type="button" value="Revise search" name="revise"} .
           qq{ onClick="parent.location='$newloc';" /> };
       return $result;
 }  }
   
 ######################################################################  ######################################################################
Line 1484  sub write_status { Line 2064  sub write_status {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub run_search {  sub run_search {
     my ($r,$query,$customquery,$customshow,$serverlist) = @_;      my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $connection = $r->connection;
     #      #
     # Timing variables      # Timing variables
     #      #
     my $starttime = time;      my $starttime = time;
     my $max_time  = 120;  # seconds for the search to complete      my $max_time  = 30;  # seconds for the search to complete
       #
       # Print run_search header
       #
       $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(&mt("Search").": ".$pretty_string);
       $r->rflush();
     #      #
     # Determine the servers we need to contact.      # Determine the servers we need to contact.
     #      #
     my @Servers_to_contact;      my @Servers_to_contact;
     if (defined($serverlist)) {      if (defined($serverlist)) {
         @Servers_to_contact = @$serverlist;          if (ref($serverlist) eq 'ARRAY') {
               @Servers_to_contact = @$serverlist;
           } else {
               @Servers_to_contact = ($serverlist);
           }
     } else {      } else {
         @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));          @Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
     }      }
     my %Server_status;      my %Server_status;
     #      my $table =$ENV{'form.table'};
     # Create Table      if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
     #          $r->print("Unable to determine table id to store search results in.".
     my $table = &Apache::lonmysql::create_table                    "The search has been aborted.</body></html>");
         ( { columns => \%Datatypes,          return;
             column_order => \@DataOrder,      }
         } );      my $table_status = &Apache::lonmysql::check_table($table);
     if (! defined($table)) {      if (! defined($table_status)) {
         # What do I do now?  Print out an error page.          $r->print("Unable to determine status of table.</body></html>");
         &Apache::lonnet::logthis("lonmysql attempted to create a table ".          &Apache::lonnet::logthis("Bogus table id of $table for ".
                                  "and this was the result:".                                   "$ENV{'user.name'} @ $ENV{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                  &Apache::lonmysql::get_error());                                   &Apache::lonmysql::get_error());
         $r->print("An internal error occured with the database.<br />".          return;
                   "The error has been logged, but you should probably alert".      }
                   " your system administrator.");      if (! $table_status) {
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
         return;          return;
     }      }
     ##      ##
     ## form.table needs to be stored in the persistent database...      ## Prepare for the big loop.
     ##       ##
     $ENV{'form.table'}=$table;  
     #  
     # Prepare for the big loop.  
     #  
     my $hitcountsum;      my $hitcountsum;
     my $server;       my $server; 
     my $status;      my $status;
     while ((time - $starttime < $max_time) &&       my $revise = &revise_button();
       $r->print(<<END);
   <table>
   <tr><th>Status</th><th>Total Matches</th><th>Time Remaining</th><th></th></tr>
   <tr>
   <td><input type="text" name="status"  value="" size="30" /></td>
   <td><input type="text" name="count"   value="" size="10" /></td>
   <td><input type="text" name="seconds" value="" size="8" /></td>
   <td>$revise</td>
   </tr>
   </table>
   </form>
   END
       $r->rflush();
       my $time_remaining = $max_time - (time - $starttime) ;
       my $last_time = $time_remaining;
       &update_seconds($r,$time_remaining);
       &update_status($r,'contacting '.$Servers_to_contact[0]);
       while (($time_remaining > 0) &&
            ((@Servers_to_contact) || keys(%Server_status))) {             ((@Servers_to_contact) || keys(%Server_status))) {
         # Send out a search request if it needs to be done.          # Send out a search request if it needs to be done.
         if (@Servers_to_contact) {          if (@Servers_to_contact) {
             # Contact one server              # Contact one server
             my $server = shift(@Servers_to_contact);              my $server = shift(@Servers_to_contact);
               &update_status($r,&mt('contacting').' '.$server);
             my $reply=&Apache::lonnet::metadata_query($query,$customquery,              my $reply=&Apache::lonnet::metadata_query($query,$customquery,
                                                       $customshow,[$server]);                                                        $customshow,[$server]);
             ($server) = keys(%$reply);              ($server) = keys(%$reply);
             $Server_status{$server} = $reply->{$server};              $Server_status{$server} = $reply->{$server};
             # &write_status($r,"Contacted:$server:reply:".  
             #                   $Server_status{$server});  
             if ($max_time - (time - $starttime) < 20) {  
                 # If there are less than 20 seconds to go in the search,  
                 # give the newly contacted servers 20 more seconds to   
                 # respond....  
                 $max_time += 20;  
             }  
         } else {          } else {
             sleep(1); # wait a sec. to give time for files to be written              # wait a sec. to give time for files to be written
               # This sleep statement is here instead of outside the else 
               # block because we do not want to pause if we have servers
               # left to contact.  
               if (scalar (keys(%Server_status))) {
                   &update_status($r,
                          &mt('waiting on').' '.(join(' ',keys(%Server_status))));
               }
               sleep(1); 
         }          }
           #
           #
           # Loop through the servers we have contacted but do not
           # have results from yet, looking for results.
         while (my ($server,$status) = each(%Server_status)) {          while (my ($server,$status) = each(%Server_status)) {
               last if ($connection->aborted());
             if ($status eq 'con_lost') {              if ($status eq 'con_lost') {
                 delete ($Server_status{$server});                  delete ($Server_status{$server});
                 # &write_status($r,"server $server is not responding.");  
                 next;                  next;
             }              }
             $status=~/^([\.\w]+)$/;               $status=~/^([\.\w]+)$/; 
            my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;             my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;
             if (-e $datafile && ! -e "$datafile.end") {              if (-e $datafile && ! -e "$datafile.end") {
                 # Let the user know we are receiving data from the server                  &update_status($r,&mt('Receiving results from').' '.$server);
                 # &write_status($r,"$server:Receiving file");  
                 next;                  next;
             }              }
               last if ($connection->aborted());
             if (-e "$datafile.end") {              if (-e "$datafile.end") {
                   &update_status($r,&mt('Reading results from').' '.$server);
                 if (-z "$datafile") {                  if (-z "$datafile") {
                     delete($Server_status{$server});                      delete($Server_status{$server});
                     next;                      next;
                 }                  }
                 my $fh;                  my $fh;
                 if (!($fh=Apache::File->new($datafile))) {                   if (!($fh=Apache::File->new($datafile))) { 
                     # Error opening file...                      $r->print("Unable to open search results file for ".
                     # Tell the user and exit...?  
                     # Should I give up on opening it?  
                     &write_status("Unable to open search results file for ".  
                                   "server $server.  Omitting from search");                                    "server $server.  Omitting from search");
                     next;                      delete($Server_status{$server}); 
                      next;
                 }                  }
                 # Read in the whole file.                  # Read in the whole file.
                 while (my $result = <$fh>) {                  while (my $result = <$fh>) {
                       last if ($connection->aborted());
                     # handle custom fields?  Someday we will!                      # handle custom fields?  Someday we will!
                     chomp($result);                      chomp($result);
                     next unless $result;                      next unless $result;
Line 1587  sub run_search { Line 2214  sub run_search {
                     # Store the result in the mysql database                      # Store the result in the mysql database
                     my $result = &Apache::lonmysql::store_row($table,\%Fields);                      my $result = &Apache::lonmysql::store_row($table,\%Fields);
                     if (! defined($result)) {                      if (! defined($result)) {
                         &write_status($r,&Apache::lonmysql::get_error());                          $r->print(&Apache::lonmysql::get_error());
                     }                      }
                     # &write_status($r,&Apache::lonmysql::get_debug());                      # $r->print(&Apache::lonmysql::get_debug());
                     $hitcountsum ++;                      $hitcountsum ++;
                       $time_remaining = $max_time - (time - $starttime) ;
                       if ($last_time - $time_remaining > 0) {
                           &update_seconds($r,$time_remaining);
                           $last_time = $time_remaining;
                       }
                       if ($hitcountsum % 50 == 0) {
                           &update_count_status($r,$hitcountsum);
                       }
                 } # End of foreach (@results)                  } # End of foreach (@results)
                 $fh->close();                  $fh->close();
                 # $server is only deleted if the results file has been                   # $server is only deleted if the results file has been 
                 # found and (successfully) opened.  This may be a bad idea.                  # found and (successfully) opened.  This may be a bad idea.
                 delete($Server_status{$server});                  delete($Server_status{$server});
                 #&write_status($r,"Received $new_count more results from ".  
                 #              $server.".");  
             }              }
               last if ($connection->aborted());
               &update_count_status($r,$hitcountsum);
         }          }
           last if ($connection->aborted());
         # Finished looping through the servers          # Finished looping through the servers
           $starttime = time if (@Servers_to_contact);
           $time_remaining = $max_time - (time - $starttime) ;
           if ($last_time - $time_remaining > 0) {
               $last_time = $time_remaining;
               &update_seconds($r,$time_remaining);
           }
     }      }
       &update_status($r,&mt('Search Complete').$server);
       &update_seconds($r,0);
     &Apache::lonmysql::disconnect_from_db();      &Apache::lonmysql::disconnect_from_db();
     # Let the user know  
     #  
     # We have run out of time or run out of servers to talk to and      # We have run out of time or run out of servers to talk to and
     # results to get.        # results to get.  
     &write_status($r,"Search completed.");      $r->print("</body></html>");
     if ($hitcountsum) {      if ($ENV{'form.catalogmode'} ne 'groupsearch') {
         &write_status($r,$hitcountsum." successful matches to your query.");          $r->print("<script>".
     } else {                        "window.location='/adm/searchcat?".
         &write_status($r,"There were no successful matches to your query.");                        "phase=sort&".
                         "persistent_db_id=$ENV{'form.persistent_db_id'}';".
                     "</script>");
     }      }
     return;      return;
 }  }
Line 1620  sub run_search { Line 2264  sub run_search {
 ######################################################################  ######################################################################
 =pod  =pod
   
 =item &display_buttons  =item &prev_next_buttons
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub display_buttons {  sub prev_next_buttons {
     my ($current_min,$show,$total,$parms) = @_;      my ($current_min,$show,$total,$parms) = @_;
     return '' if ($show eq 'all'); # No links if you get them all at once.      return '' if ($show eq 'all'); # No links if you get them all at once.
     my $links;      my $links;
     ##      ##
     ## Prev      ## Prev
     my $prev_min = $current_min - $show;      my $prev_min = $current_min - $show;
     $prev_min = 0 if $prev_min < 0;      $prev_min = 1 if $prev_min < 1;
     if ($prev_min < $current_min) {      if ($prev_min < $current_min) {
         $links .= qq{          $links .= qq{
 <a href="/adm/searchcat?$parms&startwith=$prev_min&show=$show">prev</a>  <a href="/adm/searchcat?$parms&start=$prev_min&show=$show">prev</a>
 };      };    
       } else {
           $links .= 'prev';
     }      }
     ##      ##
     ## Pages.... Someday.      ## Pages.... Someday.
     ##      ##
       $links .= qq{ &nbsp;
   <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">reload</a>
   };
     ##      ##
     ## Next      ## Next
     my $next_min = $current_min + $show;      my $next_min = $current_min + $show;
     my $next_min = $current_min if ($next_min > $total);      $next_min = $current_min if ($next_min > $total);
     if ($next_min != $current_min) {      if ($next_min != $current_min) {
         $links .= qq{          $links .= qq{ &nbsp;
 <a href="/adm/searchcat?$parms&startwith=$next_min&show=$show">next</a>  <a href="/adm/searchcat?$parms&start=$next_min&show=$show">next</a>
 };      };    
       } else {
           $links .= '&nbsp;next';
     }      }
     return $links;      return $links;
 }  }
Line 1666  sub display_buttons { Line 2316  sub display_buttons {
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub display_results {  sub display_results {
     my ($r,$mode,$importbutton,$closebutton) = @_;      my ($r,$importbutton,$closebutton,$diropendb) = @_;
       my $connection = $r->connection;
       $r->print(&search_results_header($importbutton,$closebutton));
     ##      ##
     ## Set viewing function      ## Set viewing function
     ##      ##
Line 1677  sub display_results { Line 2329  sub display_results {
         return;          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      ## Get the catalog controls setup
     ##      ##
     my $action = "/adm/searchcat";      my $action = "/adm/searchcat?phase=results";
     if ($mode eq 'Basic') {       ##
         $action .= "?reqinterface=basic";      ## Deal with groupsearch
     } elsif ($mode eq 'Advanced') {      ##
         $action .= "?reqinterface=advanced";      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;
           } 
     }      }
     $r->print(<<CATALOGCONTROLS);  
 <form name='results' method="post" action="$action">  
 $hidden_fields  
 <input type='hidden' name='acts' value='' />  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $importbutton  
 $closebutton  
 <hr />  
 CATALOGCONTROLS  
     if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
         $r->print('Unable to tie hash to db file</body></html>');  
         $r->rflush();  
         return;  
     }   
     ##      ##
     ## Prepare the table for querying      ## Prepare the table for querying
     ##      ##
     my $table = $ENV{'form.table'};      my $table = $ENV{'form.table'};
     my $connection_result = &Apache::lonmysql::connect_to_db();      return if (! &ensure_db_and_table($r,$table));
     if (!defined($connection_result)) {  
         &write_status($r,&Apache::lonmysql::get_error());  
     }  
     my $table_check = &Apache::lonmysql::check_table($table);  
     if (! defined($table_check)) {  
         $r->print("A MySQL error has occurred.</body></html>");  
         &Apache::lonnet::logthis("lonmysql was unable to determine the status".  
                                  " of table ".$table);  
         return;  
     } elsif (! $table_check) {  
         $r->print("The table of results could not be found.");  
         &Apache::lonnet::logthis("The user requested a table, ".$table.  
                                  ", that could not be found.");  
         return;  
     }  
     ##      ##
     ## Get the number of results       ## Get the number of results 
     ##      ##
     my $total_results = &Apache::lonmysql::number_of_rows($table);      my $total_results = &Apache::lonmysql::number_of_rows($table);
     if (! defined($total_results)) {      if (! defined($total_results)) {
         $r->print("A MySQL error has occurred.</body></html>");          $r->print("A MySQL error has occurred.</form></body></html>");
         &Apache::lonnet::logthis("lonmysql was unable to determine the number".          &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                  " of rows in table ".$table);                                   " of rows in table ".$table);
         &Apache::lonnet::logthis(&Apache::lonmysql::get_error());          &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
         &Apache::lonnet::logthis(&Apache::lonmysql::get_debug());  
         return;  
     }  
     if ($total_results == 0) {  
         $r->print("There were no results matching your query.\n".  
                   "</form></body></html>");  
         return;          return;
     }      }
     ##      ##
     ## Determine how many results we need to get      ## Determine how many results we need to get
     ##      ##
     $ENV{'form.startwith'} = 0      if (! exists($ENV{'form.startwith'}));      $ENV{'form.start'} = 1      if (! exists($ENV{'form.start'}));
     $ENV{'form.show'}      = 'all'  if (! exists($ENV{'form.show'}));      $ENV{'form.show'}  = 'all'  if (! exists($ENV{'form.show'}));
     my $min = $ENV{'form.startwith'};      my $min = $ENV{'form.start'};
     my $max;      my $max;
     if ($ENV{'form.show'} eq 'all') {      if ($ENV{'form.show'} eq 'all') {
         $max = $total_results ;          $max = $total_results ;
     } else {      } else {
         $max = $min + $ENV{'form.show'};          $max = $min + $ENV{'form.show'} - 1;
           $max = $total_results if ($max > $total_results);
     }      }
     ##      ##
     ## Output links (if necessary) for 'prev' and 'next' pages.      ## Output links (if necessary) for 'prev' and 'next' pages.
     ##      ##
           $r->print
           ('<center>'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                               "table=".$ENV{'form.table'}.
                               "&phase=results".
                               "&persistent_db_id=".$ENV{'form.persistent_db_id'})
            ."</center>\n"
            );
       if ($total_results == 0) {
           $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="1">'.
                     '<h3>'.&mt('There are currently no results').'.</h3>'.
                     "</form></body></html>");
           return;
       } else {
           $r->print
               ("<center>Results $min to $max out of $total_results</center>\n");
       }
     ##      ##
     ## Get results from MySQL table      ## Get results from MySQL table
     ##      ##
     my @Results = &Apache::lonmysql::get_rows($table,      my @Results = &Apache::lonmysql::get_rows($table,
                                               'id>'.$min.' AND id<='.$max);                                                'id>='.$min.' AND id<='.$max);
     ##      ##
     ## Loop through the results and output them.      ## Loop through the results and output them.
     ##      ##
     foreach my $row (@Results) {      foreach my $row (@Results) {
           if ($connection->aborted()) {
               &cleanup();
               return;
           }
         my %Fields = %{&parse_row(@$row)};          my %Fields = %{&parse_row(@$row)};
         my $output="<p>\n";          my $output="<p>\n";
         $output.=&catalogmode_output($Fields{'title'},$Fields{'url'});          my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'},
                                          $Fields{'id'},$checkbox_num++);
         # Render the result into html          # Render the result into html
         $output.= &$viewfunction(%Fields);          $output.= &$viewfunction($prefix,%Fields);
         $output.="</p>\n<hr align='left' width='200' noshade />";  
         # Print them out as they come in.          # Print them out as they come in.
         $r->print($output);          $r->print($output);
         $r->rflush();          $r->rflush();
     }      }
     if (@Results < 1) {      if (@Results < 1) {
         $r->print("There were no results matching your query");          $r->print(&mt("There were no results matching your query"));
       } else {
           $r->print
               ('<center>'.
                &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                                   "table=".$ENV{'form.table'}.
                                   "&phase=results".
                                   "&persistent_db_id=".
                                   $ENV{'form.persistent_db_id'})
                ."</center>\n"
                );
     }      }
     $r->print("</body></html>");      $r->print("</form></body></html>");
     $r->rflush();      $r->rflush();
     untie %groupsearch_db;      untie %groupsearch_db if (tied(%groupsearch_db));
     return;      return;
 }  }
   
Line 1786  CATALOGCONTROLS Line 2443  CATALOGCONTROLS
   
 =pod  =pod
   
 =item &catalogmode_output($title,$url)  =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
   
 Returns html needed for the various catalog modes.  Gets inputs from  Returns html needed for the various catalog modes.  Gets inputs from
 $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db and $fnum   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
 (local variable).  
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 {   
 my $fnum;  
   
 sub catalogmode_output {  sub catalogmode_output {
     my $output = '';      my $output = '';
     my ($title,$url) = @_;      my ($title,$url,$fnum,$checkbox_num) = @_;
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
         $title=~ s/\'/\\'/g; # ' Escape single quotes.          $title=~ s/\'/\\\'/g;
         if ($ENV{'form.catalogmode'} eq 'interactive') {          if ($ENV{'form.catalogmode'} eq 'interactive') {
             $output.=<<END               $output.=<<END 
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
Line 1811  onClick="javascript:select_data('$title' Line 2464  onClick="javascript:select_data('$title'
 </font>  </font>
 END  END
         }          }
     }      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
     if ($ENV{'form.catalogmode'} eq 'groupsearch') {  
         $fnum+=0;  
         $groupsearch_db{"pre_${fnum}_link"}=$url;          $groupsearch_db{"pre_${fnum}_link"}=$url;
         $groupsearch_db{"pre_${fnum}_title"}=$title;          $groupsearch_db{"pre_${fnum}_title"}=$title;
         $output.=<<END;          $output.=<<END;
 <font size='-1'>  <font size='-1'>
 <input type="checkbox" name="returnvalues" value="SELECT"  <input type="checkbox" name="returnvalues" value="SELECT"
 onClick="javascript:queue($fnum)" />  onClick="javascript:queue($checkbox_num,$fnum)" />
 </font>  </font>
 END  END
         $fnum++;  
     }      }
     return $output;      return $output;
 }  }
   
 }  
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 1845  sub parse_row { Line 2493  sub parse_row {
     my @Row = @_;      my @Row = @_;
     my %Fields;      my %Fields;
     for (my $i=0;$i<=$#Row;$i++) {      for (my $i=0;$i<=$#Row;$i++) {
         $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]);          $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
     }      }
     $Fields{'language'} =       $Fields{'language'} = 
         &Apache::loncommon::languagedescription($Fields{'lang'});          &Apache::loncommon::languagedescription($Fields{'language'});
     $Fields{'copyrighttag'} =      $Fields{'copyrighttag'} =
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
     $Fields{'mimetag'} =      $Fields{'mimetag'} =
Line 1864  sub parse_row { Line 2512  sub parse_row {
 =item &parse_raw_result()  =item &parse_raw_result()
   
 Takes a line from the file of results and parse it.  Returns a hash   Takes a line from the file of results and parse it.  Returns a hash 
 with keys for the following fields:  with keys according to column labels
 'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes',   
 'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate',   
 'lastrevisiondate'.  
   
 In addition, the following tags are set by calling the appropriate   In addition, the following tags are set by calling the appropriate 
 lonnet function: 'language', 'cprtag', 'mimetag'.  lonnet function: 'language', 'copyrighttag', 'mimetag'.
   
 The 'title' field is set to "Untitled" if the title field is blank.  The 'title' field is set to "Untitled" if the title field is blank.
   
Line 1885  sub parse_raw_result { Line 2530  sub parse_raw_result {
     # Check for a comma - if it is there then we do not need to unescape the      # Check for a comma - if it is there then we do not need to unescape the
     # string.  There seems to be some kind of problem with some items in      # string.  There seems to be some kind of problem with some items in
     # the database - the entire string gets sent out unescaped...?      # the database - the entire string gets sent out unescaped...?
     unless ($result =~ /,/) {  #    unless ($result =~ /,/) {
         $result = &Apache::lonnet::unescape($result);  #        $result = &Apache::lonnet::unescape($result);
     }  #    }
     my @fields=map {  # conclude from self to others regarding fields
         &Apache::lonnet::unescape($_);      my %Fields=&Apache::lonmeta::metadata_col_to_hash(
     } (split(/\,/,$result));   map {
     my ($title,$author,$subject,$url,$keywords,$version,   &Apache::lonnet::unescape($_);
         $notes,$abstract,$mime,$lang,   } (split(/\,/,$result))
         $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;        );
     my %Fields =   # prettier display
         ( title     => &Apache::lonnet::unescape($title),  
           author    => &Apache::lonnet::unescape($author),  
           subject   => &Apache::lonnet::unescape($subject),  
           url       => &Apache::lonnet::unescape($url),  
           keywords  => &Apache::lonnet::unescape($keywords),  
           version   => &Apache::lonnet::unescape($version),  
           notes     => &Apache::lonnet::unescape($notes),  
           abstract  => &Apache::lonnet::unescape($abstract),  
           mime      => &Apache::lonnet::unescape($mime),  
           lang      => &Apache::lonnet::unescape($lang),  
           owner     => &Apache::lonnet::unescape($owner),  
           copyright => &Apache::lonnet::unescape($copyright),  
           creationdate     => &Apache::lonnet::unescape($creationdate),  
           lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate)  
         );  
     $Fields{'language'} =       $Fields{'language'} = 
         &Apache::loncommon::languagedescription($Fields{'lang'});          &Apache::loncommon::languagedescription($Fields{'language'});
     $Fields{'copyrighttag'} =      $Fields{'copyrighttag'} =
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
     $Fields{'mimetag'} =      $Fields{'mimetag'} =
Line 1925  sub parse_raw_result { Line 2555  sub parse_raw_result {
         $Fields{'title'}='Untitled';           $Fields{'title'}='Untitled'; 
     }      }
     unless ($ENV{'user.adv'}) {      unless ($ENV{'user.adv'}) {
         # What is this anyway?          # do not show descriptive information to non-advanced users
         $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 2015  Checked for existance & 'edit' mode. Line 2645  Checked for existance & 'edit' mode.
   
 =item 'form.form'  =item 'form.form'
   
   Contains the name of the form that has the input fields to set
   
 =item 'form.element'  =item 'form.element'
   
   the name of the input field to put the URL into
   
   =item 'form.titleelement'
   
   the name of the input field to put the title into
   
 =back  =back
   
 =cut  =cut
Line 2024  Checked for existance & 'edit' mode. Line 2662  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode,$pretty_query) = @_;      my ($importbutton,$closebutton) = @_;
     $mode = lc($mode);      my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     my $title;  
     if ($mode eq 'advanced') {  
         $title = "Advanced Search Results";  
     } elsif ($mode eq 'basic') {  
         $title = "Basic Search Results";  
     }  
     my $result = '';      my $result = '';
     # output beginning of search page      # output beginning of search page
     $result.=<<BEGINNING;  
 <html>  
 <head>  
 <title>$title</title>  
 BEGINNING  
     # conditional output of script functions dependent on the mode in      # conditional output of script functions dependent on the mode in
     # which the search was invoked      # which the search was invoked
     if ($ENV{'form.catalogmode'} eq 'interactive'){      if ($ENV{'form.catalogmode'} eq 'interactive'){
Line 2048  BEGINNING Line 2675  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 2065  SCRIPT Line 2692  SCRIPT
         } elsif ($ENV{'form.mode'} eq 'edit') {          } elsif ($ENV{'form.mode'} eq 'edit') {
             my $form = $ENV{'form.form'};              my $form = $ENV{'form.form'};
             my $element = $ENV{'form.element'};              my $element = $ENV{'form.element'};
               my $titleelement = $ENV{'form.titleelement'};
       my $changetitle;
       if (!$titleelement) {
    $changetitle='function changeTitle(val) {}';
       } else {
       $changetitle=<<END;
   function changeTitle(val) {
       if (parent.targetwin.document) {
           parent.targetwin.document.forms["$form"].elements["$titleelement"].value=val;
       } else {
    var url = 'forms[\"$form\"].elements[\"$titleelement\"].value';
           alert("Unable to transfer data to "+url);
       }
   }
   END
               }
   
             $result.=<<SCRIPT;              $result.=<<SCRIPT;
 <script type="text/javascript">  <script type="text/javascript">
 function select_data(title,url) {  function select_data(title,url) {
     changeURL(url);      changeURL(url);
     self.close();      changeTitle(title);
 }      parent.close();
 function changeTitle(val) {  
 }  }
   $changetitle
 function changeURL(val) {  function changeURL(val) {
     if (window.opener.document) {      if (parent.targetwin.document) {
         window.opener.document.forms["$form"].elements["$element"].value=val;          parent.targetwin.document.forms["$form"].elements["$element"].value=val;
     } else {      } else {
  var url = 'forms[\"$form\"].elements[\"$element\"].value';   var url = 'forms[\"$form\"].elements[\"$element\"].value';
         alert("Unable to transfer data to "+url);          alert("Unable to transfer data to "+url);
Line 2087  SCRIPT Line 2731  SCRIPT
     }      }
     $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';      $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
 <script type="text/javascript">  <script type="text/javascript">
     function select_data(title,url) {      function queue(checkbox_num,val) {
 // alert('DEBUG: Should be storing '+title+' and '+url);          if (document.forms.results.returnvalues.length != "undefined" &&
     }              typeof(document.forms.results.returnvalues.length) == "number") {
     function queue(val) {              if (document.forms.results.returnvalues[checkbox_num].checked) {
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {                  parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
     document.forms.results.acts.value+='1a'+val+'b';              } else {
  }                  parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
  else {              }
     document.forms.results.acts.value+='0a'+val+'b';          } else {
  }              if (document.forms.results.returnvalues.checked) {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b';
               } else {
                   parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b';
               }
           }
     }      }
     function select_group() {      function select_group() {
  window.location=   parent.window.location=
     "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+      "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
     document.forms.results.acts.value;      parent.statusframe.document.forms.statusform.elements.Queue.value;
     }  
 </script>  
 SCRIPT  
     $result.=<<SCRIPT;  
 <script type="text/javascript">  
     function displayinfo(val) {  
  popwin.document.forms.popremain.sdetails.value=val;  
     }  
     function openhelp(val) {  
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',  
      'scrollbars=1,width=400,height=300');  
  openhelpwin.focus();  
     }  
     function abortsearch(val) {  
  popwin.close();  
     }      }
 </script>  </script>
 SCRIPT  SCRIPT
     $result.=<<END;      $result.=<<END;
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <form name="results" method="post" action="" >
 <h1>$title</h1>  <input type="hidden" name="Queue" value="" />
   $importbutton
 END  END
     if ($pretty_query) {  
         $result .= "<p>Search query: $pretty_query</p>";  
     }  
     return $result;      return $result;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub search_status_header {
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       return <<ENDSTATUS;
   <html><head><title>Search Status</title></head>
   $bodytag
   <h3>Search Status</h3>
   Sending search request to LON-CAPA servers.<br />
   ENDSTATUS
   }
   
   sub results_link {
       my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
           "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $results_link = $basic_link."&phase=results".
           "&pause=1"."&start=1";
       return $results_link;
   }
   
   ######################################################################
   ######################################################################
   sub print_frames_interface {
       my $r = shift;
       my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
           "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $run_search_link = $basic_link."&phase=run_search";
       my $results_link = &results_link();
       my $result = <<"ENDFRAMES";
   <html>
   <head>
   <script>
   var targetwin = opener;
   var queue = '';
   </script>
   <title>LON-CAPA Digital Library Search Results</title>
   </head>
   <frameset rows="150,*">
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   </frameset>
   </html>
   ENDFRAMES
   
       $r->print($result);
       return;
   }
   
   ######################################################################
   ######################################################################
   
 =pod   =pod 
   
Line 2154  extra custom metadata to show. Line 2834  extra custom metadata to show.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>$prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
     target='search_preview'>$values{'title'}</a></h3>      target='search_preview'>$values{'title'}</a></b>
 <p>  <p>
 <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />  <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />
   
Line 2166  sub detailed_citation_view { Line 2847  sub detailed_citation_view {
 <b>Notes:         </b> $values{'notes'}<br />  <b>Notes:         </b> $values{'notes'}<br />
 <b>MIME Type:     </b> $values{'mimetag'}<br />  <b>MIME Type:     </b> $values{'mimetag'}<br />
 <b>Language:      </b> $values{'language'}<br />  <b>Language:      </b> $values{'language'}<br />
 <b>Copyright/Distribution:</b> $values{'cprtag'}<br />  <b>Copyright/Distribution:</b> $values{'copyrighttag'}<br />
 </p>  </p>
 $values{'extrashow'}  $values{'extrashow'}
 <p>  <p>
 $values{'shortabstract'}  $values{'shortabstract'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 2184  END Line 2866  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
 <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   $prefix<img src="$icon" /><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
    target='search_preview'>$values{'author'}</a><br />     target='search_preview'>$values{'author'}</a><br />
 $values{'title'}<br />  $values{'title'}<br />
 $values{'owner'} -- $values{'lastrevisiondate'}<br />  $values{'owner'} -- $values{'lastrevisiondate'}<br />
 $values{'copyrighttag'}<br />  $values{'copyrighttag'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  </p>
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 2206  END Line 2889  END
   
 =pod   =pod 
   
   =item &compact_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
       my $result=<<END;
   $prefix <img src="$icon" /> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"  target='search_preview'>
   $values{'title'}</a>
   <b>$values{'author'}</b><br />
   END
       return $result;
   }
   
   
   ######################################################################
   ######################################################################
   
   =pod 
   
 =item &fielded_format_view()   =item &fielded_format_view() 
   
 =cut  =cut
Line 2213  END Line 2919  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
     my $result=<<END;      my $result=<<END;
   $prefix <img src="$icon" />
 <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
               target='search_preview'>$values{'url'}</a>                target='search_preview'>$values{'url'}</a>
 <br />  <br />
Line 2233  sub fielded_format_view { Line 2941  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 2251  END Line 2960  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 2266  sub xml_sgml_view { Line 2976  sub xml_sgml_view {
 &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;  &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;
 &lt;/mimeInfo&gt;  &lt;/mimeInfo&gt;
 &lt;languageInfo&gt;  &lt;languageInfo&gt;
 &lt;language&gt;$values{'lang'}&lt;/language&gt;  &lt;language&gt;$values{'language'}&lt;/language&gt;
 &lt;languagetag&gt;$values{'language'}&lt;/languagetag&gt;  &lt;languagetag&gt;$values{'languagetag'}&lt;/languagetag&gt;
 &lt;/languageInfo&gt;  &lt;/languageInfo&gt;
 &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;  &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;
 &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;  &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;
Line 2281  sub xml_sgml_view { Line 2991  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 2313  sub filled { Line 3024  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,$closebutton)=@_;      my ($r,$closebutton,$parms,$hidden_fields)=@_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
Line 2327  sub output_blank_field_error { Line 3048  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">
 $hidden_fields  $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 2368  Inputs: Line 3088  Inputs:
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_date_error {  sub output_date_error {
     my ($r,$message,$closebutton)=@_;      my ($r,$message,$closebutton,$hidden_fields)=@_;
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>The LearningOnline Network with CAPA</title>
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
Line 2384  $hidden_fields Line 3105  $hidden_fields
 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 2421  sub start_fresh_session { Line 3142  sub start_fresh_session {
   
 1;  1;
   
   sub cleanup {
       if (tied(%groupsearch_db)) {
           unless (untie(%groupsearch_db)) {
     &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
           }
       }
       &untiehash();
       &Apache::lonmysql::disconnect_from_db();
   }
   
 __END__  __END__
   
 =pod  =pod
Removed from v.1.145  
changed lines
  Added in v.1.199

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