--- loncom/interface/lonsearchcat.pm 2001/03/12 17:28:32 1.7
+++ loncom/interface/lonsearchcat.pm 2001/08/16 02:20:01 1.97
@@ -1,8 +1,59 @@
# The LearningOnline Network
# 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
#
+# Functions
+#
+# 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(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
+# 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_custommetadata_query(field_name, logic_statement) : builds a perl
+# regular expression from a logical expression with AND/OR
+# keywords
+# detailed_citation_view, summary_view, fielded_format_view, xml_sgml_view:
+# four different ways to view metadata records. Outputs 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.
+# 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.
+# output_date_error(server reference, error message) : outputs
+# an error message specific to bad date format.
+# make_persistent() : makes a set of hidden HTML fields to make
+# SQL search interface information to be persistent
+
package Apache::lonsearchcat;
use strict;
@@ -10,13 +61,39 @@ use Apache::Constants qw(:common);
use Apache::lonnet();
use Apache::File();
use CGI qw(:standard);
+use Text::Query;
+# ---------------------------------------- variables used throughout the module
my %language;
my $scrout;
my %metadatafields;
my %cprtag;
my %mimetag;
+my $closebutton;
+
+# ------ form selection elements that allow for choosing different output views
+# Detailed Citation View ---> sub detailed_citationview
+# Summary View ---> sub summary_view
+# Fielded Format ---> sub fielded_format_view
+# XML/SGML ---> sub xml_sgml_view
+my $basicviewselect=<
-between:
-
-
-and:
-
-
-
$title:
".
- '';
+sub simpletextfield {
+ my ($name,$value)=@_;
+ return '';
+}
+
+sub simplecheckbox {
+ my ($name,$value)=@_;
+ my $checked='';
+ $checked="CHECKED" if $value eq 'on';
+ return '';
}
sub searchphrasefield {
@@ -702,8 +350,152 @@ as AND or OR.
END
my $uctitle=uc($title);
return "\n
$uctitle:".
- ": $instruction $uctitle:".
"
".
- '';
+ " $instruction
".
+ '';
+}
+
+sub dateboxes {
+ my ($name,$defaultmonth,$defaultday,$defaultyear,
+ $currentmonth,$currentday,$currentyear)=@_;
+ ($defaultmonth,$defaultday,$defaultyear)=('','','');
+ my $month=<
".'';
}
+# ----------------------------------------------- Performing an advanced search
+sub advancedsearch {
+ my ($r,$envhash)=@_;
+ my %ENV=%{$envhash};
+
+ my $fillflag=0;
+ # Clean up fields for safety
+ for my $field ('title','author','subject','keywords','url','version',
+ 'creationdatestart_month','creationdatestart_day',
+ 'creationdatestart_year','creationdateend_month',
+ 'creationdateend_day','creationdateend_year',
+ 'lastrevisiondatestart_month','lastrevisiondatestart_day',
+ 'lastrevisiondatestart_year','lastrevisiondateend_month',
+ 'lastrevisiondateend_day','lastrevisiondateend_year',
+ 'notes','abstract','mime','language','owner',
+ 'custommetadata','customshow') {
+ $ENV{"form.$field"}=~s/[^\w\s\(\)\=\-\"\']//g;
+ }
+
+ # Check to see if enough information was filled in
+ for my $field ('title','author','subject','keywords','url','version',
+ 'notes','abstract','mime','language','owner',
+ 'custommetadata') {
+ if (&filled($ENV{"form.$field"})) {
+ $fillflag++;
+ }
+ }
+ unless ($fillflag) {
+ &output_blank_field_error($r);
+ return OK;
+ }
+
+
+ # Turn the form input into a SQL-based query
+ my $query='';
+
+ my @queries;
+ # Evaluate logical expression AND/OR/NOT phrase fields.
+ foreach my $field ('title','author','subject','notes','abstract','url',
+ 'keywords','version','owner') {
+ if ($ENV{'form.'.$field}) {
+ push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
+ }
+ }
+ # Evaluate option lists
+ if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
+ push @queries,"(language like \"$ENV{'form.language'}\")";
+ }
+ if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
+ push @queries,"(mime like \"$ENV{'form.mime'}\")";
+ }
+ if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
+ push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
+ }
+ # Evaluate date windows
+ my $datequery=&build_date_queries(
+ $ENV{'form.creationdatestart_month'},
+ $ENV{'form.creationdatestart_day'},
+ $ENV{'form.creationdatestart_year'},
+ $ENV{'form.creationdateend_month'},
+ $ENV{'form.creationdateend_day'},
+ $ENV{'form.creationdateend_year'},
+ $ENV{'form.lastrevisiondatestart_month'},
+ $ENV{'form.lastrevisiondatestart_day'},
+ $ENV{'form.lastrevisiondatestart_year'},
+ $ENV{'form.lastrevisiondateend_month'},
+ $ENV{'form.lastrevisiondateend_day'},
+ $ENV{'form.lastrevisiondateend_year'},
+ );
+ # Test to see if date windows are legitimate
+ if ($datequery=~/^Incorrect/) {
+ &output_date_error($r,$datequery);
+ return OK;
+ }
+ elsif ($datequery) {
+ push @queries,$datequery;
+ }
+
+ # Process form information for custom metadata querying
+ my $customquery='';
+ if ($ENV{'form.custommetadata'}) {
+ $customquery=&build_custommetadata_query('custommetadata',
+ $ENV{'form.custommetadata'});
+ }
+ my $customshow='';
+ if ($ENV{'form.customshow'}) {
+ $customshow=$ENV{'form.customshow'};
+ $customshow=~s/[^\w\s]//g;
+ my @fields=split(/\s+/,$customshow);
+ $customshow=join(" ",@fields);
+ }
+ # Send query statements over the network to be processed by either the SQL
+ # database or a recursive scheme of 'grep'-like actions (for custom
+ # metadata).
+ if (@queries) {
+ $query=join(" AND ",@queries);
+ $query="select * from metadata where $query";
+ my $reply; # reply hash reference
+ unless ($customquery or $customshow) {
+ $reply=&Apache::lonnet::metadata_query($query);
+ }
+ else {
+ $reply=&Apache::lonnet::metadata_query($query,
+ $customquery,$customshow);
+ }
+ &output_results('Advanced',$r,$envhash,$customquery,$reply);
+ }
+ elsif ($customquery) {
+ my $reply; # reply hash reference
+ $reply=&Apache::lonnet::metadata_query('',
+ $customquery,$customshow);
+ &output_results('Advanced',$r,$envhash,$customquery,$reply);
+ }
+ # should not get to this point
+ return 'Error. Should not have gone to this point.';
+}
+
+# ---------------------------------------------------- see if a field is filled
+sub filled {
+ my ($field)=@_;
+ if ($field=~/\S/ && $field ne 'any') {
+ return 1;
+ }
+ else {
+ return 0;
+ }
+}
+
# --------------------------------------------------- Performing a basic search
sub basicsearch {
- my ($r,$expression)=@_;
+ my ($r,$envhash)=@_;
+ my %ENV=%{$envhash};
- my $query=$expression;
-# $query="select * from metadata where concat(title,':\@:',author) like '\%Sci\%'";
- $query="select * from metadata where concat(title,\" \",author) like '\%$expression\%'";
-# my $reply=&Apache::lonnet::reply("querysend:DESCRIBE metadata","msul3");
- my $reply=&Apache::lonnet::reply("querysend:$query",'msul3');
-# my $reply=&Apache::lonnet::reply('querysend:select * from metadata','msul3');
-
- my @results;
-
- my $replyfile='';
- $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting
- $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
- $reply=~/(.*?)\_/;
- my $hostname=$1;
+ # Clean up fields for safety
+ for my $field ('basicexp') {
+ $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
+ }
- {
- while (1) {
- last if -e $replyfile;
- sleep 1;
- }
- # QUESTION: how should I handle this error condition..
- # I'm sure there is syntax elsewhere I can use..
- my $fh=Apache::File->new($replyfile) or
- ($r->print('file cannot be opened') and return OK);
- @results=<$fh>;
+ # Check to see if enough is filled in
+ unless (&filled($ENV{'form.basicexp'})) {
+ &output_blank_field_error($r);
+ return OK;
}
+ # Build SQL query string based on form page
+ my $query='';
+ my $concatarg=join('," ",',
+ ('title', 'author', 'subject', 'notes', 'abstract'));
+ $concatarg='title' if $ENV{'form.titleonly'};
+
+ $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'});
+
+
+ # Get reply (either a hash reference to filehandles or bad connection)
+ my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query);
+
+ # Output search results
+ &output_results('Basic',$r,$envhash,$query,$reply);
+
+ return OK;
+}
+
+# ---------------- 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(<Search Catalog
+
-Title: $title
-Author(s): $author
Subject: $subject
-Keyword(s): not available yet
+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
+Copyright/Distribution: $cprtag{$copyright}
+
+$shortabstract
END + return $result; } - unless ($compiledresult) { - $compiledresult="There were no results that matched your query"; +# ---------------------------------------------------------------- Summary View +sub summary_view { + my ($title,$author,$subject,$url,$keywords,$version, + $notes,$shortabstract,$mime,$lang, + $creationdate,$lastrevisiondate,$owner,$copyright, + $hostname,$httphost,$extrashow)=@_; + my $result=<