--- loncom/interface/lonsearchcat.pm 2001/03/21 12:51:15 1.62
+++ loncom/interface/lonsearchcat.pm 2001/08/26 21:19:35 1.98
@@ -1,14 +1,40 @@
-# The LearningOnline Network
+# The LearningOnline Network with CAPA
+#
# Search Catalog
#
+# YEAR=2001
# 03/08/2001 Scott Harrison
# Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001
-# Scott Harrison: 03/20/2001
+# Scott Harrison: 03/20/2001, 03/21/2001, 03/22/2001, 03/26/2001, 03/27/2001
+# Scott Harrison: 04/02/2001, 08/15/2001, 08/24/2001, 08/25/2001
+
+###############################################################################
+## ##
+## ORGANIZATION OF THIS PERL MODULE ##
+## ##
+## 1. Description of functions ##
+## 2. Modules used by this module ##
+## 3. Choices for different output views (detailed, summary, xml, etc) ##
+## 4. BEGIN block (to be run once after compilation) ##
+## 5. Handling routine called via Apache and mod_perl ##
+## 6. Other subroutines ##
+## ##
+###############################################################################
+
+# ---------------------------------------------------- Description of functions
#
-# Functions
#
+# === WEB HANDLER FUNCTIONS
+# BEGIN() : run once after compilation to initialize values
# handler(server reference) : interacts with the Apache server layer
# (for /adm/searchcat URLs)
+# get_unprocessed_cgi() : reads in critical name/value pairs that may have not
+# been processed and passed into %ENV by the web server
+# make_persistent() : makes a set of hidden HTML fields to make
+# SQL search interface information to be persistent
+#
+#
+# === WEB INTERFACE COMPONENT FUNCTIONS
# simpletextfield(name,value) : returns HTML formatted string for simple text
# field
# simplecheckbox(name,value) : returns HTML formatted string for simple
@@ -20,25 +46,64 @@
# for a calendar date
# selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
# a selection box field
+#
+#
+# === SEARCH FUNCTIONS
# advancedsearch(server reference, environment reference) : perform a complex
# multi-field logical query
-# filled(field) : determines whether a given field has been filled
# basicsearch(server reference, environment reference) : perform a simple
# single-field logical query
-# output_blank_field_error(server reference) : outputs a message saying that
-# more fields need to be filled in
-# output_results(output mode,
-# server reference,
-# environment reference,
-# reply list reference) : outputs results from search
# build_SQL_query(field name, logic) : builds a SQL query string from a
# logical expression with AND/OR keywords
+# build_custommetadata_query(field_name, logic_statement) : builds a perl
+# regular expression from a logical expression with AND/OR
+# keywords
# recursive_SQL_query_build(field name, reverse notation expression) :
# builds a SQL query string from a reverse notation expression
# logical expression with AND/OR keywords
+# build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,
+# lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :
+# Builds a SQL logic query to check time/date entries.
+#
+#
+# === OUTPUTTING RESULTS FUNCTION
+# output_results(output mode,
+# server reference,
+# environment reference,
+# reply list reference) : outputs results from search
+#
+#
+# === DIFFERENT WAYS TO VIEW METADATA RECORDS
+# detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+# see metadata viewing notes below
+# summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+# see metadata viewing notes below
+# fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+# see metadata viewing notes below
+# xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) :
+# see metadata viewing notes below
+# ___________________________________________________________________________
+# | * Metadata viewing notes |
+# | Output is a HTML-ified string. |
+# | Input arguments are title, author, subject, url, keywords, version, notes,|
+# | short abstract, mime, language, creation date, last revision date, owner, |
+# | copyright, hostname, httphost, and extra custom metadata to show. |
+# ---------------------------------------------------------------------------
+#
+#
+# === TEST CONDITIONAL FUNCTIONS
+# filled(field) : determines whether a given field has been filled
+#
+#
+# === ERROR FUNCTIONS
+# output_blank_field_error(server reference) : outputs a message saying that
+# more fields need to be filled in
+# output_date_error(server reference, error message) : outputs
+# an error message specific to bad date format.
package Apache::lonsearchcat;
+# ------------------------------------------------- modules used by this module
use strict;
use Apache::Constants qw(:common);
use Apache::lonnet();
@@ -46,12 +111,30 @@ use Apache::File();
use CGI qw(:standard);
use Text::Query;
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
-my $closebutton;
+# ---------------------------------------- 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
+
+# -- 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 $scrout; # string that holds portions of the screen output
+my $fnum; # search result counter
+my $yourself; # allows for quickly limiting to oneself
+
+# ------------------------------------------ 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=<
@@ -69,69 +152,89 @@ my $advancedviewselect=<
END
-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'}));
-
- $r->content_type('text/html');
- $r->send_http_header;
- return OK if $r->header_only;
-
- %metadatafields=();
-
- my $hidden='';
- $hidden=<
-END
-
- $closebutton=<
-END
-
-# ------------------------------------------------ First, check out environment
- $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
-
+# ----------------------------------------------------------------------- BEGIN
+sub BEGIN {
# --------------------------------- Compute various listings of metadata values
-
- %language=();
$language{'any'}='Any language';
{
- my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');
+ my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
+ '/language.tab');
map {
$_=~/(\w+)\s+([\w\s\-]+)/; chomp;
$language{$1}=$2;
} <$fh>;
}
-
- %cprtag=();
$cprtag{'any'}='Any copyright/distribution';
{
- my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');
+ my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonIncludes'}.
+ '/copyright.tab');
map {
$_=~/(\w+)\s+([\w\s\-]+)/; chomp;
$cprtag{$1}=$2;
} <$fh>;
}
-
- %mimetag=();
$mimetag{'any'}='Any type';
{
- my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');
+ 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>;
+ }
+}
+
+# ----------------------------- Handling routine called via Apache and mod_perl
+sub handler {
+ my $r = shift;
+
+ &get_unprocessed_cgi();
+ $r->content_type('text/html');
+ $r->send_http_header;
+ return OK if $r->header_only;
+
+# ----------------------------------- configure dynamic components of interface
+ my $hidden='';
+ if ($ENV{'form.catalogmode'} eq 'interactive') {
+ $hidden="".
+ "\n";
+ $closebutton=""."\n";
+ }
+ elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ $hidden=<
+END
+ $closebutton=<
+END
+ $importbutton=<
+END
+ }
+
+# ------------------------------------------------------ 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
+
+# ----------------------------------- See if a search invocation should be done
if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
return &basicsearch($r,\%ENV);
}
@@ -139,6 +242,7 @@ END
return &advancedsearch($r,\%ENV);
}
+# ----------------------------- Else, begin building search interface to output
$scrout=''; # building a part of screen output
$scrout.=&searchphrasefield('Limit by title','title',
$ENV{'form.title'});
@@ -155,8 +259,8 @@ END
$scrout.=&searchphrasefield('Limit by URL','url',
$ENV{'form.url'});
- $scrout.=&searchphrasefield('Limit by version','version',
- $ENV{'form.version'});
+# $scrout.=&searchphrasefield('Limit by version','version',
+# $ENV{'form.version'});
$scrout.=&searchphrasefield('Limit by notes','notes',
$ENV{'form.notes'});
@@ -179,7 +283,7 @@ END
LIMIT BY CREATION DATE RANGE:
-
+
between:
CREATIONDATESTART
$scrout.=&dateboxes('creationdatestart',1,1,1976,
@@ -201,7 +305,7 @@ CREATIONDATEEND
LIMIT BY LAST REVISION DATE RANGE:
- between:
+ between:
LASTREVISIONDATESTART
$scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
$ENV{'form.lastrevisiondatestart_month'},
@@ -220,7 +324,6 @@ LASTREVISIONDATEEND
$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',
@@ -229,16 +332,27 @@ LASTREVISIONDATEEND
# ------------------------------------------- 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. 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.=<
+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.=' initial users of this system do not need to worry about this option';
+
# ---------------------------------------------------------------- Print screen
$r->print(<
@@ -246,38 +360,38 @@ $scrout.=' initial users of this syst
The LearningOnline Network with CAPA
-
+
Search Catalog
-
-
-
+
+
+
$closebutton
$basicviewselect
-
+
Advanced Search
$scrout
-
-
+
+
$closebutton
$advancedviewselect
@@ -288,18 +402,49 @@ 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') {
+ $ENV{'form.'.$name}=$value;
+ }
+ } (split(/&/,$ENV{'QUERY_STRING'}));
+}
+
+# ------------------------------------------------------------- make persistent
+sub make_persistent {
+ my $persistent='';
+
+ map {
+ if (/^form\./ && !/submit/) {
+ my $name=$_;
+ my $key=$name;
+ $ENV{$key}=~s/\'//g; # do not mess with html field syntax
+ $name=~s/^form\.//;
+ $persistent.=<
+END
+ }
+ } (keys %ENV);
+ return $persistent;
+}
+
# --------------------------------------------------------- Various form fields
sub simpletextfield {
my ($name,$value)=@_;
- return '';
+ return '';
}
sub simplecheckbox {
my ($name,$value)=@_;
my $checked='';
$checked="CHECKED" if $value eq 'on';
- return '';
+ return '';
}
sub searchphrasefield {
@@ -310,8 +455,8 @@ as AND or OR.
END
my $uctitle=uc($title);
return "\n
$uctitle:".
- " $instruction ".
- '';
+ " $instruction ".
+ '';
}
sub dateboxes {
@@ -462,9 +607,9 @@ sub selectbox {
my ($title,$name,$value,%options)=@_;
my $uctitle=uc($title);
my $selout="\n
END
@@ -839,12 +1304,13 @@ sub summary_view {
my ($title,$author,$subject,$url,$keywords,$version,
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
- $hostname,$httphost)=@_;
+ $hostname,$httphost,$extrashow)=@_;
my $result=<$author
$title
$owner -- $lastrevisiondate
$cprtag{$copyright}
+$extrashow
END
return $result;
@@ -855,7 +1321,7 @@ sub fielded_format_view {
my ($title,$author,$subject,$url,$keywords,$version,
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
- $hostname,$httphost)=@_;
+ $hostname,$httphost,$extrashow)=@_;
my $result=<URL: $url
@@ -872,6 +1338,7 @@ sub fielded_format_view {
Copyright/Distribution: $cprtag{$copyright} Repository Location: $hostname Abstract: $shortabstract
+$extrashow
END
return $result;
@@ -882,7 +1349,7 @@ sub xml_sgml_view {
my ($title,$author,$subject,$url,$keywords,$version,
$notes,$shortabstract,$mime,$lang,
$creationdate,$lastrevisiondate,$owner,$copyright,
- $hostname,$httphost)=@_;
+ $hostname,$httphost,$extrashow)=@_;
my $result=<
<LonCapaResource>
@@ -911,72 +1378,61 @@ sub xml_sgml_view {
<shortabstract>$shortabstract</shortabstract>
</LonCapaResource>
+$extrashow
END
return $result;
}
-sub build_date_queries {
- my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
- $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
- my @queries;
- if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {
- unless ($cmonth1 and $cday1 and $cyear1 and
- $cmonth2 and $cday2 and $cyear2) {
- return "Incorrect entry for the creation date. You must specify ".
- "a starting month, day, and year and an ending month, ".
- "day, and year.";
- }
- my $cnumeric1="$cyear1$cmonth1$cday1";
- $cnumeric1+=0;
- my $cnumeric2="$cyear2$cmonth2$cday2";
- $cnumeric2+=0;
- if ($cnumeric1>$cnumeric2) {
- return "Incorrect entry for the creation date. The starting ".
- "date must occur before the ending date.";
- }
- my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".
- "$cyear2-$cmonth2-$cday2 23:59:59')";
- push @queries,$cquery;
- }
- if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {
- unless ($lmonth1 and $lday1 and $lyear1 and
- $lmonth2 and $lday2 and $lyear2) {
- return "Incorrect entry for the last revision date. You must ".
- "specify a starting month, day, and year and an ending ".
- "month, day, and year.";
- }
- my $lnumeric1="$lyear1$lmonth1$lday1";
- $lnumeric1+=0;
- my $lnumeric2="$lyear2$lmonth2$lday2";
- $lnumeric2+=0;
- if ($lnumeric1>$lnumeric2) {
- return "Incorrect entry for the last revision date. The ".
- "starting date must occur before the ending date.";
- }
- my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".
- "$lyear2-$lmonth2-$lday2 23:59:59')";
- push @queries,$lquery;
+# ---------------------------------------------------- see if a field is filled
+sub filled {
+ my ($field)=@_;
+ if ($field=~/\S/ && $field ne 'any') {
+ return 1;
}
- if (@queries) {
- return join(" AND ",@queries);
+ else {
+ return 0;
}
- return '';
}
+# ---------------- Message to output when there are not enough fields filled in
+sub output_blank_field_error {
+ my ($r)=@_;
+ # make query information persistent to allow for subsequent revision
+ my $persistent=&make_persistent();
+
+ $r->print(<
+
+The LearningOnline Network with CAPA
+BEGINNING
+ $r->print(<
+
+
+
Search Catalog
+
+$persistent
+
+$closebutton
+
+
Helpful Message
+
+Incorrect search query due to blank entry fields.
+You need to fill in the relevant
+fields on the search page in order for a query to be
+processed.
+
+
+
+RESULTS
+}
+
+# ----------------------------------------------------------- Output date error
sub output_date_error {
my ($r,$message)=@_;
# make query information persistent to allow for subsequent revision
- my $persistent='';
- map {
- if (/^form\./ && !/submit/) {
- my $name=$_;
- my $key=$name;
- $name=~s/^form\.//;
- $persistent.=<
-END
- }
- } (keys %ENV);
+ my $persistent=&make_persistent();
$r->print(<
@@ -986,14 +1442,14 @@ BEGINNING
$r->print(<
-
+