--- loncom/interface/lonsearchcat.pm 2001/03/15 17:55:59 1.16
+++ loncom/interface/lonsearchcat.pm 2002/06/25 15:08:59 1.129
@@ -1,126 +1,409 @@
-# The LearningOnline Network
+# The LearningOnline Network with CAPA
# Search Catalog
#
-# 03/08/2001 Scott Harrison
+# $Id: lonsearchcat.pm,v 1.129 2002/06/25 15:08:59 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
+
+button to take the selecte results and go to group sorting
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
+=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=<Search Catalog
+
+ +$closebutton + + + + +
+ + + +ENDDOCUMENT + return $scrout; +} +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by abstract','abstract', - $ENV{'form.abstract'}); +=pod - $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'}); - $scrout.=&selectbox('Limit by MIME type','mime', - $ENV{'form.mime'},%mimetag); +=item &advanced_search_form() - $ENV{'form.language'}='any' unless length($ENV{'form.language'}); +Returns a scalar which holds html for the advanced search form. - $scrout.=&selectbox('Limit by language','language', - $ENV{'form.language'},%language); - +=cut + +###################################################################### +###################################################################### +sub advanced_search_form{ + my ($closebutton,$hidden) = @_; + my $advanced_buttons = <<"END"; ++ + +$closebutton + + + + +
+END + my $scrout=<<"ENDHEADER"; + + +- - - -
+SHOW SPECIAL METADATA FIELDS: + +Enter in a space-separated list of special metadata fields to show +in a fielded listing for each record result. +$title: $uctitle:".
- " '.
+ ''.$uctitle.': Basic search: '.$ENV{'form.basicexp'}.' Advanced search '.$query.' \n";
+ if ($ENV{'form.catalogmode'} eq 'interactive') {
+ my $titleesc=$Fields{'title'};
+ $titleesc=~s/\'/\\'/; # '
+ $compiledresult.=<
".
- '';
+=pod
+
+=item &make_persistent()
+
+Returns a scalar which holds the current ENV{'form.*'} values in
+a 'hidden' html input tag. This allows search interface information
+to be somewhat persistent.
+
+=cut
+
+######################################################################
+######################################################################
+
+sub make_persistent {
+ my $persistent='';
+ foreach (keys %ENV) {
+ if (/^form\./ && !/submit/) {
+ my $name=$_;
+ my $key=$name;
+ $ENV{$key}=~s/\'//g; # do not mess with html field syntax
+ $name=~s/^form\.//;
+ $persistent.=<
".'Search Catalog
+CATALOGBEGIN
+ my $action = "/adm/searchcat";
+ if ($mode eq 'Basic') {
+ $action .= "?reqinterface=basic";
+ } elsif ($mode eq 'Advanced') {
+ $action .= "?reqinterface=advanced";
+ }
+ $r->print(<
+Search Query
+CATALOGCONTROLS
+ #
+ # Remind them what they searched for
+ #
+ if ($mode eq 'Basic') {
+ $r->print('Search Results
');
+ $r->rflush();
+ #
+ # make the pop-up window for status
+ #
+ $r->print(&make_popwin(%rhash));
+ $r->rflush();
+ ##
+ ## Prepare for the main loop below
+ ##
+ my $servercount=0;
+ my $hitcountsum=0;
+ my $servernum=(keys %rhash);
+ my $serversleft=$servernum;
+ ##
+ ## Run until we run out of time or we run out of servers
+ ##
+ while($serversleft && $timeremain) {
+ ##
+ ## %rhash has servers deleted from it as results come in
+ ## (within the foreach loop below).
+ ##
+ foreach my $rkey (sort keys %rhash) {
+# &Apache::lonnet::logthis("Server $rkey:".time);
+ $servercount++;
+ $compiledresult='';
+ my $reply=$rhash{$rkey};
+ my @results;
+ if ($reply eq 'con_lost') {
+ &popwin_imgupdate($r,$rkey,"srvbad.gif");
+ $serversleft--;
+ delete $rhash{$rkey};
+ } else {
+ # must do since 'use strict' checks for tainting
+ $reply=~/^([\.\w]+)$/;
+ my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
+ $reply=~/(.*?)\_/;
+ for (my $counter=0;$counter<2;$counter++) {
+ if (-e $replyfile && ! -e "$replyfile.end") {
+ &popwin_imgupdate($r,$rkey,"srvhalf.gif");
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
+ '"still transferring..."'.';');
+ }
+ # Are we finished transferring data?
+ if (-e "$replyfile.end") {
+ $serversleft--;
+ delete $rhash{$rkey};
+ if (-s $replyfile) {
+ &popwin_imgupdate($r,$rkey,"srvgood.gif");
+ my $fh;
+ unless ($fh=Apache::File->new($replyfile)){
+ # Is it really appropriate to die on this error?
+ $r->print('ERROR: file '.
+ $replyfile.' cannot be opened');
+ return OK;
+ }
+ @results=<$fh> if $fh;
+ my $hits =@results;
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]='.
+ $hits.';');
+ $hitcountsum+=$hits;
+ &popwin_js($r,'popwin.document.forms.popremain.'.
+ 'numhits.value='.$hitcountsum.';');
+ } else {
+ &popwin_imgupdate($r,$rkey,"srvempty.gif");
+ &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;');
+ }
+ last;
+ } # end of if ( -e "$replyfile.end")
+ last unless $timeremain;
+ sleep 1; # wait for daemons to write files?
+ $timeremain--;
+ $elapsetime++;
+ &popwin_js($r,"popwin.document.popremain.".
+ "elapsetime.value=$elapsetime;");
+ }
+ &popwin_js($r,'popwin.document.whirly.'.
+ 'src="/adm/lonIcons/lonanimend.gif";');
+ } # end of if ($reply eq 'con_lost') else statement
+ my %Fields = undef; # Holds the data to be sent to the various
+ # *_view routines.
+ my ($extrashow,$customfields,$customhash) = &handle_custom_fields(\@results);
+ my @customfields = @$customfields;
+ my %customhash = %$customhash;
+ untie %hash if (keys %hash);
+ #
+ if (! tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ $r->print('Unable to tie hash to db '.
+ 'file');
+ } else {
+ if ($ENV{'form.launch'} eq '1') {
+ &start_fresh_session();
+ }
+ foreach my $result (@results) {
+ next if $result=~/^custom\=/;
+ chomp $result;
+ next unless $result;
+ %Fields = &parse_raw_result($result,$rkey);
+ $Fields{'extrashow'}=$extrashow;
+ if ($extrashow) {
+ foreach my $field (@customfields) {
+ my $value='';
+ $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s);
+ $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g;
+ }
+ }
+ if ($compiledresult or $servercount!=$servernum) {
+ $compiledresult.="
";
+ }
+ $compiledresult.="\n
+
END
- $compiledresult.=<
-Title: $title
-Author(s): $author
-Subject: $subject
-Keyword(s): $keywords
-Notes: $notes
-Abstract: $shortabstract
-MIME Type: $mimetag{$mime}
-Language: $language{$lang}
-Creation Date: $creationdate
-Last Revision Date: $lastrevisiondate
-Publisher/Owner: $owner
-Copyright/Distribution: $copyright
-Repository Location: $hostname
-
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;
}
- unless ($compiledresult) {
- $compiledresult="There were no results that matched your query";
+###########################################################
+###########################################################
+
+=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;
+}
- # make query information persistent to allow for subsequent revision
- my $persistent='';
- map {
- if (/^form\./ && !/submit/) {
- my $name=$_;
- my $key=$name;
- $name=~s/^form\.//;
- $persistent.=<
\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;
}
- } (keys %ENV);
+ }
+ return ($extrashow,\@customfields,\%customhash);
+}
- $r->print(<
'+\n";
+ # $sn is the server number, used ONLY to make sure we have
+ # rows of 10 each. No longer used to index images.
+ my $sn=1;
+ foreach my $sk (sort keys %rhash) {
+ # ''+
+ $grid.="'+\"'\"+')\">'+";
+ $grid.="\n";
+ $grid.="''+\n";
+ $grid.="'
'+\n" unless $sn%10;
+ $sn++;
+ }
+ my $result.=<$values{'title'}
+$values{'author'}
+
+Subject: $values{'subject'}
+Keyword(s): $values{'keywords'}
+Notes: $values{'notes'}
+MIME Type:
+END
+ $result.=&Apache::loncommon::filedescription($values{'mime'});
+ $result.=<
+$values{'shortabstract'} +
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &summary_view() + +=cut + +###################################################################### +###################################################################### +sub summary_view { + my %values = @_; + my $result=<