[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.331.4.1

version 1.144, 2002/07/26 16:37:58 version 1.331.4.1, 2012/05/10 18:34:18
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();
   use Parse::RecDescent;
   use Apache::lonnavmaps;
   use Apache::lonindexer();
   use LONCAPA;
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   ##
 =pod   ## Global variables
   ##
 =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  
 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,
                "detailedpreview" => \&detailed_citation_preview,
 =item $hidden       "summary"  => \&summary_view,
                "summarypreview" => \&summary_preview,
 holds 'hidden' html forms       "fielded"  => \&fielded_format_view,
        "xml"      => \&xml_sgml_view,
 =item $scrout       "compact"  => \&compact_view);
   
 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();
       #
       # 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().
   
     $r->content_type('text/html');      #
       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','area','inhibitmenu']);
       ##
       ## 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).      my $temp_file_dir = LONCAPA::tempdir();
             "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";      $diropendb= $temp_file_dir .
     $results_db = "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).          "$env{'user.domain'}_$env{'user.name'}_sel_res.db";
         '_'.&Apache::lonnet::escape($ENV{'user.name'})."_searchresults.db";      #
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      # set the name of the persistent database
              ['catalogmode','launch','acts','mode','form','element',      #          $env{'form.persistent_db_id'} can only have digits in it.
               'reqinterface']);      if (! exists($env{'form.persistent_db_id'}) ||
           ($env{'form.persistent_db_id'} =~ /\D/) ||
           ($env{'form.launch'} eq '1')) {
           $env{'form.persistent_db_id'} = time;
       }
   
       my $persistent_db_file = $temp_file_dir .
           &escape($domain).
               '_'.&escape($env{'user.name'}).
                   '_'.$env{'form.persistent_db_id'}.'_persistent_search.db';
       ##
       &Apache::lonhtmlcommon::clear_breadcrumbs();
   
       my @allowed_searches = ('portfolio');
       if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'})) {
           push(@allowed_searches,'res');
       } 
       my $crumb_text = 'Portfolio Search';
       if (@allowed_searches ==2) {
          $crumb_text = 'Portfolio and Catalog Search'; 
       }
       &Apache::lonhtmlcommon::add_breadcrumb
          ({href=>'/adm/searchcat?'.
          &Apache::loncommon::inhibit_menu_check().
                  '&catalogmode='.$env{'form.catalogmode'}.
                  '&launch='.$env{'form.launch'}.
                  '&mode='.$env{'form.mode'},
                 text=>"$crumb_text",
                 target=>'_top',
                 bug=>'Searching',});
       #
       if ($env{'form.phase'} !~ m/(basic|adv|course)_search/) {
           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);
    my $msg =
       'We were unable to retrieve data describing your search. '.
       'This is a serious error and has been logged. '.
       'Please alert your LON-CAPA administrator.';
    &Apache::loncommon::simple_error_page($r,'Search Error',
         $msg);
    return OK;
               }
           }
       } else {
           &clean_up_environment();
       }
     ##      ##
     ## 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 'import'))) {
    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.
       my $msg = 'Unable to tie hash to db file.';
       &Apache::loncommon::simple_error_page($r,'Search Error',
     $msg);
     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 .= &hidden_field('catalogmode');
       }
       if (exists($env{'form.form'})) {
           $hidden_fields .= &hidden_field('form');
       }
       if (exists($env{'form.element'})) {
           $hidden_fields .= &hidden_field('element');
       }
       if (exists($env{'form.titleelement'})) {
           $hidden_fields .= &hidden_field('titleelement');
       }
       if (exists($env{'form.mode'})) {
           $hidden_fields .= &hidden_field('mode');
       }
       if (exists($env{'form.area'})) {
           $hidden_fields .= &hidden_field('area');
       }
       if (exists($env{'form.inhibitmenu'})) {
           $hidden_fields .= &hidden_field('inhibitmenu');
       }
     ##      ##
     ## 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') {          $closebutton="<input type='button' name='close' value='".&mt('Close')."' ";
  $hidden="<input type='hidden' name='catalogmode' value='interactive'>".          if ($env{'form.phase'} =~ /(results|run_search)/) {
     "\n";              $closebutton .="onclick='parent.close()'";
         $closebutton="<input type='button' name='close' value='CLOSE' ".          } else {
     "onClick='self.close()'>"."\n";              $closebutton .="onclick='self.close()'";
     } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {          }
  $hidden=<<END;          $closebutton .=" />\n";
 <input type='hidden' name='catalogmode' value='groupsearch'>      } elsif ($env{'form.catalogmode'} eq 'import') {
 END          $closebutton="<input type='button' name='close' value='".&mt('Close')."' ";
         $closebutton=<<END;          if ($env{'form.phase'} =~ /(results|run_search)/) {
 <input type='button' name='close' value='CLOSE' onClick='self.close()'>              $closebutton .="onclick='parent.close()'";
 END          } else {
               $closebutton .="onclick='self.close()'";
           }
           $closebutton .= " />";
           my $txt_import = &mt('IMPORT');
         $importbutton=<<END;          $importbutton=<<END;
 <input type='button' name='import' value='IMPORT'  <input type='button' name='import' value='$txt_import'
 onClick='javascript:select_group()'>  onclick='javascript:select_group()' />
 END  END
       } else {
           $closebutton = '';
           $importbutton = '';
       }
       ##
       ## Sanity checks on form elements
       ##
       if (!defined($env{'form.viewselect'})) {
    $env{'form.viewselect'} ="summary";
       }
       $env{'form.phase'} = 'disp_basic' if (! exists($env{'form.phase'}));
       $env{'form.show'} = 20 if (! exists($env{'form.show'}));
       #
       $env{'form.searchmode'} = 'basic' if (! exists($env{'form.searchmode'}));
       if ($env{'form.phase'} eq 'adv_search' ||
           $env{'form.phase'} eq 'disp_adv') {
           $env{'form.searchmode'} = 'advanced';
     }      }
     $hidden .= &make_persistent({ "form.mode"    => $ENV{'form.mode'},      #
                                   "form.form"    => $ENV{'form.form'},      if ($env{'form.searchmode'} eq 'advanced') {
                                   "form.element" => $ENV{'form.element'},          my $srchtype = 'Catalog';
                                   "form.date"    => 2 });          if ($env{'form.area'} eq 'portfolio') {
     ##              $srchtype = 'Portfolio';
     ##  What are we doing?          }
     ##          &Apache::lonhtmlcommon::add_breadcrumb
     my $searchtype;              ({href=>'/adm/searchcat?'.&Apache::loncommon::inhibit_menu_check().
     $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');                    '&amp;phase=disp_adv'.
     $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');                    '&amp;catalogmode='.$env{'form.catalogmode'}.
     if ($searchtype) {                    '&amp;launch='.$env{'form.launch'}.
         # We are running a search                    '&amp;mode='.$env{'form.mode'},
                     text=>"Advanced $srchtype 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,
                            $env{'form.area'});
       } 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,$env{'form.area'});
           }
       } elsif(($env{'form.phase'} eq 'basic_search') ||
               ($env{'form.phase'} eq 'adv_search')) {
           #
           # We are running a search, try to parse it
         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);
               return OK if (! defined($query));
               &make_persistent({ basicexp => $env{'form.basicexp'}},
                                $persistent_db_file);
           } 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);  
   
         $r->rflush();  
     } else {  
         #  
         # We need to get information to search on  
         #          #
         # Set the default view if it is not already set.          # Set up table
         if (!defined($ENV{'form.viewselect'})) {          if (! defined(&create_results_table($env{'form.area'}))) {
             $ENV{'form.viewselect'} ="Detailed Citation View";      my $errorstring=&Apache::lonmysql::get_error();
         }              &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
         # Output the advanced interface                                       'needed table.  lonmysql error:'.
         if ($ENV{'form.reqinterface'} eq 'advanced') {                                       $errorstring);
             $r->print(&advanced_search_form($closebutton,$hidden));  
         } else {       my $msg = 
             # Output normal search interface   'Unable to create table in which to save search results. '.
             $r->print(&basic_search_form($closebutton,$hidden));   'The search has been aborted.';
       &Apache::loncommon::simple_error_page($r,'Search Error',
     $msg);
       return OK;
           }
           delete($env{'form.launch'});
           if (! &make_form_data_persistent($r,$persistent_db_file)) {
       my $msg=
    'Unable to properly save search information. '.
    'The search has been aborted.';
       &Apache::loncommon::simple_error_page($r,'Search Error',
     $msg);
       return OK;
    }
           ##
           ## Print out the frames interface
           ##
           if (defined($query)) {
               &print_frames_interface($r);
         }          }
     }      }
     return OK;      return OK;
 }   } 
   
 ######################################################################  #
   # The mechanism used to store values away and retrieve them does not
   # handle the case of missing environment variables being significant.
   #
   # This routine sets non existant checkbox form elements to ''.
   #
   sub clean_up_environment {
       if ($env{'form.phase'} eq 'basic_search') {
           if (! exists($env{'form.related'})) {
               $env{'form.related'} = '';
           }
           if (! exists($env{'form.domains'})) {
               $env{'form.domains'} = '';
           }
       } elsif ($env{'form.phase'} eq 'adv_search') {
           foreach my $field ('title','keywords','notes',
                              'abstract','standards','mime') {
               if (! exists($env{'form.'.$field.'_related'})) {
                   $env{'form.'.$field.'_related'} = '';
               }
           }
       } elsif ($env{'form.phase'} eq 'course_search') {
           if (! exists($env{'form.crsrelated'})) {
               $env{'form.crsrelated'} = '';
           }
       }
   }
   
   sub hidden_field {
       my ($name,$value) = @_;
       if (! defined($value)) {
           $value = $env{'form.'.$name};
       }
       return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'.$/;
   }
   
 ######################################################################  ######################################################################
   
 =pod   =pod 
   
 =item &basic_search_form()   =item &print_basic_search_form() 
   
 Returns a scalar which holds html for the basic search form.  Prints the form for the basic search.  Sorry the name is so cryptic.
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub print_basic_search_form {
 sub basic_search_form{      my ($r,$closebutton,$hidden_fields) = @_;
     my ($closebutton,$hidden) = @_;      my $result = ($env{'form.catalogmode'} ne 'import');
     my $scrout=<<"ENDDOCUMENT";      my $bread_crumb =
 <html>          &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Basic',
 <head>      $env{'form.catalogmode'} ne 'import');
 <title>The LearningOnline Network with CAPA</title>      my $scrout = &Apache::loncommon::start_page('Content Library').$bread_crumb;
 <script type="text/javascript">  # Search form for resource space 
     function openhelp(val) {      if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'})) {
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',          $scrout .= &setup_basic_search($r,'res',$hidden_fields,$closebutton);
      'scrollbars=1,width=600,height=300');          $scrout .= '<hr /><br />';
  openhelpwin.focus();  
     }      }
 </script>  # Search form for accessible portfolio files
 </head>      $scrout.= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton);
 <body bgcolor="#FFFFFF">      $scrout .= &Apache::loncommon::end_page();
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />      $r->print($scrout);
 <h1>Search Catalog</h1>      return;
 <form method="post" action="/adm/searchcat">  
 $hidden  
 <h3>Basic Search</h3>  
 <p>  
 Enter terms or phrases separated by AND, OR, or NOT   
 then press SEARCH below.  
 </p>  
 <p>  
 <table>  
 <tr><td>  
 ENDDOCUMENT  
     $scrout.='&nbsp;'.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).  
         '&nbsp;';  
 #    $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'});  
 #    $scrout.='<font color="#800000">Search historic archives</font>';  
     my $checkbox = &simplecheckbox('related',$ENV{'form.related'});  
     $scrout.=<<END;  
 </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr>  
 <tr><td>$checkbox use related words</td><td></td></tr>  
 </table>  
 </p>  
 <p>  
 &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;  
 $closebutton  
 END  
     $scrout.=&selectbox(undef,'viewselect',  
  $ENV{'form.viewselect'},  
  undef,undef,undef,  
  sort(keys(%Views)));  
     $scrout.=<<ENDDOCUMENT;  
 <input type="button" value="HELP" onClick="openhelp()" />  
 </p>  
 </form>  
 </body>  
 </html>  
 ENDDOCUMENT  
     return $scrout;  
 }  }
   
   sub setup_basic_search {
       my ($r,$area,$hidden_fields,$closebutton) = @_;
       # Define interface components
       my %lt = &Apache::lonlocal::texthash (
                                 res => 'LON-CAPA Catalog Search',
                                 portfolio => 'Portfolio Search',
       );
       my ($userelatedwords,$onlysearchdomain,$inclext,$adv_search_link,$scrout);
   
       $userelatedwords = '<label>'
                         .&Apache::lonhtmlcommon::checkbox(
                              'related',
                              $env{'form.related'},
                              'related')
                         .' '
                        .&mt('use related words')
                        .'</label>';
   
       $onlysearchdomain = '<label>'
                          .&Apache::lonhtmlcommon::checkbox(
                              'domains',
                              $env{'form.domains'},
                              $r->dir_config('lonDefDomain'))
                          .' '
                          .&mt('only search domain [_1]'
                                  ,'<b>'.$r->dir_config('lonDefDomain').'</b>')
                          .'</label>';
   
       $adv_search_link = '<a href="/adm/searchcat?'.
                  &Apache::loncommon::inhibit_menu_check().
          '&amp;phase=disp_adv'.
                          '&amp;catalogmode='.$env{'form.catalogmode'}.
                          '&amp;launch='.$env{'form.launch'}.
                          '&amp;mode='.$env{'form.mode'}.
                          '&amp;area='.$area.
                          '&amp;form='.$env{'form.form'}.
                          '&amp;titleelement='.$env{'form.titleelement'}.
                          '&amp;element='.$env{'form.element'}.
                          '">'.&mt('Advanced Search').'</a>';
       #
       $scrout.='<form name="loncapa_search" method="post" '.
                'action="/adm/searchcat">'.
                '<input type="hidden" name="phase" value="basic_search" />'.
                $hidden_fields;
                if (!exists($env{'form.area'})) {
                    $scrout .= '<input type="hidden" name="area" value="'.$area.'" />';
                }
       #
       $scrout .= '<div align="center">'.$/;
   #    if ($env{'request.course.id'}) {
           $scrout .= '<h1>'.$lt{$area}.'</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 />'.
               '<span class="LC_fontsize_small">'.&searchhelp().'</span>'.'</td>'.
               '<td>'.
               '<span class="LC_nobreak">'.('&nbsp;'x3).$adv_search_link.'</span>'.'<br />'.
               '<span class="LC_nobreak">'.('&nbsp;'x1).$userelatedwords.'</span>'.'<br />'.
               '<span class="LC_nobreak">'.('&nbsp;'x1).$onlysearchdomain.'</span>'.'<br />'.
               '<span class="LC_nobreak">'.('&nbsp;'x1).$inclext.'</span>'.'<br />'.
                '</td>'.
               '</tr>'.
               '</table>'.$/;
       #
       $scrout .= '<p>'
                 .&viewoptions()
                 .'</p>'
                 .'<p>'
                 .'<input type="submit" name="basicsubmit" '
                 .'value="'.&mt('Search').'" />'
                 .' '
                 .$closebutton
                 .'</p>';
       #
       $scrout .= '</div>'.'</form>';
       return $scrout;
   } 
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 361  ENDDOCUMENT Line 546  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 $bread_crumb = 
     my $advanced_buttons = <<"END";          &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Advanced',
       $env{'form.catalogmode'} ne 'import');
       my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
          'reset' => 'Reset',
          'help' => 'Help');
       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()" />  
 </p>  </p>
 END  END
     if (!defined($ENV{'form.viewselect'})) {      my $srchtype = 'Catalog';
         $ENV{'form.viewselect'} ="Detailed Citation View";      my $jscript;
     }      if ($env{'form.area'} eq 'portfolio') {
     my $scrout=<<"ENDHEADER";          $srchtype = 'Portfolio';
 <html>          $jscript = '<script type="text/javascript">
 <head>  // <![CDATA[
 <title>The LearningOnline Network with CAPA</title>  function additional_metadata() {
 <script type="text/javascript">      if (document.advsearch.newfield.checked) {
     function openhelp(val) {          document.advsearch.phase.value = "disp_adv";
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',          document.advsearch.numaddedfields.value = parseInt(document.advsearch.numaddedfields.value) +1;
      'scrollbars=1,width=600,height=300');          document.advsearch.submit();
  openhelpwin.focus();      }
   }
   // ]]>
   </script>';
       }
       my $scrout= &Apache::loncommon::start_page("Advanced $srchtype Search",
                                                  $jscript);
       $scrout .= $bread_crumb;
   
       $scrout .= '<form method="post" action="/adm/searchcat" name="advsearch">'
                 .$hidden_fields 
                 .'<input type="hidden" name="phase" value="adv_search" />';
   
       $scrout .= '<fieldset>'."\n"
                 .'<legend>'.&mt('Display Options').'</legend>'."\n"
                 .&viewoptions()
                 .'</fieldset>';
   
       $scrout .= $advanced_buttons;
   
       $scrout .= &Apache::lonhtmlcommon::start_pick_box();
   
       my %fields=&Apache::lonmeta::fieldnames();
   
       # Standard Metadata
       $scrout .= &Apache::lonhtmlcommon::row_headline()
                 .'<h3>'.&mt("Standard $srchtype Metadata").'</h3>'
                 .&searchhelp()
                 .&Apache::lonhtmlcommon::row_closure();
       my %related_word_search = 
           ('title'    => 1,
            'author'   => 0,
            'owner'    => 0,
            'authorspace'  => 0,
            'modifyinguser'=> 0,
            'keywords' => 1,
            'notes'    => 1,
            'abstract' => 1,
            'standards'=> 1,
            'mime'     => 1,
            'subject'  => 1,
            );
       #
       foreach my $field ('title','author','subject','owner','authorspace',
                          'modifyinguser','keywords','notes','abstract',
                          'standards','mime') {
           $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield($fields{$field}))
                     .&Apache::lonmeta::prettyinput($field,
                                             $env{'form.'.$field},
                                             $field,
                                             'advsearch',
                                             $related_word_search{$field},
                                             '',
                                             $env{'form.'.$field.'_related'},
                                             50);
           if ($related_word_search{$field}) {
               $scrout .= &mt('related words');
           } else {
               $scrout .= '';
           }
           $scrout .= &Apache::lonhtmlcommon::row_closure();
     }      }
 </script>      foreach my $field ('lowestgradelevel','highestgradelevel') {
 </head>          $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield($fields{$field}))
 <body bgcolor="#FFFFFF">                    .&Apache::lonmeta::prettyinput($field,
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />                                            $env{'form.'.$field},
 <h1>Advanced Catalog Search</h1>                                            $field,
 <hr />                                            'advsearch',
 Enter terms or phrases separated by search operators                                             0)
 such as AND, OR, or NOT.<br />                    .&Apache::lonhtmlcommon::row_closure();
 <form method="post" action="/adm/searchcat">      }
 $advanced_buttons  
 $hidden      $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('MIME Type Category')))
 <table>                .&Apache::loncommon::filecategoryselect('category',
 <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>                     $env{'form.category'})
 <td>                .&Apache::lonhtmlcommon::row_closure();
 ENDHEADER  
     $scrout.=&selectbox(undef,'viewselect',      $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Domains')))
  $ENV{'form.viewselect'},                .&Apache::loncommon::domain_select('domains',
  undef,undef,undef,                     $env{'form.domains'},1)
  sort(keys(%Views)));                .&Apache::lonhtmlcommon::row_closure();
     $scrout.="</td><td>Related<br />Words</td></tr>\n";  
     $scrout.=&searchphrasefield_with_related('title',   'title'   ,      # Misc metadata
                                              $ENV{'form.title'});      if ($env{'form.area'} ne 'portfolio') {
     $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});          $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Copyright/Distribution')))
     $scrout.=&searchphrasefield_with_related('subject', 'subject' ,                    .&Apache::lonmeta::selectbox('copyright',
                                              $ENV{'form.subject'});                                               $env{'form.copyright'},
     $scrout.=&searchphrasefield_with_related('keywords','keywords',                                  \&Apache::loncommon::copyrightdescription,
                                              $ENV{'form.keywords'});                                         ( undef,
     $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});                                          &Apache::loncommon::copyrightids)
     $scrout.=&searchphrasefield_with_related('notes',   'notes'   ,                                  )
                                              $ENV{'form.notes'});                    .&Apache::lonhtmlcommon::row_closure();
     $scrout.=&searchphrasefield_with_related('abstract','abstract',      }
                                              $ENV{'form.abstract'});  
     # Hack - an empty table row.      $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Language')))
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";                .&Apache::lonmeta::selectbox('language',
     $scrout.=&searchphrasefield('file<br />extension','mime',                                      $env{'form.language'},
                         $ENV{'form.mime'});                                      \&Apache::loncommon::languagedescription,
     $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n";                                      ('any',&Apache::loncommon::languageids)
     $scrout.=&searchphrasefield('publisher<br />owner','owner',                                      )
  $ENV{'form.owner'});                .&Apache::lonhtmlcommon::row_closure();
     $scrout.="</table>\n";      
     $ENV{'form.category'}='any' unless length($ENV{'form.category'});      # Portfolio Metadata
     $scrout.=&selectbox('File Category','category',      if ($env{'form.area'} eq 'portfolio') {
  $ENV{'form.category'},          # Added fields
  'any','Any category',          my $curnumadd = $env{'form.numaddedfields'};
  undef,          if ($curnumadd eq '') {
  (&Apache::loncommon::filecategories()));              $curnumadd = 1;
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});          }
     #----------------------------------------------------------------          $scrout .= &Apache::lonhtmlcommon::row_headline()
     # Allow restriction to multiple domains.                    .'<h3>'.&mt('Custom Metadata fields').'</h3>'
     #   I make the crazy assumption that there will never be a domain 'any'.                    .&Apache::lonhtmlcommon::row_closure()
     #                    .&Apache::lonhtmlcommon::row_title('')
     $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));                    .&mt('Field Name').' | '.&mt('Field Value(s)')
     my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}}                     .&Apache::lonhtmlcommon::row_closure();
                            :  ($ENV{'form.domains'}) );  
     my %domain_hash = ();          for (my $j=0; $j<$curnumadd; $j++) {
     foreach (@allowed_domains) {              my $num = $j+1;
         $domain_hash{$_}++;              $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Custom metadata [_1]',$num))
                         .'<input type="text"'
                         .' name="addedfield_'.$j.'" size="10"'
                         .' value="'.$env{'form.addedfield_'.$j}.'" />'
                         .' '
                         .'<input type="text" '
                         .'name="addedvalues_'.$j.'" size="15"'
                         .' value="'.$env{'form.addedvalues_'.$j}.'" />'
                         .&Apache::lonhtmlcommon::row_closure();
           }
           $scrout .= &Apache::lonhtmlcommon::row_title('')
                     .'<label>'
                     .'<input type="checkbox" name="newfield"'
                     .' value="1" onclick="javascript:additional_metadata()" />'
                     .&mt('Another custom field/value pair?').'</label>'
                     .'<input type="hidden" name="numaddedfields"'
                     .' value="'.$curnumadd.'" />'
                     .&Apache::lonhtmlcommon::row_closure();
   } else {
           #
           # Dynamic metadata
           $scrout .= &Apache::lonhtmlcommon::row_headline()
                     .'<h3>'.&mt('Problem Statistics').'</h3>'
                     .&Apache::lonhtmlcommon::row_closure();
           $scrout .= &Apache::lonhtmlcommon::row_title('')
                     .&mt('Minimum').' | '.&mt('Maximum')
                     .&Apache::lonhtmlcommon::row_closure();
           foreach my $statistic 
               ({ name=>'count',
                  description=>'Network-wide number of accesses (hits)',},
                { name=>'stdno',
                  description=>
                  'Statistics calculated for number of students',},
                { name => 'avetries',
                  description=>'Average number of tries till solved',},
                { name => 'difficulty',
                  description=>'Degree of difficulty',},
                { name => 'disc',
                  description=>'Degree of discrimination'}) {
                 $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt($statistic->{'description'})))
                           .'<input type="text" name="'.$statistic->{'name'}
                           .'_min" value="" size="6" />'
                           .' '
                           .'<input type="text" name="'.$statistic->{'name'}
                           .'_max" value="" size="6" />'
                           .&Apache::lonhtmlcommon::row_closure();
           }
   
           $scrout .= &Apache::lonhtmlcommon::row_headline()
                     .'<h3>'.&mt('Evaluation Data').'</h3>'
                     .&Apache::lonhtmlcommon::row_closure();
           $scrout .= &Apache::lonhtmlcommon::row_title('')
                     .&mt('Minimum').' | '.&mt('Maximum')
                     .&Apache::lonhtmlcommon::row_closure();
           foreach my $evaluation
               ( { name => 'clear',
                   description => 'Material presented in clear way'},
                 { name =>'depth',
                   description => 'Material covered with sufficient depth'},
                 { name => 'helpful',
                   description => 'Material is helpful'},
                 { name => 'correct',
                   description => 'Material appears to be correct'},
                 { name => 'technical',
                   description => 'Resource is technically correct'}){
               $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt($evaluation->{'description'})))
                         .'<input type="text" name="'
                         .$evaluation->{'name'}.'_min" value="" size="6" />'
                         .' '
                         .'<input type="text" name="'
                         .$evaluation->{'name'}.'_max" value="" size="6" />'
                         .&Apache::lonhtmlcommon::row_closure();
           }
     }      }
     my @domains =&Apache::loncommon::get_domains();      #
     # adjust the size of the select box      # Creation/Modification date limits
     my $size = 4;      $scrout .= &Apache::lonhtmlcommon::row_headline()
     my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);                .'<h3>'.&mt('Creation and Modification dates').'</h3>'
     # standalone machines do not get to choose a domain to search.                .&Apache::lonhtmlcommon::row_closure();
     if ((scalar @domains) == 1) {      $scrout .= &Apache::lonhtmlcommon::row_title('')
         $scrout .='<input type="hidden" name="domains" value="any" />'."\n";                .&mt('Month[_1]Day[_2]Year','&nbsp;'x14,'&nbsp;'x6)
     } else {                .&Apache::lonhtmlcommon::row_closure();
         $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.  
             'DOMAINS</b></font><br />'.      my $cafter = 
                 '<select name="domains" size="'.$size.'" multiple>'."\n".          &Apache::lonhtmlcommon::date_setter('advsearch',         # formname
                     '<option name="any" value="any" '.                                              'creationdate1', # fieldname
                         ($domain_hash{'any'}? 'selected ' :'').                                              0,           # current value
                         '>all domains</option>'."\n";                                              '',          # special 
         foreach my $dom (sort @domains) {                                              1,           # includeempty
             $scrout.="<option name=\"$dom\" ".                                              '',          # state
                 ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";                                              1,           # no_hh_mm_ss
         }                                              );
         $scrout.="</select>\n";      my $cbefore = 
     }          &Apache::lonhtmlcommon::date_setter('advsearch',         # formname
     #----------------------------------------------------------------                                              'creationdate2', # fieldname
     $scrout.=&selectbox('Limit by language','language',                                              0,           # current value
  $ENV{'form.language'},'any','Any Language',                                              '',          # special 
  \&{Apache::loncommon::languagedescription},                                              1,           # includeempty
  (&Apache::loncommon::languageids),                                              '',          # state
  );                                              1,           # no_hh_mm_ss
 # ------------------------------------------------ Compute date selection boxes                                              );
     $scrout.=<<CREATIONDATESTART;      $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Created between'))
 <p>                .$cafter
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>                .&Apache::lonhtmlcommon::row_closure(1)
 </font>                .&Apache::lonhtmlcommon::row_title(&mt('and'))
 <br />                .$cbefore
 between:                .&Apache::lonhtmlcommon::row_closure();
 CREATIONDATESTART  
     $scrout.=&dateboxes('creationdatestart',1,1,1976,      my $lafter = 
  $ENV{'form.creationdatestart_month'},          &Apache::lonhtmlcommon::date_setter('advsearch',
  $ENV{'form.creationdatestart_day'},                                              'revisiondate1', 
  $ENV{'form.creationdatestart_year'},                                              0,           # current value
  );                                              '',          # special 
     $scrout.="and:\n";                                              1,           # includeempty
     $scrout.=&dateboxes('creationdateend',12,31,2051,                                              '',          # state
  $ENV{'form.creationdateend_month'},                                              1,           # no_hh_mm_ss
  $ENV{'form.creationdateend_day'},                                              );
  $ENV{'form.creationdateend_year'},      my $lbefore = 
  );          &Apache::lonhtmlcommon::date_setter('advsearch',
     $scrout.="</p>";                                              'revisiondate2',
     $scrout.=<<LASTREVISIONDATESTART;                                              0,           # current value
 <p>                                              '',          # special 
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:                                              1,           # includeempty
 </b></font>                                              '',          # state
 <br />between:                                              1,           # no_hh_mm_ss
 LASTREVISIONDATESTART                                              );
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,      $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Last modified between'))
  $ENV{'form.lastrevisiondatestart_month'},                .$lafter
  $ENV{'form.lastrevisiondatestart_day'},                .&Apache::lonhtmlcommon::row_closure(1)
  $ENV{'form.lastrevisiondatestart_year'},                .&Apache::lonhtmlcommon::row_title(&mt('and'))
  );                .$lbefore
     $scrout.=<<LASTREVISIONDATEEND;                .&Apache::lonhtmlcommon::row_closure(1); # Last row of total pick_box
 and:  
 LASTREVISIONDATEEND      $scrout .= &Apache::lonhtmlcommon::end_pick_box();
     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,  
  $ENV{'form.lastrevisiondateend_month'},      $scrout .= $advanced_buttons
  $ENV{'form.lastrevisiondateend_day'},                .'</form>';
  $ENV{'form.lastrevisiondateend_year'},  
  );      $scrout .= &Apache::loncommon::end_page();
     $scrout.='</p>';      $r->print($scrout);
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});      return;
     $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;  
 $advanced_buttons  
 </form>  
 </body>  
 </html>  
 ENDDOCUMENT  
     return $scrout;  
 }  }
   
 ######################################################################  ######################################################################
