--- loncom/interface/lonsearchcat.pm 2001/11/28 19:30:32 1.107
+++ loncom/interface/lonsearchcat.pm 2002/06/19 20:39:11 1.123
@@ -1,16 +1,72 @@
# The LearningOnline Network with CAPA
-#
# Search Catalog
#
+# $Id: lonsearchcat.pm,v 1.123 2002/06/19 20:39:11 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 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
#
-# $Id: lonsearchcat.pm,v 1.107 2001/11/28 19:30:32 harris41 Exp $
-###
+###############################################################################
+###############################################################################
+
+=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 ##
## ##
@@ -32,122 +88,155 @@ 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 %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
+
+=item $hidden
+
+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 $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
+
+######################################################################
+######################################################################
+
# -- 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
+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 $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 $scrout; # string that holds portions of the screen output
my $yourself; # allows for quickly limiting to oneself
-my %hash;
+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 = "";
# ----------------------------------------------------------------------- BEGIN
-sub BEGIN {
-# --------------------------------- Compute various listings of metadata values
- $language{'any'}='Any language';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/language.tab');
- map {
- $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
- $language{$1}=$2;
- } <$fh>;
- }
- $cprtag{'any'}='Any copyright/distribution';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonIncludes'}.
- '/copyright.tab');
- map {
- $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
- $cprtag{$1}=$2;
- } <$fh>;
- }
- $mimetag{'any'}='Any type';
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/filetypes.tab');
- map {
- $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;
- $mimetag{$1}=".$1 $3";
- } <$fh>;
- }
- {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
- '/hosts.tab');
- map {
- $_=~/(\w+?)\:(\w+?)\:(\w+?)\:(.*)/; chomp;
- if ($3 eq 'library') {
- $hostdomains{$1}=$2;
- $hostips{$1}=$4;
- }
- } <$fh>;
+
+=pod
+
+=item BEGIN block
+
+Load %hostdomains and %hostips with data from lonnet.pm. Only library
+servers are considered.
+
+=cut
+
+BEGIN {
+ foreach (keys (%Apache::lonnet::libserv)) {
+ $hostdomains{$_}=$Apache::lonnet::hostdom{$_};
+ $hostips{$_}=$Apache::lonnet::hostip{$_};
}
}
-my $diropendb = "";
-my $domain = "";
+######################################################################
+######################################################################
+
+=pod
+
+=item &handler() - main handler invoked by httpd child
+
+=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');
+ my $domain = $r->dir_config('lonDefDomain');
+ $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
+ "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
- $diropendb= "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_searchcat.db";
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['catalogmode','launch','acts','mode','form','element']);
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;
}
}
+# --------------------------- Produce some output, so people know it is working
+
+ $r->print("\n");
+ $r->rflush;
+
# ----------------------------------- configure dynamic components of interface
- my $hidden='';
+
if ($ENV{'form.catalogmode'} eq 'interactive') {
$hidden="".
"\n";
@@ -166,7 +255,12 @@ END
onClick='javascript:select_group()'>
END
}
-
+ $hidden .= <
+
+
+
+END
# ------------------------------------------------------ Determine current user
$yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
@@ -209,15 +303,20 @@ END
$scrout.=&searchphrasefield('Limit by abstract','abstract',
$ENV{'form.abstract'});
- $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});
+ $ENV{'form.mime'}='any' unless length($ENV{'form.mime'});
$scrout.=&selectbox('Limit by MIME type','mime',
- $ENV{'form.mime'},%mimetag);
+ $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'},%language);
-
+ $ENV{'form.language'},'any','Any Language',
+ \&{Apache::loncommon::languagedescription},
+ (&Apache::loncommon::languageids),
+ );
# ------------------------------------------------ Compute date selection boxes
$scrout.=<initial users of this syst
@@ -332,7 +435,15 @@ ENDDOCUMENT
$closebutton
-$basicviewselect
+
+
+
@@ -342,7 +453,15 @@ $scrout
$closebutton
-$advancedviewselect
+
+
+
@@ -352,23 +471,25 @@ ENDDOCUMENT
return OK;
}
-# ----------- grab unprocessed CGI variables that may have been appended to URL
-sub get_unprocessed_cgi {
- 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' or $name eq 'launch' or $name eq 'acts') {
- $ENV{'form.'.$name}=$value;
- }
- } (split(/&/,$ENV{'QUERY_STRING'}));
-}
+######################################################################
+######################################################################
+
+=pod
+
+=item &make_persistent()
+
+Returns a scalar which holds the current ENV{'form.*'} values in
+a 'hidden' html input tag.
+
+=cut
+
+######################################################################
+######################################################################
-# ------------------------------------------------------------- make persistent
sub make_persistent {
my $persistent='';
- map {
+ foreach (keys %ENV) {
if (/^form\./ && !/submit/) {
my $name=$_;
my $key=$name;
@@ -378,199 +499,155 @@ sub make_persistent {
END
}
- } (keys %ENV);
+ }
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()
+
+=item &selectbox()
+
+=back
+
+=cut
+
+######################################################################
+######################################################################
sub simpletextfield {
- my ($name,$value)=@_;
- return '';
+ my ($name,$value,$size)=@_;
+ $size = 20 if (! defined($size));
+ return '';
}
sub simplecheckbox {
my ($name,$value)=@_;
my $checked='';
$checked="CHECKED" if $value eq 'on';
- return '';
+ return '';
}
sub searchphrasefield {
my ($title,$name,$value)=@_;
my $instruction=<$uctitle:".
- " $instruction ".
- '';
+ return "\n".
+ '
'.$uctitle.':'.
+ " $instruction ".&simpletextfield($name,$value,80);
}
sub dateboxes {
my ($name,$defaultmonth,$defaultday,$defaultyear,
$currentmonth,$currentday,$currentyear)=@_;
($defaultmonth,$defaultday,$defaultyear)=('','','');
- my $month=<
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-END
- $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
+ #
+ # Day
my $day=<
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
END
+ for (my $i = 1; $i<=31; $i++) {
+ $day.="\n";
+ }
+ $day.="\n";
$day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);
+ #
+ # Month
+ my $month=<
+
+END
+ my $i = 1;
+ foreach (qw/January February March April May June
+ July August September October November December /){
+ $month .="\n";
+ $i++;
+ }
+ $month.="\n";
+ $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
+ #
+ # Year (obviously)
my $year=<
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
END
+ my $maxyear = 2051;
+ for (my $i = 1976; $i<=$maxyear; $i++) {
+ $year.="\n";
+ }
+ $year.="\n";
$year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);
return "$month$day$year";
}
sub selectbox {
- my ($title,$name,$value,%options)=@_;
+ my ($title,$name,$value,$anyvalue,$anytag,$functionref,@idlist)=@_;
my $uctitle=uc($title);
- my $selout="\n