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

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

version 1.74, 2001/03/22 14:19:17 version 1.136, 2002/07/05 18:56:52
Line 1 Line 1
 # The LearningOnline Network  # The LearningOnline Network with CAPA
 # Search Catalog  # Search Catalog
 #  #
 # 03/08/2001 Scott Harrison  # $Id$
 # Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001  
 # Scott Harrison: 03/20/2001  
 #  #
 # Functions  # Copyright Michigan State University Board of Trustees
 #  #
 # handler(server reference) : interacts with the Apache server layer  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #                             (for /adm/searchcat URLs)  #
 # simpletextfield(name,value) : returns HTML formatted string for simple text  # LON-CAPA is free software; you can redistribute it and/or modify
 #                               field  # it under the terms of the GNU General Public License as published by
 # simplecheckbox(name,value) : returns HTML formatted string for simple  # the Free Software Foundation; either version 2 of the License, or
 #                              checkbox  # (at your option) any later version.
 # searchphrasefield(title,name,value) : returns HTML formatted string for  #
 #                                       a search expression phrase field  # LON-CAPA is distributed in the hope that it will be useful,
 # dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML  # but WITHOUT ANY WARRANTY; without even the implied warranty of
 #                                                          formatted string  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 #                                                          for a calendar date  # GNU General Public License for more details.
 # selectbox(title,name,value,%HASH=options) : returns HTML formatted string for  #
 #                                             a selection box field  # You should have received a copy of the GNU General Public License
 # advancedsearch(server reference, environment reference) : perform a complex  # along with LON-CAPA; if not, write to the Free Software
 #                                  multi-field logical query  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 # filled(field) : determines whether a given field has been filled  #
 # basicsearch(server reference, environment reference) : perform a simple  # /home/httpd/html/adm/gpl.txt
 #                               single-field logical query  #
 # output_blank_field_error(server reference) : outputs a message saying that  # http://www.lon-capa.org/
 #                                              more fields need to be filled in  #
 # output_results(output mode,  # YEAR=2001
 #                server reference,   # 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison
 #                environment reference,  # 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison
 #                reply list reference) : outputs results from search  # 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison
 # build_SQL_query(field name, logic) : builds a SQL query string from a  # YEAR=2002
 #                                      logical expression with AND/OR keywords  # 1/17 Scott Harrison
 # recursive_SQL_query_build(field name, reverse notation expression) :   # 6/17 Matthew Hall
 #                 builds a SQL query string from a reverse notation expression  #
 #                 logical expression with AND/OR keywords  ###############################################################################
   ###############################################################################
   
   =pod 
   
   =head1 NAME
   
   lonsearchcat
   
   =head1 SYNOPSIS
   
   Search interface to LON-CAPAs digital library
   
   =head1 DESCRIPTION
   
   This module enables searching for a distributed browseable catalog.
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org.
   
   lonsearchcat presents the user with an interface to search the LON-CAPA
   digital library.  lonsearchcat also initiates the execution of a search
   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.
   
   =head1 Internals
   
   =over 4
   
   =cut
   
   ###############################################################################
   ###############################################################################
   
   ###############################################################################
   ##                                                                           ##
   ## 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);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::File();  use Apache::File();
 use CGI qw(:standard);  use CGI qw(:standard);
 use Text::Query;  use Text::Query;
   use GDBM_File;
   use Apache::loncommon();
   
 my %language;  # ---------------------------------------- variables used throughout the module
 my $scrout;  
 my %metadatafields;  ######################################################################
 my %cprtag;  ######################################################################
 my %mimetag;  
 my $closebutton;  =pod 
 my $basicviewselect=<<END;  
 <select name='basicviewselect'>  =item Global variables
 <option value='Detailed Citation View'>Detailed Citation View</option>  
 <option value='Summary View'>Summary View</option>  =over 4
 <option value='Fielded Format'>Fielded Format</option>  
 <option value='XML/SGML'>XML/SGML</option>  =item $closebutton
 </select>  
 END  button that closes the search window
 my $advancedviewselect=<<END;  
 <select name='advancedviewselect'>  =item $importbutton
 <option value='Detailed Citation View'>Detailed Citation View</option>  
 <option value='Summary View'>Summary View</option>  button to take the select results and go to group sorting
 <option value='Fielded Format'>Fielded Format</option>  
 <option value='XML/SGML'>XML/SGML</option>  =item %hash   
 </select>  
 END  The ubiquitous database hash
   
   =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().
   
   =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 %hash;     # database hash
   my $diropendb = "";    # db file
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &handler() - main handler invoked by httpd child
   
   =item Variables
   
   =over 4
   
   =item $hidden
   
   holds 'hidden' html forms
   
   =item $scrout
   
   string that holds portions of the screen output
   
   =back 
   
   =cut
   
   ######################################################################
   ######################################################################
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
       untie %hash;
 # -------------------------------------- see if called from an interactive mode  
     map {  
        my ($name, $value) = split(/=/,$_);  
        $value =~ tr/+/ /;  
        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;  
        if ($name eq 'catalogmode') {  
    $ENV{'form.'.$name}=$value;  
        }  
     } (split(/&/,$ENV{'QUERY_STRING'}));  
   
     $r->content_type('text/html');      $r->content_type('text/html');
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
   
     %metadatafields=();      my $domain  = $r->dir_config('lonDefDomain');
       $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
     my $hidden='';              "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
     $hidden=<<END if $ENV{'form.catalogmode'} eq 'interactive';  
 <input type='hidden' name='catalogmode' value='interactive'>      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                ['catalogmode','launch','acts','mode','form','element',
                 'reqinterface']);
       ##
       ## Clear out old values from database
       ##
       if ($ENV{'form.launch'} eq '1') {
    if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
       &start_fresh_session();
       untie %hash;
    } else {
       $r->print('<html><head></head><body>Unable to tie hash to db '.
         'file</body></html>');
       return OK;
    }
       }
       ##
       ## Produce some output, so people know it is working
       ##
       $r->print("\n");
       $r->rflush;
       ##
       ## Configure dynamic components of interface
       ##
       my $hidden;       # Holds 'hidden' html forms
       if ($ENV{'form.catalogmode'} eq 'interactive') {
    $hidden="<input type='hidden' name='catalogmode' value='interactive'>".
       "\n";
           $closebutton="<input type='button' name='close' value='CLOSE' ".
       "onClick='self.close()'>"."\n";
       } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
    $hidden=<<END;
   <input type='hidden' name='catalogmode' value='groupsearch'>
 END  END
           $closebutton=<<END;
     $closebutton=<<END if $ENV{'form.catalogmode'} eq 'interactive';  <input type='button' name='close' value='CLOSE' onClick='self.close()'>
 <input type="button" name="close" value='CLOSE' onClick="self.close()">  END
           $importbutton=<<END;
   <input type='button' name='import' value='IMPORT'
   onClick='javascript:select_group()'>
 END  END
   
 # ------------------------------------------------ First, check out environment  
     $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};  
   
 # --------------------------------- Compute various listings of metadata values  
       
     %language=();  
     $language{'any'}='Any language';  
     {  
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');  
  map {  
     $_=~/(\w+)\s+([\w\s\-]+)/; chomp;  
     $language{$1}=$2;  
  } <$fh>;  
     }      }
       $hidden .= &make_persistent({ "form.mode"    => $ENV{'form.mode'},
     %cprtag=();                                    "form.form"    => $ENV{'form.form'},
     $cprtag{'any'}='Any copyright/distribution';                                    "form.element" => $ENV{'form.element'},
     {                                    "form.date"    => 2 });
  my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');      ##
  map {      ##  What are we doing?
     $_=~/(\w+)\s+([\w\s\-]+)/; chomp;      ##
     $cprtag{$1}=$2;      my $searchtype;
  } <$fh>;      $searchtype = 'Basic'    if ($ENV{'form.basicsubmit'}    eq 'SEARCH');
       $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH');
       if ($searchtype) {
           my ($query,$customquery,$customshow,$libraries) = 
               (undef,undef,undef,undef);
           if ($searchtype eq 'Basic') {
               $query = &parse_basic_search($r);
           } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
               ($query,$customquery,$customshow,$libraries) 
                   = &parse_advanced_search($r);
               return OK if (! defined($query));
           }
           # Send query statements over the network to be processed by 
           # either the SQL database or a recursive scheme of 'grep'-like 
           # actions (for custom metadata).
           $r->rflush();
           my $reply=&Apache::lonnet::metadata_query($query,$customquery,
                                                  $customshow,$libraries);
           &output_results($searchtype,$r,$reply,$hidden);
       } elsif ($ENV{'form.reqinterface'} eq 'advanced') {
           # Output the advanced interface
           $r->print(&advanced_search_form($closebutton,$hidden));
       } else { 
           # Output normal search interface
           $r->print(&basic_search_form($closebutton,$hidden));
     }      }
       return OK;
   } 
   
     %mimetag=();  ######################################################################
     $mimetag{'any'}='Any type';  ######################################################################
     {  
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');  
  map {  
     $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;  
     $mimetag{$1}=".$1 $3";  
  } <$fh>;  
     }  
   
     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {  =pod 
  return &basicsearch($r,\%ENV);  
     }  
     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {  
  return &advancedsearch($r,\%ENV);  
     }  
   
     $scrout=''; # building a part of screen output  =item &basic_search_form() 
     $scrout.=&searchphrasefield('Limit by title','title',  
  $ENV{'form.title'});  
   
     $scrout.=&searchphrasefield('Limit by author','author',  Returns a scalar which holds html for the basic search form.
  $ENV{'form.author'});  
   
     $scrout.=&searchphrasefield('Limit by subject','subject',  =cut
  $ENV{'form.subject'});  
   
     $scrout.=&searchphrasefield('Limit by keywords','keywords',  ######################################################################
  $ENV{'form.keywords'});  ######################################################################
   
     $scrout.=&searchphrasefield('Limit by URL','url',  sub basic_search_form{
  $ENV{'form.url'});      my ($closebutton,$hidden) = @_;
       my $scrout=<<"ENDDOCUMENT";
   <html>
   <head>
   <title>The LearningOnline Network with CAPA</title>
   <script type="text/javascript">
       function openhelp(val) {
    openhelpwin=open('/adm/help/searchcat.html','helpscreen',
        'scrollbars=1,width=600,height=300');
    openhelpwin.focus();
       }
   </script>
   </head>
   <body bgcolor="#FFFFFF">
   <img align='right' src='/adm/lonIcons/lonlogos.gif' />
   <h1>Search Catalog</h1>
   <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>';
       $scrout.=<<ENDDOCUMENT;
   </td><td><a href="/adm/searchcat?reqinterface=advanced">Advanced Search</a></td></tr></table>
   </p>
   <p>
   &nbsp;<input type="submit" name="basicsubmit" value='SEARCH' />&nbsp;
   $closebutton
   <!-- view selection -->
   <select name="viewselect">
   <option value="Detailed Citation View" selected="true" >Detailed Citation View</option>
   <option value="Summary View"  >Summary View</option>
   <option value="Fielded Format">Fielded Format</option>
   <option value="XML/SGML"      >XML/SGML</option>
   </select>
   <!-- end of view selection -->
   <input type="button" value="HELP" onClick="openhelp()" />
   </p>
   </form>
   </body>
   </html>
   ENDDOCUMENT
       return $scrout;
   }
   ######################################################################
   ######################################################################
   
     $scrout.=&searchphrasefield('Limit by version','version',  =pod 
  $ENV{'form.version'});  
   
     $scrout.=&searchphrasefield('Limit by notes','notes',  =item &advanced_search_form() 
  $ENV{'form.notes'});  
   
     $scrout.=&searchphrasefield('Limit by abstract','abstract',  Returns a scalar which holds html for the advanced search form.
  $ENV{'form.abstract'});  
   
     $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});  =cut
     $scrout.=&selectbox('Limit by MIME type','mime',  
  $ENV{'form.mime'},%mimetag);  
   
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});  ######################################################################
   ######################################################################
   
   sub advanced_search_form{
       my ($closebutton,$hidden) = @_;
       my $advanced_buttons = <<"END";
   <p>
   <input type="submit" name="advancedsubmit" value='SEARCH' />
   <input type="reset" name="reset" value='RESET' />
   $closebutton
   <input type="button" value="HELP" onClick="openhelp()" />
   </p>
   END
       my $scrout=<<"ENDHEADER";
   <html>
   <head>
   <title>The LearningOnline Network with CAPA</title>
   <script type="text/javascript">
       function openhelp(val) {
    openhelpwin=open('/adm/help/searchcat.html','helpscreen',
        'scrollbars=1,width=600,height=300');
    openhelpwin.focus();
       }
   </script>
   </head>
   <body bgcolor="#FFFFFF">
   <img align='right' src='/adm/lonIcons/lonlogos.gif' />
   <h1>Advanced Catalog Search</h1>
   <hr />
   Enter terms or phrases separated by search operators 
   such as AND, OR, or NOT.<br />
   <form method="post" action="/adm/searchcat">
   $advanced_buttons
   $hidden
   <table>
   <tr><td><font color="#800000" face="helvetica"><b>VIEW:</b></font></td>
   <td>
   <!-- view selection -->
   <select name="viewselect" size ="1">
       <option value="Detailed Citation View" selected="true">Detailed Citation View</option>
       <option value="Summary View">Summary View</option>
       <option value="Fielded Format">Fielded Format</option>
       <option value="XML/SGML">XML/SGML</option>
   </select>
   <!-- end of view selection -->
   </td></tr>
   ENDHEADER
       $scrout.=&searchphrasefield('title',   'title'   ,$ENV{'form.title'});
       $scrout.=&searchphrasefield('author',  'author'  ,$ENV{'form.author'});
       $scrout.=&searchphrasefield('subject', 'subject' ,$ENV{'form.subject'});
       $scrout.=&searchphrasefield('keywords','keywords',$ENV{'form.keywords'});
       $scrout.=&searchphrasefield('URL',     'url'     ,$ENV{'form.url'});
       $scrout.=&searchphrasefield('notes',   'notes'   ,$ENV{'form.notes'});
       $scrout.=&searchphrasefield('abstract','abstract',$ENV{'form.abstract'});
       # Hack - an empty table row.
       $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
       $scrout.=&searchphrasefield('file<br />extension','mime',
                           $ENV{'form.mime'});
       $scrout.="<tr><td>&nbsp;</td><td>&nbsp;</td></tr>\n";
       $scrout.=&searchphrasefield('publisher<br />owner','owner',
    $ENV{'form.owner'});
       $scrout.="</table>\n";
       $ENV{'form.category'}='any' unless length($ENV{'form.category'});
       $scrout.=&selectbox('File Category','category',
    $ENV{'form.category'},
    'any','Any category',
    undef,
    (&Apache::loncommon::filecategories()));
       $ENV{'form.language'}='any' unless length($ENV{'form.language'});
       #----------------------------------------------------------------
       # Allow restriction to multiple domains.
       #   I make the crazy assumption that there will never be a domain 'any'.
       #
       $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'}));
       my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
                              :  ($ENV{'form.domains'}) );
       my %domain_hash = ();
       foreach (@allowed_domains) {
           $domain_hash{$_}++;
       }
       my @domains =&Apache::loncommon::get_domains();
       # adjust the size of the select box
       my $size = 4;
       my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size);
       # standalone machines do not get to choose a domain to search.
       if ((scalar @domains) == 1) {
           $scrout .='<input type="hidden" name="domains" value="any" />'."\n";
       } else {
           $scrout.="\n".'<font color="#800000" face="helvetica"><b>'.
               'DOMAINS</b></font><br />'.
                   '<select name="domains" size="'.$size.'" multiple>'."\n".
                       '<option name="any" value="any" '.
                           ($domain_hash{'any'}? 'selected ' :'').
                           '>all domains</option>'."\n";
           foreach my $dom (sort @domains) {
               $scrout.="<option name=\"$dom\" ".
                   ($domain_hash{$dom} ? 'selected ' :'').">$dom</option>\n";
           }
           $scrout.="</select>\n";
       }
       #----------------------------------------------------------------
     $scrout.=&selectbox('Limit by language','language',      $scrout.=&selectbox('Limit by language','language',
  $ENV{'form.language'},%language);   $ENV{'form.language'},'any','Any Language',
        \&{Apache::loncommon::languagedescription},
    (&Apache::loncommon::languageids),
    );
 # ------------------------------------------------ Compute date selection boxes  # ------------------------------------------------ Compute date selection boxes
     $scrout.=<<CREATIONDATESTART;      $scrout.=<<CREATIONDATESTART;
 <p>  <p>
 <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>  <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>
 </font>  </font>
 <br>  <br />
 between:  between:
 CREATIONDATESTART  CREATIONDATESTART
     $scrout.=&dateboxes('creationdatestart',1,1,1976,      $scrout.=&dateboxes('creationdatestart',1,1,1976,
Line 187  CREATIONDATESTART Line 447  CREATIONDATESTART
  $ENV{'form.creationdatestart_day'},   $ENV{'form.creationdatestart_day'},
  $ENV{'form.creationdatestart_year'},   $ENV{'form.creationdatestart_year'},
  );   );
     $scrout.=<<CREATIONDATEEND;      $scrout.="and:\n";
 and:  
 CREATIONDATEEND  
     $scrout.=&dateboxes('creationdateend',12,31,2051,      $scrout.=&dateboxes('creationdateend',12,31,2051,
  $ENV{'form.creationdateend_month'},   $ENV{'form.creationdateend_month'},
  $ENV{'form.creationdateend_day'},   $ENV{'form.creationdateend_day'},
  $ENV{'form.creationdateend_year'},   $ENV{'form.creationdateend_year'},
  );   );
     $scrout.="</p>";      $scrout.="</p>";
   
     $scrout.=<<LASTREVISIONDATESTART;      $scrout.=<<LASTREVISIONDATESTART;
 <p>  <p>
 <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:  <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:
 </b></font>  </b></font>
 <br>between:  <br />between:
 LASTREVISIONDATESTART  LASTREVISIONDATESTART
     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,      $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
  $ENV{'form.lastrevisiondatestart_month'},   $ENV{'form.lastrevisiondatestart_month'},
