version 1.101, 2001/10/16 17:12:51
|
version 1.107, 2001/11/28 19:30:32
|
Line 3
|
Line 3
|
# Search Catalog |
# Search Catalog |
# |
# |
# YEAR=2001 |
# YEAR=2001 |
# 03/08/2001 Scott Harrison |
# 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison |
# Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001 |
# 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison |
# Scott Harrison: 03/20/2001, 03/21/2001, 03/22/2001, 03/26/2001, 03/27/2001 |
# 10/12,10/14,10/15,10/16,11/28 Scott Harrison |
# Scott Harrison: 04/02/2001, 08/15/2001, 08/24/2001, 08/25/2001 |
# |
# 10/12,10/14,10/15 Scott Harrison |
# $Id$ |
|
### |
|
|
############################################################################### |
############################################################################### |
## ## |
## ## |
## ORGANIZATION OF THIS PERL MODULE ## |
## ORGANIZATION OF THIS PERL MODULE ## |
## ## |
## ## |
## 1. Description of functions ## |
## 1. Modules used by this module ## |
## 2. Modules used by this module ## |
## 2. Choices for different output views (detailed, summary, xml, etc) ## |
## 3. Choices for different output views (detailed, summary, xml, etc) ## |
## 3. BEGIN block (to be run once after compilation) ## |
## 4. BEGIN block (to be run once after compilation) ## |
## 4. Handling routine called via Apache and mod_perl ## |
## 5. Handling routine called via Apache and mod_perl ## |
## 5. Other subroutines ## |
## 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; |
package Apache::lonsearchcat; |
|
|
# ------------------------------------------------- modules used by this module |
# ------------------------------------------------- modules used by this module |
Line 203 my $domain = "";
|
Line 123 my $domain = "";
|
# ----------------------------- Handling routine called via Apache and mod_perl |
# ----------------------------- Handling routine called via Apache and mod_perl |
sub handler { |
sub handler { |
my $r = shift; |
my $r = shift; |
|
untie %hash; |
&get_unprocessed_cgi(); |
&get_unprocessed_cgi(); |
|
|
$r->content_type('text/html'); |
$r->content_type('text/html'); |
Line 212 sub handler {
|
Line 132 sub handler {
|
|
|
$domain = $r->dir_config('lonDefDomain'); |
$domain = $r->dir_config('lonDefDomain'); |
|
|
$diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; |
$diropendb= "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_searchcat.db"; |
|
|
if ($ENV{'form.launch'} eq '1') { |
if ($ENV{'form.launch'} eq '1') { |
if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { |
if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { |
Line 917 sub output_results {
|
Line 837 sub output_results {
|
my %ENV=%{$envhash}; |
my %ENV=%{$envhash}; |
my %rhash=%{$replyref}; |
my %rhash=%{$replyref}; |
my $compiledresult=''; |
my $compiledresult=''; |
my $timeremain=30; |
my $timeremain=300; |
my $elapsetime=0; |
my $elapsetime=0; |
my $resultflag=0; |
my $resultflag=0; |
my $tflag=1; |
my $tflag=1; |
Line 982 SCRIPT
|
Line 902 SCRIPT
|
'scrollbars=1,width=400,height=300'); |
'scrollbars=1,width=400,height=300'); |
openhelpwin.focus(); |
openhelpwin.focus(); |
} |
} |
|
function abortsearch(val) { |
|
openhelpwin=open('/adm/help/searchcat.html','helpscreen', |
|
'scrollbars=1,width=400,height=300'); |
|
openhelpwin.focus(); |
|
} |
</script> |
</script> |
SCRIPT |
SCRIPT |
$r->rflush(); |
$r->rflush(); |
Line 1090 RESULTS
|
Line 1015 RESULTS
|
'<'+'br />'+ |
'<'+'br />'+ |
' <'+'input type="button" name="button"'+ |
' <'+'input type="button" name="button"'+ |
' value="abort search and view current results" '+ |
' value="abort search and view current results" '+ |
' />'+ |
' onClick="javascript:opener.abortsearch()" />'+ |
' <'+'input type="button" name="button"'+ |
' <'+'input type="button" name="button"'+ |
' value="help" onClick="javascript:opener.openhelp()" />'+ |
' value="help" onClick="javascript:opener.openhelp()" />'+ |
'<'+'/tt>'+ |
'<'+'/tt>'+ |
Line 1102 ENDPOP
|
Line 1027 ENDPOP
|
$r->rflush(); |
$r->rflush(); |
|
|
my $servercount=0; |
my $servercount=0; |
$sn=0; |
|
my $hitcountsum=0; |
my $hitcountsum=0; |
foreach my $rkey (sort keys %rhash) { |
my $bloop=$servernum; |
|
my %orkey; |
|
BLOOP: while(1) { |
|
my $sn=0; |
|
last BLOOP unless $bloop; |
|
last BLOOP unless $timeremain; |
|
RLOOP: foreach my $rkey (sort keys %rhash) { |
$sn++; |
$sn++; |
|
next RLOOP if $orkey{$rkey}; |
$servercount++; |
$servercount++; |
$tflag=1; |
$tflag=1; |
$compiledresult=''; |
$compiledresult=''; |
Line 1121 ENDPOP
|
Line 1052 ENDPOP
|
'src="/adm/lonIcons/srvbad.gif";</script>'. |
'src="/adm/lonIcons/srvbad.gif";</script>'. |
"\n"); |
"\n"); |
$r->rflush(); |
$r->rflush(); |
|
$bloop--; |
|
$orkey{$rkey}=1; |
} |
} |
else { |
else { |
$reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting |
$reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting |
Line 1142 ENDPOP
|
Line 1075 ENDPOP
|
$r->rflush(); |
$r->rflush(); |
$tflag=0; |
$tflag=0; |
} |
} |
last WLOOP if $temp>5; |
|
if (-e "$replyfile.end") { |
if (-e "$replyfile.end") { |
|
$bloop--; |
|
$orkey{$rkey}=1; |
if (-s $replyfile) { |
if (-s $replyfile) { |
$r->print('<script type="text/javascript">'. |
$r->print('<script type="text/javascript">'. |
'popwin.document.img'.$sn.'.'. |
'popwin.document.img'.$sn.'.'. |
Line 1184 ENDPOP
|
Line 1118 ENDPOP
|
} |
} |
last WLOOP; |
last WLOOP; |
} |
} |
|
if ($temp>1) { |
|
sleep 1; |
|
$timeremain--; |
|
$elapsetime++; |
|
last WLOOP; |
|
} |
last WLOOP unless $timeremain; |
last WLOOP unless $timeremain; |
sleep 1; |
sleep 1; |
$timeremain--; |
$timeremain--; |
Line 1242 ENDPOP
|
Line 1182 ENDPOP
|
my ($title,$author,$subject,$url,$keywords,$version, |
my ($title,$author,$subject,$url,$keywords,$version, |
$notes,$abstract,$mime,$lang, |
$notes,$abstract,$mime,$lang, |
$creationdate,$lastrevisiondate,$owner,$copyright)=@fields; |
$creationdate,$lastrevisiondate,$owner,$copyright)=@fields; |
|
|
|
unless ($ENV{'user.adv'}) { |
|
$keywords='<i>- not displayed -</i>'; |
|
$fields[4]=$keywords; |
|
$notes='<i>- not displayed -</i>'; |
|
$fields[6]=$notes; |
|
$abstract='<i>- not displayed -</i>'; |
|
$fields[7]=$abstract; |
|
$subject='<i>- not displayed -</i>'; |
|
$fields[2]=$subject; |
|
} |
|
|
my $shortabstract=$abstract; |
my $shortabstract=$abstract; |
$shortabstract=substr($abstract,0,200) if length($abstract)>200; |
$shortabstract=substr($abstract,0,200).'...' if length($abstract)>200; |
$fields[7]=$shortabstract; |
$fields[7]=$shortabstract; |
|
my $shortkeywords=$keywords; |
|
$shortkeywords=substr($keywords,0,200).'...' if length($keywords)>200; |
|
$fields[4]=$shortkeywords; |
|
|
my $extrashow2=$extrashow; |
my $extrashow2=$extrashow; |
if ($extrashow) { |
if ($extrashow) { |
foreach my $field (@customfields) { |
foreach my $field (@customfields) { |
Line 1268 onClick="javascript:select_data('$title'
|
Line 1224 onClick="javascript:select_data('$title'
|
</font> |
</font> |
<br /> |
<br /> |
END |
END |
$hash{"HELLOWORLD"}='123'; |
|
if ($ENV{'form.catalogmode'} eq 'groupsearch') { |
if ($ENV{'form.catalogmode'} eq 'groupsearch') { |
$fnum+=0; |
$fnum+=0; |
$hash{"pre_${fnum}_link"}=$url; |
$hash{"pre_${fnum}_link"}=$url; |
Line 1328 $compiledresult
|
Line 1283 $compiledresult
|
RESULTS |
RESULTS |
my $percent=sprintf('%3.0f',($servercount/$servernum*100)); |
my $percent=sprintf('%3.0f',($servercount/$servernum*100)); |
} |
} |
|
} |
unless ($resultflag) { |
unless ($resultflag) { |
$r->print("\nThere were no results that matched your query\n"); |
$r->print("\nThere were no results that matched your query\n"); |
} |
} |
Line 1525 $message
|
Line 1481 $message
|
RESULTS |
RESULTS |
} |
} |
|
|
# --------- settings whenever the user causes the indexer window to be launched |
# --------- settings whenever the user causes the search window to be launched |
sub start_fresh_session { |
sub start_fresh_session { |
delete $hash{'mode_catalog'}; |
delete $hash{'mode_catalog'}; |
map { |
map { |
Line 1541 sub start_fresh_session {
|
Line 1497 sub start_fresh_session {
|
1; |
1; |
|
|
__END__ |
__END__ |
|
|
|
=head1 NAME |
|
|
|
Apache::lonsearchcat - mod_perl module for handling a searchable catalog |
|
|
|
=head1 SYNOPSIS |
|
|
|
Invoked by /etc/httpd/conf/srm.conf: |
|
|
|
<Location /adm/searchcat> |
|
PerlAccessHandler Apache::lonacc |
|
SetHandler perl-script |
|
PerlHandler Apache::lonsearchcat |
|
ErrorDocument 403 /adm/login |
|
ErrorDocument 500 /adm/errorhandler |
|
</Location> |
|
|
|
=head1 INTRODUCTION |
|
|
|
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. |
|
|
|
=head1 BEGIN SUBROUTINE |
|
|
|
This routine is only run once after compilation. |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
Initializes %language hash table. |
|
|
|
=item * |
|
|
|
Initializes %cprtag hash table (for copyright.tab). |
|
|
|
=item * |
|
|
|
Initializes %mimetag hash table (for filetypes.tab). |
|
|
|
=item * |
|
|
|
Initializes %hostdomains and hostips hash table (for hosts.tab). |
|
|
|
=back |
|
|
|
=head1 HANDLER SUBROUTINE |
|
|
|
This routine is called by Apache and mod_perl. |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
configure dynamic components of interface |
|
|
|
=item * |
|
|
|
determine current user |
|
|
|
=item * |
|
|
|
see if a search invocation should be done |
|
|
|
=item * |
|
|
|
else, begin building search interface to output |
|
|
|
=item * |
|
|
|
compute date selection boxes |
|
|
|
=item * |
|
|
|
compute customized metadata field |
|
|
|
=item * |
|
|
|
print screen |
|
|
|
=back |
|
|
|
=head1 OTHER SUBROUTINES |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
get_unprocessed_cgi() : reads in critical name/value pairs that may have not |
|
been processed and passed into %ENV by the web server |
|
|
|
=item * |
|
|
|
make_persistent() : makes a set of hidden HTML fields to make |
|
SQL search interface information to be persistent |
|
|
|
=back |
|
|
|
WEB INTERFACE COMPONENT FUNCTIONS |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
simpletextfield(name,value) : returns HTML formatted string for simple text |
|
field |
|
|
|
=item * |
|
|
|
simplecheckbox(name,value) : returns HTML formatted string for simple |
|
checkbox |
|
|
|
=item * |
|
|
|
searchphrasefield(title,name,value) : returns HTML formatted string for |
|
a search expression phrase field |
|
|
|
=item * |
|
|
|
dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML |
|
formatted string for a calendar date |
|
|
|
=item * |
|
|
|
selectbox(title,name,value,%HASH=options) : returns HTML formatted string for |
|
a selection box field |
|
|
|
=back |
|
|
|
SEARCH FUNCTIONS |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
advancedsearch(server reference, environment reference) : perform a complex |
|
multi-field logical query |
|
|
|
=item * |
|
|
|
basicsearch(server reference, environment reference) : perform a simple |
|
single-field logical query |
|
|
|
=item * |
|
|
|
build_SQL_query(field name, logic) : builds a SQL query string from a |
|
logical expression with AND/OR keywords |
|
|
|
=item * |
|
|
|
build_custommetadata_query(field_name, logic_statement) : builds a perl |
|
regular expression from a logical expression with AND/OR keywords |
|
|
|
=item * |
|
|
|
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 |
|
|
|
=item * |
|
|
|
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. |
|
|
|
=back |
|
|
|
OUTPUTTING RESULTS FUNCTION |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
output_results(output mode, server reference, environment reference, |
|
reply list reference) : outputs results from search |
|
|
|
=back |
|
|
|
DIFFERENT WAYS TO VIEW METADATA RECORDS |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : |
|
see metadata viewing notes below |
|
|
|
=item * |
|
|
|
summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : |
|
see metadata viewing notes below |
|
|
|
=item * |
|
|
|
fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : |
|
see metadata viewing notes below |
|
|
|
=item * |
|
|
|
xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : |
|
see metadata viewing notes below |
|
|
|
=back |
|
|
|
_____________________________________________________________________ |
|
| * 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 |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
filled(field) : determines whether a given field has been filled |
|
|
|
=back |
|
|
|
ERROR FUNCTIONS |
|
|
|
=over 4 |
|
|
|
=item * |
|
|
|
output_blank_field_error(server reference) : outputs a message saying that |
|
more fields need to be filled in |
|
|
|
=item * |
|
|
|
output_date_error(server reference, error message) : outputs |
|
an error message specific to bad date format. |
|
|
|
=back |
|
|
|
=cut |