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

version 1.45, 2001/03/21 00:32:33 version 1.130, 2002/06/26 16:04:13
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();
   
   # ---------------------------------------- variables used throughout the module
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item Global variables
   
   =over 4
   
   =item $closebutton
   
   button that closes the search window
   
   =item $importbutton
   
   button to take the selecte results and go to group sorting
   
   =item %hash   
   
   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
   
   ######################################################################
   ######################################################################
   
 my %language;  =pod 
 my $scrout;  
 my %metadatafields;  
 my %cprtag;  
 my %mimetag;  
   
   =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'},
 END               ['catalogmode','launch','acts','mode','form','element',
                 'reqinterface']);
 # ------------------------------------------------ First, check out environment      ##
     $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};      ## Clear out old values from database
       ##
 # --------------------------------- Compute various listings of metadata values      if ($ENV{'form.launch'} eq '1') {
        if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
     %language=();      &start_fresh_session();
     $language{'any'}='Any language';      untie %hash;
     {   } else {
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');      $r->print('<html><head></head><body>Unable to tie hash to db '.
  map {        'file</body></html>');
     $_=~/(\w+)\s+([\w\s\-]+)/;      return OK;
     $language{$1}=$2;   }
  } <$fh>;  
     }  
   
     %cprtag=();  
     $cprtag{'any'}='Any copyright/distribution';  
     {  
  my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');  
  map {  
     $_=~/(\w+)\s+([\w\s\-]+)/;  
     $cprtag{$1}=$2;  
  } <$fh>;  
     }  
   
     %mimetag=();  
     $mimetag{'any'}='Any type';  
     {  
  my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');  
  map {  
     $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/;  
     $mimetag{$1}=".$1 $3";  
  } <$fh>;  
     }      }
       ##
     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {      ## Produce some output, so people know it is working
  return &basicsearch($r,\%ENV);      ##
       $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
           $closebutton=<<END;
   <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
     }      }
     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {      $hidden .= <<END;
  return &advancedsearch($r,\%ENV);  <input type='hidden' name='mode'    value='$ENV{'form.mode'}'>
   <input type='hidden' name='form'    value='$ENV{'form.form'}'>
   <input type='hidden' name='element' value='$ENV{'form.element'}'>
   <input type='hidden' name='date' value='2'>
   END
       ##
       ##  What are we doing?
       ##
       if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
           # Perform basic search and give results
    return &basicsearch($r,$hidden);
       } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
           # Perform advanced search and give results
    return &advancedsearch($r,$hidden);
       } elsif ($ENV{'form.reqinterface'} eq 'advanced') {
           # Output the advanced interface
           $r->print(&advanced_search_form($closebutton,$hidden));
           return OK;
       } else { 
           # Output normal search interface
           $r->print(&basic_search_form($closebutton,$hidden));
     }      }
       return OK;
   } 
   
     $scrout=''; # building a part of screen output  ######################################################################
     $scrout.=&searchphrasefield('Limit by title','title',  ######################################################################
  $ENV{'form.title'});  
   
     $scrout.=&searchphrasefield('Limit by author','author',  =pod 
  $ENV{'form.author'});  
   
     $scrout.=&searchphrasefield('Limit by subject','subject',  =item &basic_search_form() 
  $ENV{'form.subject'});  
   
     $scrout.=&searchphrasefield('Limit by keywords','keywords',  Returns a scalar which holds html for the basic search form.
  $ENV{'form.keywords'});  
   
     $scrout.=&searchphrasefield('Limit by URL','url',  =cut
  $ENV{'form.url'});  
   
     $scrout.=&searchphrasefield('Limit by version','version',  ######################################################################
  $ENV{'form.version'});  ######################################################################
   
     $scrout.=&searchphrasefield('Limit by notes','notes',  sub basic_search_form{
  $ENV{'form.notes'});      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 quoted 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 abstract','abstract',  =pod 
  $ENV{'form.abstract'});  
   
     $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});  =item &advanced_search_form() 
     $scrout.=&selectbox('Limit by MIME type','mime',  
  $ENV{'form.mime'},%mimetag);  
   
     $ENV{'form.language'}='any' unless length($ENV{'form.language'});  Returns a scalar which holds html for the advanced search form.
   
     $scrout.=&selectbox('Limit by language','language',  =cut
  $ENV{'form.language'},%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 quoted 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('Limit by version','version',
   # $ENV{'form.version'});
       $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.mime'}='any' unless length($ENV{'form.mime'});
   #    $scrout.=&selectbox('Limit by MIME type','mime',
   # $ENV{'form.mime'},
   # 'any','Any type',
   # \&{Apache::loncommon::filedescriptionex},
   # (&Apache::loncommon::fileextensions));
       $ENV{'form.language'}='any' unless length($ENV{'form.language'});
       $scrout.=&selectbox('Limit by 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 166  CREATIONDATESTART Line 413  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 196  LASTREVISIONDATEEND Line 440  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">  
 <input type="button" name="close" value="CLOSE" onClick="self.close()">  
 </p>  
 <hr>  
 <h3>Advanced Search</h3>  
 $scrout  
 <p>  
 <input type="submit" name="advancedsubmit" value="SEARCH">  
 <input type="reset" name="reset" value="RESET">  
 <input type="button" name="close" value="CLOSE" onClick="self.close()">  
 </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 $persistent='';
       foreach (keys %ENV) {
    if (/^form\./ && !/submit/) {
       my $name=$_;
       my $key=$name;
       $ENV{$key}=~s/\'//g; # do not mess with html field syntax
       $name=~s/^form\.//;
       $persistent.=<<END;
   <input type="hidden" name="$name" value="$ENV{$key}" />
   END
           }
       }
       return $persistent;
   }
   
 # --------------------------------------------------------- Various form fields  
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item HTML form building functions
   
   =over 4
   
   =item &simpletextfield() 
   
   Inputs: $name,$value,$size
   
   Returns a text input field with the given name, value, and size.  
   If size is not specified, a value of 20 is used.
   
   =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 value="'.$value.'">';      $size = 20 if (! defined($size));
       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><br /><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 &advancedsearch()
   
   Parse advanced search results.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub advancedsearch {
       my ($r,$hidden)=@_;
     my $fillflag=0;      my $fillflag=0;
       # Clean up fields for safety
       for my $field ('title','author','subject','keywords','url','version',
      'creationdatestart_month','creationdatestart_day',
      'creationdatestart_year','creationdateend_month',
      'creationdateend_day','creationdateend_year',
      'lastrevisiondatestart_month','lastrevisiondatestart_day',
      'lastrevisiondatestart_year','lastrevisiondateend_month',
      'lastrevisiondateend_day','lastrevisiondateend_year',
      'notes','abstract','mime','language','owner',
      'custommetadata','customshow') {
    $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 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 461  sub advancedsearch { Line 723  sub advancedsearch {
     $fillflag++;      $fillflag++;
  }   }
     }      }
   
     unless ($fillflag) {      unless ($fillflag) {
  &output_blank_field_error($r);   &output_blank_field_error($r);
  return OK;   return OK;
     }      }
       # 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') {      foreach my $field ('title','author','subject','notes','abstract','url',
          '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 (@queries) {      # Evaluate option lists
  $query="(" . (join(") and ("),@queries) . ")";      if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  $query="select * from metadata where $testquery";   push @queries,"(language like \"$ENV{'form.language'}\")";
  my $reply=&Apache::lonnet::metadata_query($query);  
  &output_results('Advanced',$r,$envhash,$query,$reply);  
     }      }
     else {  #    if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
  &output_results('Advanced',$r,$envhash,$query);  # push @queries,"(mime like \"$ENV{'form.mime'}\")";
   #    }
       if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
    push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
     }      }
     return OK;      # Evaluate date windows
 }      my $datequery=&build_date_queries(
    $ENV{'form.creationdatestart_month'},
 # ---------------------------------------------------- see if a field is filled   $ENV{'form.creationdatestart_day'},
 sub filled {   $ENV{'form.creationdatestart_year'},
     my ($field)=@_;   $ENV{'form.creationdateend_month'},
     if ($field=~/\S/) {   $ENV{'form.creationdateend_day'},
  return 1;   $ENV{'form.creationdateend_year'},
    $ENV{'form.lastrevisiondatestart_month'},
    $ENV{'form.lastrevisiondatestart_day'},
    $ENV{'form.lastrevisiondatestart_year'},
    $ENV{'form.lastrevisiondateend_month'},
    $ENV{'form.lastrevisiondateend_day'},
    $ENV{'form.lastrevisiondateend_year'},
    );
       # Test to see if date windows are legitimate
       if ($datequery=~/^Incorrect/) {
    &output_date_error($r,$datequery);
    return OK;
     }      }
     else {      elsif ($datequery) {
  return 0;   push @queries,$datequery;
       }
       # Process form information for custom metadata querying
       my $customquery='';
       if ($ENV{'form.custommetadata'}) {
    $customquery=&build_custommetadata_query('custommetadata',
         $ENV{'form.custommetadata'});
       }
       my $customshow='';
       if ($ENV{'form.customshow'}) {
    $customshow=$ENV{'form.customshow'};
    $customshow=~s/[^\w\s]//g;
    my @fields=split(/\s+/,$customshow);
    $customshow=join(" ",@fields);
       }
       # 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).
       if (@queries) {
    $query=join(" AND ",@queries);
    $query="select * from metadata where $query";
    my $reply; # reply hash reference
    unless ($customquery or $customshow) {
       $reply=&Apache::lonnet::metadata_query($query);
    }
    else {
       $reply=&Apache::lonnet::metadata_query($query,
      $customquery,$customshow);
    }
    &output_results('Advanced',$r,$customquery,$reply,$hidden);
           return OK;
       } elsif ($customquery) {
    my $reply; # reply hash reference
    $reply=&Apache::lonnet::metadata_query('',
          $customquery,$customshow);
    &output_results('Advanced',$r,$customquery,$reply,$hidden);
           return OK;
     }      }
       # should not get to this point
       return 'Error.  Should not have gone to this point.';
 }  }
   
 # --------------------------------------------------- Performing a basic search  ######################################################################
   ######################################################################
   
   =pod 
   
   =item &basicsearch() 
   
   Parse basic search form.
   
   =cut
   
   ######################################################################
   ######################################################################
 sub basicsearch {  sub basicsearch {
     my ($r,$envhash)=@_;      my ($r,$hidden)=@_;
     my %ENV=%{$envhash};      # Clean up fields for safety
       for my $field ('basicexp') {
    $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=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
   
       # Get reply (either a hash reference to filehandles or bad connection)
   #    &Apache::lonnet::logthis("metadata query started:".time);
       my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);
   #    &Apache::lonnet::logthis("metadata query finished:".time);
       # Output search results
   
       &output_results('Basic',$r,$query,$reply,$hidden);
   
     $query="select * from metadata where concat($concatarg) like '\%$ENV{'form.basicexp'}\%'";  
     my $reply=&Apache::lonnet::metadata_query($query);  
     &output_results('Basic',$r,$envhash,$query,$reply);  
     return OK;      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='';  
     map {  
  if (/^form\./ && !/submit/) {  
     my $name=$_;  
     my $key=$name;  
     $name=~s/^form\.//;  
     $persistent.=<<END;  
 <INPUT TYPE='hidden' NAME='$name' VALUE='$ENV{$key}'>  
 END  
         }  
     } (keys %ENV);  
   
     $r->print(<<BEGINNING);  ######################################################################
 <html>  ######################################################################
 <head>  
 <title>The LearningOnline Network with CAPA</title>  =pod 
 BEGINNING  
     $r->print(<<RESULTS);  =item &build_SQL_query() 
 </head>  
 <body bgcolor="#ffffff">  Builds a SQL query string from a logical expression with AND/OR keywords
 <img align=right src=/adm/lonIcons/lonlogos.gif>  using Text::Query and &recursive_SQL_query_builder()
 <h1>Search Catalog</h1>  
 <form method="post" action="/adm/searchcat">  =cut
 $persistent  
 <input type='button' value='Revise search request'  ######################################################################
 onClick='this.form.submit();'>  ######################################################################
 <input type='button' value='CLOSE'  sub build_SQL_query {
 onClick='self.close();'>      my ($field_name,$logic_statement)=@_;
 <hr>      my $q=new Text::Query('abc',
 <h3>Helpful Message</h3>    -parse => 'Text::Query::ParseAdvanced',
 <p>    -build => 'Text::Query::Build');
 Incorrect search query due to blank entry fields.      $q->prepare($logic_statement);
 You need to fill in the relevant      my $matchexp=${$q}{'matchexp'}; chomp $matchexp;
 fields on the search page in order for a query to be      my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);
 processed.      return $sql_query;
 </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) {  =pod 
   
  my @results;  =item &build_custommetadata_query() 
   
  my $replyfile='';  Constructs a custom metadata query using a rather heinous regular
  $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting  expression.
  $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;  
  $reply=~/(.*?)\_/;  =cut
  my $hostname=$1;  
   ######################################################################
  {  ######################################################################
     while (1) {  sub build_custommetadata_query {
  last if -e $replyfile;      my ($field_name,$logic_statement)=@_;
  sleep 1;      my $q=new Text::Query('abc',
     -parse => 'Text::Query::ParseAdvanced',
     -build => 'Text::Query::BuildAdvancedString');
       $q->prepare($logic_statement);
       my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
       # quick fix to change literal into xml tag-matching
       # will eventually have to write a separate builder module
       # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
       $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to 
                    /\\<$1\\>?#           \<wordone\>
                      \[\^\\<\]?#        [^\<]         
                      \*$2\[\^\\<\]?#           *wordtwo[^\<]
                      \*\\<\\\/$1\\>?#                        *\<\/wordone\>
                      /g;
       return $matchexp;
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &recursive_SQL_query_build() 
   
   Recursively constructs an SQL query.  Takes as input $dkey and $pattern.
   
   =cut
   
   ######################################################################
   ######################################################################
   sub recursive_SQL_query_build {
       my ($dkey,$pattern)=@_;
       my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
       return $pattern unless @matches;
       foreach my $match (@matches) {
    $match=~/\[ (\w+)\s(.*) \]/;
    my ($key,$value)=($1,$2);
    my $replacement='';
    if ($key eq 'literal') {
       $replacement="($dkey like \"\%$value\%\")";
    }
    elsif ($key eq 'not') {
       $value=~s/like/not like/;
   #    $replacement="($dkey not like $value)";
       $replacement="$value";
    }
    elsif ($key eq 'and') {
       $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
       $replacement="($1 AND $2)";
    }
    elsif ($key eq 'or') {
       $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
       $replacement="($1 OR $2)";
    }
    substr($pattern,
          index($pattern,$match),
          length($match),
          $replacement
          );
       }
       &recursive_SQL_query_build($dkey,$pattern);
   }
   
   ######################################################################
   ######################################################################
   
   =pod 
   
   =item &build_date_queries() 
   
   Builds a SQL logic query to check time/date entries.
   Also reports errors (check for /^Incorrect/).
   
   =cut
   
   ######################################################################
   ######################################################################
   sub build_date_queries {
       my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
    $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
       my @queries;
       if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {
    unless ($cmonth1 and $cday1 and $cyear1 and
    $cmonth2 and $cday2 and $cyear2) {
       return "Incorrect entry for the creation date.  You must specify ".
      "a starting month, day, and year and an ending month, ".
      "day, and year.";
    }
    my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);
    $cnumeric1+=0;
    my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);
    $cnumeric2+=0;
    if ($cnumeric1>$cnumeric2) {
       return "Incorrect entry for the creation date.  The starting ".
      "date must occur before the ending date.";
    }
    my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".
              "$cyear2-$cmonth2-$cday2 23:59:59')";
    push @queries,$cquery;
       }
       if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {
    unless ($lmonth1 and $lday1 and $lyear1 and
    $lmonth2 and $lday2 and $lyear2) {
       return "Incorrect entry for the last revision date.  You must ".
      "specify a starting month, day, and year and an ending ".
      "month, day, and year.";
    }
    my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);
    $lnumeric1+=0;
    my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);
    $lnumeric2+=0;
    if ($lnumeric1>$lnumeric2) {
       return "Incorrect entry for the last revision date.  The ".
      "starting date must occur before the ending date.";
    }
    my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".
              "$lyear2-$lmonth2-$lday2 23:59:59')";
    push @queries,$lquery;
       }
       if (@queries) {
    return join(" AND ",@queries);
       }
       return '';
   }
   
   ######################################################################
   ######################################################################
   
   =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,$query,$replyref,$hidden)=@_;
       my %rhash=%{$replyref};
       my $compiledresult='';
       my $timeremain=300; # (seconds)
       my $elapsetime=0;
       my $resultflag=0;
       my $tflag=1;
       my $viewselect=$ENV{'form.viewselect'};
       #
       # make query information persistent to allow for subsequent revision
       my $persistent=&make_persistent();
       # spit out the results header
       $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;");
     }      }
     # QUESTION: how should I handle this error condition..      &popwin_js($r,'popwin.document.whirly.'.
     # I'm sure there is syntax elsewhere I can use..         'src="/adm/lonIcons/lonanimend.gif";');
     my $fh=Apache::File->new($replyfile) or   } # end of if ($reply eq 'con_lost') else statement
  ($r->print('file cannot be opened') and return OK);          my %Fields = undef;     # Holds the data to be sent to the various 
     @results=<$fh>;                                  # *_view routines.
  }          my ($extrashow,$customfields,$customhash) = &handle_custom_fields(\@results);
           my @customfields = @$customfields;
  foreach my $result (@results) {          my %customhash   = %$customhash;
     my ($title,$author,$subject,$url,$keywords,$version,   untie %hash if (keys %hash);
  $notes,$abstract,$mime,$lang,          #
  $creationdate,$lastrevisiondate,$owner,$copyright   if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
  )=map {&Apache::lonnet::unescape($_)} (split(/\,/,$result));      $r->print('<html><head></head><body>Unable to tie hash to db '.
     my $shortabstract=$abstract;                        'file</body></html>');
     $shortabstract=substr($abstract,0,200) if length($abstract)>200;          } else {
     $compiledresult.=<<END;      if ($ENV{'form.launch'} eq '1') {
 <p>   &start_fresh_session();
 END      }
             $compiledresult.=<<END if $ENV{'form.catalogmode'} eq 'interactive';      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"  <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
 onClick="javascript:select_data('$title','$url')">  onClick="javascript:select_data('$titleesc','$Fields{'url'}')">
 </font>  </font>
 <br>  <br />
 END  END
             $compiledresult.=<<END;                  }
 <b>URL: </b> <A HREF="http://$ENV{'HTTP_HOST'}$url" TARGET='search_preview'>$url</A>                  if ($ENV{'form.catalogmode'} eq 'groupsearch') {
 <br>      $fnum+=0;
 <b>Title:</b> $title<br>      $hash{"pre_${fnum}_link"}=$Fields{'url'};
 <b>Author(s):</b> $author<br>      $hash{"pre_${fnum}_title"}=$Fields{'title'};
 <b>Subject:</b> $subject<br>      $compiledresult.=<<END;
 <b>Keyword(s):</b> $keywords<br>  <font size='-1'>
 <b>Notes:</b> $notes<br>  <input type="checkbox" name="returnvalues" value="SELECT"
 <b>Abstract:</b> $shortabstract<br>  onClick="javascript:queue($fnum)" />
 <b>MIME Type:</b> $mimetag{$mime}<br>  </font>
 <b>Language:</b> $language{$lang}<br>  <br />
 <b>Creation Date:</b> $creationdate<br>  
 <b>Last Revision Date:</b> $lastrevisiondate<br>  
 <b>Publisher/Owner:</b> $owner<br>  
 <b>Copyright/Distribution:</b> $copyright<br>  
 <b>Repository Location:</b> $hostname  
 </p>  
 END  END
   # <input type="hidden" name="title$fnum" value="$title" />
   # <input type="hidden" name="url$fnum" value="$url" />
                       $fnum++;
    }
           if ($viewselect eq 'Detailed Citation View') {
       $compiledresult.=&detailed_citation_view
                           (%Fields, hostname => $rkey );
    }
                   elsif ($viewselect eq 'Summary View') {
       $compiledresult.=&summary_view
                           (%Fields, hostname => $rkey );
           }
                   elsif ($viewselect eq 'Fielded Format') {
       $compiledresult.=&fielded_format_view
                           (%Fields, hostname => $rkey );
           }
                   elsif ($viewselect eq 'XML/SGML') {
       $compiledresult.=&xml_sgml_view
                           (%Fields, hostname => $rkey );
    }
                   if ($compiledresult or $servercount!=$servernum) {
                       $compiledresult.="<hr align='left' width='200' noshade />";
                   }
               }
               untie %hash;
         }          }
    if ($compiledresult) {
  unless ($compiledresult) {      $resultflag=1;
     $compiledresult="There were no results that matched your query";              $r->print($compiledresult);
  }   }
           my $percent=sprintf('%3.0f',($servercount/$servernum*100));
         } # End of foreach loop over servers remaining
       }   # End of big loop - while($serversleft && $timeremain)
       unless ($resultflag) {
           $r->print("\nThere were no results that matched your query\n");
       }
   #    $r->print('<script type="text/javascript">'.'popwin.close()</script>'."\n"); $r->rflush(); 
       $r->print("</body>\n</html>\n");
       return;
   }
   
  # make query information persistent to allow for subsequent revision  ###########################################################
  my $persistent='';  ###########################################################
  map {  
     if (/^form\./ && !/submit/) {  =pod
  my $name=$_;  
  my $key=$name;  =item &parse_raw_result()
  $name=~s/^form\.//;  
  $persistent.=<<END;  Takes a line from the file of results and parse it.  Returns a hash 
 <INPUT TYPE='hidden' NAME='$name' VALUE='$ENV{$key}'>  with keys for the following fields:
 END  'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes', 
             }  'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate', 
  } (keys %ENV);  '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'});
       # 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.
   
  $r->print(<<BEGINNING);  =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>  <html>
 <head>  <head>
 <title>The LearningOnline Network with CAPA</title>  <title>$title</title>
 BEGINNING  BEGINNING
         $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'interactive';      # conditional output of script functions dependent on the mode in
 <script>      # 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) {      function select_data(title,url) {
  changeTitle(title);   changeTitle(title);
  changeURL(url);   changeURL(url);
    self.close();
     }      }
     function changeTitle(val) {      function changeTitle(val) {
  if (opener.inf.document.forms.resinfo.elements.t) {   if (opener.inf.document.forms.resinfo.elements.t) {
Line 668  BEGINNING Line 1450  BEGINNING
     }      }
 </script>  </script>
 SCRIPT  SCRIPT
         $r->print(<<RESULTS);          } 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>  </head>
 <body bgcolor="#ffffff">  <body bgcolor="#ffffff">
 <img align=right src=/adm/lonIcons/lonlogos.gif>  <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) {
    # '<a href="
    $grid.="'<a href=\"";
    # javascript:displayinfo('+
    $grid.="javascript:opener.displayinfo('+";
    # "'"+'key
    $grid.="\"'\"+'";
    $grid.=$sk;
    my $hc;
    if ($rhash{$sk} eq 'con_lost') {
       $hc="BAD CONNECTION, CONTACT SYSTEM ADMINISTRATOR ";
    }
    else {
       $hc="'+\"'\"+\"+hc['$sk']+\"+\"'\"+'";
       $hcinit.="hc[\"$sk\"]=\"not yet connected...\";";
    }
    $grid.=" hitcount=".$hc;
    $grid.=" domain=".$Apache::lonnet::hostdom{$sk};
    $grid.=" IP=".$Apache::lonnet::hostip{$sk};
    # '+"'"+'">'+
    $grid.="'+\"'\"+')\">'+";
    $grid.="\n";
    $grid.="'<img border=\"0\" name=\"img_".$Apache::lonnet::hostdom{$sk}.
               '_'.$sk."\" src=\"/adm/lonIcons/srvnull.gif\" alt=\"".$sk.
                   "\" /></a>'+\n";
    $grid.="'<br />'+\n" unless $sn%10;
           $sn++;
       }
       my $result.=<<ENDPOP;
   <script type="text/javascript">
       popwin=open('','popwin','scrollbars=1,width=400,height=220');
       popwin.focus();
       popwin.document.writeln('<'+'html>');
       popwin.document.writeln('<'+'head>');
       popwin.document.writeln('<'+'script>');
       popwin.document.writeln('hc=new Array();$hcinit');
       popwin.document.writeln('<'+'/script>');
       popwin.document.writeln('<'+'/head>'+
           '<'+'body bgcolor="#FFFFFF">'+
    '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+
    'lonanim.gif" '+
    'alt="animated logo" />'+
    '<'+'h3>Search Results Progress<'+'/h3>'+
           '<'+'form name="popremain">'+
           '<'+'tt>'+
    '<'+'br clear="all"/><i>PLEASE BE PATIENT</i>'+
    '<'+'br />SCANNING $servernum SERVERS'+
    '<'+'br clear="all" />Number of record hits found '+
    '<'+'input type="text" size="10" name="numhits"'+
    ' value="0" />'+
    '<'+'br clear="all" />Time elapsed '+
    '<'+'input type="text" size="10" name="elapsetime"'+
    ' value="0" />'+
    '<'+'br />'+
    'SERVER GRID (click on any cell for details)'+
           $grid
           '<'+'br />'+
    'Server details '+
    '<'+'input type="text" size="35" name="sdetails"'+
    ' value="" />'+
    '<'+'br />'+
    ' <'+'input type="button" name="button"'+
    ' value="close this window" '+
    ' onClick="javascript:opener.abortsearch()" />'+
    ' <'+'input type="button" name="button"'+
    ' value="help" onClick="javascript:opener.openhelp()" />'+
    '<'+'/tt>'+
           '<'+'/form>'+
           '<'+'/body><'+'/html>');
       popwin.document.close();
   </script>
   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();
   
       $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>  <h1>Search Catalog</h1>
 <form method="post" action="/adm/searchcat">  <form method="post" action="/adm/searchcat">
 <input type='button' value='Revise search request'  
 onClick='this.form.submit();'>  
 <input type='button' value='CLOSE'  
 onClick='self.close();'>  
 $persistent  $persistent
 <hr>  <input type='button' value='Revise search request'
 <h3>Search Query</h3>  onClick='this.form.submit();' />
 RESULTS  $closebutton
     if ($mode eq 'Basic') {  <hr />
  $r->print(<<RESULTS);  <h3>Helpful Message</h3>
 <p>  <p>
 <b>Basic search:</b> $ENV{'form.basicexp'}  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>  </p>
   </body>
   </html>
 RESULTS  RESULTS
     }  }
     elsif ($mode eq 'Advanced') {  
  $r->print(<<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();
   
       $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>
   <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>  <p>
 <b>Advanced search</b>  $message
 $query  
 </p>  </p>
 RESULTS  
     }  
  $r->print(<<RESULTS);  
 <h3>Search Results</h3>  
 $compiledresult  
 </body>  </body>
 </html>  </html>
 RESULTS  RESULTS
     }  
 }  }
   
 # ------------------------------------------------------------- build_SQL_query  ######################################################################
 sub build_SQL_query {  ######################################################################
     my ($field_name,$logic_statement)=@_;  
     my $q=new Text::Query('abc',  
   -parse => 'Text::Query::ParseAdvanced',  
   -build => 'Text::Query::Build');  
     $q->prepare($logic_statement);  
     my $matchexp=${$q}{'matchexp'}; chomp $matchexp;  
     my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);  
     return $sql_query;  
 }  
   
 # - Recursively parse a reverse notation expression into a SQL query expression  =pod 
 sub recursive_SQL_query_build {  
     my ($dkey,$pattern)=@_;  =item &start_fresh_session()
     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);  
     return $pattern unless @matches;  Cleans the global %hash by removing all fields which begin with
     foreach my $match (@matches) {  'pre_' or 'store'.
  $match=~/\[ (\w+)\s(.*) \]/;  
  my ($key,$value)=($1,$2);  =cut
  my $replacement='';  
  if ($key eq 'literal') {  ######################################################################
     $replacement="($dkey like \"\%$value\%\")";  ######################################################################
  }  sub start_fresh_session {
  elsif ($key eq 'and') {      delete $hash{'mode_catalog'};
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;      foreach (keys %hash) {
     $replacement="($1 AND $2)";          if ($_ =~ /^pre_/) {
  }              delete $hash{$_};
  elsif ($key eq 'or') {          }
     $value=~/(.*[\"|\)]) ([|\(|\^].*)/;          if ($_ =~ /^store/) {
     $replacement="($1 OR $2)";      delete $hash{$_};
  }   }
  substr($pattern,  
        index($pattern,$match),  
        length($match),  
        $replacement  
        );  
     }      }
     &recursive_SQL_query_build($dkey,$pattern);  
 }  }
   
   ######################################################################
   ######################################################################
   
   =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.45  
changed lines
  Added in v.1.130


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