--- loncom/interface/lonsearchcat.pm 2002/06/19 19:40:38 1.122
+++ loncom/interface/lonsearchcat.pm 2002/07/29 21:53:57 1.146
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.122 2002/06/19 19:40:38 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.146 2002/07/29 21:53:57 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -40,7 +40,7 @@
=head1 NAME
-lonsearchcat
+lonsearchcat - LONCAPA Search Interface
=head1 SYNOPSIS
@@ -67,14 +67,14 @@ search (on a server basis) is displayed
###############################################################################
###############################################################################
+###############################################################################
## ##
## ORGANIZATION OF THIS PERL MODULE ##
## ##
## 1. Modules used by this module ##
-## 2. Choices for different output views (detailed, summary, xml, etc) ##
-## 3. BEGIN block (to be run once after compilation) ##
-## 4. Handling routine called via Apache and mod_perl ##
-## 5. Other subroutines ##
+## 2. Variables used throughout the module ##
+## 3. handler subroutine called via Apache and mod_perl ##
+## 4. Other subroutines ##
## ##
###############################################################################
@@ -87,8 +87,10 @@ use Apache::lonnet();
use Apache::File();
use CGI qw(:standard);
use Text::Query;
+use DBI;
use GDBM_File;
use Apache::loncommon();
+use Apache::lonmysql();
# ---------------------------------------- variables used throughout the module
@@ -101,52 +103,26 @@ use Apache::loncommon();
=over 4
-=item %hostdomains
-
-matches host name to host domain
-
-=item %hostips
-
-matches host name to host ip
-
-=item %hitcount
-
-stores number of hits per host
-
-=item $closebutton
-
-button that closes the search window
-
=item $importbutton
-button to take the selecte results and go to group sorting
+button to take the select results and go to group sorting
-=item $hidden
+=item %groupsearch_db
-holds 'hidden' html forms
-
-=item $scrout
-
-string that holds portions of the screen output
-
-=item $yourself
-
-allows for quickly limiting to oneself
-
-=item %hash
-
-The ubiquitous database hash
-
-=item $basicviewselect and $advancedviewselect
-
-View selection forms. These are not actually global and will be
-moved soon.
+Database hash used to save values for the groupsearch RAT interface.
=item $diropendb
The full path to the (temporary) search database file. This is set and
used in &handler() and is also used in &output_results().
+=item %Views
+
+Hash which associates an output view description with the function
+that produces it. Adding a new view type should be as easy as
+adding a line to the definition of this hash and making sure the function
+takes the proper parameters.
+
=back
=cut
@@ -154,122 +130,113 @@ used in &handler() and is also used in &
######################################################################
######################################################################
-# -- information holders
-my %hostdomains; # matches host name to host domain
-my %hostips; # matches host name to host ip
-my %hitcount; # stores number of hits per host
-
# -- 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
-my $hidden; # Holds 'hidden' html forms
# -- miscellaneous variables
-my $scrout; # string that holds portions of the screen output
-my $yourself; # allows for quickly limiting to oneself
-my %hash; # database hash
-
-# ------------------------------------------ choices for different output views
-# Detailed Citation View ---> sub detailed_citation_view
-# Summary View ---> sub summary_view
-# Fielded Format ---> sub fielded_format_view
-# XML/SGML ---> sub xml_sgml_view
-my $basicviewselect=<
-
-
-
-
-
-END
-my $advancedviewselect=<
-
-
-
-
-
-END
-
-#------------------------------------------------------------- global variables
-my $diropendb = "";
-my $domain = "";
+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;
+######################################################################
+######################################################################
-# ----------------------------------------------------------------------- BEGIN
+=pod
-=pod
+=item &handler() - main handler invoked by httpd child
-=item BEGIN block
+=item Variables
-Load %hostdomains and %hostips with data from lonnet.pm. Only library
-servers are considered.
+=over 4
-=cut
+=item $hidden
-BEGIN {
- foreach (keys (%Apache::lonnet::libserv)) {
- $hostdomains{$_}=$Apache::lonnet::hostdom{$_};
- $hostips{$_}=$Apache::lonnet::hostip{$_};
- }
-}
+holds 'hidden' html forms
-######################################################################
-######################################################################
+=item $scrout
-=pod
+string that holds portions of the screen output
-=item &handler() - main handler invoked by httpd child
+=back
=cut
######################################################################
######################################################################
-# ----------------------------- Handling routine called via Apache and mod_perl
sub handler {
my $r = shift;
- untie %hash;
-
+ #
+ 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";
-
- &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['catalogmode','launch','acts','mode','form','element']);
-
+ #
+ # 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(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
&start_fresh_session();
- untie %hash;
+ untie %groupsearch_db;
} 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
-
+ ##
+ ## Configure dynamic components of interface
+ ##
+ $hidden_fields = '';
+ ##
if ($ENV{'form.catalogmode'} eq 'interactive') {
- $hidden="".
- "\n";
$closebutton=""."\n";
- }
- elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
- $hidden=<
-END
+ } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
$closebutton=<
END
@@ -277,70 +244,269 @@ END
END
+ } else {
+ $closebutton = '';
+ $importbutton = '';
}
- $hidden .= <
-
-
-
-END
-# ------------------------------------------------------ Determine current user
- $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
+ ##
+ ## 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;
+}
-# --- Now, depending on the interface actions, do one of three things here:
-# --- 1. a basic search
-# --- 2. an advanced search
-# --- 3. output a search interface
+######################################################################
+######################################################################
-# ----------------------------------- See if a search invocation should be done
- if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
- untie %hash; return &basicsearch($r,\%ENV);
- }
- elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
- untie %hash; return &advancedsearch($r,\%ENV);
- }
+=pod
-# ----------------------------- Else, begin building search interface to output
- $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
+
+
+
+
+