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

Diff for /loncom/interface/lonsearchcat.pm between versions 1.144 and 1.213

version 1.144, 2002/07/26 16:37:58 version 1.213, 2004/04/21 15:48:34
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 56  described at http://www.lon-capa.org. Line 48  described at http://www.lon-capa.org.
 lonsearchcat presents the user with an interface to search the LON-CAPA  lonsearchcat presents the user with an interface to search the LON-CAPA
 digital library.  lonsearchcat also initiates the execution of a search  digital library.  lonsearchcat also initiates the execution of a search
 by sending the search parameters to LON-CAPA servers.  The progress of   by sending the search parameters to LON-CAPA servers.  The progress of 
 search (on a server basis) is displayed to the user in a seperate window.  search (on a server basis) is displayed to the user in a separate window.
   
 =head1 Internals  =head1 Internals
   
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::lonmeta;
 # ---------------------------------------- variables used throughout the module  use Apache::lonhtmlcommon;
   use Apache::lonlocal;
 ######################################################################  use LONCAPA::lonmetadata();
 ######################################################################  use HTML::Entities();
   
 =pod   
   
 =item Global variables  
   
 =over 4  
   
 =item $closebutton  
   
 button that closes the search window  
   
 =item $importbutton  
   
 button to take the select results and go to group sorting  
   
 =item %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.  
   
 =item $results_db  
   
 The name of the database results from searches are put in.  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
 # -- dynamically rendered interface components  ## Global variables
 my $closebutton;  # button that closes the search window  ##
 my $importbutton; # button to take the selected results and go to group sorting  
   
 # -- miscellaneous variables  
 my %groupsearch_db;     # database hash  
 my $diropendb = "";    # db file  
   
 my $results_db = "";  
 #             View Description           Function Pointer  
 my %Views = ("Detailed Citation View" => \&detailed_citation_view,  
              "Summary View"           => \&summary_view,  
              "Fielded Format"         => \&fielded_format_view,  
              "XML/SGML"               => \&xml_sgml_view );  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   my %groupsearch_db;  # Database hash used to save values for the 
 =pod                        # groupsearch RAT interface.
   my %persistent_db;   # gdbm hash which holds data which is supposed to
 =item &handler() - main handler invoked by httpd child                       # persist across calls to lonsearchcat.pm
   
 =item Variables  # The different view modes and associated functions
   
 =over 4  my %Views = ("detailed" => \&detailed_citation_view,
        "summary"  => \&summary_view,
 =item $hidden       "fielded"  => \&fielded_format_view,
        "xml"      => \&xml_sgml_view,
 holds 'hidden' html forms       "compact"  => \&compact_view);
   
 =item $scrout  
   
 string that holds portions of the screen output  
   
 =back   
   
 =cut  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
     untie %groupsearch_db;  #    &set_defaults();
       #
     $r->content_type('text/html');      # set form defaults
       #
       my $hidden_fields;# Hold all the hidden fields used to keep track
                         # of the search system state
       my $importbutton; # button to take the selected results and go to group 
                         # sorting
       my $diropendb;    # The full path to the (temporary) search database file.
                         # This is set and used in &handler() and is also used in 
                         # &output_results().
       my $bodytag;  # LON-CAPA standard body tag, gotten from 
                     # &Apache::lonnet::bodytag. 
                     # No title, no table, just a <body> tag.
   
       my $loaderror=&Apache::lonnet::overloaderror($r);
       if ($loaderror) { return $loaderror; }
   
       my $closebutton;  # button that closes the search window 
                         # This button is different for the RAT compared to
                         # normal invocation.
       #
       &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
     ##      ##
       ## Prevent caching of the search interface window.  Hopefully this means
       ## we will get the launch=1 passed in a little more.
       &Apache::loncommon::no_cache($r);
       ## 
       ## Pick up form fields passed in the links.
       ##
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element','pause',
                 'phase','persistent_db_id','table','start','show',
                 'cleargroupsort','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/".
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";          "$ENV{'user.domain'}_$ENV{'user.name'}_searchcat.db";
     $results_db = "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).      #
         '_'.&Apache::lonnet::escape($ENV{'user.name'})."_searchresults.db";      # set the name of the persistent database
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      #          $ENV{'form.persistent_db_id'} can only have digits in it.
              ['catalogmode','launch','acts','mode','form','element',      if (! exists($ENV{'form.persistent_db_id'}) ||
               'reqinterface']);          ($ENV{'form.persistent_db_id'} =~ /\D/) ||
           ($ENV{'form.launch'} eq '1')) {
           $ENV{'form.persistent_db_id'} = time;
       }
       $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       my $persistent_db_file = "/home/httpd/perl/tmp/".
           &Apache::lonnet::escape($domain).
               '_'.&Apache::lonnet::escape($ENV{'user.name'}).
                   '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
       ##
       &Apache::lonhtmlcommon::clear_breadcrumbs();
       if (exists($ENV{'request.course.id'}) && $ENV{'request.course.id'} ne '') {
           &Apache::lonhtmlcommon::add_breadcrumb
                ({href=>'/adm/searchcat?'.
                      'catalogmode='.$ENV{'form.catalogmode'}.
                      '&launch='.$ENV{'form.launch'}.
                      '&mode='.$ENV{'form.mode'},
                 text=>"Course and Catalog Search",
                 bug=>'Searching',});
       } else {
           &Apache::lonhtmlcommon::add_breadcrumb
                ({href=>'/adm/searchcat?'.
                      'catalogmode='.$ENV{'form.catalogmode'}.
                      '&launch='.$ENV{'form.launch'}.
                      '&mode='.$ENV{'form.mode'},
                 text=>"Catalog Search",
                 bug=>'Searching',});
       }
       #
       if (! &get_persistent_form_data($persistent_db_file)) {
           if ($ENV{'form.phase'} =~ /(run_search|results)/) {
               &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ".
                                        "from $persistent_db_file");
               $r->print(<<END);
   <html>
   <head><title>LON-CAPA Search Error</title></head>
   $bodytag
   We were unable to retrieve data describing your search.  This is a serious
   error and has been logged.  Please alert your LON-CAPA administrator.
   </body>
   </html>
   END
               return OK;
           }
       }
     ##      ##
     ## Clear out old values from 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;
  }   }
     }      }
     ##      ##
     ## Produce some output, so people know it is working      ## Configure hidden fields
     ##      ##
     $r->print("\n");      $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'.
     $r->rflush;          $ENV{'form.persistent_db_id'}.'" />'."\n";
       if (exists($ENV{'form.catalogmode'})) {
           $hidden_fields .= '<input type="hidden" name="catalogmode" value="'.
                   $ENV{'form.catalogmode'}.'" />'."\n";
       }
       if (exists($ENV{'form.form'})) {
           $hidden_fields .= '<input type="hidden" name="form" value="'.
                   $ENV{'form.form'}.'" />'."\n";
       }
       if (exists($ENV{'form.element'})) {
           $hidden_fields .= '<input type="hidden" name="element" value="'.
                   $ENV{'form.element'}.'" />'."\n";
       }
       if (exists($ENV{'form.titleelement'})) {
           $hidden_fields .= '<input type="hidden" name="titleelement" value="'.
                   $ENV{'form.titleelement'}.'" />'."\n";
       }
       if (exists($ENV{'form.mode'})) {
           $hidden_fields .= '<input type="hidden" name="mode" value="'.
                   $ENV{'form.mode'}.'" />'."\n";
       }
     ##      ##
     ## Configure dynamic components of interface      ## Configure dynamic components of interface
     ##      ##
     my $hidden;       # Holds 'hidden' html forms  
     if ($ENV{'form.catalogmode'} eq 'interactive') {      if ($ENV{'form.catalogmode'} eq 'interactive') {
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".          $closebutton="<input type='button' name='close' value='CLOSE' ";
     "\n";          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
         $closebutton="<input type='button' name='close' value='CLOSE' ".      $closebutton .="onClick='parent.close()'";
     "onClick='self.close()'>"."\n";          } else {
               $closebutton .="onClick='self.close()'";
           }
           $closebutton .=">\n";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {      } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
  $hidden=<<END;          $closebutton="<input type='button' name='close' value='CLOSE' ";
 <input type='hidden' name='catalogmode' value='groupsearch'>          if ($ENV{'form.phase'} =~ /(results|run_search)/) {
 END      $closebutton .="onClick='parent.close()'";
         $closebutton=<<END;          } else {
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>              $closebutton .="onClick='self.close()'";
 END          }
           $closebutton .= ">";
         $importbutton=<<END;          $importbutton=<<END;
 <input type='button' name='import' value='IMPORT'  <input type='button' name='import' value='IMPORT'
 onClick='javascript:select_group()'>  onClick='javascript:select_group()'>
 END  END
       } else {
           $closebutton = '';
           $importbutton = '';
       }
       ##
       ## Sanity checks on form elements
       ##
       if (!defined($ENV{'form.viewselect'})) {
           if (($ENV{'form.catalogmode'} eq 'groupsearch') ||
               ($ENV{'form.catalogmode'} eq 'interactive')) {
               $ENV{'form.viewselect'} ="Compact View";
           } else {
               $ENV{'form.viewselect'} ="Detailed Citation View";
           }
     }      }
     $hidden .= &make_persistent({ "form.mode"    => $ENV{'form.mode'},      $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
                                   "form.form"    => $ENV{'form.form'},      $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
                                   "form.element" => $ENV{'form.element'},      #
                                   "form.date"    => 2 });      $ENV{'form.searchmode'} = 'basic';
     ##      if ($ENV{'form.phase'} eq 'adv_search' ||
     ##  What are we doing?          $ENV{'form.phase'} eq 'disp_adv') {
     ##          $ENV{'form.searchmode'} = 'advanced';
     my $searchtype;      } elsif ($ENV{'form.phase'} eq 'course_search') {
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');          $ENV{'form.searchmode'} = 'course_search';
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');      }
     if ($searchtype) {      #
       if ($ENV{'form.searchmode'} eq 'advanced') {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Advanced Search",
                     bug=>'Searching',});
       } elsif ($ENV{'form.searchmode'} eq 'course search') {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'/adm/searchcat?phase=disp_adv&'.
                     'catalogmode='.$ENV{'form.catalogmode'}.
                     '&launch='.$ENV{'form.launch'}.
                     '&mode='.$ENV{'form.mode'},
                     text=>"Course Search",
                     bug=>'Searching',});
       }
       ##
       ## 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')) {
           # Set up table
           if (! defined(&create_results_table())) {
       my $errorstring=&Apache::lonmysql::get_error();
               &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
                                        'needed table.  lonmysql error:'.
                                        $errorstring);
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to create table in which to store search results.  
   The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           delete($ENV{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
               $r->print(<<END);
   <html><head><title>Search Error</title></head>
   $bodytag
   Unable to properly store search information.  The search has been aborted.
   </body>
   </html>
   END
               return OK;
           }
           #
         # We are running a search          # 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);              ($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);                  = &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 },
         &display_results($r,$searchtype,$hidden,$importbutton,                           $persistent_db_file);
                          $closebutton);          ##
           ## Print out the frames interface
         $r->rflush();          ##
     } else {          &print_frames_interface($r);
         #  
         # We need to get information to search on  
         #  
         # Set the default view if it is not already set.  
         if (!defined($ENV{'form.viewselect'})) {  
             $ENV{'form.viewselect'} ="Detailed Citation View";  
         }  
         # Output the advanced interface  
         if ($ENV{'form.reqinterface'} eq 'advanced') {  
             $r->print(&advanced_search_form($closebutton,$hidden));  
         } else {   
             # Output normal search interface  
             $r->print(&basic_search_form($closebutton,$hidden));  
         }  
     }      }
     return OK;      return OK;
 }   } 
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
   ##   Course Search
   ##
   ######################################################################
   ######################################################################
   {   # Scope the course search to avoid global variables
   #
   # Variables For course search
   my %alreadyseen;
   my %hash;
   my $totalfound;
   
   sub course_search {
       my $r=shift;
       my $bodytag=&Apache::loncommon::bodytag('Course Search').
    &Apache::loncommon::help_open_bug('Searching');
       my $pretty_search_string = '<b>'.$ENV{'form.courseexp'}.'</b>';
       my $search_string = $ENV{'form.courseexp'};
       my @New_Words;
       if ($ENV{'form.crsrelated'}) {
           ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
           if (@New_Words) {
               $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
           } else {
               $pretty_search_string .= ' '.&mt('with no related words').".";
           }
       }
       my $fulltext=$ENV{'form.crsfulltext'};
       my @allwords=($search_string,@New_Words);
       $totalfound=0;
       $r->print('<html><head><title>LON-CAPA Course Search</title></head>'.
         $bodytag.'<hr /><center><font size="+2" face="arial">'.$pretty_search_string.'</font></center><hr />');
       $r->rflush();
   # ======================================================= Go through the course
       undef %alreadyseen;
       %alreadyseen=();
       my $c=$r->connection;
       if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
               &GDBM_READER(),0640)) {
           foreach (keys %hash) {
               if ($c->aborted()) { last; }
               if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
                   &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
                                @allwords);
               }
           }
           untie(%hash);
       }
       unless ($totalfound) {
    $r->print('<p>'.&mt('No resources found').'.</p>');
       }
   # =================================================== Done going through course
       $r->print('</body></html>');
   }
   
 =pod   # =============================== This pulls up a resource and its dependencies
   
 =item &basic_search_form()   
   
 Returns a scalar which holds html for the basic search form.  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);
          }
       }
   }
   
 =cut  sub untiehash {
       if (tied(%hash)) {
           untie(%hash);
       }
   }
   
 ######################################################################  } # End of course search scoping
 ######################################################################  
   
 sub basic_search_form{  sub search_html_header {
     my ($closebutton,$hidden) = @_;      my $Str = <<ENDHEADER;
     my $scrout=<<"ENDDOCUMENT";  
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>The LearningOnline Network with CAPA</title>
Line 313  sub basic_search_form{ Line 512  sub basic_search_form{
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF">  ENDHEADER
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />      return $Str;
 <h1>Search Catalog</h1>  }
 <form method="post" action="/adm/searchcat">  
 $hidden  ######################################################################
 <h3>Basic Search</h3>  ######################################################################
   
   =pod 
   
   =item &print_basic_search_form() 
   
   Prints the form for the basic search.  Sorry the name is so cryptic.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_basic_search_form {
       my ($r,$closebutton,$hidden_fields) = @_;
       my $bodytag=&Apache::loncommon::bodytag('Search').
           &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Finding_Resources',
                                               undef,undef,! $ENV{'form.launch'});
       my $scrout = &search_html_header().$bodytag;
       if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
           # Define interface components
           my $userelatedwords=
               &mt('[_1] use related words',
                   &Apache::lonhtmlcommon::checkbox
                   ('related',$ENV{'form.related'}));
           my $onlysearchdomain=
               &mt('[_1] only search domain [_2]',
                   &Apache::lonhtmlcommon::checkbox
                   ('domains',$ENV{'form.domains'}),
                   $r->dir_config('lonDefDomain'));
           my $adv_search_link = 
               '<a href="/adm/searchcat?'.
               'phase=disp_adv&'.
               'catalogmode='.$ENV{'form.catalogmode'}.
               '&launch='.$ENV{'form.launch'}.
               '&mode='.$ENV{'form.mode'}.
               '">'.&mt('Advanced Search').'</a>';
           #
           $scrout.='<form name="loncapa_search" method="post" '.
               'action="/adm/searchcat">'.
               '<input type="hidden" name="phase" value="basic_search" />'.
               $hidden_fields;
           #
           $scrout .= '<center>'.$/;
           if ($ENV{'request.course.id'}) {
               $scrout .= '<h1>'.&mt('LON-CAPA Catalog Search').'</h1>';
           } else {
               # No need to tell them they are searching
               $scrout.= ('<br />'x2);
           }
           $scrout.='<table>'.
               '<tr><td align="center" valign="top">'.
               &Apache::lonhtmlcommon::textbox('basicexp',
                                               $ENV{'form.basicexp'},50).'<br />'.
               '<font size="-1">'.&searchhelp().'</font>'.'</td>'.
               '<td><font size="-1">'.
               '<nobr>'.('&nbsp;'x3).$adv_search_link.'</nobr>'.'<br />'.
               '<nobr>'.('&nbsp;'x1).$userelatedwords.'</nobr>'.'<br />'.
               '<nobr>'.('&nbsp;'x1).$onlysearchdomain.'</nobr>'.'<br />'.
               '</font></td>'.
               '</tr>'.$/;
           #
   #        $scrout .= '<tr><td align="center">'.
   #            '<font size="-1">'.
   #            $userelatedwords.('&nbsp;'x3).
   #            $onlysearchdomain.('&nbsp;'x2).$adv_search_link.
   #            '</font>'.
   #            '</td></tr>'.$/;
           $scrout .= '<tr><td align="center" colspan="2">'.
               '<font size="-1">'.
               '<input type="submit" name="basicsubmit" '.
               'value="'.&mt('Search').'" />'.
               ('&nbsp;'x2).$closebutton.('&nbsp;'x2).&viewoptions().
               '</font>'.
               '</td></tr>'.$/;
           $scrout .= '</table>'.$/.'</center>'.'</form>';
       }
       if ($ENV{'request.course.id'}) {
    my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
                                              'header' => 'Course Search',
    'note' => 'Enter terms or phrases, then press "Search" below',
    'use' => 'use related words',
    'full' =>'fulltext search (time consuming)'
      );
           $scrout.=(<<ENDCOURSESEARCH);
   <form name="loncapa_search" method="post" action="/adm/searchcat">
   <center>
   <hr />
   <h1>$lt{'header'}</h1>    
   <input type="hidden" name="phase" value="course_search" />
   $hidden_fields
 <p>  <p>
 Enter terms or phrases separated by AND, OR, or NOT   $lt{'note'}.
 then press SEARCH below.  
 </p>  </p>
 <p>  <p>
 <table>  <table>
 <tr><td>  <tr><td>
 ENDDOCUMENT  ENDCOURSESEARCH
     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).          $scrout.='&nbsp;'.
         '&nbsp;';              &Apache::lonhtmlcommon::textbox('courseexp',
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});                                    $ENV{'form.courseexp'},40);
 #    $scrout.='<font color="#800000">Search historic archives</font>';          my $crscheckbox = 
     my $checkbox = &simplecheckbox('related',$ENV{'form.related'});              &Apache::lonhtmlcommon::checkbox('crsfulltext',
     $scrout.=<<END;                                     $ENV{'form.crsfulltext'});
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr>          my $relcheckbox = 
 <tr><td>$checkbox use related words</td><td></td></tr>              &Apache::lonhtmlcommon::checkbox('crsrelated',
 </table>     $ENV{'form.crsrelated'});
 </p>          $scrout.=(<<ENDENDCOURSE);
 <p>  </td></tr>
 &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;  <tr><td>$relcheckbox $lt{'use'}</td><td></td></tr>
 $closebutton  <tr><td>$crscheckbox $lt{'full'}</td><td></td></tr>
 END  </table><p>
     $scrout.=&selectbox(undef,'viewselect',  &nbsp;<input type="submit" name="coursesubmit" value='$lt{'srch'}' />
  $ENV{'form.viewselect'},  
  undef,undef,undef,  
  sort(keys(%Views)));  
     $scrout.=<<ENDDOCUMENT;  
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  </p>
   </center>
 </form>  </form>
   ENDENDCOURSE
       }
       $scrout.=(<<ENDDOCUMENT);
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 361  ENDDOCUMENT Line 648  ENDDOCUMENT
   
 =item &advanced_search_form()   =item &advanced_search_form() 
   
 Returns a scalar which holds html for the advanced search form.  Prints the advanced search form.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub print_advanced_search_form{
 sub advanced_search_form{      my ($r,$closebutton,$hidden_fields) = @_;
     my ($closebutton,$hidden) = @_;      my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
          'reset' => 'Reset',
          'help' => 'Help');
     my $advanced_buttons = <<"END";      my $advanced_buttons = <<"END";
 <p>  <p>
 <input type="submit" name="advancedsubmit" value='SEARCH' />  <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
 <input type="reset" name="reset" value='RESET' />  <input type="reset" name="reset" value='$lt{"reset"}' />
 $closebutton  $closebutton
 <input type="button" value="HELP" onClick="openhelp()" />  <input type="button" value="$lt{'help'}" onClick="openhelp()" />
 </p>  
 END  END
     if (!defined($ENV{'form.viewselect'})) {      my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search').
         $ENV{'form.viewselect'} ="Detailed Citation View";          &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching',
     }                                              'Finding_Resources',
     my $scrout=<<"ENDHEADER";                                              undef,undef,
 <html>                                              ! $ENV{'form.launch'});
 <head>      my $searchhelp=&searchhelp();
 <title>The LearningOnline Network with CAPA</title>      my $scrout=&search_html_header();
 <script type="text/javascript">      $scrout .= <<"ENDHEADER";
     function openhelp(val) {  $bodytag
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',  <form method="post" action="/adm/searchcat" name="advsearch">
      'scrollbars=1,width=600,height=300');  
  openhelpwin.focus();  
     }  
 </script>  
 </head>  
 <body bgcolor="#FFFFFF">  
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <h1>Advanced Catalog Search</h1>  
 <hr />  
 Enter terms or phrases separated by search operators   
 such as AND, OR, or NOT.<br />  
 <form method="post" action="/adm/searchcat">  
 $advanced_buttons  $advanced_buttons
 $hidden  
 <table>  
 <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>  
 <td>  
 ENDHEADER  ENDHEADER
     $scrout.=&selectbox(undef,'viewselect',      $scrout.=('&nbsp;'x2).&viewoptions().'</p>'.$hidden_fields. 
  $ENV{'form.viewselect'},          '<input type="hidden" name="phase" value="adv_search" />';
  undef,undef,undef,      my %fields=&Apache::lonmeta::fieldnames();
  sort(keys(%Views)));      #
     $scrout.="</td><td>Related<br />Words</td></tr>\n";      $scrout.= '<p>'.$searchhelp.'</p>'.
     $scrout.=&searchphrasefield_with_related('title',   'title'   ,          "<table>\n";
                                              $ENV{'form.title'});      my %related_word_search = 
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});          ('title'=>1,
     $scrout.=&searchphrasefield_with_related('subject', 'subject' ,           'author'=>0,
                                              $ENV{'form.subject'});           'owner'=>0,
     $scrout.=&searchphrasefield_with_related('keywords','keywords',           'authorspace'=>0,
                                              $ENV{'form.keywords'});           'modifyinguser'=>0,
     $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});           'keywords'=>1,
     $scrout.=&searchphrasefield_with_related('notes',   'notes'   ,           'notes'=>1,
                                              $ENV{'form.notes'});           'abstract'=>1,
     $scrout.=&searchphrasefield_with_related('abstract','abstract',           'standards'=>1,
                                              $ENV{'form.abstract'});           'mime'=>1,
     # Hack - an empty table row.           );
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";      #
     $scrout.=&searchphrasefield('file<br />extension','mime',      foreach my $field ('title','author','owner','authorspace','modifyinguser',
                         $ENV{'form.mime'});       'keywords','notes','abstract','standards','mime') {
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";   $scrout.='<tr><td align="right">'.&titlefield($fields{$field}).'</td><td>'.
     $scrout.=&searchphrasefield('publisher<br />owner','owner',      &Apache::lonmeta::prettyinput($field,
  $ENV{'form.owner'});                                            $ENV{'form.'.$field},
     $scrout.="</table>\n";                                            $field,
     $ENV{'form.category'}='any' unless length($ENV{'form.category'});                                            'advsearch',
     $scrout.=&selectbox('File Category','category',    $related_word_search{$field},
  $ENV{'form.category'},                                            '</td><td align="left">',
  'any','Any category',                                            $ENV{'form.'.$field.'_related'},
  undef,                                            50);
  (&Apache::loncommon::filecategories()));          if ($related_word_search{$field}) {
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});              $scrout .= 'related words';
     #----------------------------------------------------------------          } else {
     # Allow restriction to multiple domains.              $scrout .= '</td><td>&nbsp;';
     #   I make the crazy assumption that there will never be a domain 'any'.          }
     #          $scrout .= '</td></tr>'.$/;
     $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));  
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}   
                            :  ($ENV{'form.domains'}) );  
     my %domain_hash = ();  
     foreach (@allowed_domains) {  
         $domain_hash{$_}++;  
     }      }
     my @domains =&Apache::loncommon::get_domains();      foreach my $field ('lowestgradelevel','highestgradelevel') {
     # adjust the size of the select box   $scrout.='<tr>'.
     my $size = 4;              '<td align="right">'.&titlefield($fields{$field}).'</td>'.
     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);              '<td colspan="2">'.
     # standalone machines do not get to choose a domain to search.      &Apache::lonmeta::prettyinput($field,
     if ((scalar @domains) == 1) {                                            $ENV{'form.'.$field},
         $scrout .='<input type="hidden" name="domains" value="any" />'."\n";                                            $field,
     } else {                                            'advsearch',
         $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.    0).
             'DOMAINS</b></font><br />'.                                            '</td></tr>'.$/;
                 '<select name="domains" size="'.$size.'" multiple>'."\n".      }
                     '<option name="any" value="any" '.      $scrout.='<tr><td align="right">'.
                         ($domain_hash{'any'}? 'selected ' :'').   &titlefield(&mt('MIME Type Category')).'</td><td colspan="2">'. 
                         '>all domains</option>'."\n";      &Apache::loncommon::filecategoryselect('category',
         foreach my $dom (sort @domains) {     $ENV{'form.category'}).
             $scrout.="<option name=\"$dom\" ".      '</td></tr>'.$/;
                 ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";      $scrout.='<tr><td align="right" valign="top">'.
         }   &titlefield(&mt('Domains')).'</td><td colspan="2">'. 
         $scrout.="</select>\n";      &Apache::loncommon::domain_select('domains',
     }     $ENV{'form.domains'},1).
     #----------------------------------------------------------------      '</td></tr>'.$/;
     $scrout.=&selectbox('Limit by language','language',      $scrout .= "</table>\n<br />\n<table>\n";
  $ENV{'form.language'},'any','Any Language',      my %dates=&Apache::lonlocal::texthash
  \&{Apache::loncommon::languagedescription},          ('creationdatestart'     => 'Creation Date After',
  (&Apache::loncommon::languageids),           'creationdateend'       => 'Creation Date Before',
  );           'lastrevisiondatestart' => 'Last Revision Date After',
 # ------------------------------------------------ Compute date selection boxes           'lastrevisiondateend'   => 'Last Revision Date Before');
     $scrout.=<<CREATIONDATESTART;      foreach my $field (sort keys %dates) {
 <p>   $scrout.='<tr>'.
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>              '<td align="right">'.&titlefield($dates{$field}).'</td><td>'. 
 </font>      &Apache::lonhtmlcommon::date_setter('advsearch',$field,0,'',1).
 <br />      '</td></tr>'.$/;
 between:      }
 CREATIONDATESTART      $scrout.="</table>\n";
     $scrout.=&dateboxes('creationdatestart',1,1,1976,  
  $ENV{'form.creationdatestart_month'},  
  $ENV{'form.creationdatestart_day'},  
  $ENV{'form.creationdatestart_year'},  
  );  
     $scrout.="and:\n";  
     $scrout.=&dateboxes('creationdateend',12,31,2051,  
  $ENV{'form.creationdateend_month'},  
  $ENV{'form.creationdateend_day'},  
  $ENV{'form.creationdateend_year'},  
  );  
     $scrout.="</p>";  
     $scrout.=<<LASTREVISIONDATESTART;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:  
 </b></font>  
 <br />between:  
 LASTREVISIONDATESTART  
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,  
  $ENV{'form.lastrevisiondatestart_month'},  
  $ENV{'form.lastrevisiondatestart_day'},  
  $ENV{'form.lastrevisiondatestart_year'},  
  );  
     $scrout.=<<LASTREVISIONDATEEND;  
 and:  
 LASTREVISIONDATEEND  
     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,  
  $ENV{'form.lastrevisiondateend_month'},  
  $ENV{'form.lastrevisiondateend_day'},  
  $ENV{'form.lastrevisiondateend_year'},  
  );  
     $scrout.='</p>';  
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});  
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',  
  $ENV{'form.copyright'},  
  'any','Any copyright/distribution',  
  \&{Apache::loncommon::copyrightdescription},  
  (&Apache::loncommon::copyrightids),  
  );  
 # ------------------------------------------- Compute customized metadata field  
     $scrout.=<<CUSTOMMETADATA;  
 <p>  
 <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>  
 </font>  
 For resource-specific metadata, enter in an expression in the form of   
 <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />  
 <b>Example:</b> grandmother=75 OR grandfather=85  
 <br />  
 CUSTOMMETADATA  
     $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});  
     $scrout.=<<CUSTOMSHOW;  
 <p>  
 <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>  
 </font>  
 Enter in a space-separated list of special metadata fields to show  
 in a fielded listing for each record result.  
 <br />  
 CUSTOMSHOW  
     $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});  
     $scrout.=<<ENDDOCUMENT;      $scrout.=<<ENDDOCUMENT;
 $advanced_buttons  $advanced_buttons
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return $scrout;      $r->print($scrout);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 556  ENDDOCUMENT Line 764  ENDDOCUMENT
   
 =pod   =pod 
   
 =item &make_persistent()   =item &titlefield()
   
 Returns a scalar which holds the current ENV{'form.*'} values in  Inputs: title text
 a 'hidden' html input tag.  This allows search interface information  
 to be somewhat persistent.  Outputs: titletext with font wrapper
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub titlefield {
 sub make_persistent {      my $title=shift;
     my %save = %{shift()};      return $title;
     my $persistent='';  
     foreach my $name (keys %save) {  
  if ($name =~ /^form\./ && $name !~ /submit/) {  
             my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));  
     $name=~s/^form\.//;  
             foreach (@values) {  
                 s/\"/\'/g; # do not mess with html field syntax  
                 next if (! $_ );  
                 $persistent.=<<END;  
 <input type="hidden" name="$name" value="$_" />  
 END  
             }  
         }  
     }  
     return $persistent;  
 }  }
   
 ######################################################################  ######################################################################
 #                HTML form building functions                        #    
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item HTML form building functions  =item viewoptiontext()
   
 =over 4  
   
 =cut  
   
 ###############################################  
 ###############################################  
   
 =pod  
   
 =item &simpletextfield()   
   
 Inputs: $name,$value,$size  Inputs: codename for view option
   
 Returns a text input field with the given name, value, and size.    Outputs: displayed text
 If size is not specified, a value of 20 is used.  
   
 =cut  =cut
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   sub viewoptiontext {
 sub simpletextfield {      my $code=shift;
     my ($name,$value,$size)=@_;      my %desc=&Apache::lonlocal::texthash
     $size = 20 if (! defined($size));          ('detailed' => "Detailed Citation View",
     return '<input type="text" name="'.$name.           'xml' => 'XML/SGML',
         '" size="'.$size.'" value="'.$value.'" />';           'compact' => 'Compact View',
 }           'fielded' => 'Fielded Format',
            'summary' => 'Summary View');
 ###############################################      return $desc{$code};
 ###############################################  
   
 =pod  
   
 =item &simplecheckbox()  
   
 Inputs: $name,$value  
   
 Returns a simple check box with the given $name.  
 If $value eq 'on' the box is checked.  
   
 =cut  
   
 ###############################################  
 ###############################################  
   
 sub simplecheckbox {  
     my ($name,$value)=@_;  
     my $checked='';  
     $checked="checked" if $value eq 'on';  
     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';  
 }  }
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   
 =pod  =pod 
   
 =item &fieldtitle()  =item viewoptions()
   
 Input: $title  Inputs: none
   
 Returns a scalar with html which will display $title as a search  Outputs: text for box with view options
 field heading.  
   
 =cut  =cut
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   sub viewoptions {
 sub fieldtitle {      my $scrout="\n".'<nobr>';
     my $title = uc(shift());      if (! defined($ENV{'form.viewselect'})) { 
     return '<font color="#800000" face="helvetica"><b>'.$title.          $ENV{'form.viewselect'}='detailed'; 
         ':&nbsp;</b></font>';      }
       $scrout.=&Apache::lonmeta::selectbox('viewselect',
    $ENV{'form.viewselect'},
    \&viewoptiontext,
    sort(keys(%Views)));
       $scrout.= '&nbsp;&nbsp;';
       $scrout.=&Apache::lonmeta::selectbox('show',
    $ENV{'form.show'},
    undef,
    (10,20,50,100,1000,10000));
       $scrout .= ('&nbsp;'x2).&mt('Records per Page').'</nobr>'.$/;
       return $scrout;
 }  }
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   
 =pod  =pod 
   
 =item &searchphrasefield()  =item searchhelp()
   
 Inputs: $title,$name,$value  Inputs: none
   
 Returns html for a title line and an input field for entering search terms.  Outputs: return little blurb on how to enter searches
 The entry field (which is where the $name and $value are used) is a 50 column   
 simpletextfield.  The html returned is for a row in a three column table.  
   
 =cut  =cut
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
       sub searchhelp {
 sub searchphrasefield {      return &mt('Enter terms or phrases separated by AND, OR, or NOT');
     my ($title,$name,$value)=@_;  
     return '<tr><td>'.&fieldtitle($title).'</td><td>'.  
         &simpletextfield($name,$value,50)."</td><td>&nbsp;</td></tr>\n";  
 }  }
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   
 =pod  
   
 =item &searchphrasefield_with_related()  
   
 Inputs: $title,$name,$value  
   
 Returns html for a title line and an input field for entering search terms  
 and a check box for 'related words'.  The entry field (which is where the   
 $name and $value are used) is a 50 column simpletextfield.  The name of  
 the related words checkbox is "$name_related".  
   
 =cut  
   
 ###############################################  =pod 
 ###############################################  
       
 sub searchphrasefield_with_related {  
     my ($title,$name,$value)=@_;  
     return '<tr><td>'.&fieldtitle($title).'</td><td>'.  
         &simpletextfield($name,$value,50).'</td><td align="center">&nbsp;'.  
             &simplecheckbox($name.'_related',$ENV{'form.'.$name.'_related'}).  
                 "&nbsp;</td></tr>\n";  
 }  
   
 ###############################################  =item &get_persistent_form_data()
 ###############################################  
   
 =pod  Inputs: filename of database
   
 =item &dateboxes()  Outputs: returns undef on database errors.
   
 Returns html selection form elements for the specification of   This function is the reverse of &make_persistent() for form data.
 the day, month, and year.  Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If a form value already exists in $ENV, it will not be
   overwritten.  Form values that are array references may have values appended
   to them.
   
 =cut  =cut
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   sub get_persistent_form_data {
 sub dateboxes {      my $filename = shift;
     my ($name,$defaultmonth,$defaultday,$defaultyear,      return 0 if (! -e $filename);
  $currentmonth,$currentday,$currentyear)=@_;      return undef if (! tie(%persistent_db,'GDBM_File',$filename,
     ($defaultmonth,$defaultday,$defaultyear)=('','','');                             &GDBM_READER(),0640));
     #      #
     # Day      # These make sure we do not get array references printed out as 'values'.
     my $day=<<END;      my %arrays_allowed = ('form.domains'=>1);
 <select name="${name}_day">  
 <option value='$defaultday'> </option>  
 END  
     for (my $i = 1; $i<=31; $i++) {  
  $day.="<option value=\"$i\">$i</option>\n";  
     }  
     $day.="</select>\n";  
     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);  
     #      #
     # Month      # Loop through the keys, looking for 'form.'
     my $month=<<END;      foreach my $name (keys(%persistent_db)) {
 <select name="${name}_month">          next if ($name !~ /^form./);
 <option value='$defaultmonth'> </option>          # Kludgification begins!
 END          if ($name eq 'form.domains' && 
     my $i = 1;              $ENV{'form.searchmode'} eq 'basic' &&
     foreach (qw/January February March April May June               $ENV{'form.phase'} ne 'disp_basic') {
      July August September October November December /){              next;
  $month .="<option value=\"$i\">$_</option>\n";          }
  $i++;          # End kludge (hopefully)
     }          next if (exists($ENV{$name}));
     $month.="</select>\n";          my @values = map { 
     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);              &Apache::lonnet::unescape($_);
     #          } split(',',$persistent_db{$name});
     # Year (obviously)          next if (@values <1);
     my $year=<<END;          if ($arrays_allowed{$name}) {
 <select name="${name}_year">              $ENV{$name} = [@values];
 <option value='$defaultyear'> </option>          } else {
 END              $ENV{$name} = $values[0] if ($values[0]);
     my $maxyear = 2051;           }
     for (my $i = 1976; $i<=$maxyear; $i++) {  
  $year.="<option value=\"$i\">$i</option>\n";  
     }      }
     $year.="</select>\n";      untie (%persistent_db);
     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);      return 1;
     return "$month$day$year";  
 }  }
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   
 =pod  
   
 =item &selectbox()  
   
 Returns a scalar containing an html <select> form.    
   
 Inputs:   
   
 =over 4  
   
 =item $title   
   
 Printed above the select box, in uppercase.  If undefined, only a select  
 box will be returned, with no additional html.  
   
 =item $name   
   
 The name element of the <select> tag.  =pod 
   
 =item $default   =item &get_persistent_data()
   
 The default value of the form.  Can be $anyvalue, or in @idlist.  Inputs: filename of database, ref to array of values to recover.
   
 =item $anyvalue   Outputs: array of values.  Returns undef on error.
   
 The <option value="..."> used to indicate a default of   This function is the reverse of &make_persistent();
 none of the values.  Can be undef.  Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If the item contains commas (before unescaping), the
   returned value will be an array pointer. 
   
 =item $anytag   =cut
   
 The text associate with $anyvalue above.  ######################################################################
   ######################################################################
   sub get_persistent_data {
       my $filename = shift;
       my @Vars = @{shift()};
       my @Values;   # Return array
       return undef if (! -e $filename);
       return undef if (! tie(%persistent_db,'GDBM_File',$filename,
                              &GDBM_READER(),0640));
       foreach my $name (@Vars) {
           if (! exists($persistent_db{$name})) {
               push @Values, undef;
               next;
           }
           my @values = map { 
               &Apache::lonnet::unescape($_);
           } split(',',$persistent_db{$name});
           if (@values <= 1) {
               push @Values,$values[0];
           } else {
               push @Values,\@values;
           }
       }
       untie (%persistent_db);
       return @Values;
   }
   
 =item $functionref   ######################################################################
   ######################################################################
   
 Each element in @idlist will be passed as a parameter   =pod 
 to the function referenced here.  The return value of the function should  
 be a scalar description of the items.  If this value is undefined the   
 description of each item in @idlist will be the item name.  
   
 =item @idlist   =item &make_persistent() 
   
 The items to be selected from.  One of these or $anyvalue will be the   Inputs: Hash of values to save, filename of persistent database.
 value returned by the form element, $ENV{form.$name}.  
   
 =back  Store variables away to the %persistent_db.
   Values will be escaped.  Values that are array pointers will have their
   elements escaped and concatenated in a comma separated string.  
   
 =cut  =cut
   
 ###############################################  ######################################################################
   ######################################################################
 sub selectbox {  sub make_persistent {
     my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;      my %save = %{shift()};
     if (! defined($functionref)) { $functionref = sub { $_[0]}; }      my $filename = shift;
     my $selout='';      return undef if (! tie(%persistent_db,'GDBM_File',
     if (defined($title)) {                             $filename,&GDBM_WRCREAT(),0640));
         my $uctitle=uc($title);      foreach my $name (keys(%save)) {
         $selout="\n".'<p><font color="#800000" face="helvetica">'.          my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
             '<b>'.$uctitle.': </b></font>';          # We handle array references, but not recursively.
     }          my $store = join(',', map { &Apache::lonnet::escape($_); } @values );
     $selout .= '<select name="'.$name.'">';          $persistent_db{$name} = $store;
     unshift @idlist,$anyvalue if (defined($anyvalue));  
     foreach (@idlist) {  
         $selout.='<option value="'.$_.'"';  
         if ($_ eq $default and !/^any$/) {  
     $selout.=' selected >'.&{$functionref}($_).'</option>';  
  }  
  elsif ($_ eq $default and /^$anyvalue$/) {  
     $selout.=' selected >'.$anytag.'</option>';  
  }  
         else {$selout.='>'.&{$functionref}($_).'</option>';}  
     }      }
     return $selout.'</select>'.(defined($title)?'</p>':' ');      untie(%persistent_db);
       return 1;
 }  }
   
 ######################################################################  ######################################################################
 #                End of HTML form building functions                 #    
 ######################################################################  ######################################################################
   
 =pod  =pod 
   
 =back   =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 separated string.  
   
 =cut  =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 893  Parse advanced search form and return th Line 1043  Parse advanced search form and return th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_advanced_search {  sub parse_advanced_search {
     my ($r)=@_;      my ($r,$closebutton,$hidden_fields)=@_;
     my $fillflag=0;      my $fillflag=0;
     my $pretty_search_string = "<br />\n";      my $pretty_search_string = "<br />\n";
     # Clean up fields for safety      # Clean up fields for safety
Line 904  sub parse_advanced_search { Line 1054  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 915  sub parse_advanced_search { Line 1065  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) {      if (! $fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton,
                                     'phase=disp_adv',$hidden_fields);
  return ;   return ;
     }      }
     # Turn the form input into a SQL-based query      # Turn the form input into a SQL-based query
Line 938  sub parse_advanced_search { Line 1087  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','standards') {
  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 957  sub parse_advanced_search { Line 1106  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 992  sub parse_advanced_search { Line 1161  sub parse_advanced_search {
  );   );
     # Test to see if date windows are legitimate      # Test to see if date windows are legitimate
     if ($datequery=~/^Incorrect/) {      if ($datequery=~/^Incorrect/) {
  &output_date_error($r,$datequery);   &output_date_error($r,$datequery,$closebutton,$hidden_fields);
  return ;   return ;
     } elsif ($datequery) {      } elsif ($datequery) {
         # Here is where you would set up pretty_search_string to output          # Here is where you would set up pretty_search_string to output
         # date query information.          # date query information.
  push @queries,$datequery;   push @queries,$datequery;
     }      }
       #
     # Process form information for custom metadata querying      # Process form information for custom metadata querying
     my $customquery=undef;      my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {      ##
         $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".      ## The custom metadata search was removed q long time ago mostly 
             $ENV{'form.custommetadata'}."</b><br />\n";      ## because I was unable to figureout exactly how it worked and could
  $customquery=&build_custommetadata_query('custommetadata',      ## not imagine people actually using it.  MH
       $ENV{'form.custommetadata'});      ##
     }      # if ($ENV{'form.custommetadata'}) {
       #    $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
       #    $ENV{'form.custommetadata'}."</b><br />\n";
       #    $customquery=&build_custommetadata_query('custommetadata',
       #                                             $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 1046  sub parse_advanced_search { Line 1244  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 1072  Parse the basic search form and return a Line 1261  Parse the basic search form and return a
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_basic_search {  sub parse_basic_search {
     my ($r)=@_;      my ($r,$closebutton)=@_;
       #
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('basicexp') {      for my $field ('basicexp') {
  $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;   $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
Line 1083  sub parse_basic_search { Line 1273  sub parse_basic_search {
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       my ($libraries_to_query,$pretty_domains_string) = 
     # Check to see if enough is filled in          &parse_domain_restrictions();
       #
       # Check to see if enough of a query is filled in
     unless (&filled($ENV{'form.basicexp'})) {      unless (&filled($ENV{'form.basicexp'})) {
  &output_blank_field_error($r);   &output_blank_field_error($r,$closebutton,'phase=disp_basic');
  return OK;   return OK;
     }      }
     my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';      my $pretty_search_string = '<b>'.$ENV{'form.basicexp'}.'</b>';
Line 1100  sub parse_basic_search { Line 1292  sub parse_basic_search {
             $pretty_search_string .= " with no related words.";              $pretty_search_string .= " with no related words.";
         }          }
     }      }
       #
     # Build SQL query string based on form page      # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',',
        ('title', 'author', 'subject', 'notes', 'abstract',         ('title', 'author', 'subject', 'notes', 'abstract',
                         'keywords'));                          'keywords'));
     $concatarg='title' if $ENV{'form.titleonly'};      $concatarg='title' if $ENV{'form.titleonly'};
     $query=&build_SQL_query('concat('.$concatarg.')',$search_string);      $query=&build_SQL_query('concat_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);
 }  }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item &related_version  =item &related_version()
   
 Modifies an input string to include related words.  Words in the string  Modifies an input string to include related words.  Words in the string
 are replaced with parenthesized lists of 'OR'd words.  For example  are replaced with parenthesized lists of 'OR'd words.  For example
Line 1221  sub recursive_SQL_query_build { Line 1419  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 1318  sub build_date_queries { Line 1512  sub build_date_queries {
   
 =item &copyright_check()  =item &copyright_check()
   
   Inputs: $Metadata, a hash pointer of metadata for a resource.
   
   Returns: 1 if the resource is available to the user making the query, 
            0 otherwise.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 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 1342  sub copyright_check { Line 1540  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()
   
   The sort feature is not implemented at this time.  This form just prints 
   a link to change the search query.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub print_sort_form {
       my ($r,$pretty_query_string) = @_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
       ##
       my %SortableFields=&Apache::lonlocal::texthash( 
            id        => 'Default',
            title     => 'Title',
            author    => 'Author',
            subject   => 'Subject',
            url       => 'URL',
            version   => 'Version Number',
            mime      => 'Mime type',
            lang      => 'Language',
            owner     => 'Owner/Publisher',
            copyright => 'Copyright',
            hostname  => 'Host',
            creationdate     => 'Creation Date',
            lastrevisiondate => 'Revision Date'
        );
       ##
       my $table = $ENV{'form.table'};
       return if (! &ensure_db_and_table($r,$table));
       ##
       ## Get the number of results 
       ##
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print("A MySQL error has occurred.</form></body></html>");
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       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 1356  the following format: Line 1703  the following format:
   
 =cut  =cut
   
 ##  #####################################################################
 ## Restrictions:  #####################################################################
 ##    columns of type 'text' and 'blob' cannot have defaults.  #
 ##    columns of type 'enum' cannot be used for FULLTEXT.  # These should probably be scoped but I don't have time right now...
 ##  #
 my @DataOrder = qw/id title author subject url keywords version notes  my @Datatypes;
     abstract mime lang owner copyright creationdate lastrevisiondate hostname  my @Fullindicies;
     idx_title idx_author idx_subject idx_abstract idx_mime idx_language       
     idx_owner idx_copyright/;  ######################################################################
   ######################################################################
 my %Datatypes =   
     ( id        =>{ type         => 'INT',  =pod
                     restrictions => 'NOT NULL',  
                     primary_key  => 'yes',  =item &create_results_table()
                     auto_inc     => 'yes'  
                     },  Creates the table of search results by calling lonmysql.  Stores the
       title     =>{ type=>'TEXT'},  table id in $ENV{'form.table'}
       author    =>{ type=>'TEXT'},  
       subject   =>{ type=>'TEXT'},  Inputs: none.
       url       =>{ type=>'TEXT',  
                     restrictions => 'NOT NULL' },  Returns: the identifier of the table on success, undef on error.
       keywords  =>{ type=>'TEXT'},  
       version   =>{ type=>'TEXT'},  =cut
       notes     =>{ type=>'TEXT'},  
       abstract  =>{ type=>'TEXT'},  ######################################################################
       mime      =>{ type=>'TEXT'},  ######################################################################
       lang      =>{ type=>'TEXT'},  sub set_up_table_structure {
       owner     =>{ type=>'TEXT'},      my ($datatypes,$fullindicies) = 
       copyright =>{ type=>'TEXT'},          &LONCAPA::lonmetadata::describe_metadata_storage();
       hostname  =>{ type=>'TEXT'},      # Copy the table description before modifying it...
       #--------------------------------------------------      @Datatypes = @{$datatypes};
       creationdate     =>{ type=>'DATETIME'},      unshift(@Datatypes,{name => 'id',  
       lastrevisiondate =>{ type=>'DATETIME'},          type => 'MEDIUMINT',
       #--------------------------------------------------          restrictions => 'UNSIGNED NOT NULL',
       idx_title     =>{ type=>'FULLTEXT', target=>'title'},          primary_key  => 'yes',
       idx_author    =>{ type=>'FULLTEXT', target=>'author'},          auto_inc     => 'yes' });
       idx_subject   =>{ type=>'FULLTEXT', target=>'subject'},      @Fullindicies = @{$fullindicies};
       idx_abstract  =>{ type=>'FULLTEXT', target=>'abstract'},      return;
       idx_mime      =>{ type=>'FULLTEXT', target=>'mime'},  }
       idx_language  =>{ type=>'FULLTEXT', target=>'lang'},  
       idx_owner     =>{ type=>'FULLTEXT', target=>'owner'},  sub create_results_table {
       idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},      &set_up_table_structure();
       );      my $table = &Apache::lonmysql::create_table
           ( { columns => \@Datatypes,
               FULLTEXT => [{'columns' => \@Fullindicies},],
           } );
       if (defined($table)) {
           $ENV{'form.table'} = $table;
           return $table;
       } 
       return undef; # Error...
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod  =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();
   }
   
   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();      $r->rflush();
     return;  
 }  }
   
 ######################################################################  ######################################################################
Line 1423  sub write_status { Line 1814  sub write_status {
   
 =pod  =pod
   
 =item &run_search   =item &revise_button()
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revise_phase = 'disp_basic';
       $revise_phase = 'disp_adv' if ($ENV{'form.searchmode'} eq 'advanced');
       my $newloc = '/adm/searchcat'.
           '?persistent_db_id='.$ENV{'form.persistent_db_id'}.
               '&cleargroupsort=1'.
               '&phase='.$revise_phase;
       my $result = qq{<input type="button" value="Revise search" name="revise"} .
           qq{ onClick="parent.location='$newloc';" /> };
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &run_search()
   
   Executes a search query by sending it the the other servers and putting the
   results into MySQL.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 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
       #
       my $starttime = time;
       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.
     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'};
     # Timing variables      if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
     my $starttime = time;          $r->print("Unable to determine table id to store search results in.".
     my $max_time  = 120;  # seconds for the search to complete                    "The search has been aborted.</body></html>");
     #          return;
     # Create Table      }
     #####################################      my $table_status = &Apache::lonmysql::check_table($table);
     my $table = &Apache::lonmysql::create_table      if (! defined($table_status)) {
         ( { columns => \%Datatypes,          $r->print("Unable to determine status of table.</body></html>");
             column_order => \@DataOrder,          &Apache::lonnet::logthis("Bogus table id of $table for ".
         } );                                   "$ENV{'user.name'} @ $ENV{'user.domain'}");
     if (! defined($table)) {          &Apache::lonnet::logthis("lonmysql error = ".
         # What do I do now?  Print out an error page.  
         &Apache::lonnet::logthis("lonmysql attempted to create a table ".  
                                  "and this was the result:".  
                                  &Apache::lonmysql::get_error());                                   &Apache::lonmysql::get_error());
         $r->print("An internal error occured with the database.<br />".  
                   "The error has been logged, but you should probably alert".  
                   " your system administrator.");  
         return;          return;
     }      }
     $ENV{'form.table'}=$table;      if (! $table_status) {
     #          &Apache::lonnet::logthis("lonmysql error = ".
     #####################################                                   &Apache::lonmysql::get_error());
           &Apache::lonnet::logthis("lonmysql debug = ".
                                    &Apache::lonmysql::get_debug());
           &Apache::lonnet::logthis('table status = "'.$table_status.'"');
           $r->print("The table id,$table, we tried to use is invalid.".
                     "The search has been aborted.</body></html>");
           return;
       }
       ##
       ## Prepare for the 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) ;
       $time_remaining = 0 if ($time_remaining <0);
       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))) {
           $time_remaining = $max_time - (time - $starttime) ;
           &update_seconds($r,$time_remaining);
         # 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]);
             # We should let the user know we have contacted another 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});  
             # Hmmm, should we add to $max_time if we contact a server?  
         } 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());
               $time_remaining = $max_time - (time - $starttime) ;
               $time_remaining = 0 if ($time_remaining < 0);
               if ($last_time - $time_remaining > 0) {
                   $last_time = $time_remaining;
                   &update_seconds($r,$time_remaining);
               }
             if ($status eq 'con_lost') {              if ($status eq 'con_lost') {
                 delete ($Server_status{$server});                  delete ($Server_status{$server});
                 # &write_status($r,"Removing $server");  
                 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...?                                    "server $server.  Omitting from search");
                     # Should I give up on opening it?                      delete($Server_status{$server}); 
                     &write_status("Unable to open $datafile");                     next;
                     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 1521  sub run_search { Line 2012  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) ;
                       $time_remaining = 0 if ($time_remaining < 0);
                       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});
             }              }
               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();
       #
     # 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.  
     if ($hitcountsum > 0) {      $r->print("</body></html>");
         $r->print("<h3>Total results = $hitcountsum</h3></body></html>");      if ($ENV{'form.catalogmode'} ne 'groupsearch') {
           $r->print("<script>".
                         "window.location='/adm/searchcat?".
                         "phase=sort&".
                         "persistent_db_id=$ENV{'form.persistent_db_id'}';".
                     "</script>");
     }      }
     return;      return;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod  =pod
   
 =item &display_buttons  =item &prev_next_buttons()
   
   Returns html for the previous and next buttons on the search results page.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub display_buttons {  sub prev_next_buttons {
     my ($low,$high,$otherparms) = @_;      my ($current_min,$show,$total,$parms) = @_;
     my $maxshow = 20;      return '' if ($show eq 'all'); # No links if you get them all at once.
     my $lowest = ($low - $maxshow < 0 ? 0 : $low-$maxshow);      my $links;
     my $highest = $high + $maxshow;      ##
     my ($previous,$current,$next);      ## Prev
     if ($lowest < $low) {      my $prev_min = $current_min - $show;
         $previous = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$lowest&high=$highest">prev</a>};      $prev_min = 1 if $prev_min < 1;
       if ($prev_min < $current_min) {
           $links .= 
               qq{<a href="/adm/searchcat?$parms&start=$prev_min&show=$show">}.
               &mt('prev').'</a>';
     } else {      } else {
         $previous = "prev";          $links .= &mt('prev');
     }      }
     $current = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$low&high=$high">reload</a>};      ##
     $next = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$high&high=$highest">next</a>};      ## Pages.... Someday.
     my $result = $previous." ".$current." ".$next;      ##
     return $result;      $links .= 
           qq{&nbsp;
              <a href="/adm/searchcat?$parms&start=$current_min&$show=$show">}.
                   &mt('reload').'</a>';
       ##
       ## Next
       my $next_min = $current_min + $show;
       $next_min = $current_min if ($next_min > $total);
       if ($next_min != $current_min) {
           $links .= 
               qq{&nbsp;
                  <a href="/adm/searchcat?$parms&start=$next_min&show=$show">}.
                       &mt('next').'</a>';
       } else {
           $links .= '&nbsp;'.&mt('next');
       }
       return $links;
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod  =pod
   
 =item &display_results  =item &display_results()
   
   Prints the results out for selection and perusal.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub display_results {  sub display_results {
     my ($r,$mode,$hidden,$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 1592  sub display_results { Line 2138  sub display_results {
         return;          return;
     }      }
     ##      ##
     ## make query information persistent to allow for subsequent revision      ## $checkbox_num is a count of the number of checkboxes output on the 
     ##      ## page this is used only during catalogmode=groupsearch.
     my $persistent=&make_persistent(\%ENV);      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 by opening the groupsearch db file.
     } elsif ($mode eq 'Advanced') {      if ($ENV{'form.catalogmode'} eq 'groupsearch') {
         $action .= "?reqinterface=advanced";          if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
     }                    &GDBM_WRCREAT(),0640)) {
     $r->print(<<CATALOGCONTROLS);              $r->print('Unable to store import results.</form></body></html>');
 <form name='results' method="post" action="$action">              $r->rflush();
 $hidden              return;
 <input type='hidden' name='acts' value='' />          } 
 <input type='button' value='Revise search request'      }
 onClick='this.form.submit();' />      ##
 $importbutton      ## Prepare the table for querying
 $closebutton  
 $persistent  
 <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;  
     }   
     #  
     my $fnum;  
     # For now, just query the whole lot and spit them out.  
     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());      ## 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 @Results = &Apache::lonmysql::get_rows($table,'id>=0');      ##
     #&write_status($r,&Apache::lonmysql::get_debug());      ## Determine how many results we need to get
     #&write_status($r,&Apache::lonmysql::get_error());      $ENV{'form.start'} = 1      if (! exists($ENV{'form.start'}));
       $ENV{'form.show'}  = 'all'  if (! exists($ENV{'form.show'}));
       my $min = $ENV{'form.start'};
       my $max;
       if ($ENV{'form.show'} eq 'all') {
           $max = $total_results ;
       } else {
           $max = $min + $ENV{'form.show'} - 1;
           $max = $total_results if ($max > $total_results);
       }
       ##
       ## Output links (if necessary) for 'prev' and 'next' pages.
       $r->print
           ('<center>'.
            &prev_next_buttons($min,$ENV{'form.show'},$total_results,
                               "table=".$ENV{'form.table'}.
                               "&phase=results".
                               "&persistent_db_id=".$ENV{'form.persistent_db_id'})
            ."</center>\n"
            );
       if ($total_results == 0) {
           $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="1">'.
                     '<h3>'.&mt('There are currently no results').'.</h3>'.
                     "</form></body></html>");
           return;
       } else {
           $r->print
               ("<center>Results $min to $max out of $total_results</center>\n");
       }
       ##
       ## Get results from MySQL table
       my @Results = &Apache::lonmysql::get_rows($table,
                                                 'id>='.$min.' AND id<='.$max);
       ##
       ## Loop through the results and output them.
     foreach my $row (@Results) {      foreach my $row (@Results) {
         my %Fields = %{&parse_row(@$row)};          if ($connection->aborted()) {
         my $output="\n<p>\n";              &cleanup();
         if ($ENV{'form.catalogmode'} eq 'interactive') {              return;
             my $titleesc=$Fields{'title'};  
             $titleesc=~s/\'/\\'/; # '  
             if ($ENV{'form.catalogmode'} eq 'interactive') {  
                 $output.=<<END   
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  
 onClick="javascript:select_data('$titleesc','$Fields{'url'}')">  
 </font>  
 <br />  
 END  
             }  
         }          }
         if ($ENV{'form.catalogmode'} eq 'groupsearch') {          my %Fields = %{&parse_row(@$row)};
             $fnum+=0;          my $output="<p>\n";
             $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'};          if (! defined($Fields{'title'}) || $Fields{'title'} eq '') {
             $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'};              $Fields{'title'} = 'Untitled';
             $output.=<<END;  
 <font size='-1'>  
 <input type="checkbox" name="returnvalues" value="SELECT"  
 onClick="javascript:queue($fnum)" />  
 </font>  
 <br />  
 END  
 # <input type="hidden" name="title$fnum" value="$title" />  
 # <input type="hidden" name="url$fnum" value="$url" />  
             $fnum++;  
         }          }
           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);
         if ($output) {          # Print them out as they come in.
             $output.="<hr align='left' width='200' noshade />";  
         }  
         $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 1683  END Line 2249  END
   
 =pod  =pod
   
 =item &parse_row  =item &catalogmode_output($title,$url,$fnum,$checkbox_num)
   
 Parse a row returned from the database.  Returns html needed for the various catalog modes.  Gets inputs from
   $ENV{'form.catalogmode'}.  Stores data in %groupsearch_db.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_row {  sub catalogmode_output {
     my @Row = @_;      my $output = '';
     my %Fields;      my ($title,$url,$fnum,$checkbox_num) = @_;
     for (my $i=0;$i<=$#Row;$i++) {      if ($ENV{'form.catalogmode'} eq 'interactive') {
         $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]);          $title=~ s/\'/\\\'/g;
           if ($ENV{'form.catalogmode'} eq 'interactive') {
               $output.=<<END 
   <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
   onClick="javascript:select_data('$title','$url')">
   </font>
   END
           }
       } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
           $groupsearch_db{"pre_${fnum}_link"}=$url;
           $groupsearch_db{"pre_${fnum}_title"}=$title;
           $output.=<<END;
   <font size='-1'>
   <input type="checkbox" name="returnvalues" value="SELECT"
   onClick="javascript:queue($checkbox_num,$fnum)" />
   </font>
   END
     }      }
     $Fields{'language'} =       return $output;
         &Apache::loncommon::languagedescription($Fields{'lang'});  
     $Fields{'copyrighttag'} =  
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});  
     $Fields{'mimetag'} =  
         &Apache::loncommon::filedescription($Fields{'mime'});  
     return \%Fields;  
 }  }
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =pod   =pod
   
 =item &output_results()   =item &parse_row()
   
 Format and output results based on a reply list.  Parse a row returned from the database.
 There are two windows that this function writes to.  The main search  
 window ("srch") has a listing of the results.  A secondary window ("popwin")  
 gives the status of the network search (time elapsed, number of machines  
 contacted, etc.)  
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_results {  sub parse_row {
 #    &Apache::lonnet::logthis("output_results:".time);      my @Row = @_;
     my $fnum; # search result counter      my %Fields;
     my ($mode,$r,$replyref,$hidden)=@_;      if (! scalar(@Datatypes)) {
     my %rhash=%{$replyref};          &set_up_table_structure();
     my $compiledresult='';  
     my $timeremain=300; # (seconds)  
     my $elapsetime=0;  
     my $resultflag=0;  
     my $tflag=1;  
     ##  
     ## Set viewing function  
     ##  
     my $viewfunction = $Views{$ENV{'form.viewselect'}};  
     if (!defined($viewfunction)) {  
         $r->print("Internal Error - Bad view selected.\n");  
         $r->rflush();  
         return;  
     }      }
     #      for (my $i=0;$i<=$#Row;$i++) {
     # make query information persistent to allow for subsequent revision          $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]);
     my $persistent=&make_persistent(\%ENV);      }
     #      $Fields{'language'} = 
     # Begin producing output          &Apache::loncommon::languagedescription($Fields{'language'});
     $r->rflush();      $Fields{'copyrighttag'} =
     #          &Apache::loncommon::copyrightdescription($Fields{'copyright'});
     # begin showing the cataloged results      $Fields{'mimetag'} =
     my $action = "/adm/searchcat";          &Apache::loncommon::filedescription($Fields{'mime'});
     if ($mode eq 'Basic') {       return \%Fields;
         $action .= "?reqinterface=basic";  
     } elsif ($mode eq 'Advanced') {  
         $action .= "?reqinterface=advanced";  
     }  
     $r->print(<<CATALOGCONTROLS);  
 <form name='results' method="post" action="$action">  
 $hidden  
 <input type='hidden' name='acts' value='' />  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();' />  
 $importbutton  
 $closebutton  
 $persistent  
 <hr />  
 CATALOGCONTROLS  
     #  
     # make the pop-up window for status  
     $r->print(&make_popwin(%rhash));  
     $r->rflush();  
     ##  
     ## Prepare for the main loop below  
     ##  
     my $servercount=0;  
     my $hitcountsum=0;  
     my $servernum=(keys %rhash);  
     my $serversleft=$servernum;  
     ##  
     ## Run until we run out of time or we run out of servers  
     ##  
     while($serversleft && $timeremain) {  
       ##  
       ## %rhash has servers deleted from it as results come in   
       ## (within the foreach loop below).  
       ##  
       foreach my $rkey (sort keys %rhash) {  
 #        &Apache::lonnet::logthis("Server $rkey:".time);  
  $servercount++;  
  $compiledresult='';  
  my $reply=$rhash{$rkey};  
  my @results;  
  if ($reply eq 'con_lost') {  
     &popwin_imgupdate($r,$rkey,"srvbad.gif");  
     $serversleft--;  
             delete $rhash{$rkey};  
  } else {  
             # must do since 'use strict' checks for tainting  
     $reply=~/^([\.\w]+)$/;   
     my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
     $reply=~/(.*?)\_/;  
             for (my $counter=0;$counter<2;$counter++) {  
                 if (-e $replyfile && ! -e "$replyfile.end") {  
                     &popwin_imgupdate($r,$rkey,"srvhalf.gif");  
                     &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
                                '"still transferring..."'.';');  
                 }  
                 # Are we finished transferring data?  
                 if (-e "$replyfile.end") {  
                     $serversleft--;  
                     delete $rhash{$rkey};  
                     if (-s $replyfile) {  
                         &popwin_imgupdate($r,$rkey,"srvgood.gif");  
                         my $fh;  
                         unless ($fh=Apache::File->new($replyfile)){   
                             # Is it really appropriate to die on this error?  
                             $r->print('ERROR: file '.  
                                       $replyfile.' cannot be opened');  
                             return OK;  
                         }  
                         @results=<$fh> if $fh;  
                         my $hits =@results;  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]='.  
                                    $hits.';');  
                         $hitcountsum+=$hits;  
                         &popwin_js($r,'popwin.document.forms.popremain.'.  
                                    'numhits.value='.$hitcountsum.';');  
                     } else {  
                         &popwin_imgupdate($r,$rkey,"srvempty.gif");  
                         &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');  
                     }  
                     last;  
                 } # end of if ( -e "$replyfile.end")  
                 last unless $timeremain;  
                 sleep 1;    # wait for daemons to write files?  
                 $timeremain--;  
                 $elapsetime++;  
                 &popwin_js($r,"popwin.document.popremain.".  
                            "elapsetime.value=$elapsetime;");  
     }  
     &popwin_js($r,'popwin.document.whirly.'.  
        'src="/adm/lonIcons/lonanimend.gif";');  
  } # end of if ($reply eq 'con_lost') else statement  
         my %Fields = undef;     # Holds the data to be sent to the various   
                                 # *_view routines.  
         my ($extrashow,$customfields,$customhash) =   
                                     &handle_custom_fields(\@results);  
         my @customfields = @$customfields;  
         my %customhash   = %$customhash;  
  untie %groupsearch_db if (tied %groupsearch_db);  
         #  
  if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {  
     $r->print('<html><head></head><body>Unable to tie hash to db '.  
                       'file</body></html>');  
         } else {  
     if ($ENV{'form.launch'} eq '1') {  
  &start_fresh_session();  
     }  
     foreach my $result (@results) {  
  next if $result=~/^custom\=/;  
  chomp $result;  
  next unless $result;  
                 %Fields = &parse_raw_result($result,$rkey);  
                 #  
                 # Check copyright tags and skip results the user cannot use  
                 my (undef,undef,$resdom,$resname) = split('/',$Fields{'url'});  
                 # Check for priv  
                 if (($Fields{'copyright'} eq 'priv') &&   
                     (($ENV{'user.name'} ne $resname) &&  
                      ($ENV{'user.domain'} ne $resdom))) {  
                     next;  
                 }  
                 # Check for domain  
                 if (($Fields{'copyright'} eq 'domain') &&  
                     ($ENV{'user.domain'} ne $resdom)) {  
                     next;  
                 }  
                 #  
  $Fields{'extrashow'}=$extrashow;  
  if ($extrashow) {  
     foreach my $field (@customfields) {  
  my $value='';  
  $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);  
                         $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;  
                     }  
                 }  
                 $compiledresult.="\n<p>\n";  
                 if ($ENV{'form.catalogmode'} eq 'interactive') {  
                     my $titleesc=$Fields{'title'};  
                     $titleesc=~s/\'/\\'/; # '  
                     $compiledresult.=<<END if ($ENV{'form.catalogmode'} eq 'interactive');  
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  
 onClick="javascript:select_data('$titleesc','$Fields{'url'}')">  
 </font>  
 <br />  
 END  
                 }  
                 if ($ENV{'form.catalogmode'} eq 'groupsearch') {  
     $fnum+=0;  
     $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'};  
     $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'};  
     $compiledresult.=<<END;  
 <font size='-1'>  
 <input type="checkbox" name="returnvalues" value="SELECT"  
 onClick="javascript:queue($fnum)" />  
 </font>  
 <br />  
 END  
 # <input type="hidden" name="title$fnum" value="$title" />  
 # <input type="hidden" name="url$fnum" value="$url" />  
                     $fnum++;  
  }  
                 # Render the result into html  
                 $compiledresult.= &$viewfunction(%Fields, hostname => $rkey );  
                 if ($compiledresult or $servercount!=$servernum) {  
                     $compiledresult.="<hr align='left' width='200' noshade />";  
                 }  
             }  
             untie %groupsearch_db;  
         }  
  if ($compiledresult) {  
     $resultflag=1;  
             $r->print($compiledresult);  
  }  
       } # End of foreach loop over servers remaining  
     }   # End of big loop - while($serversleft && $timeremain)  
     unless ($resultflag) {  
         $r->print("\nThere were no results that matched your query\n");  
     }  
     $r->print('<script type="text/javascript">'.'popwin.close()</script>'.  
               "\n");   
     $r->print("</body>\n</html>\n");  
     $r->rflush();   
     return;  
 }  }
   
 ###########################################################  ###########################################################
