--- loncom/interface/lonsearchcat.pm 2001/03/19 16:45:38 1.41 +++ loncom/interface/lonsearchcat.pm 2002/06/25 15:08:59 1.129 @@ -1,154 +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 $ # -# 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 + +=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 + +=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 -my %language; -my $scrout; -my %metadatafields; -my %cprtag; -my %mimetag; +=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=< -END - -# ------------------------------------------------ First, check out environment - $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'}; - -# --------------------------------- 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>; - } - - %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>; - } - - %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>; + 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 { + $r->print('Unable to tie hash to db '. + 'file'); + return OK; + } } - - if ($ENV{'form.basicsubmit'} eq 'SEARCH') { - return &basicsearch($r,\%ENV); + ## + ## 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') { + $hidden=< +END + $closebutton=< +END + $importbutton=< +END } - elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - return &advancedsearch($r,\%ENV); + $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; +} - $scrout=''; # building a part of screen output - $scrout.=&searchphrasefield('Limit by title','title', - $ENV{'form.title'}); +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by author','author', - $ENV{'form.author'}); +=pod - $scrout.=&searchphrasefield('Limit by subject','subject', - $ENV{'form.subject'}); +=item &basic_search_form() - $scrout.=&searchphrasefield('Limit by keywords','keywords', - $ENV{'form.keywords'}); +Returns a scalar which holds html for the basic search form. - $scrout.=&searchphrasefield('Limit by URL','url', - $ENV{'form.url'}); +=cut - $scrout.=&searchphrasefield('Limit by version','version', - $ENV{'form.version'}); +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by notes','notes', - $ENV{'form.notes'}); +sub basic_search_form{ + my ($closebutton,$hidden) = @_; + my $scrout=<<"ENDDOCUMENT"; + + +The LearningOnline Network with CAPA + + + + +

Search Catalog

+
+$hidden +

Basic Search

+

+Enter terms or quoted phrases separated by AND, OR, or NOT +then press SEARCH below. +

+

+ +
+ENDDOCUMENT + $scrout.=' '.&simpletextfield('basicexp',$ENV{'form.basicexp'},40). + ' '; +# $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'}); +# $scrout.='Search historic archives'; + $scrout.=<Advanced Search
+

+

+   +$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"; + + +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 + +ENDHEADER + $scrout.=&searchphrasefield('title','title', + $ENV{'form.title'}); + $scrout.=&searchphrasefield('author','author', + $ENV{'form.author'}); + $scrout.=&searchphrasefield('subject','subject', + $ENV{'form.subject'}); + $scrout.=&searchphrasefield('keywords','keywords', + $ENV{'form.keywords'}); + $scrout.=&searchphrasefield('URL','url', + $ENV{'form.url'}); +# $scrout.=&searchphrasefield('Limit by version','version', +# $ENV{'form.version'}); + $scrout.=&searchphrasefield('notes','notes', + $ENV{'form.notes'}); + $scrout.=&searchphrasefield('abstract','abstract', + $ENV{'form.abstract'}); + # Hack - an empty table row. + $scrout.="\n"; + $scrout.=&searchphrasefield('file
extension','mime', + $ENV{'form.mime'}); + $scrout.="\n"; + $scrout.=&searchphrasefield('publisher
owner','owner', + $ENV{'form.owner'}); + $scrout.="
  
  
\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.=< LIMIT BY CREATION DATE RANGE: -
+
between: CREATIONDATESTART $scrout.=&dateboxes('creationdatestart',1,1,1976, @@ -156,21 +411,18 @@ CREATIONDATESTART $ENV{'form.creationdatestart_day'}, $ENV{'form.creationdatestart_year'}, ); - $scrout.=< LIMIT BY LAST REVISION DATE RANGE: -
between: +
between: LASTREVISIONDATESTART $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976, $ENV{'form.lastrevisiondatestart_month'}, @@ -186,264 +438,283 @@ LASTREVISIONDATEEND $ENV{'form.lastrevisiondateend_year'}, ); $scrout.='

'; - - $scrout.=&searchphrasefield('Limit by publisher/owner','owner', - $ENV{'form.owner'}); -# $metadatafields{'owner'}); - $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'}); $scrout.=&selectbox('Limit by copyright/distribution','copyright', - $ENV{'form.copyright'},%cprtag); - + $ENV{'form.copyright'}, + 'any','Any copyright/distribution', + \&{Apache::loncommon::copyrightdescription}, + (&Apache::loncommon::copyrightids), + ); # ------------------------------------------- Compute customized metadata field $scrout.=< -LIMIT BY OTHER METADATA FIELDS: +LIMIT BY SPECIAL METADATA FIELDS: -For author-specific metadata, enter in an expression in the form of -key=value separated by operators such as AND or OR.
+For resource-specific metadata, enter in an expression in the form of +key=value separated by operators such as AND, OR or NOT.
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'; - -# ---------------------------------------------------------------- Print screen - $r->print(< - -The LearningOnline Network with CAPA - - - -

Search Catalog

-
-$hidden -
-

Basic Search

+ $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'}); + $scrout.=< -Enter terms or phrases separated by search operators -such as AND or OR then press SEARCH below. Terms should be specific -to the title, author, subject, notes, or abstract information associated -with a resource. -
-ENDDOCUMENT - $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'})); - $r->print(' '); - $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'})); - $r->print('Title only '); - $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'})); - $r->print(<Search historic archives -
- - - -

-
-

Advanced Search

-$scrout -

- - - -

+SHOW SPECIAL METADATA FIELDS: + +Enter in a space-separated list of special metadata fields to show +in a fielded listing for each record result. +
+CUSTOMSHOW + $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'}); + $scrout.=< ENDDOCUMENT - return OK; -} + return $scrout; +} + +###################################################################### +###################################################################### + +=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.=< +END + } + } + return $persistent; +} + + +###################################################################### +###################################################################### + +=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() + +Returns html selection form elements for the specification of +the day, month, and year. + +=item &selectbox() -# --------------------------------------------------------- Various form fields +Returns a scalar containing an html tag. + +=item $default + +The default value of the form. Can be $anyvalue or in @idlist. + +=item $anyvalue + +The