Line 217  LASTREVISIONDATEEND Line 474  LASTREVISIONDATEEND
  $ENV{'form.lastrevisiondateend_year'},   $ENV{'form.lastrevisiondateend_year'},
  );   );
     $scrout.='</p>';      $scrout.='</p>';
   
     $scrout.=&searchphrasefield('Limit by publisher/owner','owner',  
  $ENV{'form.owner'});  
 # $metadatafields{'owner'});  
   
     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});      $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
     $scrout.=&selectbox('Limit by copyright/distribution','copyright',      $scrout.=&selectbox('Limit by copyright/distribution','copyright',
  $ENV{'form.copyright'},%cprtag);   $ENV{'form.copyright'},
    'any','Any copyright/distribution',
    \&{Apache::loncommon::copyrightdescription},
    (&Apache::loncommon::copyrightids),
    );
 # ------------------------------------------- Compute customized metadata field  # ------------------------------------------- Compute customized metadata field
     $scrout.=<<CUSTOMMETADATA;      $scrout.=<<CUSTOMMETADATA;
 <p>  <p>
 <font color="#800000" face="helvetica"><b>LIMIT BY OTHER METADATA FIELDS:</b>  <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>
 </font>  </font>
 For author-specific metadata, enter in an expression in the form of   For resource-specific metadata, enter in an expression in the form of 
 <i>key</i>=<i>value</i> separated by operators such as AND or OR.<br>  <i>key</i>=<i>value</i> separated by operators such as AND, OR or NOT.<br />
 <b>Example:</b> grandmother=75 OR grandfather=85  <b>Example:</b> grandmother=75 OR grandfather=85
 <br>  <br />
 CUSTOMMETADATA  CUSTOMMETADATA
 $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});      $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
 $scrout.=' <i>initial users of this system do not need to worry about this option</i>';      $scrout.=<<CUSTOMSHOW;
   
 # ---------------------------------------------------------------- Print screen  
     $r->print(<<ENDDOCUMENT);  
 <html>  
 <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">  
 $hidden  
 <hr>  
 <h3>Basic Search</h3>  
 <p>  <p>
 Enter terms or phrases separated by search operators  <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
 such as AND or OR then press SEARCH below.  Terms should be specific  </font>
 to the title, author, subject, notes, or abstract information associated  Enter in a space-separated list of special metadata fields to show
 with a resource.  in a fielded listing for each record result.
 <br>  <br />
 ENDDOCUMENT  CUSTOMSHOW
     $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'}));      $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
     $r->print(' ');      $scrout.=<<ENDDOCUMENT;
     $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'}));  $advanced_buttons
     $r->print('<font color="#800000">Title only</font> ');  
     $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'}));  
     $r->print(<<ENDDOCUMENT);  
 <font color="#800000">Search historic archives</font>  
 <br>  
 <input type="submit" name="basicsubmit" value='SEARCH' />  
 <input type="reset" name="reset" value='RESET' />  
 $closebutton  
 $basicviewselect  
 </p>  
 <hr>  
 <h3>Advanced Search</h3>  
 $scrout  
 <p>  
 <input type="submit" name="advancedsubmit" value='SEARCH' />  
 <input type="reset" name="reset" value='RESET' />  
 $closebutton  
 $advancedviewselect  
 </p>  
 </form>  </form>
 </body>  </body>
 </html>  </html>
 ENDDOCUMENT  ENDDOCUMENT
     return OK;      return $scrout;
 }   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &make_persistent() 
   
   Returns a scalar which holds the current ENV{'form.*'} values in
   a 'hidden' html input tag.  This allows search interface information
   to be somewhat persistent.
   
   =cut
   
   ######################################################################
   ######################################################################
   
   sub make_persistent {
       my %save = %{shift()};
       my $persistent='';
       foreach (keys %save) {
    if (/^form\./ && !/submit/) {
       my $name=$_;
               my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
       $name=~s/^form\.//;
               foreach (@values) {
                   s/\"/\'/g; # do not mess with html field syntax
                   $persistent.=<<END;
   <input type="hidden" name="$name" value="$_" />
   END
               }
           }
       }
       return $persistent;
   }
   
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item HTML form building functions
   
   =over 4
   
   =item &simpletextfield() 
   
   Inputs: $name,$value,$size
   
 # --------------------------------------------------------- Various form fields  Returns a text input field with the given name, value, and size.  
   If size is not specified, a value of 20 is used.
   
   =item &simplecheckbox()
   
   Inputs: $name,$value
   
   Returns a simple check box with the given $name.
   If $value eq 'on' the box is checked.
   
   =item &searchphrasefield()
   
   Inputs: $title,$name,$value
   
   Returns html for a title line and an input field for entering search terms.
   the instructions "Enter terms or phrases separated by search operators such 
   as AND, OR, or NOT." are given following the title.  The entry field (which
   is where the $name and $value are used) is an 80 column simpletextfield.
   
   =item &dateboxes()
   
   Returns html selection form elements for the specification of 
   the day, month, and year.
   
   =item &selectbox()
   
   Returns a scalar containing an html <select> form.  
   
   Inputs: 
   
   =over 4
   
   =item $title 
   
   Printed above the select box, in uppercase.
   
   =item $name 
   
   The name element of the <select> tag.
   
   =item $default 
   
   The default value of the form.  Can be $anyvalue or in @idlist.
   
   =item $anyvalue 
   
   The <option value="..."> used to indicate a default of 
   none of the values.
   
   =item $anytag 
   
   The text associate with $anyvalue above.
   
   =item $functionref 
   
   Each element in @idlist will be passed as a parameter 
   to the function referenced here.  The return value of the function should
   be a scalar description of the items.  If this value is undefined the 
   description of each item in @idlist will be the item name.
   
   =item @idlist 
   
   The items to be selected from.  One of these or $anyvalue will be the 
   value returned by the form element, $ENV{form.$name}.
   
   =back
   
   =back 
   
   =cut
   
   ######################################################################
   ######################################################################
   
 sub simpletextfield {  sub simpletextfield {
     my ($name,$value)=@_;      my ($name,$value,$size)=@_;
     return '<input type=text name=\''.$name.      $size = 20 if (! defined($size));
    '\' size=20 value=\''.$value.'\' />';      return '<input type="text" name="'.$name.
           '" size="'.$size.'" value="'.$value.'" />';
 }  }
   
 sub simplecheckbox {  sub simplecheckbox {
     my ($name,$value)=@_;      my ($name,$value)=@_;
     my $checked='';      my $checked='';
     $checked="CHECKED" if $value eq 'on';      $checked="checked" if $value eq 'on';
     return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';      return '<input type="checkbox" name="'.$name.'" '. $checked . ' />';
 }  }
   
 sub searchphrasefield {  sub searchphrasefield {
     my ($title,$name,$value)=@_;      my ($title,$name,$value)=@_;
     my $instruction=<<END;  
 Enter terms or phrases separated by search operators such  
 as AND or OR.  
 END  
     my $uctitle=uc($title);      my $uctitle=uc($title);
     return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".      return '<tr><td><font color="#800000" face="helvetica">'.
    "</FONT> $instruction<br>".          '<b>'.$uctitle.':&nbsp;</b></font></td><td>'.
            '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';                  &simpletextfield($name,$value,50)."</td></tr>\n";
 }  }
   
 sub dateboxes {  sub dateboxes {
     my ($name,$defaultmonth,$defaultday,$defaultyear,      my ($name,$defaultmonth,$defaultday,$defaultyear,
  $currentmonth,$currentday,$currentyear)=@_;   $currentmonth,$currentday,$currentyear)=@_;
     ($defaultmonth,$defaultday,$defaultyear)=('','','');      ($defaultmonth,$defaultday,$defaultyear)=('','','');
     my $month=<<END;      #
 <select name="${name}_month">      # Day
 <option value='$defaultmonth'> </option>  
 <option value="1">January</option>  
 <option value="2">February</option>  
 <option value="3">March</option>  
 <option value="4">April</option>  
 <option value="5">May</option>  
 <option value="6">June</option>  
 <option value="7">July</option>  
 <option value="8">August</option>  
 <option value="9">September</option>  
 <option value="10">October</option>  
 <option value="11">November</option>  
 <option value="12">December</option>  
 </select>  
 END  
     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);  
     my $day=<<END;      my $day=<<END;
 <select name="${name}_day">  <select name="${name}_day">
 <option value='$defaultday'> </option>  <option value='$defaultday'> </option>
 <option value="1">1</option>  
 <option value="2">2</option>  
 <option value="3">3</option>  
 <option value="4">4</option>  
 <option value="5">5</option>  
 <option value="6">6</option>  
 <option value="7">7</option>  
 <option value="8">8</option>  
 <option value="9">9</option>  
 <option value="10">10</option>  
 <option value="11">11</option>  
 <option value="12">12</option>  
 <option value="13">13</option>  
 <option value="14">14</option>  
 <option value="15">15</option>  
 <option value="16">16</option>  
 <option value="17">17</option>  
 <option value="18">18</option>  
 <option value="19">19</option>  
 <option value="20">20</option>  
 <option value="21">21</option>  
 <option value="22">22</option>  
 <option value="23">23</option>  
 <option value="24">24</option>  
 <option value="25">25</option>  
 <option value="26">26</option>  
 <option value="27">27</option>  
 <option value="28">28</option>  
 <option value="29">29</option>  
 <option value="30">30</option>  
 <option value="31">31</option>  
 </select>  
 END  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);      $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);
       #
       # Month
       my $month=<<END;
   <select name="${name}_month">
   <option value='$defaultmonth'> </option>
   END
       my $i = 1;
       foreach (qw/January February March April May June 
        July August September October November December /){
    $month .="<option value=\"$i\">$_</option>\n";
    $i++;
       }
       $month.="</select>\n";
       $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
       #
       # Year (obviously)
     my $year=<<END;      my $year=<<END;
 <select name="${name}_year">  <select name="${name}_year">
 <option value='$defaultyear'> </option>  <option value='$defaultyear'> </option>
 <option value="1976">1976</option>  
 <option value="1977">1977</option>  
 <option value="1978">1978</option>  
 <option value="1979">1979</option>  
 <option value="1980">1980</option>  
 <option value="1981">1981</option>  
 <option value="1982">1982</option>  
 <option value="1983">1983</option>  
 <option value="1984">1984</option>  
 <option value="1985">1985</option>  
 <option value="1986">1986</option>  
 <option value="1987">1987</option>  
 <option value="1988">1988</option>  
 <option value="1989">1989</option>  
 <option value="1990">1990</option>  
 <option value="1991">1991</option>  
 <option value="1992">1992</option>  
 <option value="1993">1993</option>  
 <option value="1994">1994</option>  
 <option value="1995">1995</option>  
 <option value="1996">1996</option>  
 <option value="1997">1997</option>  
 <option value="1998">1998</option>  
 <option value="1999">1999</option>  
 <option value="2000">2000</option>  
 <option value="2001">2001</option>  
 <option value="2002">2002</option>  
 <option value="2003">2003</option>  
 <option value="2004">2004</option>  
 <option value="2005">2005</option>  
 <option value="2006">2006</option>  
 <option value="2007">2007</option>  
 <option value="2008">2008</option>  
 <option value="2009">2009</option>  
 <option value="2010">2010</option>  
 <option value="2011">2011</option>  
 <option value="2012">2012</option>  
 <option value="2013">2013</option>  
 <option value="2014">2014</option>  
 <option value="2015">2015</option>  
 <option value="2016">2016</option>  
 <option value="2017">2017</option>  
 <option value="2018">2018</option>  
 <option value="2019">2019</option>  
 <option value="2020">2020</option>  
 <option value="2021">2021</option>  
 <option value="2022">2022</option>  
 <option value="2023">2023</option>  
 <option value="2024">2024</option>  
 <option value="2025">2025</option>  
 <option value="2026">2026</option>  
 <option value="2027">2027</option>  
 <option value="2028">2028</option>  
 <option value="2029">2029</option>  
 <option value="2030">2030</option>  
 <option value="2031">2031</option>  
 <option value="2032">2032</option>  
 <option value="2033">2033</option>  
 <option value="2034">2034</option>  
 <option value="2035">2035</option>  
 <option value="2036">2036</option>  
 <option value="2037">2037</option>  
 <option value="2038">2038</option>  
 <option value="2039">2039</option>  
 <option value="2040">2040</option>  
 <option value="2041">2041</option>  
 <option value="2042">2042</option>  
 <option value="2043">2043</option>  
 <option value="2044">2044</option>  
 <option value="2045">2045</option>  
 <option value="2046">2046</option>  
 <option value="2047">2047</option>  
 <option value="2048">2048</option>  
 <option value="2049">2049</option>  
 <option value="2050">2050</option>  
 <option value="2051">2051</option>  
 </select>  
 END  END
       my $maxyear = 2051; 
       for (my $i = 1976; $i<=$maxyear; $i++) {
    $year.="<option value=\"$i\">$i</option>\n";
       }
       $year.="</select>\n";
     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);      $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);
     return "$month$day$year";      return "$month$day$year";
 }  }
   
 sub selectbox {  sub selectbox {
     my ($title,$name,$value,%options)=@_;      my ($title,$name,$default,$anyvalue,$anytag,$functionref,@idlist)=@_;
       if (! defined($functionref)) { $functionref = sub { $_[0]}; }
     my $uctitle=uc($title);      my $uctitle=uc($title);
     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".      my $selout="\n".'<p><font color="#800000" face="helvetica">'.
  "</b></font><br>".'<select name="'.$name.'">';          '<b>'.$uctitle.': </b></font><select name="'.$name.'">';
     map {      foreach ($anyvalue,@idlist) {
         $selout.='<option value=\''.$_.'\'';          $selout.='<option value="'.$_.'"';
         if ($_ eq $value) { $selout.=' selected'; }          if ($_ eq $default and !/^any$/) {
         $selout.='>'.$options{$_}.'</option>';      $selout.=' selected >'.&{$functionref}($_).'</option>';
     } sort keys %options;   }
     return $selout.'</select>';   elsif ($_ eq $default and /^$anyvalue$/) {
       $selout.=' selected >'.$anytag.'</option>';
    }
           else {$selout.='>'.&{$functionref}($_).'</option>';}
       }
       return $selout.'</select></p>';
 }  }
   
 # ----------------------------------------------- Performing an advanced search  ######################################################################
 sub advancedsearch {  ######################################################################
     my ($r,$envhash)=@_;  
     my %ENV=%{$envhash};  =pod 
   
   =item &parse_advanced_search()
   
   Parse advanced search form and return the following:
   
   =over 4
   
   =item $query Scalar containing an SQL query.
   
   =item $customquery Scalar containing a custom query.
   
   =item $customshow Scalar containing commands to show custom metadata.
   
   =item $libraries_to_query Reference to array of domains to search.
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub parse_advanced_search {
       my ($r)=@_;
     my $fillflag=0;      my $fillflag=0;
     # Clean up fields for safety      # Clean up fields for safety
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
Line 487  sub advancedsearch { Line 755  sub advancedsearch {
    'lastrevisiondatestart_year','lastrevisiondateend_month',     'lastrevisiondatestart_year','lastrevisiondateend_month',
    'lastrevisiondateend_day','lastrevisiondateend_year',     'lastrevisiondateend_day','lastrevisiondateend_year',
    'notes','abstract','mime','language','owner',     'notes','abstract','mime','language','owner',
    'custommetadata') {     'custommetadata','customshow','category') {
  $ENV{"form.$field"}=~s/[^\w\s\(\)\=\-\"\']//g;   $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
     }      }
       foreach ('mode','form','element') {
    # is this required?  Hmmm.
    next unless (exists($ENV{"form.$_"}));
    $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
    $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
       }
       # Preprocess the category form element.
       if ($ENV{'form.category'} ne 'any') {
           my @extensions = &Apache::loncommon::filecategorytypes
               ($ENV{'form.category'});
           $ENV{'form.mime'} = join ' OR ',@extensions;
       }
       # Check to see if enough information was filled in
     for my $field ('title','author','subject','keywords','url','version',      for my $field ('title','author','subject','keywords','url','version',
    'notes','abstract','mime','language','owner',     'notes','abstract','mime','language','owner',
    'custommetadata') {     'custommetadata') {
Line 497  sub advancedsearch { Line 778  sub advancedsearch {
     $fillflag++;      $fillflag++;
  }   }
     }      }
   
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r);
  return OK;   return ;
     }      }
       # Turn the form input into a SQL-based query
     my $query='';      my $query='';
   
     my @queries;      my @queries;
     # Go through logical expression AND/OR/NOT phrase fields.      # Evaluate logical expression AND/OR/NOT phrase fields.
   
     foreach my $field ('title','author','subject','notes','abstract','url',      foreach my $field ('title','author','subject','notes','abstract','url',
        'keywords','version','owner') {         'keywords','version','owner','mime') {
  if ($ENV{'form.'.$field}) {   if ($ENV{'form.'.$field}) {
     push @queries,&build_SQL_query($field,$ENV{'form.'.$field});      push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
  }          }
     }      }
     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {      # I dislike the hack below.
  push @queries,"(language like \"\%$ENV{'form.language'}\%\")";      if ($ENV{'form.category'}) {
           $ENV{'form.mime'}='';
     }      }
     if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {      # Evaluate option lists
  push @queries,"(mime like \"\%$ENV{'form.mime'}\%\")";      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
    push @queries,"(language like \"$ENV{'form.language'}\")";
     }      }
     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'}\")";
     }      }
       # Evaluate date windows
     my $datequery=&build_date_queries(      my $datequery=&build_date_queries(
  $ENV{'form.creationdatestart_month'},   $ENV{'form.creationdatestart_month'},
  $ENV{'form.creationdatestart_day'},   $ENV{'form.creationdatestart_day'},
Line 537  sub advancedsearch { Line 818  sub advancedsearch {
  $ENV{'form.lastrevisiondateend_day'},   $ENV{'form.lastrevisiondateend_day'},
  $ENV{'form.lastrevisiondateend_year'},   $ENV{'form.lastrevisiondateend_year'},
  );   );
       # Test to see if date windows are legitimate
     if ($datequery=~/^Incorrect/) {      if ($datequery=~/^Incorrect/) {
  &output_date_error($r,$datequery);   &output_date_error($r,$datequery);
  return OK;   return ;
     }      }
     elsif ($datequery) {      elsif ($datequery) {
  push @queries,$datequery;   push @queries,$datequery;
     }      }
     my $customquery;      # Process form information for custom metadata querying
       my $customquery=undef;
     if ($ENV{'form.custommetadata'}) {      if ($ENV{'form.custommetadata'}) {
  $customquery=&build_custommetadata_query('custommetadata',   $customquery=&build_custommetadata_query('custommetadata',
       $ENV{'form.custommetadata'});        $ENV{'form.custommetadata'});
     }      }
       my $customshow=undef;
       if ($ENV{'form.customshow'}) {
    $customshow=$ENV{'form.customshow'};
    $customshow=~s/[^\w\s]//g;
    my @fields=split(/\s+/,$customshow);
    $customshow=join(" ",@fields);
       }
       ## ---------------------------------------------------------------
       ## Deal with restrictions to given domains
       ## 
       my $libraries_to_query = undef;
       # $ENV{'form.domains'} can be either a scalar or an array reference.
       # We need an array.
       my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} 
                              :  ($ENV{'form.domains'}) );
       my %domain_hash = ();
       foreach (@allowed_domains) {
           $domain_hash{$_}++;
       }
       foreach (keys(%Apache::lonnet::libserv)) {
           if ($_ eq 'any') {
               $libraries_to_query = undef;
               last;
           }
           if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) {
               push @$libraries_to_query,$_;
           }
       }
       #
     if (@queries) {      if (@queries) {
  $query=join(" AND ",@queries);   $query=join(" AND ",@queries);
  $query="select * from metadata where $query";   $query="select * from metadata where $query";
  my $reply=&Apache::lonnet::metadata_query($query);      } elsif ($customquery) {
  &output_results('Advanced',$r,$envhash,$customquery,$reply);          $query = '';
     }  
     else {  
  &output_results('Advanced',$r,$envhash,$query);  
     }      }
     return OK;      return ($query,$customquery,$customshow,$libraries_to_query);
 }  }
   
 # ---------------------------------------------------- see if a field is filled  ######################################################################
 sub filled {  ######################################################################
     my ($field)=@_;  
     if ($field=~/\S/) {  =pod 
  return 1;  
     }  
     else {  
  return 0;  
     }  
 }  
   
 # --------------------------------------------------- Performing a basic search  =item &parse_basic_search() 
 sub basicsearch {  
     my ($r,$envhash)=@_;  
     my %ENV=%{$envhash};  
   
   Parse the basic search form and return a scalar containing an sql query.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub parse_basic_search {
       my ($r)=@_;
     # 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') {
    # is this required?  Hmmm.
    next unless (exists($ENV{"form.$_"}));
    $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"});
    $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
       }
   
       # Check to see if enough is filled in
     unless (&filled($ENV{'form.basicexp'})) {      unless (&filled($ENV{'form.basicexp'})) {
  &output_blank_field_error($r);   &output_blank_field_error($r);
  return OK;   return OK;
     }      }
   
       # Build SQL query string based on form page
     my $query='';      my $query='';
     my $concatarg=join(',"    ",',      my $concatarg=join(',"    ",',
        ('title', 'author', 'subject', 'notes', 'abstract'));         ('title', 'author', 'subject', 'notes', 'abstract',
                           'keywords'));
       $concatarg='title' if $ENV{'form.titleonly'};
   
     $query="select * from metadata where concat($concatarg) like '\%$ENV{'form.basicexp'}\%'";      $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
     my $reply=&Apache::lonnet::metadata_query($query);      return 'select * from metadata where '.$query;
     &output_results('Basic',$r,$envhash,$query,$reply);  
     return OK;  
 }  }
   
 # ---------------- Message to output when there are not enough fields filled in  
 sub output_blank_field_error {  
     my ($r)=@_;  
     # make query information persistent to allow for subsequent revision  
     my $persistent=&make_persistent();  
   
     $r->print(<<BEGINNING);  
 <html>  
 <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">  
 $persistent  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();'>  
 $closebutton  
 <hr>  
 <h3>Helpful Message</h3>  
 <p>  
 Incorrect search query due to blank entry fields.  
 You need to fill in the relevant  
 fields on the search page in order for a query to be  
 processed.  
 </p>  
 </body>  
 </html>  
 RESULTS  
 }  
   
 # ----------------------------- format and output results based on a reply list  
 sub output_results {  
     my ($mode,$r,$envhash,$query,@replylist)=@_;  
     my %ENV=%{$envhash};  
     my $compiledresult='';  
   
     foreach my $reply (@replylist) {  
   
  my @results;  
   
  my $replyfile='';  
  $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting  
  $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
  $reply=~/(.*?)\_/;  
  my $hostname=$1;  
  sleep 3; # temporary fix, need to check for completion and status  
  {  
     while (1) {  
  last if -e $replyfile;  
  sleep 1;  
     }  
     # QUESTION: how should I handle this error condition..  
     # I'm sure there is syntax elsewhere I can use..  
     my $fh=Apache::File->new($replyfile) or  
  ($r->print('file cannot be opened') and return OK);  
     @results=<$fh>;  
  }  
   
  foreach my $result (@results) {  
     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 $shortabstract=$abstract;  
     $shortabstract=substr($abstract,0,200) if length($abstract)>200;  
     $fields[7]=$shortabstract;  
     $compiledresult.=<<END;  
 <p>  
 END  
             $compiledresult.=<<END if $ENV{'form.catalogmode'} eq 'interactive';  
 <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"  
 onClick="javascript:select_data('$title','$url')">  
 </font>  
 <br>  
 END  
             my $httphost=$ENV{'HTTP_HOST'};  
   
     my $viewselect;  
     if ($mode eq 'Basic') {  
  $viewselect=$ENV{'form.basicviewselect'};  
     }  
     elsif ($mode eq 'Advanced') {  
  $viewselect=$ENV{'form.advancedviewselect'};  
     }  
   
             if ($viewselect eq 'Detailed Citation View') {  ######################################################################
  $compiledresult.=&detailed_citation_view(@fields,  ######################################################################
  $hostname,$httphost);  
     }  
             elsif ($viewselect eq 'Summary View') {  
  $compiledresult.=&summary_view(@fields,$hostname,$httphost);  
     }  
             elsif ($viewselect eq 'Fielded Format') {  
  $compiledresult.=&fielded_format_view(@fields,$hostname,  
       $httphost);  
     }  
             elsif ($viewselect eq 'XML/SGML') {  
  $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost);  
     }  
   
         }  =pod 
   
  unless ($compiledresult) {  =item &build_SQL_query() 
     $compiledresult="There were no results that matched your query";  
  }  
   
  # make query information persistent to allow for subsequent revision  Builds a SQL query string from a logical expression with AND/OR keywords
  my $persistent=&make_persistent();  using Text::Query and &recursive_SQL_query_builder()
   
  $r->print(<<BEGINNING);  =cut
 <html>  
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 BEGINNING  
         $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'interactive';  
 <script>  
     function select_data(title,url) {  
  changeTitle(title);  
  changeURL(url);  
     }  
     function changeTitle(val) {  
  if (opener.inf.document.forms.resinfo.elements.t) {  
     opener.inf.document.forms.resinfo.elements.t.value=val;  
  }  
     }  
     function changeURL(val) {  
  if (opener.inf.document.forms.resinfo.elements.u) {  
     opener.inf.document.forms.resinfo.elements.u.value=val;  
  }  
     }  
 </script>  
 SCRIPT  
         $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">  
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();'>  
 $closebutton  
 $persistent  
 <hr>  
 <h3>Search Query</h3>  
 RESULTS  
     if ($mode eq 'Basic') {  
  $r->print(<<RESULTS);  
 <p>  
 <b>Basic search:</b> $ENV{'form.basicexp'}  
 </p>  
 RESULTS  
     }  
     elsif ($mode eq 'Advanced') {  
  $r->print(<<RESULTS);  
 <p>  
 <b>Advanced search</b>  
 $query  
 </p>  
 RESULTS  
     }  
  $r->print(<<RESULTS);  
 <h3>Search Results</h3>  
 $compiledresult  
 </body>  
 </html>  
 RESULTS  
     }  
 }  
   
 # ------------------------------------------------------------- build_SQL_query  ######################################################################
   ######################################################################
 sub build_SQL_query {  sub build_SQL_query {
     my ($field_name,$logic_statement)=@_;      my ($field_name,$logic_statement)=@_;
     my $q=new Text::Query('abc',      my $q=new Text::Query('abc',
Line 784  sub build_SQL_query { Line 939  sub build_SQL_query {
     return $sql_query;      return $sql_query;
 }  }
   
 # ------------------------------------------------- build custom metadata query  ######################################################################
   ######################################################################
   
   =pod 
   
   =item &build_custommetadata_query() 
   
   Constructs a custom metadata query using a rather heinous regular
   expression.
   
   =cut
   
   ######################################################################
   ######################################################################
 sub build_custommetadata_query {  sub build_custommetadata_query {
     my ($field_name,$logic_statement)=@_;      my ($field_name,$logic_statement)=@_;
     my $q=new Text::Query('abc',      my $q=new Text::Query('abc',
Line 793  sub build_custommetadata_query { Line 961  sub build_custommetadata_query {
     $q->prepare($logic_statement);      $q->prepare($logic_statement);
     my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};      my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
     # quick fix to change literal into xml tag-matching      # quick fix to change literal into xml tag-matching
     my $oldmatchexp=$matchexp;      # will eventually have to write a separate builder module
     $matchexp=~s/\(\?[\:\=]([^\)]*)\\\=([^\)]*)\)/\(\?\:\\\<$1\\\>\[\^\\\<\]\*$2\[\^\\\<\]\*\\\<\\\/$1\\\>)/g;      # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
     return $oldmatchexp;      $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to 
                    /\\<$1\\>?#           \<wordone\>
                      \[\^\\<\]?#        [^\<]         
                      \*$2\[\^\\<\]?#           *wordtwo[^\<]
                      \*\\<\\\/$1\\>?#                        *\<\/wordone\>
                      /g;
       return $matchexp;
 }  }
   
 # - Recursively parse a reverse notation expression into a SQL query expression  ######################################################################
   ######################################################################
   
   =pod 
   
   =item &recursive_SQL_query_build() 
   
   Recursively constructs an SQL query.  Takes as input $dkey and $pattern.
   
   =cut
   
   ######################################################################
   ######################################################################
 sub recursive_SQL_query_build {  sub recursive_SQL_query_build {
     my ($dkey,$pattern)=@_;      my ($dkey,$pattern)=@_;
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);      my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
Line 810  sub recursive_SQL_query_build { Line 996  sub recursive_SQL_query_build {
  if ($key eq 'literal') {   if ($key eq 'literal') {
     $replacement="($dkey like \"\%$value\%\")";      $replacement="($dkey like \"\%$value\%\")";
  }   }
    elsif ($key eq 'not') {
       $value=~s/like/not like/;
   #    $replacement="($dkey not like $value)";
       $replacement="$value";
    }
  elsif ($key eq 'and') {   elsif ($key eq 'and') {
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;      $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
     $replacement="($1 AND $2)";      $replacement="($1 AND $2)";
Line 827  sub recursive_SQL_query_build { Line 1018  sub recursive_SQL_query_build {
     &recursive_SQL_query_build($dkey,$pattern);      &recursive_SQL_query_build($dkey,$pattern);
 }  }
   
 # ------------------------------------------------------ Detailed Citation View  ######################################################################
 sub detailed_citation_view {  ######################################################################
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost)=@_;  
     my $result=<<END;  
 <i>$owner</i>, last revised $lastrevisiondate  
 <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>  
 <h3>$author</h3>  
 </p>  
 <p>  
 <b>Subject:</b> $subject<br>  
 <b>Keyword(s):</b> $keywords<br>  
 <b>Notes:</b> $notes<br>  
 <b>MIME Type:</b> $mimetag{$mime}<br>  
 <b>Language:</b> $language{$lang}<br>  
 <b>Copyright/Distribution:</b> $cprtag{$copyright}<br>  
 $shortabstract  
 </p>  
 END  
     return $result;  
 }  
   
 # ---------------------------------------------------------------- Summary View  =pod 
 sub summary_view {  
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost)=@_;  
     my $result=<<END;  
 <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />  
 $title<br />  
 $owner -- $lastrevisiondate<br />  
 $cprtag{$copyright}<br />  
 </p>  
 END  
     return $result;  
 }  
   
 # -------------------------------------------------------------- Fielded Format  =item &build_date_queries() 
 sub fielded_format_view {  
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost)=@_;  
     my $result=<<END;  
 <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>  
 <br />  
 <b>Title:</b> $title<br />  
 <b>Author(s):</b> $author<br />  
 <b>Subject:</b> $subject<br />  
 <b>Keyword(s):</b> $keywords<br />  
 <b>Notes:</b> $notes<br />  
 <b>MIME Type:</b> $mimetag{$mime}<br />  
 <b>Language:</b> $language{$lang}<br />  
 <b>Creation Date:</b> $creationdate<br />  
 <b>Last Revision Date:</b> $lastrevisiondate<br />  
 <b>Publisher/Owner:</b> $owner<br />  
 <b>Copyright/Distribution:</b> $cprtag{$copyright}<br />  
 <b>Repository Location:</b> $hostname<br />  
 <b>Abstract:</b> $shortabstract<br />  
 </p>  
 END  
     return $result;  
 }  
   
 # -------------------------------------------------------------------- XML/SGML  Builds a SQL logic query to check time/date entries.
 sub xml_sgml_view {  Also reports errors (check for /^Incorrect/).
     my ($title,$author,$subject,$url,$keywords,$version,  
  $notes,$shortabstract,$mime,$lang,  =cut
  $creationdate,$lastrevisiondate,$owner,$copyright,  
  $hostname,$httphost)=@_;  
     my $result=<<END;  
 <pre>  
 &lt;LonCapaResource&gt;  
 &lt;url&gt;$url&lt;/url&gt;  
 &lt;title&gt;$title&lt;/title&gt;  
 &lt;author&gt;$author&lt;/author&gt;  
 &lt;subject&gt;$subject&lt;/subject&gt;  
 &lt;keywords&gt;$keywords&lt;/keywords&gt;  
 &lt;notes&gt;$notes&lt;/notes&gt;  
 &lt;mimeInfo&gt;  
 &lt;mime&gt;$mime&lt;/mime&gt;  
 &lt;mimetag&gt;$mimetag{$mime}&lt;/mimetag&gt;  
 &lt;/mimeInfo&gt;  
 &lt;languageInfo&gt;  
 &lt;language&gt;$lang&lt;/language&gt;  
 &lt;languagetag&gt;$language{$lang}&lt;/languagetag&gt;  
 &lt;/languageInfo&gt;  
 &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;  
 &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;  
 &lt;owner&gt;$owner&lt;/owner&gt;  
 &lt;copyrightInfo&gt;  
 &lt;copyright&gt;$copyright&lt;/copyright&gt;  
 &lt;copyrighttag&gt;$cprtag{$copyright}&lt;/copyrighttag&gt;  
 &lt;/copyrightInfo&gt;  
 &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;  
 &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;  
 &lt;/LonCapaResource&gt;  
 </pre>  
 END  
     return $result;  
 }  
   
   ######################################################################
   ######################################################################
 sub build_date_queries {  sub build_date_queries {
     my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,      my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
  $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;   $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
Line 980  sub build_date_queries { Line 1080  sub build_date_queries {
     return '';      return '';
 }  }
   
 sub output_date_error {  ######################################################################
     my ($r,$message)=@_;  ######################################################################
   
   =pod 
   
   =item &output_results() 
   
   Format and output results based on a reply list.
   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
   
   ######################################################################
   ######################################################################
   sub output_results {
   #    &Apache::lonnet::logthis("output_results:".time);
       my $fnum; # search result counter
       my ($mode,$r,$replyref,$hidden)=@_;
       my %rhash=%{$replyref};
       my $compiledresult='';
       my $timeremain=300; # (seconds)
       my $elapsetime=0;
       my $resultflag=0;
       my $tflag=1;
       ##
       ## Set viewing function
       ##
       my $viewfunction = undef;
       if ($ENV{'form.viewselect'} eq 'Detailed Citation View') {
           $viewfunction = \&detailed_citation_view;
       } elsif ($ENV{'form.viewselect'} eq 'Summary View') {
           $viewfunction = \&summary_view;
       } elsif ($ENV{'form.viewselect'} eq 'Fielded Format') {
           $viewfunction = \&fielded_format_view;
       } elsif ($ENV{'form.viewselect'} eq 'XML/SGML') {
           $viewfunction = \&xml_sgml_view;
       }
       if (!defined($viewfunction)) {
           $r->print("Internal Error - Bad view selected.\n");
           $r->rflush();
           return;
       }
       #
     # make query information persistent to allow for subsequent revision      # make query information persistent to allow for subsequent revision
     my $persistent=&make_persistent();      my $persistent=&make_persistent(\%ENV);
       #
       # Begin producing output
       $r->print(&search_results_header($mode));
       $r->rflush();
       #
       # begin showing the cataloged results
       my $action = "/adm/searchcat";
       if ($mode eq 'Basic') { 
           $action .= "?reqinterface=basic";
       } elsif ($mode eq 'Advanced') {
           $action .= "?reqinterface=advanced";
       }
       $r->print(<<CATALOGCONTROLS);
   <form name='results' method="post" action="$action">
   $hidden
   <input type='hidden' name='acts' value='' />
   <input type='button' value='Revise search request'
   onClick='this.form.submit();' />
   $importbutton
   $closebutton
   $persistent
   <hr />
   CATALOGCONTROLS
       #
       # make the pop-up window for status
       $r->print(&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 %hash if (keys %hash);
           #
    if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
       $r->print('<html><head></head><body>Unable to tie hash to db '.
                         'file</body></html>');
           } else {
       if ($ENV{'form.launch'} eq '1') {
    &start_fresh_session();
       }
       foreach my $result (@results) {
    next if $result=~/^custom\=/;
    chomp $result;
    next unless $result;
                   %Fields = &parse_raw_result($result,$rkey);
    $Fields{'extrashow'}=$extrashow;
    if ($extrashow) {
       foreach my $field (@customfields) {
    my $value='';
    $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);
                           $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;
                       }
                   }
                   $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;
       $hash{"pre_${fnum}_link"}=$Fields{'url'};
       $hash{"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 %hash;
           }
    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;
   }
   
   ###########################################################
   ###########################################################
   
   =pod
   
   =item &parse_raw_result()
   
   Takes a line from the file of results and parse it.  Returns a hash 
   with keys for the following fields:
   '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 
   lonnet function: 'language', 'cprtag', 'mimetag'.
   
   The 'title' field is set to "Untitled" if the title field is blank.
   
   'abstract' and 'keywords' are truncated to 200 characters.
   
   =cut
   
   ###########################################################
   ###########################################################
   sub parse_raw_result {
       my ($result,$hostname) = @_;
       # Check for a comma - if it is there then we do not need to unescape the
       # string.  There seems to be some kind of problem with some items in
       # the database - the entire string gets sent out unescaped...?
       unless ($result =~ /,/) {
           $result = &Apache::lonnet::unescape($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'}) {
           $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;
   }
   
   ###########################################################
   ###########################################################
   
   =pod
   
   =item &handle_custom_fields()
   
   =cut
   
   ###########################################################
   ###########################################################
   sub handle_custom_fields {
       my @results = @{shift()};
       my $customshow='';
       my $extrashow='';
       my @customfields;
       if ($ENV{'form.customshow'}) {
           $customshow=$ENV{'form.customshow'};
           $customshow=~s/[^\w\s]//g;
           my @fields=map {
               "<font color=\"#008000\">$_:</font><!-- $_ -->";
           } split(/\s+/,$customshow);
           @customfields=split(/\s+/,$customshow);
           if ($customshow) {
               $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
           }
       }
       my $customdata='';
       my %customhash;
       foreach my $result (@results) {
           if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
               my $tmp=$result;
               $tmp=~s/^custom\=//;
               my ($k,$v)=map {&Apache::lonnet::unescape($_);
                           } split(/\,/,$tmp);
               $customhash{$k}=$v;
           }
       }
       return ($extrashow,\@customfields,\%customhash);
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &search_results_header
   
   Output the proper html headers and javascript code to deal with different 
   calling modes.
   
   Takes most inputs directly from %ENV, except $mode.  
   
   =over 4
   
   =item $mode is either (at this writing) 'Basic' or 'Advanced'
   
   =back
   
   The following environment variables are checked:
   
   =over 4
   
   =item 'form.catalogmode' 
   
   Checked for 'interactive' and 'groupsearch'.
   
   =item 'form.mode'
   
   Checked for existance & 'edit' mode.
   
   =item 'form.form'
   
   =item 'form.element'
   
   =back
   
   =cut
   
   ######################################################################
   ######################################################################
   sub search_results_header {
       my ($mode) = @_;
       $mode = lc($mode);
       my $title;
       if ($mode eq 'advanced') {
           $title = "Advanced Search Results";
       } elsif ($mode eq 'basic') {
           $title = "Basic Search Results";
       }
       my $result = '';
       # output beginning of search page
       $result.=<<BEGINNING;
   <html>
   <head>
   <title>$title</title>
   BEGINNING
       # conditional output of script functions dependent on the mode in
       # which the search was invoked
       if ($ENV{'form.catalogmode'} eq 'interactive'){
    if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') {
               $result.=<<SCRIPT;
   <script type="text/javascript">
       function select_data(title,url) {
    changeTitle(title);
    changeURL(url);
    self.close();
       }
       function changeTitle(val) {
    if (opener.inf.document.forms.resinfo.elements.t) {
       opener.inf.document.forms.resinfo.elements.t.value=val;
    }
       }
       function changeURL(val) {
    if (opener.inf.document.forms.resinfo.elements.u) {
       opener.inf.document.forms.resinfo.elements.u.value=val;
    }
       }
   </script>
   SCRIPT
           } elsif ($ENV{'form.mode'} eq 'edit') {
               my $form = $ENV{'form.form'};
               my $element = $ENV{'form.element'};
               $result.=<<SCRIPT;
   <script type="text/javascript">
   function select_data(title,url) {
       changeURL(url);
       self.close();
   }
   function changeTitle(val) {
   }
   function changeURL(val) {
       if (window.opener.document) {
           window.opener.document.forms["$form"].elements["$element"].value=val;
       } else {
    var url = 'forms[\"$form\"].elements[\"$element\"].value';
           alert("Unable to transfer data to "+url);
       }
   }
   </script>
   SCRIPT
           }
       }
       $result.=<<SCRIPT if $ENV{'form.catalogmode'} eq 'groupsearch';
   <script type="text/javascript">
       function select_data(title,url) {
   // alert('DEBUG: Should be storing '+title+' and '+url);
       }
       function queue(val) {
    if (eval("document.forms.results.returnvalues["+val+"].checked")) {
       document.forms.results.acts.value+='1a'+val+'b';
    }
    else {
       document.forms.results.acts.value+='0a'+val+'b';
    }
       }
       function select_group() {
    window.location=
       "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+
       document.forms.results.acts.value;
       }
   </script>
   SCRIPT
       $result.=<<SCRIPT;
   <script type="text/javascript">
       function displayinfo(val) {
    popwin.document.forms.popremain.sdetails.value=val;
       }
       function openhelp(val) {
    openhelpwin=open('/adm/help/searchcat.html','helpscreen',
        'scrollbars=1,width=400,height=300');
    openhelpwin.focus();
       }
       function abortsearch(val) {
    popwin.close();
       }
   </script>
   SCRIPT
       $result.=<<END;
   </head>
   <body bgcolor="#ffffff">
   <img align=right src=/adm/lonIcons/lonlogos.gif>
   <h1>$title</h1>
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod
   
   =item &make_popwin()
   
   Returns html with javascript in it to open up the status window.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub make_popwin {
       my %rhash = @_;
       my $servernum=(keys %rhash);
       my $hcinit;
       my $grid="'<br />'+\n";
       # $sn is the server number, used ONLY to make sure we have
       # rows of 10 each.  No longer used to index images.
       my $sn=1;
       foreach my $sk (sort keys %rhash) {
    $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;
   <script type="text/javascript">
       popwin=open('','popwin','scrollbars=1,width=400,height=220');
       popwin.focus();
       popwin.document.writeln('<'+'html>');
       popwin.document.writeln('<'+'head>');
       popwin.document.writeln('<'+'script>');
       popwin.document.writeln('hc=new Array();$hcinit');
       popwin.document.writeln('<'+'/script>');
       popwin.document.writeln('<'+'/head>'+
           '<'+'body bgcolor="#FFFFFF">'+
    '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+
    'lonanim.gif" '+
    'alt="animated logo" />'+
    '<'+'h3>Search Results Progress<'+'/h3>'+
           '<'+'form name="popremain">'+
           '<'+'tt>'+
    '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+
    '<'+'br />SCANNING $servernum SERVERS'+
    '<'+'br clear="all" />Number of record hits found '+
    '<'+'input type="text" size="10" name="numhits"'+
    ' value="0" />'+
    '<'+'br clear="all" />Time elapsed '+
    '<'+'input type="text" size="10" name="elapsetime"'+
    ' value="0" />'+
    '<'+'br />'+
    'SERVER GRID (click on any cell for details)'+
           $grid
           '<'+'br />'+
    'Server details '+
    '<'+'input type="text" size="35" name="sdetails"'+
    ' value="" />'+
    '<'+'br />'+
    ' <'+'input type="button" name="button"'+
    ' value="close this window" '+
    ' onClick="javascript:opener.abortsearch()" />'+
    ' <'+'input type="button" name="button"'+
    ' value="help" onClick="javascript:opener.openhelp()" />'+
    '<'+'/tt>'+
           '<'+'/form>'+
           '<'+'/body><'+'/html>');
       popwin.document.close();
   </script>
   ENDPOP
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item Metadata Viewing Functions
   
   Output is a HTML-ified string.
   Input arguments are title, author, subject, url, keywords, version,
   notes, short abstract, mime, language, creation date,
   last revision date, owner, copyright, hostname, and
   extra custom metadata to show.
   
   =over 4
   
   =item &detailed_citation_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub detailed_citation_view {
       my %values = @_;
       my $result=<<END;
   <h3><a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
       target='search_preview'>$values{'title'}</a></h3>
   <p>
   <b>$values{'author'}</b>, <i>$values{'owner'}</i><br />
   
   <b>Subject:       </b> $values{'subject'}<br />
   <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>Copyright/Distribution:</b> $values{'cprtag'}<br />
   </p>
   $values{'extrashow'}
   <p>
   $values{'shortabstract'}
   </p>
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &summary_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub summary_view {
       my %values = @_;
       my $result=<<END;
   <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
      target='search_preview'>$values{'author'}</a><br />
   $values{'title'}<br />
   $values{'owner'} -- $values{'lastrevisiondate'}<br />
   $values{'copyrighttag'}<br />
   $values{'extrashow'}
   </p>
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &fielded_format_view() 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub fielded_format_view {
       my %values = @_;
       my $result=<<END;
   <b>URL: </b> <a href="http://$ENV{'HTTP_HOST'}$values{'url'}" 
                 target='search_preview'>$values{'url'}</a>
   <br />
   <b>Title:</b> $values{'title'}<br />
   <b>Author(s):</b> $values{'author'}<br />
   <b>Subject:</b> $values{'subject'}<br />
   <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
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &xml_sgml_view() 
   
   =back 
   
   =cut
   
   ######################################################################
   ######################################################################
   sub xml_sgml_view {
       my %values = @_;
       my $result=<<END;
   <pre>
   &lt;LonCapaResource&gt;
   &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>
   $values{'extrashow'}
   END
       return $result;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &filled() see if field is filled.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub filled {
       my ($field)=@_;
       if ($field=~/\S/ && $field ne 'any') {
    return 1;
       }
       else {
    return 0;
       }
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &output_blank_field_error()
   
   =cut
   
   ######################################################################
   ######################################################################
   sub output_blank_field_error {
       my ($r)=@_;
       # make query information persistent to allow for subsequent revision
       my $persistent=&make_persistent(\%ENV);
   
     $r->print(<<BEGINNING);      $r->print(<<BEGINNING);
 <html>  <html>
Line 993  BEGINNING Line 1868  BEGINNING
     $r->print(<<RESULTS);      $r->print(<<RESULTS);
 </head>  </head>
 <body bgcolor="#ffffff">  <body bgcolor="#ffffff">
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <img align='right' src='/adm/lonIcons/lonlogos.gif' />
   <h1>Search Catalog</h1>
   <form method="post" action="/adm/searchcat">
   $persistent
   <input type='button' value='Revise search request'
   onClick='this.form.submit();' />
   $closebutton
   <hr />
   <h3>Helpful Message</h3>
   <p>
   Incorrect search query due to blank entry fields.
   You need to fill in the relevant
   fields on the search page in order for a query to be
   processed.
   </p>
   </body>
   </html>
   RESULTS
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &output_date_error()
   
   Output a full html page with an error message.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub output_date_error {
       my ($r,$message)=@_;
       # make query information persistent to allow for subsequent revision
       my $persistent=&make_persistent(\%ENV);
   
       $r->print(<<RESULTS);
   <html>
   <head>
   <title>The LearningOnline Network with CAPA</title>
   </head>
   <body bgcolor="#ffffff">
   <img align='right' src='/adm/lonIcons/lonlogos.gif' />
 <h1>Search Catalog</h1>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 $persistent  $persistent
 <input type='button' value='Revise search request'  <input type='button' value='Revise search request'
 onClick='this.form.submit();'>  onClick='this.form.submit();' />
 $closebutton  $closebutton
 <hr>  <hr />
 <h3>Helpful Message</h3>  <h3>Helpful Message</h3>
 <p>  <p>
 $message  $message
Line 1010  $message Line 1929  $message
 RESULTS  RESULTS
 }  }
   
 sub make_persistent {  ######################################################################
     my $persistent='';  ######################################################################
       
     map {  =pod 
  if (/^form\./ && !/submit/) {  
     my $name=$_;  =item &start_fresh_session()
     my $key=$name;  
     $ENV{$key}=~s/\'//g; # do not mess with html field syntax  Cleans the global %hash by removing all fields which begin with
     $name=~s/^form\.//;  'pre_' or 'store'.
     $persistent.=<<END;  
 <input type='hidden' name='$name' value='$ENV{$key}' />  =cut
 END  
   ######################################################################
   ######################################################################
   sub start_fresh_session {
       delete $hash{'mode_catalog'};
       foreach (keys %hash) {
           if ($_ =~ /^pre_/) {
               delete $hash{$_};
         }          }
     } (keys %ENV);          if ($_ =~ /^store/) {
     return $persistent;      delete $hash{$_};
    }
       }
 }  }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &popwin_js() send javascript to popwin
   
   =cut
   
   ######################################################################
   ######################################################################
   sub popwin_js {
       # Print javascript out to popwin, but make sure we dont generate
       # any javascript errors in doing so.
       my ($r,$text) = @_;
       $r->print(<<"END");
   <script type="text/javascript">
       if (! popwin.closed) {
    $text
       }
   </script>
   END
       $r->rflush();
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &popwin_imgupdate()
   
   Send a given image (and its location) out to the browser.  Takes as 
   input $r, loncapa server id, and an icon URL.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub popwin_imgupdate {
       my ($r,$server,$icon) = @_;
       &popwin_js($r,'popwin.document.img_'.$Apache::lonnet::hostdom{$server}.
                  '_'.$server.'.'.'src="/adm/lonIcons/'.$icon.'";');
   }    
   
 1;  1;
   
 __END__  __END__
   
   =pod
   
   =back 
   
   =cut
Removed from v.1.74  
changed lines
  Added in v.1.136

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