Line 1943  END Line 2321  END
 =item &parse_raw_result()  =item &parse_raw_result()
   
 Takes a line from the file of results and parse it.  Returns a hash   Takes a line from the file of results and parse it.  Returns a hash 
 with keys for the following fields:  with keys according to column labels
 'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes',   
 'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate',   
 'lastrevisiondate'.  
   
 In addition, the following tags are set by calling the appropriate   In addition, the following tags are set by calling the appropriate 
 lonnet function: 'language', 'cprtag', 'mimetag'.  lonnet function: 'language', 'copyrighttag', 'mimetag'.
   
 The 'title' field is set to "Untitled" if the title field is blank.  The 'title' field is set to "Untitled" if the title field is blank.
   
Line 1961  The 'title' field is set to "Untitled" i Line 2336  The 'title' field is set to "Untitled" i
 ###########################################################  ###########################################################
 sub parse_raw_result {  sub parse_raw_result {
     my ($result,$hostname) = @_;      my ($result,$hostname) = @_;
     # Check for a comma - if it is there then we do not need to unescape the      # conclude from self to others regarding fields
     # string.  There seems to be some kind of problem with some items in      my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash
     # the database - the entire string gets sent out unescaped...?          (map {
     unless ($result =~ /,/) {              &Apache::lonnet::unescape($_);
         $result = &Apache::lonnet::unescape($result);          } (split(/\,/,$result)) );
     }  
     my @fields=map {  
         &Apache::lonnet::unescape($_);  
     } (split(/\,/,$result));  
     my ($title,$author,$subject,$url,$keywords,$version,  
         $notes,$abstract,$mime,$lang,  
         $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;  
     my %Fields =   
         ( title     => &Apache::lonnet::unescape($title),  
           author    => &Apache::lonnet::unescape($author),  
           subject   => &Apache::lonnet::unescape($subject),  
           url       => &Apache::lonnet::unescape($url),  
           keywords  => &Apache::lonnet::unescape($keywords),  
           version   => &Apache::lonnet::unescape($version),  
           notes     => &Apache::lonnet::unescape($notes),  
           abstract  => &Apache::lonnet::unescape($abstract),  
           mime      => &Apache::lonnet::unescape($mime),  
           lang      => &Apache::lonnet::unescape($lang),  
           owner     => &Apache::lonnet::unescape($owner),  
           copyright => &Apache::lonnet::unescape($copyright),  
           creationdate     => &Apache::lonnet::unescape($creationdate),  
           lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate)  
         );  
     $Fields{'language'} =   
         &Apache::loncommon::languagedescription($Fields{'lang'});  
     $Fields{'copyrighttag'} =  
         &Apache::loncommon::copyrightdescription($Fields{'copyright'});  
     $Fields{'mimetag'} =  
         &Apache::loncommon::filedescription($Fields{'mime'});  
     if ($Fields{'author'}=~/^(\s*|error)$/) {  
         $Fields{'author'}="Unknown Author";  
     }  
     # Put spaces in the keyword list, if needed.  
     $Fields{'keywords'}=~ s/,([A-z])/, $1/g;   
     if ($Fields{'title'}=~ /^\s*$/ ) {   
         $Fields{'title'}='Untitled';   
     }  
     unless ($ENV{'user.adv'}) {  
         # What is this anyway?  
         $Fields{'keywords'} = '- not displayed -';  
         $Fields{'notes'}    = '- not displayed -';  
         $Fields{'abstract'} = '- not displayed -';  
         $Fields{'subject'}  = '- not displayed -';  
     }  
     if (length($Fields{'abstract'})>200) {  
         $Fields{'abstract'} =   
             substr($Fields{'abstract'},0,200).'...';  
     }  
     if (length($Fields{'keywords'})>200) {  
         $Fields{'keywords'} =  
             substr($Fields{'keywords'},0,200).'...';  
     }  
     return %Fields;      return %Fields;
 }  }
   
