--- loncom/interface/lonsearchcat.pm 2001/03/14 15:26:47 1.9
+++ loncom/interface/lonsearchcat.pm 2002/06/27 14:46:00 1.132
@@ -1,443 +1,1499 @@
-# The LearningOnline Network
+# The LearningOnline Network with CAPA
# Search Catalog
#
-# 03/08/2001 Scott Harrison
+# $Id: lonsearchcat.pm,v 1.132 2002/06/27 14:46:00 matthew Exp $
#
+# Copyright Michigan State University Board of Trustees
+#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
+#
+# LON-CAPA is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LON-CAPA is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with LON-CAPA; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+# /home/httpd/html/adm/gpl.txt
+#
+# http://www.lon-capa.org/
+#
+# YEAR=2001
+# 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison
+# 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison
+# 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison
+# YEAR=2002
+# 1/17 Scott Harrison
+# 6/17 Matthew Hall
+#
+###############################################################################
+###############################################################################
+
+=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;
+# ------------------------------------------------- modules used by this module
use strict;
use Apache::Constants qw(:common);
use Apache::lonnet();
use Apache::File();
use CGI qw(:standard);
+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
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
+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
+
+######################################################################
+######################################################################
+
+=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 {
my $r = shift;
-
-# -------------------------------------- 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'}));
+ untie %hash;
$r->content_type('text/html');
$r->send_http_header;
return OK if $r->header_only;
- %metadatafields=();
-
- my $hidden='';
- $hidden=<
-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\-]+)/;
- $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>;
+ my $domain = $r->dir_config('lonDefDomain');
+ $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
+ "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
+
+ &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('Unable to tie hash to db '.
+ 'file');
+ 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="".
+ "\n";
+ $closebutton=""."\n";
+ } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ $hidden=<
+END
+ $closebutton=<
+END
+ $importbutton=<
+END
+ }
+ $hidden .= <
+
+
+
+END
+ ##
+ ## What are we doing?
+ ##
if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
- return &basicsearch($r,$ENV{'form.basicexp'});
+ # 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',
- '');
+######################################################################
+######################################################################
- $scrout.=&searchphrasefield('Limit by author','author',
- '');
+=pod
- $scrout.=&searchphrasefield('Limit by subject','subject',
- '');
+=item &basic_search_form()
- $scrout.=&searchphrasefield('Limit by notes','notes',
- '');
+Returns a scalar which holds html for the basic search form.
- $scrout.=&searchphrasefield('Limit by abstract','abstract',
- '');
+=cut
- $scrout.=&selectbox('Limit by MIME type','mime',
- 'notxxx',%mimetag);
+######################################################################
+######################################################################
- $scrout.=&selectbox('Limit by language','language',
- 'any',%language);
-
+sub basic_search_form{
+ my ($closebutton,$hidden) = @_;
+ my $scrout=<<"ENDDOCUMENT";
+
+
+The LearningOnline Network with CAPA
+
+
+
+
+
Search Catalog
+
+
+
+$closebutton
+
+
+
+
+
+
+
+
+ENDDOCUMENT
+ return $scrout;
+}
+######################################################################
+######################################################################
+
+=pod
+
+=item &advanced_search_form()
+
+Returns a scalar which holds html for the advanced search form.
+=cut
+
+######################################################################
+######################################################################
+
+sub advanced_search_form{
+ my ($closebutton,$hidden) = @_;
+ my $advanced_buttons = <<"END";
+
+
+
+$closebutton
+
+
+END
+ my $scrout=<<"ENDHEADER";
+
+
+The LearningOnline Network with CAPA
+
+
+
+
+
Advanced Catalog Search
+
+Enter terms or phrases separated by search operators
+such as AND, OR, or NOT.
+