--- loncom/interface/lonsearchcat.pm 2003/12/16 15:00:56 1.195
+++ loncom/interface/lonsearchcat.pm 2004/04/19 17:44:47 1.211
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.195 2003/12/16 15:00:56 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.211 2004/04/19 17:44:47 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -48,7 +48,7 @@ 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.
+search (on a server basis) is displayed to the user in a separate window.
=head1 Internals
@@ -59,20 +59,8 @@ search (on a server basis) is displayed
###############################################################################
###############################################################################
-###############################################################################
-## ##
-## 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 :http);
use Apache::lonnet();
@@ -82,103 +70,49 @@ use Text::Query;
use GDBM_File;
use Apache::loncommon();
use Apache::lonmysql();
+use Apache::lonmeta;
+use Apache::lonhtmlcommon;
use Apache::lonlocal;
-
-# ---------------------------------------- variables used throughout the module
-
-######################################################################
-######################################################################
-
-=pod
-
-=item Global variables
-
-=over 4
-
-=item $importbutton
-
-button to take the select results and go to group sorting
-
-=item %groupsearch_db
-
-Database hash used to save values for the groupsearch RAT interface.
-
-=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().
-
-=item %Views
-
-Hash which associates an output view description with the function
-that produces it. Adding a new view type should be as easy as
-adding a line to the definition of this hash and making sure the function
-takes the proper parameters.
-
-=item $bodytag
-
-LON-CAPA standard body tag, gotten from &Apache::lonnet::bodytag.
-No title, no table, just a
tag.
-
-=back
-
-=cut
+use LONCAPA::lonmetadata();
######################################################################
######################################################################
-
-# -- dynamically rendered interface components
-my $importbutton; # button to take the selected results and go to group sorting
-
-# -- miscellaneous variables
-my %groupsearch_db; # database hash
-my $diropendb = ""; # db file
-# View Description Function Pointer
-my %Views = ("Detailed Citation View" => \&detailed_citation_view,
- "Summary View" => \&summary_view,
- "Fielded Format" => \&fielded_format_view,
- "XML/SGML" => \&xml_sgml_view,
- "Compact View" => \&compact_view);
-my %persistent_db;
-my $hidden_fields;
-my $bodytag;
-
-#
-# For course search
-#
-my %alreadyseen;
-my $hashtied;
-my %hash;
-my $totalfound;
-
+##
+## Global variables
+##
######################################################################
######################################################################
+my %groupsearch_db; # Database hash used to save values for the
+ # groupsearch RAT interface.
+my %persistent_db; # gdbm hash which holds data which is supposed to
+ # persist across calls to lonsearchcat.pm
-=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
+# The different view modes and associated functions
-=back
-
-=cut
+my %Views = ("detailed" => \&detailed_citation_view,
+ "summary" => \&summary_view,
+ "fielded" => \&fielded_format_view,
+ "xml" => \&xml_sgml_view,
+ "compact" => \&compact_view);
######################################################################
######################################################################
sub handler {
my $r = shift;
+# &set_defaults();
#
+ # set form defaults
+ #
+ my $hidden_fields;# Hold all the hidden fields used to keep track
+ # of the search system state
+ my $importbutton; # button to take the selected results and go to group
+ # sorting
+ my $diropendb; # The full path to the (temporary) search database file.
+ # This is set and used in &handler() and is also used in
+ # &output_results().
+ my $bodytag; # LON-CAPA standard body tag, gotten from
+ # &Apache::lonnet::bodytag.
+ # No title, no table, just a tag.
my $loaderror=&Apache::lonnet::overloaderror($r);
if ($loaderror) { return $loaderror; }
@@ -230,6 +164,25 @@ sub handler {
'_'.&Apache::lonnet::escape($ENV{'user.name'}).
'_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
##
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ if (exists($ENV{'request.course.id'}) && $ENV{'request.course.id'} ne '') {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?'.
+ 'catalogmode='.$ENV{'form.catalogmode'}.
+ '&launch='.$ENV{'form.launch'}.
+ '&mode='.$ENV{'form.mode'},
+ text=>"Course and Catalog Search",
+ bug=>'Searching',});
+ } else {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?'.
+ 'catalogmode='.$ENV{'form.catalogmode'}.
+ '&launch='.$ENV{'form.launch'}.
+ '&mode='.$ENV{'form.mode'},
+ text=>"Catalog Search",
+ bug=>'Searching',});
+ }
+ #
if (! &get_persistent_form_data($persistent_db_file)) {
if ($ENV{'form.phase'} =~ /(run_search|results)/) {
&Apache::lonnet::logthis("lonsearchcat:Unable to recover data ".
@@ -330,15 +283,41 @@ END
}
$ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'}));
$ENV{'form.show'} = 20 if (! exists($ENV{'form.show'}));
+ #
+ $ENV{'form.searchmode'} = 'basic';
+ if ($ENV{'form.phase'} eq 'adv_search' ||
+ $ENV{'form.phase'} eq 'disp_adv') {
+ $ENV{'form.searchmode'} = 'advanced';
+ } elsif ($ENV{'form.phase'} eq 'course_search') {
+ $ENV{'form.searchmode'} = 'course_search';
+ }
+ #
+ if ($ENV{'form.searchmode'} eq 'advanced') {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?phase=disp_adv&'.
+ 'catalogmode='.$ENV{'form.catalogmode'}.
+ '&launch='.$ENV{'form.launch'}.
+ '&mode='.$ENV{'form.mode'},
+ text=>"Advanced Search",
+ bug=>'Searching',});
+ } elsif ($ENV{'form.searchmode'} eq 'course search') {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?phase=disp_adv&'.
+ 'catalogmode='.$ENV{'form.catalogmode'}.
+ '&launch='.$ENV{'form.launch'}.
+ '&mode='.$ENV{'form.mode'},
+ text=>"Course Search",
+ bug=>'Searching',});
+ }
##
## Switch on the phase
##
if ($ENV{'form.phase'} eq 'disp_basic') {
- &print_basic_search_form($r,$closebutton);
+ &print_basic_search_form($r,$closebutton,$hidden_fields);
} elsif ($ENV{'form.phase'} eq 'disp_adv') {
- &print_advanced_search_form($r,$closebutton);
+ &print_advanced_search_form($r,$closebutton,$hidden_fields);
} elsif ($ENV{'form.phase'} eq 'results') {
- &display_results($r,$importbutton,$closebutton);
+ &display_results($r,$importbutton,$closebutton,$diropendb);
} elsif ($ENV{'form.phase'} =~ /^(sort|run_search)$/) {
my ($query,$customquery,$customshow,$libraries,$pretty_string) =
&get_persistent_data($persistent_db_file,
@@ -354,12 +333,12 @@ END
&course_search($r);
} elsif(($ENV{'form.phase'} eq 'basic_search') ||
($ENV{'form.phase'} eq 'adv_search')) {
- $ENV{'form.searchmode'} = 'basic';
- if ($ENV{'form.phase'} eq 'adv_search') {
- $ENV{'form.searchmode'} = 'advanced';
- }
# Set up table
if (! defined(&create_results_table())) {
+ my $errorstring=&Apache::lonmysql::get_error();
+ &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
+ 'needed table. lonmysql error:'.
+ $errorstring);
$r->print(<Search Error
$bodytag
@@ -388,10 +367,10 @@ END
my $pretty_string;
if ($ENV{'form.phase'} eq 'basic_search') {
($query,$pretty_string,$libraries) =
- &parse_basic_search($r,$closebutton);
+ &parse_basic_search($r,$closebutton,$hidden_fields);
} else { # Advanced search
($query,$customquery,$customshow,$libraries,$pretty_string)
- = &parse_advanced_search($r,$closebutton);
+ = &parse_advanced_search($r,$closebutton,$hidden_fields);
return OK if (! defined($query));
}
&make_persistent({ query => $query,
@@ -410,40 +389,54 @@ END
######################################################################
######################################################################
+##
+## Course Search
+##
+######################################################################
+######################################################################
+{ # Scope the course search to avoid global variables
+#
+# Variables For course search
+my %alreadyseen;
+my %hash;
+my $totalfound;
sub course_search {
my $r=shift;
- my $bodytag=&Apache::loncommon::bodytag('Course Search');
+ my $bodytag=&Apache::loncommon::bodytag('Course Search').
+ &Apache::loncommon::help_open_bug('Searching');
my $pretty_search_string = ''.$ENV{'form.courseexp'}.'';
my $search_string = $ENV{'form.courseexp'};
my @New_Words;
if ($ENV{'form.crsrelated'}) {
($search_string,@New_Words) = &related_version($ENV{'form.courseexp'});
if (@New_Words) {
- $pretty_search_string .= " with related words: @New_Words.";
+ $pretty_search_string .= ' '.&mt("with related words").": @New_Words.";
} else {
- $pretty_search_string .= " with no related words.";
+ $pretty_search_string .= ' '.&mt('with no related words').".";
}
}
my $fulltext=$ENV{'form.crsfulltext'};
my @allwords=($search_string,@New_Words);
$totalfound=0;
$r->print('LON-CAPA Course Search'.
- $bodytag.$pretty_search_string);
+ $bodytag.'
'.$pretty_search_string.'
');
$r->rflush();
# ======================================================= Go through the course
- $hashtied=0;
- undef %alreadyseen;
- %alreadyseen=();
+ undef %alreadyseen;
+ %alreadyseen=();
my $c=$r->connection;
- &tiehash();
- foreach (keys %hash) {
- if ($c->aborted()) { last; }
- if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
- &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,@allwords);
- }
- }
- &untiehash();
+ if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
+ &GDBM_READER(),0640)) {
+ foreach (keys %hash) {
+ if ($c->aborted()) { last; }
+ if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) {
+ &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,
+ @allwords);
+ }
+ }
+ untie(%hash);
+ }
unless ($totalfound) {
$r->print('
'.&mt('No resources found').'.
');
}
@@ -451,23 +444,6 @@ sub course_search {
$r->print('');
}
-# ---------------------------------------------------------------- tie the hash
-
-sub tiehash {
- $hashtied=0;
- if ($ENV{'request.course.fn'}) {
- if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db",
- &GDBM_READER(),0640)) {
- $hashtied=1;
- }
- }
-}
-
-sub untiehash {
- if ($hashtied) { untie %hash; }
- $hashtied=0;
-}
-
# =============================== This pulls up a resource and its dependencies
sub checkonthis {
@@ -513,24 +489,16 @@ sub checkonthis {
}
}
-######################################################################
-######################################################################
-
-=pod
-
-=item &print_basic_search_form()
-
-Returns a scalar which holds html for the basic search form.
-
-=cut
+sub untiehash {
+ if (tied(%hash)) {
+ untie(%hash);
+ }
+}
-######################################################################
-######################################################################
+} # End of course search scoping
-sub print_basic_search_form{
- my ($r,$closebutton) = @_;
- my $bodytag=&Apache::loncommon::bodytag('Search');
- my $scrout=<<"ENDDOCUMENT";
+sub search_html_header {
+ my $Str = <The LearningOnline Network with CAPA
@@ -542,13 +510,32 @@ sub print_basic_search_form{
}
-$bodytag
-ENDDOCUMENT
-if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
- my $CatalogSearch=&mt('Catalog Search');
- my $Statement=&mt('Enter terms or phrases separated by AND, OR, or NOT then press SEARCH below');
- $scrout.=(<$CatalogSearch
+ENDHEADER
+ return $Str;
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item &print_basic_search_form()
+
+Prints the form for the basic search. Sorry the name is so cryptic.
+
+=cut
+
+######################################################################
+######################################################################
+sub print_basic_search_form {
+ my ($r,$closebutton,$hidden_fields) = @_;
+ my $bodytag=&Apache::loncommon::bodytag('Search').
+ &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Finding_Resources',
+ undef,undef,! $ENV{'form.launch'});
+ my $scrout = &search_html_header().$bodytag;
+ if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) {
+ my $Statement=&searchhelp();
+ $scrout.=(<
$hidden_fields
@@ -559,16 +546,23 @@ $Statement.
ENDDOCUMENT
- $scrout.=' '.&simpletextfield('basicexp',$ENV{'form.basicexp'},40).
- ' ';
- my $relatedcheckbox = &simplecheckbox('related',$ENV{'form.related'});
- my $domain = $r->dir_config('lonDefDomain');
- my $domaincheckbox = &simplecheckbox('domains',$domain);
- my $srch=&mt('Search');
- my $header=&mt('Advanced Search');
- my $userelatedwords=&mt('use related words');
- my $onlysearchdomain=&mt('only search domain');
- $scrout.=<dir_config('lonDefDomain');
+ my $domaincheckbox =
+ &Apache::lonhtmlcommon::checkbox('domains',
+ $ENV{'form.domains'});
+ my $srch=&mt('Search');
+ my $header=&mt('Advanced Search');
+ my $userelatedwords=&mt('use related words');
+ my $onlysearchdomain=&mt('only search domain');
+ my $view=&viewoptions();
+ $scrout.=<
\n";
$scrout.=<
@@ -838,7 +749,105 @@ ENDDOCUMENT
=pod
-=item &get_persistent_form_data
+=item &titlefield()
+
+Inputs: title text
+
+Outputs: titletext with font wrapper
+
+=cut
+
+######################################################################
+######################################################################
+sub titlefield {
+ my $title=shift;
+ return $title;
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item viewoptiontext()
+
+Inputs: codename for view option
+
+Outputs: displayed text
+
+=cut
+
+######################################################################
+######################################################################
+sub viewoptiontext {
+ my $code=shift;
+ my %desc=&Apache::lonlocal::texthash
+ ('detailed' => "Detailed Citation View",
+ 'xml' => 'XML/SGML',
+ 'compact' => 'Compact View',
+ 'fielded' => 'Fielded Format',
+ 'summary' => 'Summary View');
+ return $desc{$code};
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item viewoptions()
+
+Inputs: none
+
+Outputs: text for box with view options
+
+=cut
+
+######################################################################
+######################################################################
+sub viewoptions {
+ my $scrout="\n".'';
+ if (! defined($ENV{'form.viewselect'})) {
+ $ENV{'form.viewselect'}='detailed';
+ }
+ $scrout.=&Apache::lonmeta::selectbox('viewselect',
+ $ENV{'form.viewselect'},
+ \&viewoptiontext,
+ sort(keys(%Views)));
+ $scrout.= ' ';
+ $scrout.=&Apache::lonmeta::selectbox('show',
+ $ENV{'form.show'},
+ undef,
+ (10,20,50,100,1000,10000));
+ $scrout .= (' 'x2).&mt('Records per Page').''.$/;
+ return $scrout;
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item searchhelp()
+
+Inputs: none
+
+Outputs: return little blurb on how to enter searches
+
+=cut
+
+######################################################################
+######################################################################
+sub searchhelp {
+ return &mt('Enter terms or phrases separated by AND, OR, or NOT');
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item &get_persistent_form_data()
Inputs: filename of database
@@ -893,7 +902,7 @@ sub get_persistent_form_data {
=pod
-=item &get_persistent_data
+=item &get_persistent_data()
Inputs: filename of database, ref to array of values to recover.
@@ -944,7 +953,7 @@ Inputs: Hash of values to save, filename
Store variables away to the %persistent_db.
Values will be escaped. Values that are array pointers will have their
-elements escaped and concatenated in a comma seperated string.
+elements escaped and concatenated in a comma separated string.
=cut
@@ -976,7 +985,7 @@ Inputs: filename of persistent database.
Store most form variables away to the %persistent_db.
Values will be escaped. Values that are array pointers will have their
-elements escaped and concatenated in a comma seperated string.
+elements escaped and concatenated in a comma separated string.
=cut
@@ -994,288 +1003,6 @@ sub make_form_data_persistent {
}
######################################################################
-# HTML form building functions #
-######################################################################
-
-=pod
-
-=item HTML form building functions
-
-=over 4
-
-=cut
-
-###############################################
-###############################################
-
-=pod
-
-=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.
-
-=cut
-
-###############################################
-###############################################
-
-sub simpletextfield {
- my ($name,$value,$size)=@_;
- $size = 20 if (! defined($size));
- return '';
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &simplecheckbox()
-
-Inputs: $name,$value
-
-Returns a simple check box with the given $name.
-If $value eq 'on' the box is checked.
-
-=cut
-
-###############################################
-###############################################
-
-sub simplecheckbox{
- my ($name,$value,$checked)=@_;
- $checked="checked" if ($value eq 'on');
- return '';
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &fieldtitle()
-
-Input: $title
-
-Returns a scalar with html which will display $title as a search
-field heading.
-
-=cut
-
-###############################################
-###############################################
-
-sub fieldtitle {
- my $title = uc(&mt(shift()));
- return ''.$title.
- ': ';
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &searchphrasefield()
-
-Inputs: $title,$name,$value
-
-Returns html for a title line and an input field for entering search terms.
-The entry field (which is where the $name and $value are used) is a 50 column
-simpletextfield. The html returned is for a row in a three column table.
-
-=cut
-
-###############################################
-###############################################
-
-sub searchphrasefield {
- my ($title,$name,$value)=@_;
- return '
'.&fieldtitle($title).'
'.
- &simpletextfield($name,$value,50)."
\n";
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &searchphrasefield_with_related()
-
-Inputs: $title,$name,$value
-
-Returns html for a title line and an input field for entering search terms
-and a check box for 'related words'. The entry field (which is where the
-$name and $value are used) is a 50 column simpletextfield. The name of
-the related words checkbox is "$name_related".
-
-=cut
-
-###############################################
-###############################################
-
-sub searchphrasefield_with_related {
- my ($title,$name,$value)=@_;
- return '