Line 556  ENDDOCUMENT Line 844  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  
   
 Returns a text input field with the given name, value, and size.    
 If size is not specified, a value of 20 is used.  
   
 =cut  
   
 ###############################################  
 ###############################################  
   
 sub simpletextfield {  
     my ($name,$value,$size)=@_;  
     $size = 20 if (! defined($size));  
     return '<input type="text" name="'.$name.  
         '" size="'.$size.'" value="'.$value.'" />';  
 }  
   
 ###############################################  
 ###############################################  
   
 =pod  Inputs: codename for view option
   
 =item &simplecheckbox()  
   
 Inputs: $name,$value  Outputs: displayed text
   
 Returns a simple check box with the given $name.  
 If $value eq 'on' the box is checked.  
   
 =cut  =cut
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   sub viewoptiontext {
 sub simplecheckbox {      my $code=shift;
     my ($name,$value)=@_;      my %desc=&Apache::lonlocal::texthash
     my $checked='';          ('detailed' => "Detailed Citation View",
     $checked="checked" if $value eq 'on';           'xml' => 'XML/SGML',
     return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';           'compact' => 'Compact View',
            'fielded' => 'Fielded Format',
            'summary' => 'Summary View',
            'summarypreview' => 'Summary Preview',
            'detailedpreview' => 'Detailed Citation Preview');
       return $desc{$code};
 }  }
   
 ###############################################  ######################################################################
 ###############################################  ######################################################################
   
 =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;
     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 .= '<span class="LC_nobreak">'
                 .&mt('Type:').' '
                 .&Apache::lonmeta::selectbox('viewselect',
                      $env{'form.viewselect'},
                      \&viewoptiontext,
                      sort(keys(%Views)))
                 .'</span>';
       my $countselect = &Apache::lonmeta::selectbox('show',
                                                     $env{'form.show'},
                                                     undef,
                                                     (10,20,50,100,1000,10000));
       $scrout .= ' <span class="LC_nobreak">'
                 .&mt('Records per Page:').' '.$countselect
                 .'</span>'.$/;
       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 words and quoted phrases');
     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 
   
 ###############################################  =item &get_persistent_form_data()
 ###############################################  
       
 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";  
 }  
   
 ###############################################  Inputs: filename of database
 ###############################################  
   
 =pod  Outputs: returns undef on database errors.
   
 =item &dateboxes()  This function is the reverse of &make_persistent() for form data.
   Retrieve persistent data from %persistent_db.  Retrieved items will have their
 Returns html selection form elements for the specification of   values unescaped.  If a form value already exists in $env, it will not be
 the day, month, and year.  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);              &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   =pod 
   
 The name element of the <select> tag.  =item &get_persistent_data()
   
 =item $default   Inputs: filename of database, ref to array of values to recover.
   
 The default value of the form.  Can be $anyvalue, or in @idlist.  Outputs: array of values.  Returns undef on error.
   
 =item $anyvalue   This function is the reverse of &make_persistent();
   Retrieve persistent data from %persistent_db.  Retrieved items will have their
   values unescaped.  If the item contains commas (before unescaping), the
   returned value will be an array pointer. 
   
 The <option value="..."> used to indicate a default of   =cut
 none of the values.  Can be undef.  
   
 =item $anytag   ######################################################################
   ######################################################################
   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 { 
               &unescape($_);
           } split(',',$persistent_db{$name});
           if (@values <= 1) {
               push @Values,$values[0];
           } else {
               push @Values,\@values;
           }
       }
       untie (%persistent_db);
       return @Values;
   }
   
 The text associate with $anyvalue above.  ######################################################################
   ######################################################################
   
 =item $functionref   =pod 
   
 Each element in @idlist will be passed as a parameter   =item &make_persistent() 
 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   Inputs: Hash of values to save, filename of persistent database.
   
 The items to be selected from.  One of these or $anyvalue will be the   Store variables away to the %persistent_db.
 value returned by the form element, $ENV{form.$name}.  Values will be escaped.  Values that are array pointers will have their
   elements escaped and concatenated in a comma separated string.  
 =back  
   
 =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 { &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 1129  Parse advanced search form and return th
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub parse_advanced_search {  sub parse_advanced_search {
     my ($r)=@_;      my ($r,$closebutton,$hidden_fields)=@_;
       my @BasicFields = ('title','author','subject','keywords','url','version',
                          'notes','abstract','extension','owner','authorspace',
   #                       'custommetadata','customshow',
                          'modifyinguser','standards','mime');
       my @StatsFields = &statfields();
       my @EvalFields = &evalfields();
     my $fillflag=0;      my $fillflag=0;
     my $pretty_search_string = "<br />\n";      my $pretty_search_string = "";
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('title','author','subject','keywords','url','version',      for my $field (@BasicFields,
    'creationdatestart_month','creationdatestart_day',                     'creationdatestart_month','creationdatestart_day',
    'creationdatestart_year','creationdateend_month',     'creationdatestart_year','creationdateend_month',
    'creationdateend_day','creationdateend_year',     'creationdateend_day','creationdateend_year',
    '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',   $env{'form.'.$field}=~s/[^\w\/\s\(\)\=\-\"\'.\*]//g;
    'custommetadata','customshow','category') {  
  $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;  
     }      }
     foreach ('mode','form','element') {      foreach ('mode','form','element') {
  # is this required?  Hmmm.   # is this required?  Hmmm.
  next unless (exists($ENV{"form.$_"}));   next if (! exists($env{'form.'.$_}));
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $env{'form.'.$_}=&unescape($env{'form.'.$_});
  $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',      foreach my $field (@BasicFields) {
    'notes','abstract','mime','language','owner',   if (&filled($env{'form.'.$field})) {
    'custommetadata') {  
  if (&filled($ENV{"form.$field"})) {  
     $fillflag++;      $fillflag++;
  }   }
     }      }
     unless ($fillflag) {      foreach my $field (@StatsFields,@EvalFields) {
  &output_blank_field_error($r);          if (&filled($env{'form.'.$field.'_max'})) {
               $fillflag++;
           }
           if (&filled($env{'form.'.$field.'_min'})) {
               $fillflag++;
           }
       }
   
       for my $field ('lowestgradelevel','highestgradelevel') {
           if ( $env{'form.'.$field} =~ /^\d+$/ &&
                $env{'form.'.$field} > 0) {
               $fillflag++;
           }
       }
       if ($env{'form.area'} eq 'portfolio') {
           # Added metadata fields
           for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) {
               my $field = $env{'form.addedfield_'.$i};
               $field =~ s/^\s*(\S*)\s*$/$1/;
               $field =~ s/\W/_/g;
               if ($field ne '') {
                   $fillflag++;
               }
           }
       }
       if (! $fillflag) {
    &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 937  sub parse_advanced_search { Line 1200  sub parse_advanced_search {
     my @queries;      my @queries;
     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 (@BasicFields) {
        'keywords','version','owner','mime') {   next if (!defined($env{'form.'.$field}) || $env{'form.'.$field} eq '');
  if ($ENV{'form.'.$field}) {          my ($error,$SQLQuery) = 
             my $searchphrase = $ENV{'form.'.$field};              &process_phrase_input($env{'form.'.$field},
             $pretty_search_string .= $font."$field</font> contains <b>".                                    $env{'form.'.$field.'_related'},$field);
                 $searchphrase."</b>";          if (defined($error)) {
             if ($ENV{'form.'.$field.'_related'}) {              &output_unparsed_phrase_error($r,$closebutton,'phase=disp_adv',
                 my @New_Words;                                           $hidden_fields,$field);
                 ($searchphrase,@New_Words) = &related_version($searchphrase);              return;
                 if (@New_Words) {          } else {
                     $pretty_search_string .= " with related words: ".              $pretty_search_string .= 
                         "<b>@New_Words</b>.";                  $font.$field.'</font>: '.$env{'form.'.$field};
               if ($env{'form.'.$field.'_related'}) {
                   my @Words = 
                       &Apache::loncommon::get_related_words
                       ($env{'form.'.$field});
                   if (@Words) {
                       $pretty_search_string.= ' with related words: '.
                           join(', ',@Words[0..4]);
                 } else {                  } else {
                     $pretty_search_string .= " with no related words.";                      $pretty_search_string.= ' with related words.';
                 }                  }
             }              }
             $pretty_search_string .= "<br />\n";              $pretty_search_string .= '<br />';
     push @queries,&build_SQL_query($field,$searchphrase);              push (@queries,$SQLQuery);
           }
       }
       #
       # Make the 'mime' from 'form.category' and 'form.extension'
       #
       my $searchphrase;
       if (exists($env{'form.category'})    && 
           $env{'form.category'} !~ /^\s*$/ &&
           $env{'form.category'} ne 'any')     {
           my @extensions = &Apache::loncommon::filecategorytypes
                                                      ($env{'form.category'});
           if (scalar(@extensions) > 0) {
               $searchphrase = join(' OR ',@extensions);
         }          }
     }      }
     # I dislike the hack below.      if (defined($searchphrase)) {
     if ($ENV{'form.category'}) {          my ($error,$SQLsearch) = &process_phrase_input($searchphrase,0,'mime');
         $ENV{'form.mime'}='';          push @queries,$SQLsearch;
           $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.lowestgradelevel'}        &&
  push @queries,"(language like \"$ENV{'form.language'}\")";          $env{'form.lowestgradelevel'} ne '0' &&
           $env{'form.lowestgradelevel'} =~ /^\d+$/) {
    push(@queries,
                '(lowestgradelevel>='.$env{'form.lowestgradelevel'}.')');
           $pretty_search_string.="lowestgradelevel>=".
               $env{'form.lowestgradelevel'}."<br />\n";
       }
       if ($env{'form.highestgradelevel'}        &&
           $env{'form.highestgradelevel'} ne '0' &&
           $env{'form.highestgradelevel'} =~ /^\d+$/) {
    push(@queries,
                '(highestgradelevel<='.$env{'form.highestgradelevel'}.')');
           $pretty_search_string.="highestgradelevel<=".
               $env{'form.highestgradelevel'}."<br />\n";
       }
       if ($env{'form.language'} and $env{'form.language'} ne 'any') {
    push @queries,"(language like \"$env{'form.language'}\")";
         $pretty_search_string.=$font."language</font>= ".          $pretty_search_string.=$font."language</font>= ".
             &Apache::loncommon::languagedescription($ENV{'form.language'}).              &Apache::loncommon::languagedescription($env{'form.language'}).
                 "<br />\n";                  "<br />\n";
     }      }
     if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {      if ($env{'form.copyright'} and $env{'form.copyright'} ne 'any') {
  push @queries,"(copyright like \"$ENV{'form.copyright'}\")";   push @queries,"(copyright like \"$env{'form.copyright'}\")";
         $pretty_search_string.=$font."copyright</font> = ".          $pretty_search_string.=$font."copyright</font> = ".
             &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}).              &Apache::loncommon::copyrightdescription($env{'form.copyright'}).
                 "<br \>\n";                  "<br />\n";
       }
       if ($env{'form.area'} eq 'portfolio') {
           #
           # Added metadata fields
           for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) {
               my $field = $env{'form.addedfield_'.$i};
               $field =~ s/^\s*(\S*)\s*$/$1/;
               $field =~ s/\W/_/g;
               $field =~ tr/A-Z/a-z/; 
               if ($field ne '') {
                   my $value = $env{'form.addedvalues_'.$i};
                   if ($value ne '') {
                       $value =~ s/'/''/g; #' stupid emacs
                       my ($error,$query) = 
                           &process_phrase_input($value,0,'pf.value');
                       if (!defined($error)) {
                           push(@queries,"pf.field = '$field' AND $query");
                           $pretty_search_string .=
                               $font.$field.'</font>: '.
                               $env{'form.addedvalues_'.$i}.'<br />';
                       }
                   } else {
                       push(@queries,"pf.field = '$field' AND pf.value IS NULL");
                   }
               }
           }
       } else {
           #
           # Statistics
           foreach my $field (@StatsFields,@EvalFields) {
               my ($min,$max);
               if (exists($env{'form.'.$field.'_min'}) && 
                   $env{'form.'.$field.'_min'} ne '') {
                   $min = $env{'form.'.$field.'_min'};
               }
               if (exists($env{'form.'.$field.'_max'}) &&
                   $env{'form.'.$field.'_max'} ne '') {
                   $max = $env{'form.'.$field.'_max'};
               }
               next if (! defined($max) && ! defined($min));
               if (defined($min) && defined($max)) {
                   ($min,$max) = sort {$a <=>$b} ($min,$max);
               }
               if (defined($min) && $min =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
                   push(@queries,'('.$field.'>'.$min.')');
                   $pretty_search_string.=$font.$field.'</font>&gt;'.$min.'<br />';
               }
               if (defined($max) && $max =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
                   push(@queries,'('.$field.'<'.$max.')');
                   $pretty_search_string.=$font.$field.'</font>&lt;'.$max.'<br />';
               }
           }
     }      }
     #      #
     # Evaluate date windows      # Evaluate date windows
     my $datequery=&build_date_queries(      my $cafter =
  $ENV{'form.creationdatestart_month'},          &Apache::lonhtmlcommon::get_date_from_form('creationdate1');
  $ENV{'form.creationdatestart_day'},      my $cbefore = 
  $ENV{'form.creationdatestart_year'},          &Apache::lonhtmlcommon::get_date_from_form('creationdate2');
  $ENV{'form.creationdateend_month'},      if ($cafter > $cbefore) {
  $ENV{'form.creationdateend_day'},          my $tmp = $cafter;
  $ENV{'form.creationdateend_year'},          $cafter = $cbefore;
  $ENV{'form.lastrevisiondatestart_month'},          $cbefore = $tmp;
  $ENV{'form.lastrevisiondatestart_day'},      }
  $ENV{'form.lastrevisiondatestart_year'},      my $mafter = 
  $ENV{'form.lastrevisiondateend_month'},          &Apache::lonhtmlcommon::get_date_from_form('revisiondate1');
  $ENV{'form.lastrevisiondateend_day'},      my $mbefore =
  $ENV{'form.lastrevisiondateend_year'},          &Apache::lonhtmlcommon::get_date_from_form('revisiondate2');
  );      if ($mafter > $mbefore) {
     # Test to see if date windows are legitimate          my $tmp = $mafter;
     if ($datequery=~/^Incorrect/) {          $mafter = $mbefore;
  &output_date_error($r,$datequery);          $mbefore = $tmp;
  return ;      }
     } elsif ($datequery) {      my ($datequery,$error,$prettydate)=&build_date_queries($cafter,$cbefore,
                                                              $mafter,$mbefore);
       if (defined($error)) {
           &output_date_error($r,$error,$closebutton,$hidden_fields);
       } elsif (defined($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.
           $pretty_search_string .= '<br />'.$prettydate.'<br />';
  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();
       if ($pretty_domains_string) {
          $pretty_search_string .= $pretty_domains_string."<br />\n";
       }
       #
       if (@queries) {
           if ($env{'form.area'} eq 'portfolio') {
               $query ="SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa, portfolio_addedfields pf WHERE (pm.url = pa.url AND pf.url = pm.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND (".join(') AND (',@queries).'))';
           } else {
       $query="SELECT * FROM metadata WHERE (".join(") AND (",@queries).')';
           }
       } elsif ($customquery) {
           $query = '';
       }
       #&Apache::lonnet::logthis('advanced query = '.$/.$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'} eq '') {
                            :  ($ENV{'form.domains'}) );          return (undef,'',undef);
       }
       my @allowed_domains = &Apache::loncommon::get_env_multiple('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 = &mt("in all LON-CAPA domains.");
     } else {      } else {
         if (@allowed_domains > 1) {          if (@allowed_domains > 1) {
             $pretty_domains_string = "Searching domains:";              $pretty_domains_string = &mt("in LON-CAPA domains:");
         } else {          } else {
             $pretty_domains_string = "Searching domain ";              $pretty_domains_string = &mt("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)) {   my %servers = &Apache::lonnet::get_unique_servers(\@allowed_domains,
             if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {     'library');
                 push @$libraries_to_query,$_;   $libraries_to_query = [keys(%servers)];
             }  
         }  
     }  
     $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,      return ($libraries_to_query,
             $pretty_search_string);              $pretty_domains_string);
 }  }
   
 ######################################################################  ######################################################################
Line 1072  Parse the basic search form and return a Line 1450  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;
     }      }
     foreach ('mode','form','element') {      foreach ('mode','form','element') {
  # is this required?  Hmmm.   # is this required?  Hmmm.
  next unless (exists($ENV{"form.$_"}));   next unless (exists($env{"form.$_"}));
  $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});   $env{"form.$_"}=&unescape($env{"form.$_"});
  $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;   $env{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       my ($libraries_to_query,$pretty_domains_string) = &parse_domain_restrictions();
     # Check to see if enough is filled in      #
     unless (&filled($ENV{'form.basicexp'})) {      # Check to see if enough of a query is filled in
  &output_blank_field_error($r);      my $search_string = $env{'form.basicexp'};
       if (! &filled($search_string)) {
    &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=$search_string;
     my $search_string = $ENV{'form.basicexp'};      my @Queries;
     if ($ENV{'form.related'}) {      my @fields = ('title','author','subject','notes','abstract','keywords');
         my @New_Words;      my $searchfield;
         ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'});      if ($env{'form.area'} eq 'portfolio') {
         if (@New_Words) {          $searchfield = 'concat_ws(" ",pm.'.join(',pm.',@fields).')';
             $pretty_search_string .= " with related words: <b>@New_Words</b>.";      } else {
         } else {          $searchfield = 'concat_ws(" ",'.join(',',@fields).')';
             $pretty_search_string .= " with no related words.";      }
         }      my ($error,$SQLQuery) = &process_phrase_input($search_string,
                                                       $env{'form.related'},
                                                       $searchfield);
       if ($error) {
           &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic',
                                         '','basicexp');
           return;
       }
       push(@Queries,$SQLQuery);
       #foreach my $q (@Queries) {
       #    &Apache::lonnet::logthis('    '.$q);
       #}
       my $final_query;
       if ($env{'form.area'} eq 'portfolio') {
           $final_query = 'SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa  WHERE (pm.url = pa.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND '.join(" AND ",@Queries).')';
       } else {
           $final_query = 'SELECT * FROM metadata WHERE '.join(" AND ",@Queries);
       }
       #
       if ($env{'form.related'}) {
    $pretty_search_string.=' '.&mt('(including related words)');
       }
       if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
           $pretty_search_string .= ' '.$pretty_domains_string;
     }      }
     # Build SQL query string based on form page  
     my $query='';  
     my $concatarg=join(',"    ",',  
        ('title', 'author', 'subject', 'notes', 'abstract',  
                         'keywords'));  
     $concatarg='title' if $ENV{'form.titleonly'};  
     $query=&build_SQL_query('concat('.$concatarg.')',$search_string);  
     $pretty_search_string .= "<br />\n";      $pretty_search_string .= "<br />\n";
     return 'select * from metadata where '.$query,$pretty_search_string;      $pretty_search_string =~ s:^<br /> and ::;
       &Apache::lonnet::logthis('simple search final query = '.$/.$final_query);
       return ($final_query,$pretty_search_string,
               $libraries_to_query);
 }  }
   
   
   ###############################################################
   ###############################################################
   
   my @Phrases;
   
   sub concat {
       my ($item) = @_;
       my $results = '';
       foreach (@$item) {
           if (ref($_) eq 'ARRAY') {
               $results .= join(' ',@$_);
           }
       }
       return $results;
   }
   
   sub process_phrase_input {
       my ($phrase,$related,$field)=@_;
       #&Apache::lonnet::logthis('phrase = :'.$phrase.':');
       my $grammar = <<'ENDGRAMMAR';
       searchphrase:
           expression /^\Z/ {
               # &Apache::lonsearchcat::print_item(\@item,0);
               [@item];
           }
       expression:
           phrase(s)   {
               [@item];
           }
       phrase:
           orword {
               [@item];
           }
         | andword {
               [@item];
           }
         | minusword {
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
         | word {
               unshift(@::Phrases,$item[1]);
               [@item];
           } 
       #
       orword:
           word 'OR' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]);
               [@item];
           }
           | word 'or' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]);
               [@item];
           }    
           | minusword 'OR' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
           | minusword 'or' phrase {
               unshift(@::Phrases,'OR');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }    
       andword:
           word phrase {
               unshift(@::Phrases,'AND');
               unshift(@::Phrases,$item[1]);
               [@item];
           }
           | minusword phrase {
               unshift(@::Phrases,'AND');
               unshift(@::Phrases,$item[1]->[0]);
               unshift(@::Phrases,$item[1]->[1]);
               [@item];
           }
       #
       minusword:
           '-' word {
               [$item[2],'NOT'];
           }
       word:
           "'" term(s) "'" {
             &Apache::lonsearchcat::concat(\@item);
           }
         | '"' term(s) '"' {
             &Apache::lonsearchcat::concat(\@item);
           }
         | term {
               $item[1];
           }
       term:
           /[\w\Q:!@#$%^&*()+_=|{}<>,.;\\\/?\E\-]+/ {
               $item[1];
           }
   ENDGRAMMAR
       #
       # The end result of parsing the phrase with the grammar is an array
       # @::Phrases.
       # $phrase = "gene splicing" or cat -> "gene splicing","OR","cat"
       # $phrase = "genetic engineering" -dna ->
       #                      "genetic engineering","AND","NOT","dna"
       # $phrase = cat or dog -poodle -> "cat","OR","dog","AND","NOT","poodle"
       undef(@::Phrases);
       my $p = new Parse::RecDescent($grammar);
       if (! defined($p->searchphrase($phrase))) {
           &Apache::lonnet::logthis('lonsearchcat:unable to process:'.$phrase);
           return 'Unable to process phrase '.$phrase;
       }
       #
       # Go through the phrases and make sense of them.  
       # Apply modifiers NOT OR and AND to the phrases.
       my @NewPhrases;
       while(@::Phrases) {
           my $phrase = shift(@::Phrases);
           # &Apache::lonnet::logthis('phrase = '.$phrase);
           my $phrasedata;
           if ($phrase =~ /^(NOT|OR|AND)$/) {
               if ($phrase eq 'OR') {
                   $phrasedata->{'or'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               } elsif ($phrase eq 'AND') {
                   $phrasedata->{'and'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               }
               if ($phrase eq 'NOT') {
                   $phrasedata->{'negate'}++;
                   if (! @::Phrases) { $phrasedata = undef; last; }
                   $phrase = shift(@::Phrases);
               }
           }
           $phrasedata->{'phrase'} = $phrase;
           if ($related) {
               my @NewWords;
               (undef,@NewWords) = &related_version($phrasedata->{'phrase'});
               $phrasedata->{'related_words'} = \@NewWords;
           }
           push(@NewPhrases,$phrasedata);
       }
       #
       # Actually build the sql query from the phrases
       my $SQLQuery;
       foreach my $phrase (@NewPhrases) {
           my $query;
           if ($phrase->{'negate'}) {
               $query .= $field.' NOT LIKE "%'.$phrase->{'phrase'}.'%"';
           } else {
               $query .= $field.' LIKE "%'.$phrase->{'phrase'}.'%"';
           }
           foreach my $related (@{$phrase->{'related_words'}}) {
               if ($phrase->{'negate'}) {
                   $query .= ' AND '.$field.' NOT LIKE "%'.$related.'%"';
               } else {
                   $query .= ' OR '.$field.' LIKE "%'.$related.'%"';
               }
           }
           if ($SQLQuery) {
               if ($phrase->{'or'}) {
                   $SQLQuery .= ' OR ('.$query.')';
               } else {
                   $SQLQuery .= ' AND ('.$query.')';
               }
           } else {
               $SQLQuery = '('.$query.')';
           }
       }
       #
       # &Apache::lonnet::logthis("SQLQuery = $SQLQuery");
       #
       return undef,$SQLQuery;
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =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 1130  Note: Using this twice on a string is pr Line 1709  Note: Using this twice on a string is pr
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub related_version {  sub related_version {
     my $search_string = shift;      my ($word) = @_;
     my $result = $search_string;      return (undef) if (lc($word) =~ /\b(or|and|not)\b/);
     my %New_Words = ();      my @Words = &Apache::loncommon::get_related_words($word);
     while ($search_string =~ /(\w+)/cg) {      # Only use 4 related words
         my $word = $1;      @Words = ($#Words>4? @Words[0..4] : @Words);
         next if (lc($word) =~ /\b(or|and|not)\b/);      my $result = join " OR ", ($word,@Words);
         my @Words = &Apache::loncommon::get_related_words($word);      return $result,sort(@Words);
         @Words = ($#Words>4? @Words[0..4] : @Words);  
         foreach (@Words) { $New_Words{$_}++;}  
         my $replacement = join " OR ", ($word,@Words);  
         $result =~ s/(\b)$word(\b)/$1($replacement)$2/g;  
     }  
     return $result,sort(keys(%New_Words));  
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &build_SQL_query()   
   
 Builds a SQL query string from a logical expression with AND/OR keywords  
 using Text::Query and &recursive_SQL_query_builder()  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub build_SQL_query {  
     my ($field_name,$logic_statement)=@_;  
     my $q=new Text::Query('abc',  
   -parse => 'Text::Query::ParseAdvanced',  
   -build => 'Text::Query::Build');  
     $q->prepare($logic_statement);  
     my $matchexp=${$q}{'matchexp'}; chomp $matchexp;  
     my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);  
     return $sql_query;  
 }  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 1203  sub build_custommetadata_query { Line 1752  sub build_custommetadata_query {
     return $matchexp;      return $matchexp;
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =pod   
   
 =item &recursive_SQL_query_build()   
   
 Recursively constructs an SQL query.  Takes as input $dkey and $pattern.  
   
 =cut  
   
 ######################################################################  
 ######################################################################  
 sub recursive_SQL_query_build {  
     my ($dkey,$pattern)=@_;  
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);  
     return $pattern unless @matches;  
     foreach my $match (@matches) {  
  $match=~/\[ (\w+)\s(.*) \]/;  
  my ($key,$value)=($1,$2);  
  my $replacement='';  
  if ($key eq 'literal') {  
     $replacement="($dkey like \"\%$value\%\")";  
  }  
  elsif ($key eq 'not') {  
     $value=~s/like/not like/;  
 #    $replacement="($dkey not like $value)";  
     $replacement="$value";  
  }  
  elsif ($key eq 'and') {  
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  
     $replacement="($1 AND $2)";  
  }  
  elsif ($key eq 'or') {  
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;  
     $replacement="($1 OR $2)";  
  }  
  substr($pattern,  
        index($pattern,$match),  
        length($match),  
        $replacement  
        );  
     }  
     &recursive_SQL_query_build($dkey,$pattern);  
 }  
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
Line 1264  Also reports errors (check for /^Incorre Line 1768  Also reports errors (check for /^Incorre
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub build_date_queries {  sub build_date_queries {
     my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,      my ($cafter,$cbefore,$mafter,$mbefore) = @_;
  $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;      my ($result,$error,$pretty_string);
     my @queries;      #
     if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {      # Verify the input
  unless ($cmonth1 and $cday1 and $cyear1 and      if (! defined($cafter) && ! defined($cbefore) &&
  $cmonth2 and $cday2 and $cyear2) {          ! defined($mafter) && ! defined($mbefore)) {
     return "Incorrect entry for the creation date.  You must specify ".          # This is an okay situation, so return undef for the error
    "a starting month, day, and year and an ending month, ".          return (undef,undef,undef);
    "day, and year.";      }
  }      if ((defined($cafter)  && ! defined($cbefore)) ||
  my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);          (defined($cbefore) && ! defined($cafter))) {
  $cnumeric1+=0;          # This is bad, so let them know
  my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);          $error = &mt('Incorrect entry for the creation date.  '.
  $cnumeric2+=0;                      'You must specify both the beginning and ending dates.');
  if ($cnumeric1>$cnumeric2) {      }
     return "Incorrect entry for the creation date.  The starting ".      if (! defined($error) && 
    "date must occur before the ending date.";          ((defined($mafter)  && ! defined($mbefore)) ||
  }          (defined($mbefore) && ! defined($mafter)))) {
  my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".          # This is also bad, so let them know
            "$cyear2-$cmonth2-$cday2 23:59:59')";          $error = &mt('Incorrect entry for the last revision date.  '.
  push @queries,$cquery;                       'You must specify both the beginning and ending dates.');
     }  
     if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {  
  unless ($lmonth1 and $lday1 and $lyear1 and  
  $lmonth2 and $lday2 and $lyear2) {  
     return "Incorrect entry for the last revision date.  You must ".  
    "specify a starting month, day, and year and an ending ".  
    "month, day, and year.";  
  }  
  my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);  
  $lnumeric1+=0;  
  my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);  
  $lnumeric2+=0;  
  if ($lnumeric1>$lnumeric2) {  
     return "Incorrect entry for the last revision date.  The ".  
    "starting date must occur before the ending date.";  
  }  
  my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".  
            "$lyear2-$lmonth2-$lday2 23:59:59')";  
  push @queries,$lquery;  
     }      }
     if (@queries) {      if (! defined($error)) {
  return join(" AND ",@queries);          #
           # Build the queries
           my @queries;
           if (defined($cbefore) && defined($cafter)) {
               my (undef,undef,undef,$caday,$camon,$cayear) = localtime($cafter);
               my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore);
               # Correct for year being relative to 1900
               $cayear+=1900; $cbyear+=1900;
               my $cquery=
                   '(creationdate BETWEEN '.
                   "'".$cayear.'-'.$camon.'-'.$caday."'".
                   ' AND '.
                   "'".$cbyear.'-'.$cbmon.'-'.$cbday." 23:59:59')";
               $pretty_string .= '<br />' if (defined($pretty_string));
               $pretty_string .= 
                   &mt('created between [_1] and [_2]',
                       &Apache::lonlocal::locallocaltime($cafter),
                       &Apache::lonlocal::locallocaltime($cbefore+24*60*60-1));
               push(@queries,$cquery);
               $pretty_string =~ s/ 00:00:00//g;
           }
           if (defined($mbefore) && defined($mafter)) {
               my (undef,undef,undef,$maday,$mamon,$mayear) = localtime($mafter);
               my (undef,undef,undef,$mbday,$mbmon,$mbyear) = localtime($mbefore);
               # Correct for year being relative to 1900
               $mayear+=1900; $mbyear+=1900;
               my $mquery=
                   '(lastrevisiondate BETWEEN '.
                   "'".$mayear.'-'.$mamon.'-'.$maday."'".
                   ' AND '.
                   "'".$mbyear.'-'.$mbmon.'-'.$mbday." 23:59:59')";
               push(@queries,$mquery);
               $pretty_string .= '<br />' if (defined($pretty_string));
               $pretty_string .= 
                   &mt('last revised between [_1] and [_2]',
                       &Apache::lonlocal::locallocaltime($mafter),
                       &Apache::lonlocal::locallocaltime($mbefore+24*60*60-1));
               $pretty_string =~ s/ 00:00:00//g;
           }
           if (@queries) {
               $result .= join(" AND ",@queries);
           }
     }      }
     return '';      return ($result,$error,$pretty_string);
 }  }
   
 ######################################################################  ######################################################################
Line 1318  sub build_date_queries { Line 1844  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 1330  sub copyright_check { Line 1860  sub copyright_check {
                                               $Metadata->{'url'});                                                $Metadata->{'url'});
     # Check for priv      # Check for priv
     if (($Metadata->{'copyright'} eq 'priv') &&       if (($Metadata->{'copyright'} eq 'priv') && 
         (($ENV{'user.name'} ne $resname) &&          (($env{'user.name'} ne $resname) &&
          ($ENV{'user.domain'} ne $resdom))) {           ($env{'user.domain'} ne $resdom))) {
         return 0;          return 0;
     }      }
     # Check for domain      # Check for domain
     if (($Metadata->{'copyright'} eq 'domain') &&      if (($Metadata->{'copyright'} eq 'domain') &&
         ($ENV{'user.domain'} ne $resdom)) {          ($env{'user.domain'} ne $resdom)) {
         return 0;          return 0;
     }      }
       # Check for custom rights
       if ($Metadata->{'copyright'} eq 'custom') {
          return &Apache::lonnet::customaccess('bre',$Metadata->{'url'});
       }
     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(&Apache::loncommon::start_page(&mt('Error'))
   . '<p>table: |'.$table.'|</p>' # SB
                    .'<p class="LC_error">'
                    .&mt('Unable to retrieve search results. '
                        .'Unable to determine the table results were saved in.')
                    .&Apache::loncommon::end_page()
           );
           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 saved.".
     &Apache::loncommon::end_page());
           &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>".
     &Apache::loncommon::end_page());
           &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 %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>".
     &Apache::loncommon::end_page());
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
           return;
       }
       my $js =<<END;
   <script type="text/javascript">
   // <![CDATA[
       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>
   END
   
       my $start_page = &Apache::loncommon::start_page('Results',$js);
       my $breadcrumbs=
           &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
       $env{'form.catalogmode'} ne 'import');
   
       my $result = <<END;
   $start_page
   $breadcrumbs
   <form name="statusform" action="" method="post" target="_top">
   <input type="hidden" name="catalogmode" value="import" />
   <input type="hidden" name="acts" 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.='<p>'
               .&mt('There are [_1] matches to your query.',$total_results)
               .' '.$revise.'</p>'
               .'<p>'.&mt('Search: ').$pretty_query_string
               .'</p></form>';
       $r->print($result.&Apache::loncommon::end_page());
       return;
   }
   
 #####################################################################  #####################################################################
 #####################################################################  #####################################################################
   
