--- loncom/interface/lonsearchcat.pm 2001/03/08 16:54:20 1.4
+++ loncom/interface/lonsearchcat.pm 2001/08/28 12:12:38 1.100
@@ -1,645 +1,408 @@
-# 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, 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
+#
+#
+# === 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
+# 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
+#
+#
+# === SEARCH FUNCTIONS
+# advancedsearch(server reference, environment reference) : perform a complex
+# multi-field logical query
+# basicsearch(server reference, environment reference) : perform a simple
+# single-field logical query
+# 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();
+use Apache::File();
+use CGI qw(:standard);
+use Text::Query;
+
+# ---------------------------------------- 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=<
+
+
+
+
+
+END
+my $advancedviewselect=<
+
+
+
+
+
+END
-my %language;
-my $scrout;
-my %metadatafields;
-my %cprtag;
-my %mimetag;
-
-sub handler {
- my $r = shift;
- $r->content_type('text/html');
- $r->send_http_header;
- return OK if $r->header_only;
-
- %metadatafields=();
-
-# ------------------------------------------------ First, check out environment
- $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
-
-
- %language=();
+# ----------------------------------------------------------------------- BEGIN
+sub BEGIN {
+# --------------------------------- Compute various listings of metadata values
$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\-]+)/;
+ $_=~/(\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\-]+)/;
+ $_=~/(\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\-]+)/;
+ $_=~/(\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);
+ }
+ elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
+ return &advancedsearch($r,\%ENV);
+ }
- $scrout="";
+# ----------------------------- Else, begin building search interface to output
+ $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'});
$scrout.=&searchphrasefield('Limit by subject','subject',
- '');
+ $ENV{'form.subject'});
+
+ $scrout.=&searchphrasefield('Limit by keywords','keywords',
+ $ENV{'form.keywords'});
+
+ $scrout.=&searchphrasefield('Limit by URL','url',
+ $ENV{'form.url'});
+
+# $scrout.=&searchphrasefield('Limit by version','version',
+# $ENV{'form.version'});
$scrout.=&searchphrasefield('Limit by notes','notes',
- '');
+ $ENV{'form.notes'});
$scrout.=&searchphrasefield('Limit by abstract','abstract',
- '');
+ $ENV{'form.abstract'});
+ $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});
$scrout.=&selectbox('Limit by MIME type','mime',
- 'notxxx',%mimetag);
+ $ENV{'form.mime'},%mimetag);
+
+ $ENV{'form.language'}='any' unless length($ENV{'form.language'});
$scrout.=&selectbox('Limit by language','language',
- 'any',%language);
+ $ENV{'form.language'},%language);
- $scrout.=<LIMIT BY CREATION DATE RANGE:
-
-between:
-
-
-and:
-
-
-
+
+between:
+CREATIONDATESTART
+ $scrout.=&dateboxes('creationdatestart',1,1,1976,
+ $ENV{'form.creationdatestart_month'},
+ $ENV{'form.creationdatestart_day'},
+ $ENV{'form.creationdatestart_year'},
+ );
+ $scrout.=<";
- $scrout.=<LIMIT BY LAST REVISION DATE RANGE:
- between:
-
-
-and:
-
-
-
+ between:
+LASTREVISIONDATESTART
+ $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
+ $ENV{'form.lastrevisiondatestart_month'},
+ $ENV{'form.lastrevisiondatestart_day'},
+ $ENV{'form.lastrevisiondatestart_year'},
+ );
+ $scrout.=<';
$scrout.=&searchphrasefield('Limit by publisher/owner','owner',
- $metadatafields{'owner'});
+ $ENV{'form.owner'});
+ $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
$scrout.=&selectbox('Limit by copyright/distribution','copyright',
- 'any',%cprtag);
+ $ENV{'form.copyright'},%cprtag);
+
+# ------------------------------------------- Compute customized metadata field
+ $scrout.=<
+LIMIT BY SPECIAL METADATA FIELDS:
+
+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';
+
+ $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(<The LearningOnline Network with CAPA
+
+
Search Catalog
-
@@ -648,38 +411,1077 @@ 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 textfield {
- my ($title,$name,$value)=@_;
- return "\n