--- loncom/interface/lonsearchcat.pm 2002/07/29 21:53:57 1.146
+++ loncom/interface/lonsearchcat.pm 2007/01/19 14:23:23 1.279
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.146 2002/07/29 21:53:57 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.279 2007/01/19 14:23:23 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,14 +25,6 @@
#
# http://www.lon-capa.org/
#
-# YEAR=2001
-# 3/8, 3/12, 3/13, 3/14, 3/15, 3/19 Scott Harrison
-# 3/20, 3/21, 3/22, 3/26, 3/27, 4/2, 8/15, 8/24, 8/25 Scott Harrison
-# 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison
-# YEAR=2002
-# 1/17 Scott Harrison
-# 6/17 Matthew Hall
-#
###############################################################################
###############################################################################
@@ -56,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
@@ -67,179 +59,224 @@ 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);
-use Apache::lonnet();
+use Apache::Constants qw(:common :http);
+use Apache::lonnet;
use Apache::File();
use CGI qw(:standard);
use Text::Query;
-use DBI;
use GDBM_File;
use Apache::loncommon();
use Apache::lonmysql();
-
-# ---------------------------------------- variables used throughout the module
+use Apache::lonmeta;
+use Apache::lonhtmlcommon;
+use Apache::lonlocal;
+use LONCAPA::lonmetadata();
+use HTML::Entities();
+use Parse::RecDescent;
+use Apache::lonnavmaps;
+use Apache::lonindexer();
+use LONCAPA;
######################################################################
######################################################################
-
-=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.
-
-=back
-
-=cut
-
+##
+## Global variables
+##
######################################################################
######################################################################
-
-# -- 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 );
-my %persistent_db;
-my $hidden_fields;
-######################################################################
-######################################################################
-
-=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
-
-=back
-
-=cut
+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
+
+# The different view modes and associated functions
+
+my %Views = ("detailed" => \&detailed_citation_view,
+ "detailedpreview" => \&detailed_citation_preview,
+ "summary" => \&summary_view,
+ "summarypreview" => \&summary_preview,
+ "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 $loaderror=&Apache::lonnet::overloaderror($r);
+ if ($loaderror) { return $loaderror; }
#
my $closebutton; # button that closes the search window
# This button is different for the RAT compared to
# normal invocation.
#
- $r->content_type('text/html');
+ &Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
return OK if $r->header_only;
+ ##
+ ## Prevent caching of the search interface window. Hopefully this means
+ ## we will get the launch=1 passed in a little more.
+ &Apache::loncommon::no_cache($r);
##
## Pick up form fields passed in the links.
##
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['catalogmode','launch','acts','mode','form','element','pause',
- 'phase','persistent_db_id','table','start','show']);
+ 'phase','persistent_db_id','table','start','show',
+ 'cleargroupsort','titleelement','area']);
##
## The following is a trick - we wait a few seconds if asked to so
## the daemon running the search can get ahead of the daemon
## printing the results. We only need (theoretically) to do
## this once, so the pause indicator is deleted
##
- if (exists($ENV{'form.pause'})) {
- sleep(5);
- delete($ENV{'form.pause'});
+ if (exists($env{'form.pause'})) {
+ sleep(1);
+ delete($env{'form.pause'});
}
##
## Initialize global variables
##
my $domain = $r->dir_config('lonDefDomain');
- $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain).
- "\_".&Apache::lonnet::escape($ENV{'user.name'})."_searchcat.db";
+ $diropendb= "/home/httpd/perl/tmp/".
+ "$env{'user.domain'}_$env{'user.name'}_sel_res.db";
#
# set the name of the persistent database
- # $ENV{'form.persistent_db_id'} can only have digits in it.
- if (! exists($ENV{'form.persistent_db_id'}) ||
- $ENV{'form.persistent_db_id'} =~ /\D/ ) {
- $ENV{'form.persistent_db_id'} = time;
+ # $env{'form.persistent_db_id'} can only have digits in it.
+ if (! exists($env{'form.persistent_db_id'}) ||
+ ($env{'form.persistent_db_id'} =~ /\D/) ||
+ ($env{'form.launch'} eq '1')) {
+ $env{'form.persistent_db_id'} = time;
}
+
my $persistent_db_file = "/home/httpd/perl/tmp/".
- &Apache::lonnet::escape($domain).
- '_'.&Apache::lonnet::escape($ENV{'user.name'}).
- '_'.$ENV{'form.persistent_db_id'}.'_persistent_search.db';
- ##
- &get_persistent_form_data($r,$persistent_db_file);
+ &escape($domain).
+ '_'.&escape($env{'user.name'}).
+ '_'.$env{'form.persistent_db_id'}.'_persistent_search.db';
+ ##
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+
+ my @allowed_searches = ('portfolio');
+ if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'})) {
+ push(@allowed_searches,'res');
+ }
+ if (exists($env{'request.course.id'}) && $env{'request.course.id'} ne '') {
+ push(@allowed_searches,'course');
+ }
+ my $crumb_text = 'Portfolio Search';
+ if (@allowed_searches == 3) {
+ $crumb_text = 'Course, Portfolio and Catalog Search';
+ } elsif (@allowed_searches ==2) {
+ if (grep(/^res$/,@allowed_searches)) {
+ $crumb_text = 'Portfolio and Catalog Search';
+ } elsif (grep(/^course$/,@allowed_searches)) {
+ $crumb_text = 'Portfolio and Course Search';
+ }
+ }
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?'.
+ 'catalogmode='.$env{'form.catalogmode'}.
+ '&launch='.$env{'form.launch'}.
+ '&mode='.$env{'form.mode'},
+ text=>"$crumb_text",
+ target=>'_top',
+ bug=>'Searching',});
+ #
+ if ($env{'form.phase'} !~ m/(basic|adv|course)_search/) {
+ if (! &get_persistent_form_data($persistent_db_file)) {
+ if ($env{'form.phase'} =~ /(run_search|results)/) {
+ &Apache::lonnet::logthis('lonsearchcat:'.
+ 'Unable to recover data from '.
+ $persistent_db_file);
+ my $msg =
+ 'We were unable to retrieve data describing your search. '.
+ 'This is a serious error and has been logged. '.
+ 'Please alert your LON-CAPA administrator.';
+ &Apache::loncommon::simple_error_page($r,'Search Error',
+ $msg);
+ return OK;
+ }
+ }
+ } else {
+ &clean_up_environment();
+ }
##
## Clear out old values from groupsearch database
##
untie %groupsearch_db if (tied(%groupsearch_db));
- if ($ENV{'form.launch'} eq '1') {
- if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ if (($env{'form.cleargroupsort'} eq '1') ||
+ (($env{'form.launch'} eq '1') &&
+ ($env{'form.catalogmode'} eq 'import'))) {
+ if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
&start_fresh_session();
untie %groupsearch_db;
+ delete($env{'form.cleargroupsort'});
} else {
- $r->print('
Unable to tie hash to db '.
- 'file');
+ # This is a stupid error to give to the user.
+ # It really tells them nothing.
+ my $msg = 'Unable to tie hash to db file.';
+ &Apache::loncommon::simple_error_page($r,'Search Error',
+ $msg);
return OK;
}
}
##
- ## Configure dynamic components of interface
+ ## Configure hidden fields
##
$hidden_fields = '';
+ $env{'form.persistent_db_id'}.'" />'."\n";
+ if (exists($env{'form.catalogmode'})) {
+ $hidden_fields .= &hidden_field('catalogmode');
+ }
+ if (exists($env{'form.form'})) {
+ $hidden_fields .= &hidden_field('form');
+ }
+ if (exists($env{'form.element'})) {
+ $hidden_fields .= &hidden_field('element');
+ }
+ if (exists($env{'form.titleelement'})) {
+ $hidden_fields .= &hidden_field('titleelement');
+ }
+ if (exists($env{'form.mode'})) {
+ $hidden_fields .= &hidden_field('mode');
+ }
+ if (exists($env{'form.area'})) {
+ $hidden_fields .= &hidden_field('area');
+ }
##
- if ($ENV{'form.catalogmode'} eq 'interactive') {
- $closebutton=""."\n";
- } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') {
- $closebutton=<
-END
+ ## Configure dynamic components of interface
+ ##
+ if ($env{'form.catalogmode'} eq 'interactive') {
+ $closebutton="
@@ -251,74 +288,377 @@ END
##
## Sanity checks on form elements
##
- if (!defined($ENV{'form.viewselect'})) {
- $ENV{'form.viewselect'} ="Detailed Citation View";
+ if (!defined($env{'form.viewselect'})) {
+ $env{'form.viewselect'} ="summary";
+ }
+ $env{'form.phase'} = 'disp_basic' if (! exists($env{'form.phase'}));
+ $env{'form.show'} = 20 if (! exists($env{'form.show'}));
+ #
+ $env{'form.searchmode'} = 'basic' if (! exists($env{'form.searchmode'}));
+ 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') {
+ my $srchtype = 'Catalog';
+ if ($env{'form.area'} eq 'portfolio') {
+ $srchtype = 'Portfolio';
+ }
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>'/adm/searchcat?phase=disp_adv&'.
+ 'catalogmode='.$env{'form.catalogmode'}.
+ '&launch='.$env{'form.launch'}.
+ '&mode='.$env{'form.mode'},
+ text=>"Advanced $srchtype 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',});
}
- $ENV{'form.phase'} = 'displaybasic' if (! exists($ENV{'form.phase'}));
##
## Switch on the phase
##
- if ($ENV{'form.phase'} eq 'disp_basic') {
- &print_basic_search_form($r,$closebutton);
- } elsif ($ENV{'form.phase'} eq 'disp_adv') {
- &print_advanced_search_form($r,$closebutton);
- } elsif ($ENV{'form.phase'} eq 'results') {
- &display_results($r,$importbutton,$closebutton);
- } elsif($ENV{'form.phase'} eq 'run_search') {
+ if ($env{'form.phase'} eq 'disp_basic') {
+ &print_basic_search_form($r,$closebutton,$hidden_fields);
+ } elsif ($env{'form.phase'} eq 'disp_adv') {
+ &print_advanced_search_form($r,$closebutton,$hidden_fields);
+ } elsif ($env{'form.phase'} eq 'results') {
+ &display_results($r,$importbutton,$closebutton,$diropendb,
+ $env{'form.area'});
+ } elsif ($env{'form.phase'} =~ /^(sort|run_search)$/) {
my ($query,$customquery,$customshow,$libraries,$pretty_string) =
&get_persistent_data($persistent_db_file,
['query','customquery','customshow',
'libraries','pretty_string']);
- &write_status($r,"query = $query");
- &write_status($r,"customquery = $customquery");
- &write_status($r,"customshow = $customshow");
- &write_status($r,"libraries = $libraries");
- &write_status($r,"pretty_string = $pretty_string");
- &run_search($r,$query,$customquery,$customshow,
- $libraries,$pretty_string);
- } elsif(($ENV{'form.phase'} eq 'basic_search') ||
- ($ENV{'form.phase'} eq 'adv_search')) {
- # Set up table
- if (! defined(&create_results_table())) {
- # Unable to make table to store results in.
- # Definately abort search.
- }
- if (! &make_form_data_persistent($r,$persistent_db_file)) {
- # Unable to store persistent data.
- # Probably should bail out.
+ if ($env{'form.phase'} eq 'sort') {
+ &print_sort_form($r,$pretty_string);
+ } elsif ($env{'form.phase'} eq 'run_search') {
+ &run_search($r,$query,$customquery,$customshow,
+ $libraries,$pretty_string,$env{'form.area'});
}
+ } elsif ($env{'form.phase'} eq 'course_search') {
+ &course_search($r);
+ } elsif(($env{'form.phase'} eq 'basic_search') ||
+ ($env{'form.phase'} eq 'adv_search')) {
#
- # We are running a search
+ # We are running a search, try to parse it
my ($query,$customquery,$customshow,$libraries) =
(undef,undef,undef,undef);
my $pretty_string;
- if ($ENV{'form.phase'} eq 'basic_search') {
- ($query,$pretty_string) = &parse_basic_search($r,$closebutton);
+ if ($env{'form.phase'} eq 'basic_search') {
+ ($query,$pretty_string,$libraries) =
+ &parse_basic_search($r,$closebutton,$hidden_fields);
+ return OK if (! defined($query));
+ &make_persistent({ basicexp => $env{'form.basicexp'}},
+ $persistent_db_file);
} 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));
}
- &write_status($r,"query = $query");
- &write_status($r,"customquery = $customquery");
- &write_status($r,"customshow = $customshow");
- &write_status($r,"libraries = $libraries");
- &write_status($r,"pretty_string = $pretty_string");
- &make_persistent($r,
- { query => $query,
+ &make_persistent({ query => $query,
customquery => $customquery,
customshow => $customshow,
libraries => $libraries,
pretty_string => $pretty_string },
$persistent_db_file);
+ #
+ # Set up table
+ if (! defined(&create_results_table($env{'form.area'}))) {
+ my $errorstring=&Apache::lonmysql::get_error();
+ &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
+ 'needed table. lonmysql error:'.
+ $errorstring);
+
+ my $msg =
+ 'Unable to create table in which to store search results. '.
+ 'The search has been aborted.';
+ &Apache::loncommon::simple_error_page($r,'Search Error',
+ $msg);
+ return OK;
+ }
+ delete($env{'form.launch'});
+ if (! &make_form_data_persistent($r,$persistent_db_file)) {
+ my $msg=
+ 'Unable to properly store search information. '.
+ 'The search has been aborted.';
+ &Apache::loncommon::simple_error_page($r,'Search Error',
+ $msg);
+ return OK;
+ }
##
## Print out the frames interface
##
- &print_frames_interface($r);
+ if (defined($query)) {
+ &print_frames_interface($r);
+ }
}
return OK;
}
+#
+# The mechanism used to store values away and retrieve them does not
+# handle the case of missing environment variables being significant.
+#
+# This routine sets non existant checkbox form elements to ''.
+#
+sub clean_up_environment {
+ if ($env{'form.phase'} eq 'basic_search') {
+ if (! exists($env{'form.related'})) {
+ $env{'form.related'} = '';
+ }
+ if (! exists($env{'form.domains'})) {
+ $env{'form.domains'} = '';
+ }
+ } elsif ($env{'form.phase'} eq 'adv_search') {
+ foreach my $field ('title','keywords','notes',
+ 'abstract','standards','mime') {
+ if (! exists($env{'form.'.$field.'_related'})) {
+ $env{'form.'.$field.'_related'} = '';
+ }
+ }
+ } elsif ($env{'form.phase'} eq 'course_search') {
+ if (! exists($env{'form.crsrelated'})) {
+ $env{'form.crsrelated'} = '';
+ }
+ }
+}
+
+sub hidden_field {
+ my ($name,$value) = @_;
+ if (! defined($value)) {
+ $value = $env{'form.'.$name};
+ }
+ return ''.$/;
+}
+
+######################################################################
+######################################################################
+##
+## Course Search
+##
+######################################################################
+######################################################################
+{ # Scope the course search to avoid global variables
+#
+# Variables For course search
+my %alreadyseen;
+my %hash;
+my $totalfound;
+
+sub make_symb {
+ my ($id)=@_;
+ my ($mapid,$resid)=split(/\./,$id);
+ my $map=$hash{'map_id_'.$mapid};
+ my $res=$hash{'src_'.$id};
+ my $symb=&Apache::lonnet::encode_symb($map,$resid,$res);
+ return $symb;
+}
+
+sub course_search {
+ my $r=shift;
+ my $pretty_search_string = ''.$env{'form.courseexp'}.'';
+ my $search_string = $env{'form.courseexp'};
+ my @New_Words;
+ undef(%alreadyseen);
+ if ($env{'form.crsrelated'}) {
+ ($search_string,@New_Words) = &related_version($env{'form.courseexp'});
+ if (@New_Words) {
+ $pretty_search_string .= ' '.&mt("with related words").": @New_Words.";
+ } else {
+ $pretty_search_string .= ' '.&mt('with no related words').".";
+ }
+ }
+ my $fulltext=$env{'form.crsfulltext'};
+ my $discuss=$env{'form.crsdiscuss'};
+ my @allwords=($search_string,@New_Words);
+ $totalfound=0;
+ $r->print(&Apache::loncommon::start_page('Course Search').
+ '
'.
+ $pretty_search_string.'
'.
+ ''.&mt('Course content').': ');
+ $r->rflush();
+# ======================================================= Go through the course
+ my $c=$r->connection;
+ if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.".db",
+ &GDBM_READER(),0640)) {
+ foreach (sort(keys(%hash))) {
+ if ($c->aborted()) { last; }
+ if (($_=~/^src\_(.+)$/)) {
+ if ($hash{'randomout_'.$1} & !$env{'request.role.adv'}) {
+ next;
+ }
+ my $symb=&make_symb($1);
+ &checkonthis($r,$1,$hash{$_},0,&Apache::lonnet::gettitle($symb),
+ $fulltext,$symb,@allwords);
+ }
+ }
+ untie(%hash);
+ }
+ unless ($totalfound) {
+ $r->print('
'.&mt('No matches found in resources').'.
');
+ }
+
+# Check discussions if requested
+ if ($discuss) {
+ my $totaldiscussions = 0;
+ $r->print('
'.&mt('Discussion postings').': ');
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ my @allres=$navmap->retrieveResources();
+ my %discussiontime = &Apache::lonnet::dump('discussiontimes',
+ $env{'course.'.$env{'request.course.id'}.'.domain'},
+ $env{'course.'.$env{'request.course.id'}.'.num'});
+ foreach my $resource (@allres) {
+ my $result = '';
+ my $applies = 0;
+ my $symb = $resource->symb();
+ my $ressymb = $symb;
+ if ($symb =~ m#(___adm/$LONCAPA::domain_re/$LONCAPA::username_re)/(\d+)/bulletinboard$#) {
+ $ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
+ unless ($ressymb =~ m#bulletin___\d+___adm/wrapper#) {
+ $ressymb=~s#(bulletin___\d+___)#$1adm/wrapper/#;
+ }
+ }
+ if (defined($discussiontime{$ressymb})) {
+ my %contrib = &Apache::lonnet::restore($ressymb,$env{'request.course.id'},
+ $env{'course.'.$env{'request.course.id'}.'.domain'},
+ $env{'course.'.$env{'request.course.id'}.'.num'});
+ if ($contrib{'version'}) {
+ for (my $id=1;$id<=$contrib{'version'};$id++) {
+ unless (($contrib{'hidden'}=~/\.$id\./) || ($contrib{'deleted'}=~/\.$id\./)) {
+ if ($contrib{$id.':subject'}) {
+ $result .= $contrib{$id.':subject'};
+ }
+ if ($contrib{$id.':message'}) {
+ $result .= $contrib{$id.':message'};
+ }
+ if ($contrib{$id,':attachmenturl'}) {
+ if ($contrib{$id,':attachmenturl'} =~ m-/([^/]+)$-) {
+ $result .= $1;
+ }
+ }
+ $applies = &checkwords($result,$applies,@allwords);
+ }
+ }
+ }
+ }
+# Does this discussion apply?
+ if ($applies) {
+ my ($map,$ind,$url)=&Apache::lonnet::decode_symb($ressymb);
+ my $disctype = &mt('resource');
+ if ($url =~ m#/bulletinboard$#) {
+ if ($url =~m#^adm/wrapper/adm/.*/bulletinboard$#) {
+ $url =~s#^adm/wrapper##;
+ }
+ $disctype = &mt('bulletin board');
+ } else {
+ $url = '/res/'.$url;
+ }
+ if ($url =~ /\?/) {
+ $url .= '&symb=';
+ } else {
+ $url .= '?symb=';
+ }
+ $url .= &escape($resource->symb());
+ my $title = $resource->compTitle();
+ $r->print(' '.
+ ($title?$title:$url).' - '.$disctype.' ');
+ $totaldiscussions++;
+ } else {
+ $r->print(' .');
+ }
+ }
+ unless ($totaldiscussions) {
+ $r->print('
'.&mt('No matches found in postings').'.
');
+ }
+ }
+
+# =================================================== Done going through course
+ $r->print(&Apache::loncommon::end_page());
+}
+
+# =============================== This pulls up a resource and its dependencies
+
+sub checkonthis {
+ my ($r,$id,$url,$level,$title,$fulltext,$symb,@allwords)=@_;
+ $alreadyseen{$id}=1;
+ if (&Apache::loncommon::connection_aborted($r)) { return; }
+ $r->rflush();
+
+ my $result=$title.' ';
+ if ($env{'request.role.adv'} || !$hash{'encrypted_'.$id}) {
+ $result.=&Apache::lonnet::metadata($url,'title').' '.
+ &Apache::lonnet::metadata($url,'subject').' '.
+ &Apache::lonnet::metadata($url,'abstract').' '.
+ &Apache::lonnet::metadata($url,'keywords');
+ }
+ my ($extension)=($url=~/\.(\w+)$/);
+ if (&Apache::loncommon::fileembstyle($extension) eq 'ssi' &&
+ ($url) && ($fulltext)) {
+ $result.=&Apache::lonnet::ssi_body($url.'?symb='.&escape($symb));
+ }
+ $result=~s/\s+/ /gs;
+ my $applies = 0;
+ $applies = &checkwords($result,$applies,@allwords);
+# Does this resource apply?
+ if ($applies) {
+ $r->print(' ');
+ for (my $i=0;$i<=$level*5;$i++) {
+ $r->print(' ');
+ }
+ my $href=$url;
+ if ($hash{'encrypted_'.$id} && !$env{'request.role.adv'}) {
+ $href=&Apache::lonenc::encrypted($href)
+ .'?symb='.&Apache::lonenc::encrypted($symb);
+ } else {
+ $href.='?symb='.&escape($symb);
+ }
+ $r->print(''.($title?$title:$url).
+ ' ');
+ $totalfound++;
+ } elsif ($fulltext) {
+ $r->print(' .');
+ }
+ $r->rflush();
+# Check also the dependencies of this one
+ my $dependencies=
+ &Apache::lonnet::metadata($url,'dependencies');
+ foreach (split(/\,/,$dependencies)) {
+ if (($_=~/^\/res\//) && (!$alreadyseen{$id})) {
+ &checkonthis($r,$id,$_,$level+1,'',$fulltext,undef,@allwords);
+ }
+ }
+}
+
+sub checkwords {
+ my ($result,$applies,@allwords) = @_;
+ foreach (@allwords) {
+ if ($_=~/\w/) {
+ if ($result=~/$_/si) {
+ $applies++;
+ }
+ }
+ }
+ return $applies;
+}
+
+sub untiehash {
+ if (tied(%hash)) {
+ untie(%hash);
+ }
+}
+
+} # End of course search scoping
+
+
######################################################################
######################################################################
@@ -326,70 +666,145 @@ END
=item &print_basic_search_form()
-Returns a scalar which holds html for the 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) = @_;
- my $scrout=<<"ENDDOCUMENT";
-
-
-The LearningOnline Network with CAPA
-
-
-
-
-
Search Catalog
-
-
-
-ENDDOCUMENT
+ENDENDCOURSE
+ }
+ $scrout .= &Apache::loncommon::end_page();
$r->print($scrout);
return;
}
+
+sub setup_basic_search {
+ my ($r,$area,$hidden_fields,$closebutton) = @_;
+ # Define interface components
+ my %lt = &Apache::lonlocal::texthash (
+ res => 'LON-CAPA Catalog Search',
+ portfolio => 'Portfolio Search',
+ );
+ my ($userelatedwords,$onlysearchdomain,$inclext,$adv_search_link,$scrout);
+ $userelatedwords = '';
+ $onlysearchdomain = '';
+ if ($area eq 'res') {
+ $inclext= '';
+ }
+ $adv_search_link = ''.&mt('Advanced Search').'';
+ #
+ $scrout.='';
+ return $scrout;
+}
+
######################################################################
######################################################################
@@ -397,189 +812,277 @@ ENDDOCUMENT
=item &advanced_search_form()
-Returns a scalar which holds html for the advanced search form.
+Prints the advanced search form.
=cut
######################################################################
######################################################################
-
sub print_advanced_search_form{
- my ($r,$closebutton) = @_;
- my $advanced_buttons = <<"END";
-
-
-
+ my ($r,$closebutton,$hidden_fields) = @_;
+ my $bread_crumb =
+ &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Advanced',
+ $env{'form.catalogmode'} ne 'import');
+ my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
+ 'reset' => 'Reset',
+ 'help' => 'Help');
+ my $advanced_buttons=<<"END";
+
+
$closebutton
-
-
END
- if (!defined($ENV{'form.viewselect'})) {
- $ENV{'form.viewselect'} ="Detailed Citation View";
- }
- my $scrout=<<"ENDHEADER";
-
-
-The LearningOnline Network with CAPA
-
-
-
-
-
Advanced Catalog Search
-
-Enter terms or phrases separated by search operators
-such as AND, OR, or NOT.
-".
+ &Apache::loncommon::end_page());
+ &Apache::lonnet::logthis("lonmysql was unable to determine the status".
+ " of table ".$table);
+ return undef;
+ } elsif (! $table_check) {
+ $r->print("The table of results could not be found.");
+ &Apache::lonnet::logthis("The user requested a table, ".$table.
+ ", that could not be found.");
+ return undef;
+ }
+ return 1;
+}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item &print_sort_form()
+
+The sort feature is not implemented at this time. This form just prints
+a link to change the search query.
+
+=cut
+
+######################################################################
+######################################################################
+sub print_sort_form {
+ my ($r,$pretty_query_string) = @_;
+
+ ##
+ my %SortableFields=&Apache::lonlocal::texthash(
+ id => 'Default',
+ title => 'Title',
+ author => 'Author',
+ subject => 'Subject',
+ url => 'URL',
+ version => 'Version Number',
+ mime => 'Mime type',
+ lang => 'Language',
+ owner => 'Owner/Publisher',
+ copyright => 'Copyright',
+ hostname => 'Host',
+ creationdate => 'Creation Date',
+ lastrevisiondate => 'Revision Date'
+ );
+ ##
+ my $table = $env{'form.table'};
+ return if (! &ensure_db_and_table($r,$table));
+ ##
+ ## Get the number of results
+ ##
+ my $total_results = &Apache::lonmysql::number_of_rows($table);
+ if (! defined($total_results)) {
+ $r->print("A MySQL error has occurred.".
+ &Apache::loncommon::end_page());
+ &Apache::lonnet::logthis("lonmysql was unable to determine the number".
+ " of rows in table ".$table);
+ &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
+ return;
+ }
+ my $js =<
+ function change_sort() {
+ var newloc = "/adm/searchcat?phase=results";
+ newloc += "&persistent_db_id=$env{'form.persistent_db_id'}";
+ newloc += "&sortby=";
+ newloc += document.forms.statusform.elements.sortby.value;
+ parent.resultsframe.location= newloc;
+ }
+
+END
+
+ my $start_page = &Apache::loncommon::start_page('Results',$js,
+ {'no_title' => 1});
+ my $breadcrumbs=
+ &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
+ $env{'form.catalogmode'} ne 'import');
+
+ my $result = <
+
+
+END
+
+#
Sort Results
+#Sort by: \n";
+ my $revise = &revise_button();
+ $result.=<
+There are $total_results matches to your query. $revise
+
+Search: $pretty_query_string
+
+
+END
+ $r->print($result.&Apache::loncommon::end_page());
+ return;
+}
+
#####################################################################
#####################################################################
@@ -1521,50 +2289,14 @@ the following format:
=cut
-##
-## Restrictions:
-## columns of type 'text' and 'blob' cannot have defaults.
-## columns of type 'enum' cannot be used for FULLTEXT.
-##
-my @DataOrder = qw/id title author subject url keywords version notes
- abstract mime lang owner copyright creationdate lastrevisiondate hostname
- idx_title idx_author idx_subject idx_abstract idx_mime idx_language
- idx_owner idx_copyright/;
-
-my %Datatypes =
- ( id =>{ type => 'INT',
- restrictions => 'NOT NULL',
- primary_key => 'yes',
- auto_inc => 'yes'
- },
- title =>{ type=>'TEXT'},
- author =>{ type=>'TEXT'},
- subject =>{ type=>'TEXT'},
- url =>{ type=>'TEXT',
- restrictions => 'NOT NULL' },
- keywords =>{ type=>'TEXT'},
- version =>{ type=>'TEXT'},
- notes =>{ type=>'TEXT'},
- abstract =>{ type=>'TEXT'},
- mime =>{ type=>'TEXT'},
- lang =>{ type=>'TEXT'},
- owner =>{ type=>'TEXT'},
- copyright =>{ type=>'TEXT'},
- hostname =>{ type=>'TEXT'},
- #--------------------------------------------------
- creationdate =>{ type=>'DATETIME'},
- lastrevisiondate =>{ type=>'DATETIME'},
- #--------------------------------------------------
- idx_title =>{ type=>'FULLTEXT', target=>'title'},
- idx_author =>{ type=>'FULLTEXT', target=>'author'},
- idx_subject =>{ type=>'FULLTEXT', target=>'subject'},
- idx_abstract =>{ type=>'FULLTEXT', target=>'abstract'},
- idx_mime =>{ type=>'FULLTEXT', target=>'mime'},
- idx_language =>{ type=>'FULLTEXT', target=>'lang'},
- idx_owner =>{ type=>'FULLTEXT', target=>'owner'},
- idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'},
- );
-
+#####################################################################
+#####################################################################
+#
+# These should probably be scoped but I don't have time right now...
+#
+my @Datatypes;
+my @Fullindicies;
+
######################################################################
######################################################################
@@ -1573,9 +2305,9 @@ my %Datatypes =
=item &create_results_table()
Creates the table of search results by calling lonmysql. Stores the
-table id in $ENV{'form.table'}
+table id in $env{'form.table'}
-Inputs: none.
+Inputs: search area - either res or portfolio
Returns: the identifier of the table on success, undef on error.
@@ -1583,35 +2315,142 @@ Returns: the identifier of the table on
######################################################################
######################################################################
+sub set_up_table_structure {
+ my ($tabletype) = @_;
+ my ($datatypes,$fullindicies) =
+ &LONCAPA::lonmetadata::describe_metadata_storage($tabletype);
+ # Copy the table description before modifying it...
+ @Datatypes = @{$datatypes};
+ unshift(@Datatypes,{name => 'id',
+ type => 'MEDIUMINT',
+ restrictions => 'UNSIGNED NOT NULL',
+ primary_key => 'yes',
+ auto_inc => 'yes' });
+ @Fullindicies = @{$fullindicies};
+ return;
+}
+
sub create_results_table {
+ my ($area) = @_;
+ if ($area eq 'portfolio') {
+ &set_up_table_structure('portfolio_search');
+ } else {
+ &set_up_table_structure('metadata');
+ }
my $table = &Apache::lonmysql::create_table
- ( { columns => \%Datatypes,
- column_order => \@DataOrder,
+ ( { columns => \@Datatypes,
+ FULLTEXT => [{'columns' => \@Fullindicies},],
} );
if (defined($table)) {
- $ENV{'form.table'} = $table;
+ $env{'form.table'} = $table;
return $table;
}
return undef; # Error...
}
+
+######################################################################
+######################################################################
+
+=pod
+
+=item Search Status update functions
+
+Each of the following functions changes the values of one of the
+input fields used to display the search status to the user. The names
+should be explanatory.
+
+Inputs: Apache request handler ($r), text to display.
+
+Returns: Nothing.
+
+=over 4
+
+=item &update_count_status()
+
+=item &update_status()
+
+=item &update_seconds()
+
+=back
+
+=cut
+
+######################################################################
+######################################################################
+sub update_count_status {
+ my ($r,$text) = @_;
+ $text =~ s/\'/\\\'/g;
+ $r->print
+ ("\n");
+ $r->rflush();
+}
+
+sub update_status {
+ my ($r,$text) = @_;
+ $text =~ s/\'/\\\'/g;
+ $r->print
+ ("\n");
+ $r->rflush();
+}
+
+{
+ my $max_time = 300; # seconds for the search to complete
+ my $start_time = 0;
+ my $last_time = 0;
+
+sub reset_timing {
+ $start_time = 0;
+ $last_time = 0;
+}
+
+sub time_left {
+ if ($start_time == 0) {
+ $start_time = time;
+ }
+ my $time_left = $max_time - (time - $start_time);
+ $time_left = 0 if ($time_left < 0);
+ return $time_left;
+}
+
+sub update_seconds {
+ my ($r) = @_;
+ my $time = &time_left();
+ if (($last_time-$time) > 0) {
+ $r->print("\n");
+ $r->rflush();
+ }
+ $last_time = $time;
+}
+
+}
+
######################################################################
######################################################################
=pod
-=item &write_status()
+=item &revise_button()
+
+Inputs: None
+
+Returns: html string for a 'revise search' button.
=cut
######################################################################
######################################################################
-sub write_status {
- my ($r,$string) = @_;
- $string =~ s/(\')/\$1/g;
- $string =~ s/\n//sg;
-# $r->print("\n");
-# $r->rflush();
- return;
+sub revise_button {
+ my $revise_phase = 'disp_basic';
+ $revise_phase = 'disp_adv' if ($env{'form.searchmode'} eq 'advanced');
+ my $newloc = '/adm/searchcat'.
+ '?persistent_db_id='.$env{'form.persistent_db_id'}.
+ '&cleargroupsort=1'.
+ '&phase='.$revise_phase;
+ my $result = qq{ };
+ return $result;
}
######################################################################
@@ -1619,146 +2458,245 @@ sub write_status {
=pod
-=item &run_search
+=item &run_search()
+
+Executes a search query by sending it the the other servers and putting the
+results into MySQL.
=cut
######################################################################
######################################################################
sub run_search {
- my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_;
- #
- # Timing variables
- #
- my $starttime = time;
- my $max_time = 120; # seconds for the search to complete
+ my ($r,$query,$customquery,$customshow,$serverlist,
+ $pretty_string,$area) = @_;
+ my $tabletype = 'metadata';
+ if ($area eq 'portfolio') {
+ $tabletype = 'portfolio_search';
+ }
+ my $connection = $r->connection;
#
# Print run_search header
#
- $r->print("Search Status");
- $r->print("Search: ".$pretty_string." \n");
+ my $start_page = &Apache::loncommon::start_page('Search Status',undef,
+ {'no_title' => 1});
+ my $breadcrumbs =
+ &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
+ $env{'form.catalogmode'} ne 'import');
+ $r->print(<
+
+END
+ # Remove leading and trailing
+ $pretty_string =~ s:^\s* ::i;
+ $pretty_string =~ s:( )*\s*$::im;
+ my @Lines = split(" ",$pretty_string);
+ # I keep getting blank items at the end of the list, hence the following:
+ while ($Lines[-1] =~ /^\s*$/ && @Lines) {
+ pop(@Lines);
+ }
+ if (@Lines > 2) {
+ $pretty_string = join ' ',(@Lines[0..2],'.... ');
+ }
+ $r->print(&mt("Search: [_1]",$pretty_string));
$r->rflush();
#
# Determine the servers we need to contact.
- #
my @Servers_to_contact;
if (defined($serverlist)) {
- @Servers_to_contact = @$serverlist;
+ if (ref($serverlist) eq 'ARRAY') {
+ @Servers_to_contact = @$serverlist;
+ } else {
+ @Servers_to_contact = ($serverlist);
+ }
} else {
@Servers_to_contact = sort(keys(%Apache::lonnet::libserv));
}
my %Server_status;
- my $table =$ENV{'form.table'};
- if (! defined($table)) {
- # What do I do now? Print out an error page.
- &Apache::lonnet::logthis("lonmysql attempted to create a table ".
- "and this was the result:".
+ #
+ # Check on the mysql table we will use to store results.
+ my $table =$env{'form.table'};
+ if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
+ $r->print("Unable to determine table id to store search results in.".
+ "The search has been aborted.".
+ &Apache::loncommon::end_page());
+ return;
+ }
+ my $table_status = &Apache::lonmysql::check_table($table);
+ if (! defined($table_status)) {
+ $r->print("Unable to determine status of table.".
+ &Apache::loncommon::end_page());
+ &Apache::lonnet::logthis("Bogus table id of $table for ".
+ "$env{'user.name'} @ $env{'user.domain'}");
+ &Apache::lonnet::logthis("lonmysql error = ".
+ &Apache::lonmysql::get_error());
+ return;
+ }
+ if (! $table_status) {
+ &Apache::lonnet::logthis("lonmysql error = ".
&Apache::lonmysql::get_error());
- $r->print("An internal error occured with the database. ".
- "The error has been logged, but you should probably alert".
- " your system administrator.");
+ &Apache::lonnet::logthis("lonmysql debug = ".
+ &Apache::lonmysql::get_debug());
+ &Apache::lonnet::logthis('table status = "'.$table_status.'"');
+ $r->print("The table id,$table, we tried to use is invalid.".
+ "The search has been aborted.".
+ &Apache::loncommon::end_page());
return;
}
##
## Prepare for the big loop.
- ##
my $hitcountsum;
+ my %matches;
my $server;
my $status;
- while ((time - $starttime < $max_time) &&
+ my $revise = &revise_button();
+ $r->print(<
+
");
- if ($hitcountsum) {
- $r->print($hitcountsum." successful matches to your query. ");
- } else {
- $r->print("There were no successful matches to your query. ");
- }
- $r->print("");
+ # results to get, so let the client know the top frame needs to be
+ # loaded from /adm/searchcat
+ $r->print(&Apache::loncommon::end_page());
+# if ($env{'form.catalogmode'} ne 'import') {
+ $r->print("");
+# }
return;
}
######################################################################
######################################################################
+
=pod
-=item &prev_next_buttons
+=item &prev_next_buttons()
+
+Returns html for the previous and next buttons on the search results page.
=cut
@@ -1767,163 +2705,271 @@ sub run_search {
sub prev_next_buttons {
my ($current_min,$show,$total,$parms) = @_;
return '' if ($show eq 'all'); # No links if you get them all at once.
- my $links;
- ##
- ## Prev
- my $prev_min = $current_min - $show;
- $prev_min = 0 if $prev_min < 0;
- if ($prev_min < $current_min) {
- $links .= qq{
-prev
-};
- } else {
- $links .= 'prev';
- }
- ##
- ## Pages.... Someday.
- ##
- $links .= qq{
-reload
-};
- ##
- ## Next
- my $next_min = $current_min + $show;
- $next_min = $current_min if ($next_min > $total);
- if ($next_min != $current_min) {
- $links .= qq{
-next
-};
- } else {
- $links .= ' next';
- }
- return $links;
+ #
+ # Create buttons
+ my $buttons = '';
+ $buttons .= ' 'x3;
+ $buttons .= 'print(&search_results_header());
+ my ($r,$importbutton,$closebutton,$diropendb,$area) = @_;
+ my $connection = $r->connection;
+ $r->print(&search_results_header($importbutton,$closebutton));
##
## Set viewing function
##
- my $viewfunction = $Views{$ENV{'form.viewselect'}};
+ my $viewfunction = $Views{$env{'form.viewselect'}};
if (!defined($viewfunction)) {
$r->print("Internal Error - Bad view selected.\n");
$r->rflush();
return;
}
##
+ ## $checkbox_num is a count of the number of checkboxes output on the
+ ## page this is used only during catalogmode=import.
+ my $checkbox_num = 0;
+ ##
## Get the catalog controls setup
##
my $action = "/adm/searchcat?phase=results";
##
- ##
- ##
- if ($ENV{'form.catalogmode'} eq 'groupsearch') {
+ ## Deal with import by opening the import db file.
+ if ($env{'form.catalogmode'} eq 'import') {
if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
- &GDBM_WRCREAT,0640)) {
- $r->print('Unable to tie hash to db file