Line 1356  the following format: Line 2048  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: search area - either res or portfolio 
       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 ($tabletype) = @_;
       copyright =>{ type=>'TEXT'},      my ($datatypes,$fullindicies) = 
       hostname  =>{ type=>'TEXT'},          &LONCAPA::lonmetadata::describe_metadata_storage($tabletype);
       #--------------------------------------------------      # Copy the table description before modifying it...
       creationdate     =>{ type=>'DATETIME'},      @Datatypes = @{$datatypes};
       lastrevisiondate =>{ type=>'DATETIME'},      unshift(@Datatypes,{name => 'id',  
       #--------------------------------------------------          type => 'MEDIUMINT',
       idx_title     =>{ type=>'FULLTEXT', target=>'title'},          restrictions => 'UNSIGNED NOT NULL',
       idx_author    =>{ type=>'FULLTEXT', target=>'author'},          primary_key  => 'yes',
       idx_subject   =>{ type=>'FULLTEXT', target=>'subject'},          auto_inc     => 'yes' });
       idx_abstract  =>{ type=>'FULLTEXT', target=>'abstract'},      @Fullindicies = @{$fullindicies};
       idx_mime      =>{ type=>'FULLTEXT', target=>'mime'},      return;
       idx_language  =>{ type=>'FULLTEXT', target=>'lang'},  }
       idx_owner     =>{ type=>'FULLTEXT', target=>'owner'},  
       idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},  sub create_results_table {
       );      my ($area) = @_;
       if ($area eq 'portfolio') {
           &set_up_table_structure('portfolio_search');
       } else {
           &set_up_table_structure('metadata');
       }
       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);
   <script type="text/javascript">
   // <![CDATA[
   document.statusform.count.value = ' $text'
   // ]]>
   </script>
   SCRIPT
   
     $r->rflush();      $r->rflush();
     return;  }
   
   sub update_status {
       my ($r,$text) = @_;
       $text =~ s/\'/\\\'/g;
       $r->print(<<SCRIPT);
   <script type="text/javascript">
   // <![CDATA[
   document.statusform.status.value = ' $text'
   // ]]>
   </script>
   SCRIPT
   
       $r->rflush();
   }
   
   {
       my $max_time  = 300;  # seconds for the search to complete
       my $start_time = 0;
       my $last_time = 0;
   
   sub reset_timing {
       $start_time = 0;
       $last_time = 0;
   }
   
   sub time_left {
       if ($start_time == 0) {
           $start_time = time;
       }
       my $time_left = $max_time - (time - $start_time);
       $time_left = 0 if ($time_left < 0);
       return $time_left;
   }
   
   sub update_seconds {
       my ($r) = @_;
       my $time = &time_left();
       if (($last_time-$time) > 0) {
           $r->print(<<SCRIPT);
   <script type="text/javascript">
   // <![CDATA[
   document.statusform.seconds.value = '$time'
   // ]]>
   </script>
   SCRIPT
   
           $r->rflush();
       }
       $last_time = $time;
   }
   
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &revise_button()
   
   Inputs: None
   
   Returns: html string for a 'revise search' button.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub revise_button {
       my $revisetext = &mt('Revise search');
       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'}.
               '&amp;cleargroupsort=1'.
               '&amp;phase='.$revise_phase;
       my $result = qq{<input type="button" value="$revisetext" name="revise"} .
           qq{ onclick="parent.location='$newloc';" /> };
       return $result;
 }  }
   
 ######################################################################  ######################################################################
