--- loncom/interface/lonsearchcat.pm 2001/12/13 14:00:37 1.112
+++ loncom/interface/lonsearchcat.pm 2002/06/25 15:08:59 1.129
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.112 2001/12/13 14:00:37 harris41 Exp $
+# $Id: lonsearchcat.pm,v 1.129 2002/06/25 15:08:59 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,19 +28,53 @@
# 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 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. 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 ##
## ##
###############################################################################
@@ -58,98 +92,115 @@ use Apache::loncommon();
# ---------------------------------------- variables used throughout the module
-# -- information holders
-# my %language; # holds contents of language.tab
-# my %cprtag; # holds contents of copyright.tab
-# my %mimetag; # holds contents of filetypes.tab
-my %hostdomains; # matches host name to host domain
-my %hostips; # matches host name to host ip
-my %hitcount; # stores number of hits per host
+######################################################################
+######################################################################
+
+=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 $closebutton; # button that closes the search window
my $importbutton; # button to take the selected results and go to group sorting
# -- miscellaneous variables
-my $scrout; # string that holds portions of the screen output
-my $yourself; # allows for quickly limiting to oneself
-my %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
+my %hash; # database hash
+my $diropendb = ""; # db file
-# ----------------------------------------------------------------------- BEGIN
-sub BEGIN {
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/hosts.tab');
- while (<$fh>) {
- $_=~/(\w+?)\:(\w+?)\:(\w+?)\:(.*)/; chomp;
- if ($3 eq 'library') {
- $hostdomains{$1}=$2;
- $hostips{$1}=$4;
- }
- }
- }
-}
+######################################################################
+######################################################################
+
+=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
-my $diropendb = "";
-my $domain = "";
+=cut
-# ----------------------------- Handling routine called via Apache and mod_perl
+######################################################################
+######################################################################
sub handler {
my $r = shift;
untie %hash;
- &get_unprocessed_cgi();
$r->content_type('text/html');
$r->send_http_header;
return OK if $r->header_only;
- $domain = $r->dir_config('lonDefDomain');
-
- $diropendb= "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_searchcat.db";
-
+ 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 {
+ } else {
$r->print('Unable to tie hash to db '.
'file');
return OK;
}
}
-
-# ----------------------------------- configure dynamic components of interface
- my $hidden='';
+ ##
+ ## 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') {
+ } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
$hidden=<
END
@@ -161,64 +212,192 @@ END
onClick='javascript:select_group()'>
END
}
+ $hidden .= <
+
+
+
+END
+ ##
+ ## What are we doing?
+ ##
+ if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
+ # Perform basic search and give results
+ return &basicsearch($r,\%ENV,$hidden);
+ } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
+ # Perform advanced search and give results
+ return &advancedsearch($r,\%ENV,$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;
+}
-# ------------------------------------------------------ Determine current user
- $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
+######################################################################
+######################################################################
-# --- 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
+=pod
-# ----------------------------------- 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);
+=item &basic_search_form()
+
+Returns a scalar which holds html for the basic search form.
+
+=cut
+
+######################################################################
+######################################################################
+
+sub basic_search_form{
+ my ($closebutton,$hidden) = @_;
+ my $scrout=<<"ENDDOCUMENT";
+
+
+The LearningOnline Network with CAPA
+
+
+
+
+
Search Catalog
+
+
+
+$closebutton
+
+
+
+
+
+
+
+
+ENDDOCUMENT
+ return $scrout;
+}
+######################################################################
+######################################################################
-# ----------------------------- Else, begin building search interface to output
- $scrout=''; # building a part of screen output
- $scrout.=&searchphrasefield('Limit by title','title',
- $ENV{'form.title'});
+=pod
- $scrout.=&searchphrasefield('Limit by author','author',
- $ENV{'form.author'});
+=item &advanced_search_form()
- $scrout.=&searchphrasefield('Limit by subject','subject',
- $ENV{'form.subject'});
+Returns a scalar which holds html for the advanced search form.
- $scrout.=&searchphrasefield('Limit by keywords','keywords',
- $ENV{'form.keywords'});
+=cut
- $scrout.=&searchphrasefield('Limit by URL','url',
- $ENV{'form.url'});
+######################################################################
+######################################################################
+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 quoted phrases separated by search operators
+such as AND, OR, or NOT.
+$advanced_buttons
+$hidden
+
\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
$scrout.=<
@@ -232,16 +411,13 @@ CREATIONDATESTART
$ENV{'form.creationdatestart_day'},
$ENV{'form.creationdatestart_year'},
);
- $scrout.=<";
-
$scrout.=<LIMIT BY LAST REVISION DATE RANGE:
@@ -262,10 +438,6 @@ LASTREVISIONDATEEND
$ENV{'form.lastrevisiondateend_year'},
);
$scrout.='';
-
- $scrout.=&searchphrasefield('Limit by publisher/owner','owner',
- $ENV{'form.owner'});
-
$ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
$scrout.=&selectbox('Limit by copyright/distribution','copyright',
$ENV{'form.copyright'},
@@ -273,7 +445,6 @@ LASTREVISIONDATEEND
\&{Apache::loncommon::copyrightdescription},
(&Apache::loncommon::copyrightids),
);
-
# ------------------------------------------- Compute customized metadata field
$scrout.=<
@@ -284,9 +455,7 @@ For resource-specific metadata, enter in
Example: grandmother=75 OR grandfather=85
CUSTOMMETADATA
-$scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
-$scrout.=' initial users of this system do not need to worry about this option';
-
+ $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
$scrout.=<SHOW SPECIAL METADATA FIELDS:
@@ -295,83 +464,34 @@ Enter in a space-separated list of speci
in a fielded listing for each record result.
CUSTOMSHOW
-$scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
-$scrout.=' initial users of this system do not need to worry about this option';
-
-# ---------------------------------------------------------------- Print screen
- $r->print(<
-
-The LearningOnline Network with CAPA
-
-
-
-
-
Search Catalog
-
+
+END
+ }
+ if ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ $fnum+=0;
+ $hash{"pre_${fnum}_link"}=$Fields{'url'};
+ $hash{"pre_${fnum}_title"}=$Fields{'title'};
+ $compiledresult.=<
+
+
+
+END
+#
+#
+ $fnum++;
+ }
+ my $viewselect;
+ if ($mode eq 'Basic') {
+ $viewselect=$ENV{'form.basicviewselect'};
+ }
+ elsif ($mode eq 'Advanced') {
+ $viewselect=$ENV{'form.advancedviewselect'};
+ }
+ if ($viewselect eq 'Detailed Citation View') {
+ $compiledresult.=&detailed_citation_view
+ (%Fields, hostname => $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 );
+ }
+ }
+ untie %hash;
+ }
+ if ($compiledresult) {
+ $resultflag=1;
+ $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(''."\n"); $r->rflush();
+ $r->print("\n\n");
+ return;
+}
+
+###########################################################
+###########################################################
+
+=pod
+
+=item &parse_raw_result()
+
+Takes a line from the file of results and parse it. Returns a hash
+with keys for the following fields:
+'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes',
+'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate',
+'lastrevisiondate'.
+
+In addition, the following tags are set by calling the appropriate
+lonnet function: 'language', 'cprtag', 'mimetag'.
+
+The 'title' field is set to "Untitled" if the title field is blank.
+
+'abstract' and 'keywords' are truncated to 200 characters.
+
+=cut
+
+###########################################################
+###########################################################
+sub parse_raw_result {
+ my ($result,$hostname) = @_;
+ # Check for a comma - if it is there then we do not need to unescape the
+ # string. There seems to be some kind of problem with some items in
+ # the database - the entire string gets sent out unescaped...?
+ unless ($result =~ /,/) {
+ $result = &Apache::lonnet::unescape($result);
+ }
+ my @fields=map {
+ &Apache::lonnet::unescape($_);
+ } (split(/\,/,$result));
+ my ($title,$author,$subject,$url,$keywords,$version,
+ $notes,$abstract,$mime,$lang,
+ $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
+ my %Fields =
+ ( title => &Apache::lonnet::unescape($title),
+ author => &Apache::lonnet::unescape($author),
+ subject => &Apache::lonnet::unescape($subject),
+ url => &Apache::lonnet::unescape($url),
+ keywords => &Apache::lonnet::unescape($keywords),
+ version => &Apache::lonnet::unescape($version),
+ notes => &Apache::lonnet::unescape($notes),
+ abstract => &Apache::lonnet::unescape($abstract),
+ mime => &Apache::lonnet::unescape($mime),
+ lang => &Apache::lonnet::unescape($lang),
+ owner => &Apache::lonnet::unescape($owner),
+ copyright => &Apache::lonnet::unescape($copyright),
+ creationdate => &Apache::lonnet::unescape($creationdate),
+ lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate)
+ );
+ $Fields{'language'} =
+ &Apache::loncommon::languagedescription($Fields{'lang'});
+ $Fields{'copyrighttag'} =
+ &Apache::loncommon::copyrightdescription($Fields{'copyright'});
+ $Fields{'mimetag'} =
+ &Apache::loncommon::filedescription($Fields{'mime'});
+ # 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 {
+ "$_:";
+ } split(/\s+/,$customshow);
+ @customfields=split(/\s+/,$customshow);
+ if ($customshow) {
+ $extrashow="
".join("
",@fields)."
\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 javascript code to deal with different calling modes.
+
+Takes inputs directly from from %ENV. The following environment variables
+are checked:
+
+=over 4
+
+=item 'form.catalogmode'
+
+Checked for 'interactive' and 'groupsearch'.
+
+=item 'form.mode'
+
+Checked for existance & 'edit' mode.
+
+=item 'form.form'
+
+=item 'form.element'
+
+=back
+
+=cut
+
+######################################################################
+######################################################################
+sub search_results_header {
+ my $result = '';
# output beginning of search page
- $r->print(<The LearningOnline Network with CAPA
BEGINNING
-
# conditional output of script functions dependent on the mode in
# which the search was invoked
- $r->print(<
SCRIPT
- $r->print(<
+SCRIPT
+ }
+ }
+ $result.=<
SCRIPT
- $r->print(<
SCRIPT
- $r->rflush();
+ return $result;
+}
- # begin showing the cataloged results
- $r->print(<
-
-
-