--- loncom/interface/lonsearchcat.pm 2001/03/19 16:45:38 1.41
+++ loncom/interface/lonsearchcat.pm 2002/07/29 21:53:57 1.146
@@ -1,154 +1,518 @@
-# The LearningOnline Network
+# The LearningOnline Network with CAPA
# Search Catalog
#
-# 03/08/2001 Scott Harrison
+# $Id: lonsearchcat.pm,v 1.146 2002/07/29 21:53:57 matthew Exp $
#
-# Functions
+# Copyright Michigan State University Board of Trustees
#
-# handler(server reference) : interacts with the Apache server layer
-# (for /adm/searchcat URLs)
-# simpletextfield(name,value) : returns HTML formatted string for simple text
-# field
-# simplecheckbox(name,value) : returns HTML formatted string for simple
-# checkbox
-# searchphrasefield(title,name,value) : returns HTML formatted string for
-# a search expression phrase field
-# dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
-# formatted string
-# for a calendar date
-# selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
-# a selection box field
-# advancedsearch() :
-# filled(field) : determines whether a given field has been filled
-# basicsearch() :
-# output_blank_field_error() : outputs a message saying that more fields need
-# to be filled in
-# output_results() : outputs results from search
-# build_SQL_query() : builds a SQL query string from a logical expression
-# with AND/OR keywords
+# 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 - LONCAPA Search Interface
+
+=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 DBI;
+use GDBM_File;
+use Apache::loncommon();
+use Apache::lonmysql();
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
+# ---------------------------------------- variables used throughout the module
-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'}));
+=pod
- $r->content_type('text/html');
- $r->send_http_header;
- return OK if $r->header_only;
+=item Global variables
- %metadatafields=();
+=over 4
- my $hidden='';
- $hidden=<
-END
+=item $importbutton
-# ------------------------------------------------ First, check out environment
- $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
+button to take the select results and go to group sorting
-# --------------------------------- 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>;
- }
+=item %groupsearch_db
- %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>;
- }
+Database hash used to save values for the groupsearch RAT interface.
- %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>;
- }
+=item $diropendb
+
+The full path to the (temporary) search database file. This is set and
+used in &handler() and is also used in &output_results().
+
+=item %Views
+
+Hash which associates an output view description with the function
+that produces it. Adding a new view type should be as easy as
+adding a line to the definition of this hash and making sure the function
+takes the proper parameters.
+
+=back
+
+=cut
+
+######################################################################
+######################################################################
+
+# -- dynamically rendered interface components
+my $importbutton; # button to take the selected results and go to group sorting
+
+# -- miscellaneous variables
+my %groupsearch_db; # database hash
+my $diropendb = ""; # db file
+# View Description Function Pointer
+my %Views = ("Detailed Citation View" => \&detailed_citation_view,
+ "Summary View" => \&summary_view,
+ "Fielded Format" => \&fielded_format_view,
+ "XML/SGML" => \&xml_sgml_view );
+my %persistent_db;
+my $hidden_fields;
+######################################################################
+######################################################################
+
+=pod
- if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
- return &basicsearch($r,\%ENV);
+=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;
+ #
+ my $closebutton; # button that closes the search window
+ # This button is different for the RAT compared to
+ # normal invocation.
+ #
+ $r->content_type('text/html');
+ $r->send_http_header;
+ return OK if $r->header_only;
+ ##
+ ## Pick up form fields passed in the links.
+ ##
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['catalogmode','launch','acts','mode','form','element','pause',
+ 'phase','persistent_db_id','table','start','show']);
+ ##
+ ## The following is a trick - we wait a few seconds if asked to so
+ ## the daemon running the search can get ahead of the daemon
+ ## printing the results. We only need (theoretically) to do
+ ## this once, so the pause indicator is deleted
+ ##
+ if (exists($ENV{'form.pause'})) {
+ sleep(5);
+ delete($ENV{'form.pause'});
+ }
+ ##
+ ## Initialize global variables
+ ##
+ my $domain = $r->dir_config('lonDefDomain');
+ $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
+ "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
+ #
+ # set the name of the persistent database
+ # $ENV{'form.persistent_db_id'} can only have digits in it.
+ if (! exists($ENV{'form.persistent_db_id'}) ||
+ $ENV{'form.persistent_db_id'} =~ /\D/ ) {
+ $ENV{'form.persistent_db_id'} = time;
+ }
+ my $persistent_db_file = "/home/httpd/perl/tmp/".
+ &Apache::lonnet::escape($domain).
+ '_'.&Apache::lonnet::escape($ENV{'user.name'}).
+ '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
+ ##
+ &get_persistent_form_data($r,$persistent_db_file);
+ ##
+ ## Clear out old values from groupsearch database
+ ##
+ untie %groupsearch_db if (tied(%groupsearch_db));
+ if ($ENV{'form.launch'} eq '1') {
+ if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ &start_fresh_session();
+ untie %groupsearch_db;
+ } else {
+ $r->print('Unable to tie hash to db '.
+ 'file');
+ return OK;
+ }
+ }
+ ##
+ ## Configure dynamic components of interface
+ ##
+ $hidden_fields = '';
+ ##
+ if ($ENV{'form.catalogmode'} eq 'interactive') {
+ $closebutton=""."\n";
+ } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ $closebutton=<
+END
+ $importbutton=<
+END
+ } else {
+ $closebutton = '';
+ $importbutton = '';
}
- elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
- return &advancedsearch($r,\%ENV);
+ ##
+ ## Sanity checks on form elements
+ ##
+ if (!defined($ENV{'form.viewselect'})) {
+ $ENV{'form.viewselect'} ="Detailed Citation View";
}
+ $ENV{'form.phase'} = 'displaybasic' if (! exists($ENV{'form.phase'}));
+ ##
+ ## Switch on the phase
+ ##
+ if ($ENV{'form.phase'} eq 'disp_basic') {
+ &print_basic_search_form($r,$closebutton);
+ } elsif ($ENV{'form.phase'} eq 'disp_adv') {
+ &print_advanced_search_form($r,$closebutton);
+ } elsif ($ENV{'form.phase'} eq 'results') {
+ &display_results($r,$importbutton,$closebutton);
+ } elsif($ENV{'form.phase'} eq 'run_search') {
+ my ($query,$customquery,$customshow,$libraries,$pretty_string) =
+ &get_persistent_data($persistent_db_file,
+ ['query','customquery','customshow',
+ 'libraries','pretty_string']);
+ &write_status($r,"query = $query");
+ &write_status($r,"customquery = $customquery");
+ &write_status($r,"customshow = $customshow");
+ &write_status($r,"libraries = $libraries");
+ &write_status($r,"pretty_string = $pretty_string");
+ &run_search($r,$query,$customquery,$customshow,
+ $libraries,$pretty_string);
+ } elsif(($ENV{'form.phase'} eq 'basic_search') ||
+ ($ENV{'form.phase'} eq 'adv_search')) {
+ # Set up table
+ if (! defined(&create_results_table())) {
+ # Unable to make table to store results in.
+ # Definately abort search.
+ }
+ if (! &make_form_data_persistent($r,$persistent_db_file)) {
+ # Unable to store persistent data.
+ # Probably should bail out.
+ }
+ #
+ # We are running a search
+ my ($query,$customquery,$customshow,$libraries) =
+ (undef,undef,undef,undef);
+ my $pretty_string;
+ if ($ENV{'form.phase'} eq 'basic_search') {
+ ($query,$pretty_string) = &parse_basic_search($r,$closebutton);
+ } else { # Advanced search
+ ($query,$customquery,$customshow,$libraries,$pretty_string)
+ = &parse_advanced_search($r,$closebutton);
+ return OK if (! defined($query));
+ }
+ &write_status($r,"query = $query");
+ &write_status($r,"customquery = $customquery");
+ &write_status($r,"customshow = $customshow");
+ &write_status($r,"libraries = $libraries");
+ &write_status($r,"pretty_string = $pretty_string");
+ &make_persistent($r,
+ { query => $query,
+ customquery => $customquery,
+ customshow => $customshow,
+ libraries => $libraries,
+ pretty_string => $pretty_string },
+ $persistent_db_file);
+ ##
+ ## Print out the frames interface
+ ##
+ &print_frames_interface($r);
+ }
+ return OK;
+}
+
+######################################################################
+######################################################################
+
+=pod
- $scrout=''; # building a part of screen output
- $scrout.=&searchphrasefield('Limit by title','title',
- $ENV{'form.title'});
+=item &print_basic_search_form()
- $scrout.=&searchphrasefield('Limit by author','author',
- $ENV{'form.author'});
+Returns a scalar which holds html for the basic search form.
- $scrout.=&searchphrasefield('Limit by subject','subject',
- $ENV{'form.subject'});
+=cut
- $scrout.=&searchphrasefield('Limit by keywords','keywords',
- $ENV{'form.keywords'});
+######################################################################
+######################################################################
+
+sub print_basic_search_form{
+ my ($r,$closebutton) = @_;
+ my $scrout=<<"ENDDOCUMENT";
+
+
+The LearningOnline Network with CAPA
+
+
+
+
+