Line 1423  sub write_status { Line 2235  sub write_status {
   
 =pod  =pod
   
 =item &run_search   =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,$area) = @_;
       my $tabletype = 'metadata';
       if ($area eq 'portfolio') {
           $tabletype = 'portfolio_search';
       }
       my $connection = $r->connection;
     #      #
       # Print run_search header
       #
       my $start_page = &Apache::loncommon::start_page('Search Status',undef);
       my $breadcrumbs =
    &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
       $env{'form.catalogmode'} ne 'import');
       $r->print(<<END);
   $start_page
   $breadcrumbs
   END
       # Remove leading and trailing <br />
       $pretty_string =~ s:^\s*<br />::i;
       $pretty_string =~ s:(<br />)*\s*$::im;
       my @Lines = split("<br />",$pretty_string);
       # I keep getting blank items at the end of the list, hence the following:
       while ($Lines[-1] =~ /^\s*$/ && @Lines) {
           pop(@Lines);
       }
       if (@Lines > 2) {
           $pretty_string = join '<br />',(@Lines[0..2],'...<br />');
       }
       $r->print(&mt("Search: [_1]",$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));   my %all_library_servers = &Apache::lonnet::unique_library();
           @Servers_to_contact = sort(keys(%all_library_servers));
     }      }
     my %Server_status;      my %Server_status;
     #      #
     # Timing variables      # Check on the mysql table we will use to store results.
     my $starttime = time;      my $table =$env{'form.table'};
     my $max_time  = 120;  # seconds for the search to complete      if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
     #          $r->print("Unable to determine table id to save search results in.".
     # Create Table                    "The search has been aborted.".
     #####################################    &Apache::loncommon::end_page());
     my $table = &Apache::lonmysql::create_table          return;
         ( { columns => \%Datatypes,      }
             column_order => \@DataOrder,      my $table_status = &Apache::lonmysql::check_table($table);
         } );      if (! defined($table_status)) {
     if (! defined($table)) {          $r->print("Unable to determine status of table.".
         # What do I do now?  Print out an error page.    &Apache::loncommon::end_page());
         &Apache::lonnet::logthis("lonmysql attempted to create a table ".          &Apache::lonnet::logthis("Bogus table id of $table for ".
                                  "and this was the result:".                                   "$env{'user.name'} @ $env{'user.domain'}");
           &Apache::lonnet::logthis("lonmysql error = ".
                                  &Apache::lonmysql::get_error());                                   &Apache::lonmysql::get_error());
         $r->print("An internal error occured with the database.<br />".  
                   "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.".
     &Apache::loncommon::end_page());
           return;
       }
       ##
       ## Prepare for the big loop.
     my $hitcountsum;      my $hitcountsum;
       my %matches;
     my $server;       my $server; 
     my $status;      my $status;
     while ((time - $starttime < $max_time) &&       my $revise = &revise_button();
       $r->print('<form name="statusform" action="" method="post">'."\n".
                 '<input type="hidden" name="acts" value="" />'."\n".
                 '<table border="0"><tr><td>'."\n".
                 &Apache::loncommon::start_data_table());
       $r->print(&Apache::loncommon::start_data_table_header_row()
                .'<th>'.&mt('Status').'</th>'
                .'<th>'.&mt('Total Matches').'</th>'
                .'<th>'.&mt('Time Remaining').'</th>'
                .&Apache::loncommon::end_data_table_header_row()
                .&Apache::loncommon::start_data_table_row()
                .'<td><input type="text" name="status"  value="" size="50" readonly="readonly" /></td>'
                .'<td><input type="text" name="count"   value="" size="10" readonly="readonly" /></td>'
                .'<td><input type="text" name="seconds" value="" size="8" readonly="readonly" /></td>'
                .&Apache::loncommon::end_data_table_row()
                .&Apache::loncommon::end_data_table()
                .'</td><td>&nbsp;</td><td>'.$revise.'</td></tr></table></form>');
       $r->rflush();
       &reset_timing();
       &update_seconds($r);
       &update_status($r,&mt('contacting [_1]',$Servers_to_contact[0]));
       while (&time_left() &&
            ((@Servers_to_contact) || keys(%Server_status))) {             ((@Servers_to_contact) || keys(%Server_status))) {
         # Send out a search request if it needs to be done.          &update_seconds($r);
           #
           # Send out a search request
         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 [_1]',$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 [_1]',join(' ',keys(%Server_status))));
               }
               sleep(1); 
         }          }
         while (my ($server,$status) = each(%Server_status)) {          #
           # Loop through the servers we have contacted but do not
           # have results from yet, looking for results.
           foreach my $server (keys(%Server_status)) {
               last if ($connection->aborted());
               &update_seconds($r);
               my $status = $Server_status{$server};
             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=~s|/||g;
            my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
   
   
              my $datafile=LONCAPA::tempdir().$status;
             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 [_1]',$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 [_1]',$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>) {
                     # handle custom fields?  Someday we will!                      last if ($connection->aborted());
                       #
                       # Records are stored one per line
                     chomp($result);                      chomp($result);
                     next unless $result;                      next if (! $result);
                       #
                     # Parse the result.                      # Parse the result.
                     my %Fields = &parse_raw_result($result,$server);                      my %Fields = &parse_raw_result($result,$server,$tabletype);
                     $Fields{'hostname'} = $server;                      $Fields{'hostname'} = $server;
                       #
                       # Skip based on copyright
                     next if (! &copyright_check(\%Fields));                      next if (! &copyright_check(\%Fields));
   
                       if ($area eq 'portfolio') {
                           next if (defined($matches{$Fields{'url'}}));
                           # Skip if inaccessible
                           next if (!&Apache::lonnet::portfolio_access($Fields{'url'}));
                           $matches{$Fields{'url'}} = 1; 
                       }
                       #
                     # 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());                      #
                     $hitcountsum ++;                      $hitcountsum ++;
                 } # End of foreach (@results)                      &update_seconds($r);
                       if ($hitcountsum % 50 == 0) {
                           &update_count_status($r,$hitcountsum);
                       }
                   }
                 $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);
         }          }
         # Finished looping through the servers          last if ($connection->aborted());
           &update_seconds($r);
     }      }
     &Apache::lonmysql::disconnect_from_db();      &update_status($r,&mt('Search Complete on Server [_1]',$server));
       &update_seconds($r);
       #
       &Apache::lonmysql::disconnect_from_db(); # This is unneccessary
       #
     # 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, so let the client know the top frame needs to be
     if ($hitcountsum > 0) {      # loaded from /adm/searchcat
         $r->print("<h3>Total results = $hitcountsum</h3></body></html>");      $r->print(&Apache::loncommon::end_page());
     }  #    if ($env{'form.catalogmode'} ne 'import') {
            $r->print(<<SCRIPT);
   <script>
   window.location='/adm/searchcat?phase=sort&persistent_db_id=$env{'form.persistent_db_id'}';
   </script>
   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 $highest = $high + $maxshow;      # Create buttons
     my ($previous,$current,$next);      return '<p class="LC_nobreak">'
     if ($lowest < $low) {            .'<input type="submit" name="prev" value="&lt;"'
         $previous = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$lowest&high=$highest">prev</a>};            .' title="'.&mt('Previous').'" />'
     } else {            .' '
         $previous = "prev";            .'<input type="submit" name="reload" value="'.&mt('Reload').'" />'
     }            .' '
     $current = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$low&high=$high">reload</a>};            .'<input type="submit" name="next" value="&gt;"'
     $next = qq{<a href="/adm/searchcat?$otherparms&mode=display&low=$high&high=$highest">next</a>};            .' title="'.&mt('Next').'" />'
     my $result = $previous." ".$current." ".$next;            .'</p>';
     return $result;  
 }  }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
 =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,$area) = @_;
       my $connection = $r->connection;
       $r->print(&search_results_header($importbutton,$closebutton));
     ##      ##
     ## Set viewing function      ## Set viewing function
     ##      ##
     my $viewfunction = $Views{$ENV{'form.viewselect'}};      my $viewfunction = $Views{$env{'form.viewselect'}};
     if (!defined($viewfunction)) {      if (!defined($viewfunction)) {
         $r->print("Internal Error - Bad view selected.\n");          $r->print('<p class="LC_error">'
                    .&mt('Internal Error - Bad view selected.')
                    .'</p>'."\n");
         $r->rflush();          $r->rflush();
         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=import.
     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 import by opening the import db file.
     } elsif ($mode eq 'Advanced') {      if ($env{'form.catalogmode'} eq 'import') {
         $action .= "?reqinterface=advanced";          if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
     }                    &GDBM_WRCREAT(),0640)) {
     $r->print(<<CATALOGCONTROLS);              $r->print('<p class="LC_error">'.
 <form name='results' method="post" action="$action">                &mt('Unable to save import results.').
 $hidden                '</p>'.
 <input type='hidden' name='acts' value='' />                '</form>'.
 <input type='button' value='Revise search request'        &Apache::loncommon::end_page());
 onClick='this.form.submit();' />              $r->rflush();
 $importbutton              return;
 $closebutton          } 
 $persistent      }
 <hr />      ##
 CATALOGCONTROLS      ## Prepare the table for querying
     if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {      my $table = $env{'form.table'};
         $r->print('Unable to tie hash to db file</body></html>');      return if (! &ensure_db_and_table($r,$table));
         $r->rflush();      ##
       ## Get the number of results 
       my $total_results = &Apache::lonmysql::number_of_rows($table);
       if (! defined($total_results)) {
           $r->print('<p class="LC_error">'.
             &mt('A MySQL error has occurred.').
             '</p>'.
             '</form>'.
     &Apache::loncommon::end_page());
           &Apache::lonnet::logthis("lonmysql was unable to determine the number".
                                    " of rows in table ".$table);
           &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
         return;          return;
     }       }
       ##
       ## Determine how many results we need to get
       $env{'form.start'} = 1  if (! exists($env{'form.start'}));
       $env{'form.show'}  = 20 if (! exists($env{'form.show'}));
       if (exists($env{'form.prev'})) {
           $env{'form.start'} -= $env{'form.show'};
       } elsif (exists($env{'form.next'})) {
           $env{'form.start'} += $env{'form.show'};
       }
       $env{'form.start'} = 1 if ($env{'form.start'}<1);
       $env{'form.start'} = $total_results if ($env{'form.start'}>$total_results);
       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 form elements
       $r->print(&hidden_field('table').
                 &hidden_field('phase').
                 &hidden_field('persistent_db_id').
                 &hidden_field('start').
                 &hidden_field('area')
                 );
     #      #
     my $fnum;      # Build sorting selector
     # For now, just query the whole lot and spit them out.      my @fields = 
     my $table = $ENV{'form.table'};          (
     my $connection_result = &Apache::lonmysql::connect_to_db();           {key=>'default' },
     if (!defined($connection_result)) {           {key=>'title' },
         &write_status($r,&Apache::lonmysql::get_error());           {key =>'author' },
            {key =>'subject'},
            {key =>'url',desc=>'URL'},
            {key =>'keywords'},
            {key =>'language'},
            {key =>'creationdate'},
            {key =>'lastrevisiondate'},
            {key =>'owner'},
            {key =>'copyright'},
            {key =>'authorspace'},
            {key =>'lowestgradelevel'},
            {key =>'highestgradelevel'},
            {key =>'standards',desc=>'Standards'},
           );
       if ($area eq 'portfolio') {
           push(@fields,
          (
            {key => 'scope'},
            {key => 'keynum'},
          ));
       } else {
           push(@fields,
          (
            {key =>'count',desc=>'Number of accesses'},
            {key =>'stdno',desc=>'Students Attempting'},
            {key =>'avetries',desc=>'Average Number of Tries'},
            {key =>'difficulty',desc=>'Mean Degree of Difficulty'},
            {key =>'disc',desc=>'Mean Degree of Discrimination'},
            {key =>'clear',desc=>'Evaluation: Clear'},
            {key =>'technical',desc=>'Evaluation: Technically Correct'},
            {key =>'correct',desc=>'Evaluation: Material is Correct'},
            {key =>'helpful',desc=>'Evaluation: Material is Helpful'},
            {key =>'depth',desc=>'Evaluation: Material has Depth'},
          ));
       }
       my %fieldnames = &Apache::lonmeta::fieldnames();
       my @field_order;
       foreach my $field_data (@fields) {
           push(@field_order,$field_data->{'key'});
           if (! exists($field_data->{'desc'})) {
               $field_data->{'desc'}=$fieldnames{$field_data->{'key'}};
           } else {
               if (! defined($field_data->{'desc'})) {
                   $field_data->{'desc'} = ucfirst($field_data->{'key'});
               }
               $field_data->{'desc'} = &mt($field_data->{'desc'});
           }
       }
       my %sort_fields = map {$_->{'key'},$_->{'desc'}} @fields;
       $sort_fields{'select_form_order'} = \@field_order;
       $env{'form.sortorder'} = 'desc' if (! exists($env{'form.sortorder'}));
       if (! exists($env{'form.sortfield'})) {
           if ($area eq 'portfolio') {
               $env{'form.sortfield'} = 'owner';
           } else {
               $env{'form.sortfield'} = 'count';
           }
       }
       if (! exists($env{'form.sortorder'})) {
    if ($env{'form.sortfield'}=~/^(count|stdno|disc|clear|technical|correct|helpful)$/) {
       $env{'form.sortorder'}='desc';
    } else {
       $env{'form.sortorder'}='asc';
    }
     }      }
     my @Results = &Apache::lonmysql::get_rows($table,'id>=0');      my $sortform = '<span class="LC_nobreak">'
     #&write_status($r,&Apache::lonmysql::get_debug());                    .&mt('Sort by:').' '
     #&write_status($r,&Apache::lonmysql::get_error());                    .&Apache::loncommon::select_form($env{'form.sortfield'},
                                                         'sortfield',
                                                         \%sort_fields)
                     .' '
                     .&Apache::loncommon::select_form($env{'form.sortorder'},
                                                         'sortorder',
                                                         {asc =>&mt('Ascending'),
                                                          desc=>&mt('Descending')
                                                          })
                     .'</span>';
       ##
       ## Display links for 'prev' and 'next' pages (if necessary) and Display Options
       $r->print('<fieldset>'."\n"
                .'<legend>'.&mt('Display Options').'</legend>'."\n"
                .$sortform
                .' '
                .&viewoptions()
                .'</fieldset>'
                .&prev_next_buttons($min,$env{'form.show'},$total_results)
       );
   
       if ($total_results == 0) {
           $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="2" />'.
                     '<p class="LC_info">'.&mt('There are currently no results.').'</p>'.
                     "</form>".
     &Apache::loncommon::end_page());
           return;
       } else {
           $r->print('<div>'.
                     mt('Results [_1] to [_2] out of [_3]',
                        $min,$max,$total_results).
                     "</div>\n");
       }
       ##
       ## Get results from MySQL table
       my $sort_command  = 'id>='.$min.' AND id<='.$max;
       my $order;
       if (exists($env{'form.sortorder'})) {
           if ($env{'form.sortorder'} eq 'asc') {
               $order = 'ASC';
           } elsif ($env{'form.sortorder'} eq 'desc') {
               $order = 'DESC';
           } else {
               $order = '';
           }
       } else {
           $order = '';
       }
       if ($env{'form.sortfield'} ne 'default' && 
           exists($sort_fields{$env{'form.sortfield'}})) {
           $sort_command = $env{'form.sortfield'}.' IS NOT NULL '.
               'ORDER BY '.$env{'form.sortfield'}.' '.$order.
               '  LIMIT '.($min-1).','.($max-$min+1);
       }
       my @Results = &Apache::lonmysql::get_rows($table,$sort_command);
       ##
       ## Loop through the results and output them.
       my $tabletype = 'metadata';
       if ($area eq 'portfolio') {
           $tabletype = 'portfolio_search';
       }
       $r->print(&Apache::loncommon::start_data_table());
     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($tabletype,@$row)};
             $fnum+=0;          my $output;
             $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(&Apache::loncommon::start_data_table_row()
         }                   .'<td>'
         $r->print($output);                   .$output
                    .'</td>'
                    .&Apache::loncommon::end_data_table_row()
           );
         $r->rflush();          $r->rflush();
     }      }
       $r->print(&Apache::loncommon::end_data_table());
     if (@Results < 1) {      if (@Results < 1) {
         $r->print("There were no results matching your query");          $r->print('<p class="LC_info">'
                    .&mt('There were no results matching your query.')
                    .'</p>');
       } else {
           $r->print(
               &prev_next_buttons($min,$env{'form.show'},$total_results,
                                   "table=".$env{'form.table'}.
                                   "&amp;phase=results".
                                   "&amp;persistent_db_id=".
                                   $env{'form.persistent_db_id'})
           );
     }      }
     $r->print("</body></html>");      $r->print("</form>".&Apache::loncommon::end_page());
     $r->rflush();      $r->rflush();
     untie %groupsearch_db;      untie %groupsearch_db if (tied(%groupsearch_db));
     return;      return;
 }  }
   