Line 2067  sub handle_custom_fields { Line 2390  sub handle_custom_fields {
   
 =pod  =pod
   
 =item &search_results_header  =item &search_results_header()
   
 Output the proper html headers and javascript code to deal with different   Output the proper html headers and javascript code to deal with different 
 calling modes.  calling modes.
Line 2094  Checked for existance & 'edit' mode. Line 2417  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 2103  Checked for existance & 'edit' mode. Line 2434  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 2127  BEGINNING Line 2447  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 2144  SCRIPT Line 2464  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 2166  SCRIPT Line 2503  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
   }
   
 =pod  sub results_link {
       my $basic_link   = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
 =item &make_popwin()          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
       my $results_link = $basic_link."&phase=results".
 Returns html with javascript in it to open up the status window.          "&pause=1"."&start=1";
       return $results_link;
 =cut  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub make_popwin {  sub print_frames_interface {
     my %rhash = @_;      my $r = shift;
     my $servernum=(keys %rhash);      my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}.
     my $hcinit;          "&persistent_db_id=".$ENV{'form.persistent_db_id'};
     my $grid="'<br />'+\n";      my $run_search_link = $basic_link."&phase=run_search";
     # $sn is the server number, used ONLY to make sure we have      my $results_link = &results_link();
     # rows of 10 each.  No longer used to index images.      my $result = <<"ENDFRAMES";
     my $sn=1;  <html>
     foreach my $sk (sort keys %rhash) {  <head>
  $grid.="'<a href=\"";  <script>
  $grid.="javascript:opener.displayinfo('+";  var targetwin = opener;
  $grid.="\"'\"+'";  var queue = '';
  $grid.=$sk;  
  my $hc;  
  if ($rhash{$sk} eq 'con_lost') {  
     $hc="BAD CONNECTION ";  
  }  
  else {  
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";  
  }  
  $grid.=" hitcount=".$hc;  
  $grid.=" domain=".$Apache::lonnet::hostdom{$sk};  
  $grid.=" IP=".$Apache::lonnet::hostip{$sk};  
  # '+"'"+'">'+  
  $grid.="'+\"'\"+')\">'+";  
  $grid.="\n";  
  $grid.="'<img border=\"0\" name=\"img_".$Apache::lonnet::hostdom{$sk}.  
             '_'.$sk."\" src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk.  
                 "\" /></a>'+\n";  
  $grid.="'<br />'+\n" unless $sn%10;  
         $sn++;  
     }  
     my $result.=<<ENDPOP;  
 <script type="text/javascript">  
     popwin=open('','popwin','scrollbars=1,width=400,height=220');  
     popwin.focus();  
     popwin.document.writeln('<'+'html>');  
     popwin.document.writeln('<'+'head>');  
     popwin.document.writeln('<'+'script>');  
     popwin.document.writeln('hc=new Array();$hcinit');  
     popwin.document.writeln('<'+'/script>');  
     popwin.document.writeln('<'+'/head>'+  
         '<'+'body bgcolor="#FFFFFF">'+  
  '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+  
  'lonanim.gif" '+  
  'alt="animated logo" />'+  
  '<'+'h3>Search Results Progress<'+'/h3>'+  
         '<'+'form name="popremain">'+  
         '<'+'tt>'+  
  '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+  
  '<'+'br />SCANNING $servernum SERVERS'+  
  '<'+'br clear="all" />Number of record hits found '+  
  '<'+'input type="text" size="10" name="numhits"'+  
  ' value="0" />'+  
  '<'+'br clear="all" />Time elapsed '+  
  '<'+'input type="text" size="10" name="elapsetime"'+  
  ' value="0" />'+  
  '<'+'br />'+  
  'SERVER GRID (click on any cell for details)'+  
         $grid  
         '<'+'br />'+  
  'Server details '+  
  '<'+'input type="text" size="35" name="sdetails"'+  
  ' value="" />'+  
  '<'+'br />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="close this window" '+  
  ' onClick="javascript:opener.abortsearch()" />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="help" onClick="javascript:opener.openhelp()" />'+  
  '<'+'/tt>'+  
         '<'+'/form>'+  
         '<'+'/body><'+'/html>');  
     popwin.document.close();  
 </script>  </script>
 ENDPOP  <title>LON-CAPA Digital Library Search Results</title>
     return $result;  </head>
   <frameset rows="150,*">
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   </frameset>
   </html>
   ENDFRAMES
   
       $r->print($result);
       return;
 }  }
   
 ######################################################################  ######################################################################
Line 2312  ENDPOP Line 2592  ENDPOP
 =item Metadata Viewing Functions  =item Metadata Viewing Functions
   
 Output is a HTML-ified string.  Output is a HTML-ified string.
   
 Input arguments are title, author, subject, url, keywords, version,  Input arguments are title, author, subject, url, keywords, version,
 notes, short abstract, mime, language, creation date,  notes, short abstract, mime, language, creation date,
 last revision date, owner, copyright, hostname, and  last revision date, owner, copyright, hostname, and
Line 2326  extra custom metadata to show. Line 2607  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 2338  sub detailed_citation_view { Line 2620  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 2356  END Line 2639  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 2378  END Line 2662  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 2385  END Line 2692  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 2405  sub fielded_format_view { Line 2714  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 2423  END Line 2733  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub xml_sgml_view {  sub xml_sgml_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $xml = <<END;
   <LonCapaResource>
   <url>$values{'url'}</url>
   <title>$values{'title'}</title>
   <author>$values{'author'}</author>
   <subject>$values{'subject'}</subject>
   <keywords>$values{'keywords'}</keywords>
   <notes>$values{'notes'}</notes>
   <mimeInfo>
   <mime>$values{'mime'}</mime>
   <mimetag>$values{'mimetag'}</mimetag>
   </mimeInfo>
   <languageInfo>
   <language>$values{'language'}</language>
   <languagetag>$values{'languagetag'}</languagetag>
   </languageInfo>
   <creationdate>$values{'creationdate'}</creationdate>
   <lastrevisiondate>$values{'lastrevisiondate'}</lastrevisiondate>
   <owner>$values{'owner'}</owner>
   <copyrightInfo>
   <copyright>$values{'copyright'}</copyright>
   <copyrighttag>$values{'copyrighttag'}</copyrighttag>
   </copyrightInfo>
   <repositoryLocation>$values{'hostname'}</repositoryLocation>
   <shortabstract>$values{'shortabstract'}</shortabstract>
   </LonCapaResource>
   END
       $xml = &HTML::Entities::encode($xml,'<>&');
     my $result=<<END;      my $result=<<END;
   $prefix
 <pre>  <pre>
 &lt;LonCapaResource&gt;  $xml
 &lt;url&gt;$values{'url'}&lt;/url&gt;  
 &lt;title&gt;$values{'title'}&lt;/title&gt;  
 &lt;author&gt;$values{'author'}&lt;/author&gt;  
 &lt;subject&gt;$values{'subject'}&lt;/subject&gt;  
 &lt;keywords&gt;$values{'keywords'}&lt;/keywords&gt;  
 &lt;notes&gt;$values{'notes'}&lt;/notes&gt;  
 &lt;mimeInfo&gt;  
 &lt;mime&gt;$values{'mime'}&lt;/mime&gt;  
 &lt;mimetag&gt;$values{'mimetag'}&lt;/mimetag&gt;  
 &lt;/mimeInfo&gt;  
 &lt;languageInfo&gt;  
 &lt;language&gt;$values{'lang'}&lt;/language&gt;  
 &lt;languagetag&gt;$values{'language'}&lt;/languagetag&gt;  
 &lt;/languageInfo&gt;  
 &lt;creationdate&gt;$values{'creationdate'}&lt;/creationdate&gt;  
 &lt;lastrevisiondate&gt;$values{'lastrevisiondate'}&lt;/lastrevisiondate&gt;  
 &lt;owner&gt;$values{'owner'}&lt;/owner&gt;  
 &lt;copyrightInfo&gt;  
 &lt;copyright&gt;$values{'copyright'}&lt;/copyright&gt;  
 &lt;copyrighttag&gt;$values{'copyrighttag'}&lt;/copyrighttag&gt;  
 &lt;/copyrightInfo&gt;  
 &lt;repositoryLocation&gt;$values{'hostname'}&lt;/repositoryLocation&gt;  
 &lt;shortabstract&gt;$values{'shortabstract'}&lt;/shortabstract&gt;  
 &lt;/LonCapaResource&gt;  
 </pre>  </pre>
 $values{'extrashow'}  $values{'extrashow'}
   <hr align='left' width='200' noshade />
 END  END
     return $result;      return $result;
 }  }
Line 2471  END Line 2787  END
 sub filled {  sub filled {
     my ($field)=@_;      my ($field)=@_;
     if ($field=~/\S/ && $field ne 'any') {      if ($field=~/\S/ && $field ne 'any') {
  return 1;          return 1;
     }      } else {
     else {          return 0;
  return 0;  
     }      }
 }  }
   
Line 2485  sub filled { Line 2800  sub filled {
   
 =item &output_blank_field_error()  =item &output_blank_field_error()
   
   Output a complete page that indicates the user has not filled in enough
   information to do a search.
   
   Inputs: $r (Apache request handle), $closebutton, $parms.
   
   Returns: nothing
   
   $parms is extra information to include in the 'Revise search request' link.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_blank_field_error {  sub output_blank_field_error {
     my ($r)=@_;      my ($r,$closebutton,$parms,$hidden_fields)=@_;
       my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent(\%ENV);  
   
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
 <head>  <head>
Line 2501  sub output_blank_field_error { Line 2824  sub output_blank_field_error {
 BEGINNING  BEGINNING
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <a href="/adm/searchcat?$parms&persistent_db_id=$ENV{'form.persistent_db_id'}"
 onClick='this.form.submit();' />  >Revise search request</a>&nbsp;
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Unactionable search query.</h3>
 <p>  <p>
 Incorrect search query due to blank entry fields.  You did not fill in enough information for the search to be started.
 You need to fill in the relevant  You need to fill in relevant fields on the search page in order 
 fields on the search page in order for a query to be  for a query to be processed.
 processed.  
 </p>  </p>
 </body>  </body>
 </html>  </html>
Line 2531  RESULTS Line 2853  RESULTS
   
 Output a full html page with an error message.  Output a full html page with an error message.
   
   Inputs: 
   
       $r, the request pointer.
       $message, the error message for the user.
       $closebutton, the specialized close button needed for groupsearch.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub output_date_error {  sub output_date_error {
     my ($r,$message)=@_;      my ($r,$message,$closebutton,$hidden_fields)=@_;
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent(\%ENV);      my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
   
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 <html>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>The LearningOnline Network with CAPA</title>
 </head>  </head>
 <body bgcolor="#ffffff">  $bodytag
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $hidden_fields
 <input type='button' value='Revise search request'  <input type='button' value='Revise search request'
 onClick='this.form.submit();' />  onClick='this.form.submit();' />
 $closebutton  $closebutton
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>Error</h3>
 <p>  <p>
 $message  $message
 </p>  </p>
Line 2589  sub start_fresh_session { Line 2916  sub start_fresh_session {
     }      }
 }  }
   
 ######################################################################  1;
 ######################################################################  
   
 =pod   
   
 =item &popwin_js() send javascript to popwin  
   
 =cut  
   
 ######################################################################  sub cleanup {
 ######################################################################      if (tied(%groupsearch_db)) {
 sub popwin_js {          unless (untie(%groupsearch_db)) {
     # Print javascript out to popwin, but make sure we dont generate    &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db');
     # any javascript errors in doing so.          }
     my ($r,$text) = @_;  
     $r->print(<<"END");  
 <script type="text/javascript">  
     if (! popwin.closed) {  
  $text  
     }      }
 </script>      &untiehash();
 END      &Apache::lonmysql::disconnect_from_db();
     $r->rflush();  
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &popwin_imgupdate()  
   
 Send a given image (and its location) out to the browser.  Takes as   
 input $r, loncapa server id, and an icon URL.  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub popwin_imgupdate {  
     my ($r,$server,$icon) = @_;  
     &popwin_js($r,'popwin.document.img_'.$Apache::lonnet::hostdom{$server}.  
                '_'.$server.'.'.'src="/adm/lonIcons/'.$icon.'";');  
 }      
   
 1;  
   
 __END__  __END__
   
 =pod  =pod
Removed from v.1.144  
changed lines
  Added in v.1.213

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