Line 1683  END Line 2776  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 'import') {
           $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 ($tabletype,@Row) = @_;
     my $fnum; # search result counter      my %Fields;
     my ($mode,$r,$replyref,$hidden)=@_;      if (! scalar(@Datatypes)) {
     my %rhash=%{$replyref};          &set_up_table_structure($tabletype);
     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'}}=&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 2848  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 1960  The 'title' field is set to "Untitled" i Line 2862  The 'title' field is set to "Untitled" i
 ###########################################################  ###########################################################
 ###########################################################  ###########################################################
 sub parse_raw_result {  sub parse_raw_result {
     my ($result,$hostname) = @_;      my ($result,$hostname,$tabletype) = @_;
     # 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...?          ($tabletype,
     unless ($result =~ /,/) {           map {
         $result = &Apache::lonnet::unescape($result);              &unescape($_);
     }           } (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 2037  sub handle_custom_fields { Line 2888  sub handle_custom_fields {
     my $customshow='';      my $customshow='';
     my $extrashow='';      my $extrashow='';
     my @customfields;      my @customfields;
     if ($ENV{'form.customshow'}) {      if ($env{'form.customshow'}) {
         $customshow=$ENV{'form.customshow'};          $customshow=$env{'form.customshow'};
         $customshow=~s/[^\w\s]//g;          $customshow=~s/[^\w\s]//g;
         my @fields=map {          my @fields=map {
             "<font color=\"#008000\">$_:</font><!-- $_ -->";              "<font color=\"#008000\">$_:</font><!-- $_ -->";
Line 2054  sub handle_custom_fields { Line 2905  sub handle_custom_fields {
         if ($result=~/^(custom\=.*)$/) { # grab all custom metadata          if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
             my $tmp=$result;              my $tmp=$result;
             $tmp=~s/^custom\=//;              $tmp=~s/^custom\=//;
             my ($k,$v)=map {&Apache::lonnet::unescape($_);              my ($k,$v)=map {&unescape($_);
                         } split(/\,/,$tmp);                          } split(/\,/,$tmp);
             $customhash{$k}=$v;              $customhash{$k}=$v;
         }          }
Line 2067  sub handle_custom_fields { Line 2918  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.
   
 Takes most inputs directly from %ENV, except $mode.    Takes most inputs directly from %env, except $mode.  
   
 =over 4  =over 4
   
Line 2086  The following environment variables are Line 2937  The following environment variables are
   
 =item 'form.catalogmode'   =item 'form.catalogmode' 
   
 Checked for 'interactive' and 'groupsearch'.  Checked for 'interactive' and 'import'.
   
 =item 'form.mode'  =item 'form.mode'
   
Line 2094  Checked for existance & 'edit' mode. Line 2945  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 2962  Checked for existance & 'edit' mode.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub search_results_header {  sub search_results_header {
     my ($mode,$pretty_query) = @_;      my ($importbutton,$closebutton) = @_;
     $mode = lc($mode);  
     my $title;      my $js;
     if ($mode eq 'advanced') {  
         $title = "Advanced Search Results";  
     } elsif ($mode eq 'basic') {  
         $title = "Basic Search Results";  
     }  
     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'){
  if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') {   if (! exists($env{'form.mode'}) || $env{'form.mode'} ne 'edit') {
             $result.=<<SCRIPT;              $js.=<<SCRIPT;
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
     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>
 SCRIPT  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'};
             $result.=<<SCRIPT;              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
               }
   
               $js.=<<SCRIPT;
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
 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);
     }      }
 }  }
   // ]]>
 </script>  </script>
 SCRIPT  SCRIPT
         }          }
     }      }
     $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';      my $inhibit_menu = "&".&Apache::loncommon::inhibit_menu_check();
       $js.=<<SCRIPT if $env{'form.catalogmode'} eq 'import';
 <script type="text/javascript">  <script type="text/javascript">
     function select_data(title,url) {  // <![CDATA[
 // alert('DEBUG: Should be storing '+title+' and '+url);      function queue(checkbox_num,val) {
     }          if (document.forms.results.returnvalues.length != "undefined" &&
     function queue(val) {              typeof(document.forms.results.returnvalues.length) == "number") {
  if (eval("document.forms.results.returnvalues["+val+"].checked")) {              if (document.forms.results.returnvalues[checkbox_num].checked) {
     document.forms.results.acts.value+='1a'+val+'b';                  parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b';
  }              } else {
  else {                  parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b';
     document.forms.results.acts.value+='0a'+val+'b';              }
  }          } else {
               if (document.forms.results.returnvalues.checked) {
                   parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b';
               } else {
                   parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b';
               }
           }
     }      }
     function select_group() {      function select_group() {
  window.location=   parent.window.location=
     "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+      "/adm/groupsort?mode=$env{'form.mode'}&catalogmode=import$inhibit_menu&acts="+
     document.forms.results.acts.value;      parent.statusframe.document.forms.statusform.elements.acts.value;
     }      }
   // ]]>
 </script>  </script>
 SCRIPT  SCRIPT
     $result.=<<SCRIPT;  
 <script type="text/javascript">      my $start_page  = &Apache::loncommon::start_page(undef,$js,
     function displayinfo(val) {       {'only_body' =>1,});
  popwin.document.forms.popremain.sdetails.value=val;      my $result=<<END;
     }  $start_page
     function openhelp(val) {  <form name="results" method="post" action="/adm/searchcat">
  openhelpwin=open('/adm/help/searchcat.html','helpscreen',  $importbutton
      'scrollbars=1,width=400,height=300');  
  openhelpwin.focus();  
     }  
     function abortsearch(val) {  
  popwin.close();  
     }  
 </script>  
 SCRIPT  
     $result.=<<END;  
 </head>  
 <body bgcolor="#ffffff">  
 <img align=right src=/adm/lonIcons/lonlogos.gif>  
 <h1>$title</h1>  
 END  END
     if ($pretty_query) {  
         $result .= "<p>Search query: $pretty_query</p>";  
     }  
     return $result;      return $result;
 }  }
   
   sub results_link {
       my $basic_link   = "/adm/searchcat?"."&amp;table=".$env{'form.table'}.
           "&amp;persistent_db_id=".$env{'form.persistent_db_id'};
       my $results_link = $basic_link."&amp;phase=results".
           "&amp;pause=1"."&amp;start=1";
       return $results_link;
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   sub print_frames_interface {
       my $r = shift;
       my $basic_link = "/adm/searchcat?"."&amp;table=".$env{'form.table'}.
           "&amp;persistent_db_id=".$env{'form.persistent_db_id'};
       my $run_search_link = $basic_link."&amp;phase=run_search";
       my $results_link = &results_link();
       my $js = <<JS;
   <script type="text/javascript">
   // <![CDATA[
   var targetwin = opener;
   var queue = '';
   // ]]>
   </script>
   JS
   
 =pod      my $start_page =
           &Apache::loncommon::start_page('LON-CAPA Digital Library Search Results',
 =item &make_popwin()         $js,
          {'frameset'    => 1,
 Returns html with javascript in it to open up the status window.   'add_entries' => {
       'rows' => "150,*",},});
       my $end_page =
           &Apache::loncommon::end_page({'frameset' => 1});
   
       my $result = <<"ENDFRAMES";
   $start_page
       <frame name="statusframe"  src="$run_search_link">
       <frame name="resultsframe" src="$results_link">
   $end_page
   ENDFRAMES
   
 =cut      $r->print($result);
       return;
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub make_popwin {  
     my %rhash = @_;  sub has_stat_data {
     my $servernum=(keys %rhash);      my ($values) = @_;
     my $hcinit;      if ( (defined($values->{'count'})      && $values->{'count'}      ne '') ||
     my $grid="'<br />'+\n";           (defined($values->{'stdno'})      && $values->{'stdno'}      ne '') ||
     # $sn is the server number, used ONLY to make sure we have           (defined($values->{'disc'})       && $values->{'disc'}       ne '') ||
     # rows of 10 each.  No longer used to index images.           (defined($values->{'avetries'})   && $values->{'avetries'}   ne '') ||
     my $sn=1;           (defined($values->{'difficulty'}) && $values->{'difficulty'} ne '')) {
     foreach my $sk (sort keys %rhash) {          return 1;
  $grid.="'<a href=\"";  
  $grid.="javascript:opener.displayinfo('+";  
  $grid.="\"'\"+'";  
  $grid.=$sk;  
  my $hc;  
  if ($rhash{$sk} eq 'con_lost') {  
     $hc="BAD CONNECTION ";  
  }  
  else {  
     $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";  
     $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";  
  }  
  $grid.=" hitcount=".$hc;  
  $grid.=" domain=".$Apache::lonnet::hostdom{$sk};  
  $grid.=" IP=".$Apache::lonnet::hostip{$sk};  
  # '+"'"+'">'+  
  $grid.="'+\"'\"+')\">'+";  
  $grid.="\n";  
  $grid.="'<img border=\"0\" name=\"img_".$Apache::lonnet::hostdom{$sk}.  
             '_'.$sk."\" src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk.  
                 "\" /></a>'+\n";  
  $grid.="'<br />'+\n" unless $sn%10;  
         $sn++;  
     }      }
     my $result.=<<ENDPOP;      return 0;
 <script type="text/javascript">  }
     popwin=open('','popwin','scrollbars=1,width=400,height=220');  
     popwin.focus();  sub statfields {
     popwin.document.writeln('<'+'html>');      return ('count','stdno','disc','avetries','difficulty');
     popwin.document.writeln('<'+'head>');  }
     popwin.document.writeln('<'+'script>');  
     popwin.document.writeln('hc=new Array();$hcinit');  sub has_eval_data {
     popwin.document.writeln('<'+'/script>');      my ($values) = @_;
     popwin.document.writeln('<'+'/head>'+      if ( (defined($values->{'clear'})     && $values->{'clear'}     ne '') ||
         '<'+'body bgcolor="#FFFFFF">'+           (defined($values->{'technical'}) && $values->{'technical'} ne '') ||
  '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+           (defined($values->{'correct'})   && $values->{'correct'}   ne '') ||
  'lonanim.gif" '+           (defined($values->{'helpful'})   && $values->{'helpful'}   ne '') ||
  'alt="animated logo" />'+           (defined($values->{'depth'})     && $values->{'depth'}     ne '')) {
  '<'+'h3>Search Results Progress<'+'/h3>'+          return 1;
         '<'+'form name="popremain">'+      }
         '<'+'tt>'+      return 0;
  '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+  }
  '<'+'br />SCANNING $servernum SERVERS'+  
  '<'+'br clear="all" />Number of record hits found '+  sub evalfields { 
  '<'+'input type="text" size="10" name="numhits"'+      return ('clear','technical','correct','helpful','depth');
  ' value="0" />'+  
  '<'+'br clear="all" />Time elapsed '+  
  '<'+'input type="text" size="10" name="elapsetime"'+  
  ' value="0" />'+  
  '<'+'br />'+  
  'SERVER GRID (click on any cell for details)'+  
         $grid  
         '<'+'br />'+  
  'Server details '+  
  '<'+'input type="text" size="35" name="sdetails"'+  
  ' value="" />'+  
  '<'+'br />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="close this window" '+  
  ' onClick="javascript:opener.abortsearch()" />'+  
  ' <'+'input type="button" name="button"'+  
  ' value="help" onClick="javascript:opener.openhelp()" />'+  
  '<'+'/tt>'+  
         '<'+'/form>'+  
         '<'+'/body><'+'/html>');  
     popwin.document.close();  
 </script>  
 ENDPOP  
     return $result;  
 }  }
   
 ######################################################################  ######################################################################
Line 2312  ENDPOP Line 3160  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 3175  extra custom metadata to show.
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub detailed_citation_view {  sub detailed_citation_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $result;
 <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}"       my $jumpurl=$values{'url'};
     target='search_preview'>$values{'title'}</a></h3>      $jumpurl=~s|^/ext/|http://|;
 <p>      $result .= '<b>'.$prefix.
 <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />          '<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />'.'&nbsp;'.
           '<a href="'.$jumpurl.'?inhibitmenu=yes" '.
 <b>Subject:       </b> $values{'subject'}<br />          'target="preview">'.$values{'title'}."</a></b>\n";
 <b>Keyword(s):    </b> $values{'keywords'}<br />      $result .= "<p>\n";
 <b>Notes:         </b> $values{'notes'}<br />      $result .= '<b>'.$values{'author'}.'</b>,'.
 <b>MIME Type:     </b> $values{'mimetag'}<br />          ' <i>'.$values{'owner'}.'</i><br />';
 <b>Language:      </b> $values{'language'}<br />      foreach my $field 
 <b>Copyright/Distribution:</b> $values{'cprtag'}<br />          (
 </p>           { name=>'url',
 $values{'extrashow'}             translate => '<b>URL:</b>&nbsp;[_1]',
 <p>             special => 'url link',},
 $values{'shortabstract'}           { name=>'subject',
 </p>             translate => '<b>Subject:</b>&nbsp;[_1]',},
 END           { name=>'keywords',
              translate => '<b>Keywords:</b>&nbsp;[_1]',},
            { name=>'notes',
              translate => '<b>Notes:</b>&nbsp;[_1]',},
            { name=>'mimetag',
              translate => '<b>MIME Type:</b>&nbsp;[_1]',},
            { name=>'standards',
              translate => '<b>Standards:</b>[_1]',},
            { name=>'copyrighttag',
              translate => '<b>Copyright/Distribution:</b>&nbsp;[_1]',},
            { name=>'count',
              format => "%d",
              translate => '<b>Access Count:</b>&nbsp;[_1]',},
            { name=>'stdno',
              format => "%d",
              translate => '<b>Number of Students:</b>&nbsp;[_1]',},
            { name=>'avetries',
              format => "%.2f",
              translate => '<b>Average Tries:</b>&nbsp;[_1]',},
            { name=>'disc',
              format => "%.2f",
              translate => '<b>Degree of Discrimination:</b>&nbsp;[_1]',},
            { name=>'difficulty',
              format => "%.2f",
              translate => '<b>Degree of Difficulty:</b>&nbsp;[_1]',},
            { name=>'clear',
              format => "%.2f",
              translate => '<b>Clear:</b>&nbsp;[_1]',},
            { name=>'depth',
              format => "%.2f",
              translate => '<b>Depth:</b>&nbsp;[_1]',},
            { name=>'helpful',
              format => "%.2f",
              translate => '<b>Helpful:</b>&nbsp;[_1]',},
            { name=>'correct',
              format => "%.2f",
              translate => '<b>Correct:</b>&nbsp;[_1]',},
            { name=>'technical',
              format => "%.2f",
              translate => '<b>Technical:</b>&nbsp;[_1]',},
            { name=>'comefrom_list',
              type => 'list',
              translate => 'Resources that lead up to this resource in maps',},
            { name=>'goto_list',
              type => 'list',
              translate => 'Resources that follow this resource in maps',},
            { name=>'sequsage_list',
              type => 'list',
              translate => 'Resources using or importing resource',},
            ) {
           next if (! exists($values{$field->{'name'}}) ||
                    $values{$field->{'name'}} eq '');
           if (exists($field->{'type'}) && $field->{'type'} eq 'list') {
               $result .= '<b>'.&mt($field->{'translate'}).'</b>';
               foreach my $item (split(',',$values{$field->{'name'}})){
                   $item = &Apache::lonnet::clutter($item);
                   $result .= '<br />'.&display_url($item,1).'<br />';
               }
           } elsif (exists($field->{'format'}) && $field->{'format'} ne ''){
               $result.= &mt($field->{'translate'},
                             sprintf($field->{'format'},
                                     $values{$field->{'name'}}))."<br />\n";
           } else {
               if ($field->{'special'} eq 'url link') {
                   $result .= '<br />'.&display_url($jumpurl,1).'<br />';
               } else {
                   $result.= &mt($field->{'translate'},
                                 $values{$field->{'name'}});
               }
               $result .= "<br />\n";
           }
       }
       $result .= "</p>";
       if (exists($values{'extrashow'}) && $values{'extrashow'} ne '') {
           $result .= '<p>'.$values{'extrashow'}.'</p>';
       }
       if (exists($values{'shortabstract'}) && $values{'shortabstract'} ne '') {
           $result .= '<p>'.$values{'shortabstract'}.'</p>';
       }
     return $result;      return $result;
 }  }
   
   sub detailed_citation_preview {
       my ($prefix,%values)=@_;
       return &detailed_citation_view($prefix,%values).
              '</td><td>'.
              &Apache::lonindexer::showpreview($values{'url'});
   }
   
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 2356  END Line 3291  END
 =item &summary_view()   =item &summary_view() 
   
 =cut  =cut
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub summary_view {  sub summary_view {
     my %values = @_;      my ($prefix,%values) = @_;
     my $result=<<END;      my $icon=&Apache::loncommon::icon($values{'url'});
 <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"       my $result=qq{$prefix<img src="$icon" alt="" />};
    target='search_preview'>$values{'author'}</a><br />      if (exists($env{'form.sortfield'}) && 
 $values{'title'}<br />          $env{'form.sortfield'} !~ /^(default|
 $values{'owner'} -- $values{'lastrevisiondate'}<br />                                       author|
                                        url|
                                        title|
                                        owner|
                                        lastrevisiondate|
                                        copyright)$/x) {
           my $tmp = $values{$env{'form.sortfield'}};
           if (! defined($tmp)) { $tmp = 'undefined'; }
           $result .= '&nbsp;'.$tmp.'&nbsp;';
       }
       my $jumpurl=$values{'url'};
       $jumpurl=~s|^/ext/|http://|;
       my $link = '<br />'.&display_url($jumpurl,1).'<br />';
   
       $result.=<<END;
   <a href="$jumpurl?inhibitmenu=yes" 
      target="preview">$values{'title'}</a>
   <br />
   $link<br />
   $values{'author'}, $values{'owner'} -- $values{'lastrevisiondate'}<br />
 $values{'copyrighttag'}<br />  $values{'copyrighttag'}<br />
 $values{'extrashow'}  $values{'extrashow'}
 </p>  
 END  END
     return $result;      return $result;
 }  }
   
   sub summary_preview {
       my ($prefix,%values)=@_;
       return &summary_view($prefix,%values).
              '</td><td>'.
              &Apache::lonindexer::showpreview($values{'url'});
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &compact_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub compact_view {
       my ($prefix,%values) = @_;
       my $jumpurl=$values{'url'};
       $jumpurl=~s|^/ext/|http://|;
   
       my $link = &display_url($jumpurl,1);
       
       my $result = 
           $prefix.'<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />';
       if (exists($env{'form.sortfield'}) && 
           $env{'form.sortfield'} !~ /^(default|author|url|title)$/) {
           my $tmp = $values{$env{'form.sortfield'}};
           if (! defined($tmp)) { $tmp = 'undefined'; }
           $result .= '&nbsp;'.$tmp.'&nbsp;';
       }
       $jumpurl = &HTML::Entities::encode($jumpurl,'<>&"');
       $result.=' <span class="LC_nobreak">'.
    '<a href="'.$jumpurl.'?inhibitmenu=yes" target="preview">'.
           &HTML::Entities::encode($values{'title'},'<>&"').'</a></span> '.
    $link.' <b>'.$values{'author'}.'</b> ('.$values{'domain'}.')';
       return $result;
   }
   
   sub display_url {
       my ($url,$skiplast) = @_;
       my $link;
       if ($url=~m|^/ext/|) {
    $url=~s|^/ext/|http://|;
    $link='<span class="LC_filename">'.$url.'</span>';
       } elsif ($url=~m{^(http://|/uploaded/)}) {
    $link='<span class="LC_filename">'.$url.'</span>';
       } else {
           $link=&Apache::lonhtmlcommon::crumbs(
                     $url,
                     'preview',
                     '',
                     (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),
                     $skiplast).' ';
       }
       return $link;
   }
   
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
   
Line 2385  END Line 3397  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub fielded_format_view {  sub fielded_format_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $icon=&Apache::loncommon::icon($values{'url'});
       my %Translated = &Apache::lonmeta::fieldnames();
       my $jumpurl=$values{'url'};
       $jumpurl=~s|^/ext/|http://|;
   
     my $result=<<END;      my $result=<<END;
 <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}"   $prefix <img src="$icon" alt="" />
               target='search_preview'>$values{'url'}</a>  <dl>
 <br />  <dt>URL:</dt>
 <b>Title:</b> $values{'title'}<br />      <dd><a href="$jumpurl?inhibitmenu=yes" 
 <b>Author(s):</b> $values{'author'}<br />           target='preview'>$values{'url'}</a>
 <b>Subject:</b> $values{'subject'}<br />      </dd>
 <b>Keyword(s):</b> $values{'keywords'}<br />  
 <b>Notes:</b> $values{'notes'}<br />  
 <b>MIME Type:</b> $values{'mimetag'}<br />  
 <b>Language:</b> $values{'language'}<br />  
 <b>Creation Date:</b> $values{'creationdate'}<br />  
 <b>Last Revision Date:</b> $values{'lastrevisiondate'}<br />  
 <b>Publisher/Owner:</b> $values{'owner'}<br />  
 <b>Copyright/Distribution:</b> $values{'copyrighttag'}<br />  
 <b>Repository Location:</b> $values{'hostname'}<br />  
 <b>Abstract:</b> $values{'shortabstract'}<br />  
 $values{'extrashow'}  
 </p>  
 END  END
       foreach my $field ('title','author','domain','subject','keywords','notes',
                          'mimetag','language','creationdate','lastrevisiondate',
                          'owner','copyrighttag','hostname','abstract') {
           $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
               (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
       }
       if (&has_stat_data(\%values)) {
           foreach my $field (&statfields()) {
               $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
                   (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
           }
       }
       if (&has_eval_data(\%values)) {
           foreach my $field (&evalfields()) {
               $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n".
                   (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n";
           }
       }
       $result .= "</dl>\n";
       $result .= $values{'extrashow'};
     return $result;      return $result;
 }  }
   
Line 2423  END Line 3448  END
 ######################################################################  ######################################################################
 ######################################################################  ######################################################################
 sub xml_sgml_view {  sub xml_sgml_view {
     my %values = @_;      my ($prefix,%values) = @_;
       my $xml = '<LonCapaResource>'."\n";
       # The usual suspects
       foreach my $field ('url','title','author','subject','keywords','notes','domain') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       #
       $xml .= "<mimeInfo>\n";
       foreach my $field ('mime','mimetag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</mimeInfo>\n";
       #
       $xml .= "<languageInfo>\n";
       foreach my $field ('language','languagetag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</languageInfo>\n";
       #
       foreach my $field ('creationdate','lastrevisiondate','owner') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       #
       $xml .= "<copyrightInfo>\n";
       foreach my $field ('copyright','copyrighttag') {
           $xml .= qq{<$field>$values{$field}</$field>}."\n";
       }
       $xml .= "</copyrightInfo>\n";
       $xml .= qq{<repositoryLocation>$values{'hostname'}</repositoryLocation>}.
           "\n";
       $xml .= qq{<shortabstract>$values{'shortabstract'}</shortabstract>}."\n";
       #
       if (&has_stat_data(\%values)){
           $xml .= "<problemstatistics>\n";
           foreach my $field (&statfields()) {
               $xml .= qq{<$field>$values{$field}</$field>}."\n";            
           }
           $xml .= "</problemstatistics>\n";
       }
       #
       if (&has_eval_data(\%values)) {
           $xml .= "<evaluation>\n";
           foreach my $field (&evalfields) {
               $xml .= qq{<$field>$values{$field}</$field>}."\n";            
           }
           $xml .= "</evaluation>\n";
       }    
       #
       $xml .= "</LonCapaResource>\n";
       $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'}
 END  END
Line 2471  END Line 3522  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 {
           return 0;
     }      }
     else {  }
  return 0;  
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &output_unparsed_phrase_error()
   
   =cut
   
   ######################################################################
   ######################################################################
   sub output_unparsed_phrase_error {
       my ($r,$closebutton,$parms,$hidden_fields,$field)=@_;
       my $errorstring;
       if ($field eq 'basicexp') {
           $errorstring = &mt('Unable to understand the search phrase [_1]. Please modify your search.'
                              ,'<i>'.$env{'form.basicexp'}.'</i>');
       } else {
           $errorstring = &mt('Unable to understand the search phrase [_1]: [_2]'
                              ,'<i>'.$field.'</i>'
                              ,$env{'form.'.$field});
     }      }
       my $heading = &mt('Unparsed Field');
       my $revise  = &mt('Revise search request');
       # make query information persistent to allow for subsequent revision
       my $start_page = &Apache::loncommon::start_page('Search');
       my $end_page   = &Apache::loncommon::end_page();
       $r->print(<<ENDPAGE);
   $start_page
   <form method="post" action="/adm/searchcat">
   $hidden_fields
   $closebutton
   <hr />
   <h2>$heading</h2>
   <p class="LC_warning">
   $errorstring
   </p>
   <p>
   <a href="/adm/searchcat?$parms&amp;persistent_db_id=$env{'form.persistent_db_id'}">$revise</a>
   </p>
   $end_page
   ENDPAGE
 }  }
   
 ######################################################################  ######################################################################
Line 2485  sub filled { Line 3579  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)=@_;
     # make query information persistent to allow for subsequent revision      my $errormsg = &mt('You did not fill in enough information for the search to be started. You need to fill in relevant fields on the search page in order for a query to be processed.');
     my $persistent=&make_persistent(\%ENV);      my $revise = &mt('Revise Search Request');
       my $heading = &mt('Unactionable Search Query');
       my $start_page = &Apache::loncommon::start_page('Search');
       my $end_page   = &Apache::loncommon::end_page();
       if ($closebutton) {
           $closebutton = '<p>'.$closebutton.'</p><hr />';
       } else {
           &Apache::lonhtmlcommon::add_breadcrumb
               ({href=>'',
                 text=>$heading,});
           $start_page .= &Apache::lonhtmlcommon::breadcrumbs();
       }
   
     $r->print(<<BEGINNING);      $r->print(<<ENDPAGE);
 <html>  $start_page
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 BEGINNING  
     $r->print(<<RESULTS);  
 </head>  
 <body bgcolor="#ffffff">  
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <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'  
 onClick='this.form.submit();' />  
 $closebutton  $closebutton
 <hr />  </form>
 <h3>Helpful Message</h3>  <h2>$heading</h2>
   <p class="LC_warning">
   $errormsg
   </p>
 <p>  <p>
 Incorrect search query due to blank entry fields.  <a href="/adm/searchcat?$parms&amp;persistent_db_id=$env{'form.persistent_db_id'}">$revise</a>
 You need to fill in the relevant  
 fields on the search page in order for a query to be  
 processed.  
 </p>  </p>
 </body>  $end_page
 </html>  ENDPAGE
 RESULTS      return;
 }  }
   
 ######################################################################  ######################################################################
Line 2531  RESULTS Line 3635  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 $start_page = &Apache::loncommon::start_page('Search');
       my $end_page   = &Apache::loncommon::end_page();
       my $heading = &mt('Error');
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 <html>  $start_page
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 </head>  
 <body bgcolor="#ffffff">  
 <img align='right' src='/adm/lonIcons/lonlogos.gif' />  
 <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
   </form>
 <hr />  <hr />
 <h3>Helpful Message</h3>  <h3>$heading</h3>
 <p>  <p class="LC_error">
 $message  $message
 </p>  </p>
 </body>  $end_page
 </html>  
 RESULTS  RESULTS
 }  }
   
Line 2589  sub start_fresh_session { Line 3694  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();      return OK;
 }  }
   
 ######################################################################  
 ######################################################################  
   
 =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.331.4.1

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